%all.entities; ]> March 2019 VBoxManage snapshot VBoxManage-snapshot 1 VBoxManage-snapshot manage &product-name; virtual machine snapshots Oracle VM VirtualBox VBoxManage snapshot uuid|vmname VBoxManage snapshot uuid|vmname take snapshot-name --description=description --live --uniquename Number,Timestamp,Space,Force VBoxManage snapshot uuid|vmname delete snapshot-name VBoxManage snapshot uuid|vmname restore snapshot-name VBoxManage snapshot uuid|vmname restorecurrent VBoxManage snapshot uuid|vmname edit snapshot-name --current --description=description --name=new-name VBoxManage snapshot uuid|vmname list --details--machinereadable VBoxManage snapshot uuid|vmname showvminfo snapshot-name Description The VBoxManage snapshot command manages snapshots. &product-name; uses the snapshot to capture the state of a virtual machine (VM). You can later use the snapshot to revert to the state described by the snapshot. A snapshot is a complete copy of a VM's settings. If you take the snapshot while the VM is running, the snapshot also includes the VM's state file. After you take a snapshot, &product-name; creates a differencing hard disk for each normal hard disk that is associated with the host machine. When you restore a snapshot, &product-name; uses these differencing files to quickly reset the contents of the VM's virtual hard disks. For each VBoxManage snapshot command, you must specify the name or the universal unique identifier (UUID) of the VM for which you want to take a snapshot. General Command Operand uuid|vmname Specifies the UUID or name of the VM. Take a Snapshot of a Virtual Machine The VBoxManage snapshot take command takes a snapshot of the current state of the VM. You must supply a name for the snapshot and can optionally supply a description. The new snapshot is inserted into the snapshots tree as a child of the current snapshot and then becomes the new current snapshot. Specifies a description of the snapshot. Specifies that the VM is not stopped while you create the snapshot. This operation is know as live snapshotting. TBD. What does this option do and how is it used? snapshot-name Specifies the name of the snapshot to create. Delete a Snapshot The VBoxManage snapshot delete command removes the specified snapshot. The delete operation may take some time to finish. This is because the differencing images that are associated with the snapshot may need to be merged with their child differencing images. snapshot-name Specifies the UUID or name of the snapshot. Restore a Snapshot The VBoxManage snapshot restore command restores the specified snapshot. This operation resets the VM's settings and current state to that of the snapshot. The state of the VM on which you restore a snapshot is lost. When restored, the specified snapshot becomes the new current snapshot and subsequent snapshots are children of that snapshot. snapshot-name Specifies the UUID or name of the snapshot. Restore the Current Snapshot The VBoxManage snapshot restorecurrent command restores the current snapshot. The current snapshot is the one from which the current state is derived. This command is equivalent to using the VBoxManage snapshot restore command and specifying the name or UUID of the current snapshot. Change the Name or Description of an Existing Snapshot The VBoxManage snapshot edit command enables you to change the name or the description of a specified snapshot. snapshot-name Specifies the UUID or name of the snapshot to edit. This option is mutually exclusive with the option. Specifies that you update the current version of the snapshot. This option is mutually exclusive with a specific snapshot name or its UUID. Specifies a new description for the snapshot. Specifies a new name for the snapshot. List the Snapshots The VBoxManage snapshot list command lists all the snapshots for a VM. Specifies that the output shows detailed information about the snapshot. This option is mutually exclusive with the option. Specifies that the output is shown in a machine-readable format. This option is mutually exclusive with the option. Show Information About a Snapshot's Settings The VBoxManage snapshot showvminfo command enables you to view the VM settings that are part of an existing snapshot. snapshot-name Specifies the UUID or name of the snapshot. Examples The following command creates a snapshot of the ol7u4 VM. The snapshot is called ol7u4-snap-001. The command uses the option to provide a description of the snapshot contents. $ VBoxManage snapshot ol7u4 take ol7u4-snap-001 \ --description="Oracle Linux 7.4" The following command lists the snapshots for the ol7u4 VM. $ VBoxManage snapshot ol7u4 list The following command changes the description for the ol7u4-snap-001 snapshot of the ol7u4 VM. $ VBoxManage snapshot ol7u4 edit ol7u4-snap-001 \ --description="Oracle Linux 7.4 with UEK4 kernel" The following command shows VM settings for the ol7u1-snap-001 snapshot of the ol7u4 VM. $ VBoxManage snapshot ol7u4 showvminfo ol7u4-snap-001 Name: ol7u4 Groups: / Guest OS: Oracle (64-bit) UUID: 43349d78-2ab3-4cb8-978f-0e755cd98090 Config file: C:\Users\user1\VirtualBox VMs\ol7u4\ol7u4.vbox ... Snapshots: Name: ol7u4-snap-001 (UUID: 1cffc37d-5c37-4b86-b9c5-a0f157a55f43) Description: Oracle Linux 7.4 with UEK4 kernel