Include.vmdisk
The INCLUDE.VMDISK option includes a virtual machine (VM) disk in backup operations. If you do not specify one or more disk labels, all disks in the VM are backed up.
This option is available only if you are using the IBM Spectrum Protect™ for Virtual Environments licensed product. For more information about this option, see the IBM Spectrum Protect for Virtual Environments product documentation on IBM® Knowledge Center at http://www.ibm.com/support/knowledgecenter/SSERB6/welcome.
The INCLUDE.VMDISK option specifies the label of a VM disk to be included in a backup vm operation. If you include a disk on the backup vm command, the command-line parameters override any INCLUDE.VMDISK statements in the options file.
This option applies to both VMware and Microsoft Hyper-V virtual machine disks.
INCLUDE.VMDISK for VMware virtual machines
Use the INCLUDE.VMDISK option to include a VMware virtual machine in backup operations.
Supported clients
This option can be used with supported x86_64 Linux clients.
This option can be used with supported Windows clients.
Options file
Set this option in the client options file. Command line parameters override statements in the options file.
Syntax for VMware virtual machines
>>-INCLUDE.VMDISK--vmname-- -vmdk_label------------------------><
Parameters
- vmname
- Specifies the name of the virtual machine that contains a disk that you want to include in a Backup VM operation. The name is the virtual machine display name. You can specify only one virtual machine name on each INCLUDE.VMDISK statement. Specify additional INCLUDE.VMDISK statements for each virtual machine disk to include.
- The virtual machine name can contain an asterisk (*), to match any character string, and question mark (?) to match any one character. Surround the VM name with quotation marks (" ") if the VM name contains space characters.
- Tip: If the virtual machine name contains special characters, such as bracket characters ([ or ]), the virtual machine name might not be correctly matched. If a virtual machine name uses special characters in the name, you might need to use the question mark character (?) to match the special characters in the VM name
For example, to include Hard Disk 1 in the backup of a virtual machine named "Windows VM3 [2012R2]", use this syntax in the options file: INCLUDE.VMDISK "Windows VM3 ?2012R2?" "Hard Disk 1"
- vmdk_label
- Specifies the disk label of the disk that you want to include. Wildcard characters are not allowed. Use the Backup VM command with the -preview option to determine the disk labels of disks in a given virtual machine. See "Backup VM" for the syntax.
Examples
- Options file
- Assume that a virtual machine named vm1 contains four disks, labeled Hard Disk 1, Hard Disk 2,
Hard Disk 3, and Hard Disk 4. To include only disk 2 in a Backup VM operations,
specify the following in the options
file:
INCLUDE.VMDISK "vm1" "Hard Disk 2"
- Include disks 2 and 3 in Backup VM operations:
INCLUDE.VMDISK "vm1" "Hard Disk 2" INCLUDE.VMDISK "vm1" "Hard Disk 3"
- Command line
- Include a single disk when backing up
vm1:
dsmc backup vm "vm1:vmdk=Hard Disk 1"
- Include disk 2 and disk 3 on
vm1:
dsmc backup vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"
INCLUDE.VMDISK for Microsoft Hyper-V virtual machines
Use the INCLUDE.VMDISK option to include a VM disk from Hyper-V RCT backup operations on Windows Server 2016 or later operating systems.
Supported clients
This option can be used with Windows Server 2016 or later clients.
Options file
Set this option in the client options file. Command-line parameters override statements in the options file.
Syntax for Microsoft Hyper-V virtual machines
>>-INCLUDE.VMDISK--vmname-- -disk_location---------------------><
Parameters
- vmname
- Specifies the name of the VM that contains a disk that you want to include from a backup vm operation. The name is the virtual machine display name. You can specify only one VM name on each INCLUDE.VMDISK statement. Specify additional INCLUDE.VMDISK statements for each VM disk to include.
- The VM name can contain an asterisk (*) to match any character string, and a question mark (?) to match any one character. If the VM name contains space characters, surround the VM name with quotation marks (" ").
- Tip: If the VM name contains special characters, such as bracket characters ([) or (]), the VM name might not be correctly matched. If a VM name includes special characters, use a question mark (?) to represent the special characters.For example, to include a SCSI VM disk in the backup of a virtual machine named "Windows VM3 [2012R2]", use this syntax in the options file:
INCLUDE.VMDISK "Windows VM3 ?2012R2?" "SCSI 0 1"
- disk_location
- Specify the location of the VM disk to include in a Hyper-V RCT backup operation. The disk
location label must begin with "SCSI" or "IDE" followed by the controller number and device location
number. Wildcard characters are not allowed. Tip: Use the backup vm command with the -preview option to determine the location of disks in a given virtual machine. See the "Backup VM" topic for the syntax.
Examples
- Options file
- Virtual machine vm1 contains an IDE VM disk (VHDX) at controller number 1 and
device location 0. To include this VHDX in backup vm operations, specify the
following statement in the options file:
INCLUDE.VMDISK vm1 "IDE 1 0"
- Virtual machine vm2 contains a SCSI VM disk at controller number 0 and device
location 1. Include this VHDX in backup operations by specifying the following statement in the
options file:
INCLUDE.VMDISK vm2 "SCSI 0 1"
- Command line
- Include a single IDE disk (at controller number 1 and device location 0) when virtual machine
vm1 is backed up:
dsmc backup vm "vm1:vhdx=IDE 1 0"
- Include a SCSI disk (at controller number 0 and device location 1) in the backup operation of
virtual machine vm2:
dsmc backup vm "vm2:vhdx=SCSI 0 1"