The domain.vmfull option
specifies the virtual machines to include in your full VM image backups.
The domain.vmfull option
works with the vmchost option. The vmchost option
identifies the vCenter server or ESX server that contains the virtual
machines that you want to protect. The domain.vmfull parameters
are used to narrow the focus of an operation to a subset of the virtual
machines that are running on the system that is identified by vmchost.
You can specify which virtual
machines are to be processed by using any of the following techniques:
- Use the VM= option and specify the name of a
virtual machine.
- Provide a comma-separated list of virtual machine names.
- Use wildcard syntax to process virtual machines that match the
name pattern.
- Use one of the following domain-level parameters:
- all-vm
- all-windows
- vmhost
- vmfolder
- vmhostcluster
- vmdatastore
When you use domain-level parameters, virtual
machines that are created in the domain are automatically included
when the next backup occurs. For example, if you use the vmfolder parameter
to back up all virtual machines included in a folder, any new virtual
machines that get added to that folder are included in the next backup.
The same is true of pattern-matched names that are included in a wildcard
match.
The virtual machines
that are specified on the domain.vmfull option are
processed only when the backup vm command is issued
without specifying a virtual machine or a list of virtual machines
on the command line.
This
option is not used to back up or restore Hyper-V systems. Hyper-V
system backup and restore operations are performed only on the Hyper-V
virtual machines that are specified on the command line, or on the -vmlist option.
Supported Clients
This
option can be used with supported x86_64 Linux clients.
This
option can be used with supported Windows clients.
The
server can also define this option.
Options file
Set this option
in the client options, by using the command line, or by using the
VM
Backup tab of the Preferences editor.
Restriction: The vmname:vmdk=vmdk_label parameters
cannot be set in the Preferences Editor. Include this setting in the
options file, or on the command line when you run a backup
vm command.
Syntax
.-;-------------------------------------.
V .-vmname1,vmname2-------------------. |
>>-DOMAIN.VMFUll----+-----------------------------------+-+----><
+-VM=vmname1,vmname2----------------+
+- -VM=vmname1,vmname2--------------+
+-ALL-VM----------------------------+
+-ALL-WINdows-----------------------+
+-VMHost=srv1,srv2------------------+
+-VMFolder=foldername1,foldername2--+
+-VMHOSTCLUSTER=cluster1,cluster2---+
'-VMDATASTORE=datastore1,datastore2-'
Syntax rules: Multiple
keywords must be separated by a semicolon. There cannot be any spaces
after the semicolons. Multiple machine or domain names must be separated
by commas, with no space characters. For examples, see vm=vmname.
Parameters
- vmname
- Defines the virtual machine name that you want to process. You
can supply a list of virtual machine host names, by separating the
names with commas (vm1,vm2,vm5).
- vm=vmname
- The vm= keyword specifies that the next set of
values is a list of virtual machine names. vm= is
the default and is not required.
In this example,
vm= is
not specified and commas are used to separate the machine names.
domain.vmfull my_vm1,my_vm2
- If you specify multiple keywords, such as vm= and vmfolder=,
the values that the keywords refer to must be separated by semicolons,
with no intervening space characters:
domain.vmfull vm=my_vm1;vm=my_vm2
domain.vmfull vm=my_vm1;vmfolder=folder1;vmfolder=folder2
Wildcard
characters can be used to select virtual machine names that match
a pattern. An asterisk (*) matches any sequence of characters. A question
mark (?) matches any single character, for example:
- Exclude all files that have "test" in the hostname: -vm=*test*
- Include all virtual machines with names such as: "test20", "test25", "test29", "test2A": vm=test2?
You can exclude a virtual machine from a backup operation by
specifying the exclude operator (-) before the
vm= keyword.
For example,
-vm is used to exclude a particular machine,
or machines, from a domain level backup, such as,
ALL-Windows,
ALL-VM,
and
VMFolder. If
"vm1" is the name of a virtual
machine in a folder that is named
"accountingDept", you can back
up all of the virtual machines in the folder, but prevent the virtual
machine vm1 from being backed up. Run the following command:
domain.vmfull VMFolder=accountingDept;-vm=vm1
You
cannot use the exclude operator (-) to exclude a domain, such as
ALL-VM,
ALL-Windows,
or
VMFolder. The exclude operator works only at the
virtual machine name level.
- vmname:vmdk=vmdk_label
- This :vmdk= keyword requires a Tivoli® Storage Manager for
Virtual Environments license.
This option is typically used to
exclude disks (see the :-vmdk syntax) that are backed
up by other means, such as by Tivoli Data
Protection products that run in the virtual machine. You can also include virtual machine disks by using
the INCLUDE.VMDISK option or exclude
virtual machine disks by using the EXCLUDE.VMDISK option.
Detailed guidance for excluding disks when you back
up VMware virtual machines is provided in the IBM® Tivoli Storage
Manager for Virtual Environments V7.1 Data Protection for VMware User's
Guide.
The virtual disks within a virtual machine have
disk labels that uniquely identify each virtual disk. You use the :vmdk= keyword
to specify the labels of the virtual disks that you want to be included
in a Backup VM operation. If you do not specify :vmdk= and
a disk label, all virtual disks in the virtual machine are backed
up.
Assume that there is a virtual machine named
"my_vm_example".
This virtual machine has four disks (labeled
Hard Disk 1,
Hard Disk 2, Hard Disk 3, Hard Disk 4). To include only Hard
Disk 2 and Hard Disk 3 in a backup, add the
:vmdk= keyword
and disk label for those disks. Quotation marks are necessary around
the parameters because the disk labels contain space characters. For
example:
domain.vmfull "my_vm_example:vmdk=Hard Disk 2:vmdk=Hard Disk 3"
This
next example backs up Hard Disk 1 and Hard Disk 2 on VM1, and Hard
Disk 3 and Hard Disk 4 on VM2. A comma is used to separate the virtual
machine information.
domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2",
"vm2:vmdk=Hard Disk 3:vmdk=Hard Disk 4"
Similar
to the -vm= keyword, you can also use the exclusion
operator (-) with :vmdk= to exclude disks from a
backup operation.
To back up a virtual machine (vm1) and exclude
disks 3 and 4, use the following syntax:
domain.vmfull "vm1:-vmdk=Hard Disk 3:-vmdk=Hard Disk 4"
To
back up two virtual machines, vm1 and vm2, and exclude the first two
disks on each machine, use the following syntax:
domain.vmfull "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2",
"vm2:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2"
You
can include one or more disks on a
domain.vmfull statement.
You can exclude one or more disks on a
domain.vmfull statement.
You can mix include and exclude disks on the same statement. For example,
the following statement is valid:
domain.vmfull
"vm1:Hard Disk 1:-vmdk=Hard Disk 2:vmdk=Hard Disk 3:vmdk:Hard Disk 4"
If
an include statement is present, all other disks in the virtual machine
are excluded from a backup operation, unless the other disks are also
specified in an include statement. For example, the following statement
excludes all hard disks on vm1, except for Hard Disk 1:
domain.vmfull "vm1:vmdk=Hard Disk 1"
Both
of the following exclude Hard Disk 4 from a backup of vm1:
domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"
domain.vmfull "vm1:-vmdk=Hard Disk 4"
- all-vm
- Process all virtual machines that are defined to the Virtual Center
or to the ESX server that is specified on the vmchost option.
- all-windows
- Process all virtual machines that are defined to the Virtual Center
or to the ESX server that is specified on the vmchost option.
The virtual machines must also have a guest operating system type
of Windows.
- vmhost=hostname
- Process all virtual machines that are defined to the Virtual Center
or to the ESX server that is specified on the vmchost option.
All virtual machines that are added to this host are automatically
included in backup and restore processing. To be included, the virtual
machines must also be running on the ESX server that is specified
by the host name; they cannot be powered off.
- This parameter can include multiple ESX servers that are separated
by commas. When the Virtual Center contains multiple ESX servers,
this option does not determine the ESX server from which a snapshot
is taken. The ESX server from which a snapshot is taken is determined
by the VMware VirtualCenter web service.
- When you connect directly to an ESXi or ESX host, the vmchost option
applies only if the vmhost is the server that you connect to. If it
is not, a warning level message is issued to the console and is recorded
in the client dsmerror.log; it is also recorded
as a server event message.
- If the vmenabletemplatebackups option is set
to yes, and VM templates are part of the domain,
they are included in the backup.
Restriction: VMware templates for virtual machines cannot be backed
up when they are in an ESX or ESXi host because ESX and ESXi hosts
do not support templates.
- vmfolder=foldername
- Process all virtual machines that are defined to
the Virtual Center or to the ESX server that is specified on the vmchost option.
The virtual machines must also exist in the VMware folder that is
specified by the folder name. Folder name can include multiple VMware
folders that are separated by commas.
- vmhostcluster=hostclustername
- Process all virtual machines that are defined to the Virtual Center
or to the ESX server that is specified on the vmchost option.
The virtual machines must also be running on the ESX host cluster
that is specified by the host cluster name. To include more than one
host cluster name, separate the cluster names with commas: VMHOSTCLUSTER=cluster1,cluster2.
- If the vmenabletemplatebackups option is set
to yes, and VM templates are part of the domain,
they are included in the backup. A VMware host cluster is not available
if you connect directly to an ESXi or ESX host. If you connect directly
to an ESXi/ESX host and a domain is processed that includes a hostcluster,
a warning level message is issued to the console and is recorded in
the client dsmerror.log; it is also recorded
as a server event message.
- vmdatastore=datastorename
- Process all virtual machines that are defined to the Virtual Center
or to the ESX server that is specified on the vmchost option.
The configured datastore location for a virtual machine must match
the datastore name that is specified by datastorename.
The datastore name can include multiple datastores that are separated
by commas: VMDATASTORE=datastore1,datastore2
- Virtual machines can have their disk (vmdk files)
on more than one datastore; but there is only one default datastore
location. This default datastore location is defined in the virtual
machine configuration and is always where the virtual machine configuration
file (.vmx file) is located. When a machine is
selected for backup by using a domain keyword, the virtual machine
configuration file, and all of the virtual machine's disks are included
in the backup, including the disks that are on a different datastore
than the one specified on the domain.
Examples
- Options file:
- Perform a full VM backup of all virtual machines.
domain.vmfull all-vm
- Perform a full VM backup of all virtual machines that have Windows
as the operating system.
domain.vmfull all-windows
- Perform a full VM backup of all virtual machines in cluster servers
1, 2, and 3.
domain.vmfull vmhostcluster=cluster1,cluster2,cluster3
- Back up all virtual machine data in datastore1.
domain.vmfull vmdatastore=datastore1
- Perform a full VM backup of all virtual machines, but exclude
virtual machines testvm1 and testmvm2.
domain.vmfull all-vm;-VM=testvm1,testvm2
- Perform a full VM backup of the virtual machines that are defined
in the VM folders that are named lab1 and lab2.
domain.vmfull vmfolder=lab1,lab2
- Perform a full VM backup of all virtual machines on the ESX hosts
named "brovar", "doomzoo", and "kepler".
domain.vmfull vmhost=brovar.example.com,
doomzoo.example.com,kepler.example.com
- Command line:
- Back up the virtual machines testvm1 and testvm2. On testvm1,
include only Hard Disk 2 and Hard Disk 3; include all disks on testvm2
in the backup.
dsmc backup vm "testvm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3",testvm2
- Back up virtual machine testvm1, and exclude Hard Disk 1 and Hard
Disk 4.
dsmc backup vm "testvm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 4"
- Back up all virtual machines that are running on the ESX servers
named brovar, doomzoo, and kepler.
dsmc backup vm -domain.vmfull="VMHOST=brovar.example.com,
doomzoo.example.com,kepler.example.com"