The domain.vmfull option
specifies the virtual machines to include in your full virtual machine
image backup operations.
For VMware virtual
machine 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.
For Hyper-V virtual machine backups,
you can use this option to specify which Hyper-V virtual machines
are processed when you run a backup vm -vmbackuptype=hypervfull command,
without specifying any Hyper-V virtual machine names. The domain.vmfull option
applies only to Hyper-V backups that use either mode=ifincremental or mode=iffull.
Those modes also require a Tivoli® Storage
Manager for Virtual Environments: Data Protection for Microsoft Hyper-V license.
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 entered
without specifying a virtual machine or a list of virtual machines
on the command line.
Attention: For Microsoft Hyper-V operations, the only valid
domain-level parameter for the
domain.vmfull option
is
all-vm. You can also include one or more virtual
machines by using the
VM= keyword, or exclude virtual
machines by using the
-VM= syntax. As an alternative
to
domain.vmfull, you can also use 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 for VMware virtual machines
.-;-------------------------------------.
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 virtual 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).
- For Hyper-V virtual machines, the names are
case-sensitive and must match the capitalization that is shown on
the Hyper-V host in the view.
- vm=vmname
- The vm= keyword specifies that the next set of
values is a list of virtual machine names. The vm= keyword
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 host name: -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. Set the following option:
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
- The :vmdk= keyword applies
only to VMware virtual machines and its use requires a Tivoli Storage
Manager for Virtual Environments: Data Protection for VMware license.
This
option is typically used to exclude disks (see the :-vmdk syntax)
from being backed up. 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.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:vmdk=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
- For VMware virtual machines. This option processes
all virtual machines that are defined to the Virtual Center or to
the ESX server that is specified on the vmchost option.
- For Hyper-V virtual machines,
this option specifies that a backup vm operation
processes all Hyper-V virtual machines that are known to the Hyper-V
host.
- all-windows
- For VMware virtual machines. This option processes 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
- For VMware virtual machines. This option processes all virtual
machines that are defined to the Virtual Center or to the ESX server
that is specified on the vmchost option. The host
name that you specify must match the fully qualified host name or
IP address, as it is specified in the vCenter server Hosts
and Clusters view.
- 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 sent to the
console and is recorded in the client dsmerror.log file;
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
- For VMware virtual machines. This option processes
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
- For VMware virtual machines. This option processes 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 host
cluster, a warning level message is sent to the console and is recorded
in the client dsmerror.log file; it is also recorded
as a server event message.
- vmdatastore=datastorename
- For VMware virtual machines. This option processes 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 as the domain.
Examples
- Options file:
- Include all virtual machines in full VM backup operations.
domain.vmfull all-vm
- Include all virtual machines in full VM backup
operations, except for the ones that have a name suffix of _test.
domain.vmfull all-vm;-vm=*_test
- Include all virtual machines that have Windows as the operating
system, in full VM backup operations.
domain.vmfull all-windows
- Include all virtual machines in cluster servers 1, 2, and 3 in
full VM backup operations.
domain.vmfull vmhostcluster=cluster1,cluster2,cluster3
- Include all virtual machine data in datastore1 in
full VM backup operations.
domain.vmfull vmdatastore=datastore1
- Include all virtual machines in full VM backup operations, but
exclude virtual machines testvm1 and testmvm2.
domain.vmfull all-vm;-VM=testvm1,testvm2
- Include the virtual machines that are defined in the VM folders
that are named lab1 and lab2 in full VM backup operations.
domain.vmfull vmfolder=lab1,lab2
- Include all virtual machines on the ESX hosts named "brovar", "doomzoo",
and "kepler" in full VM backup operations.
domain.vmfull vmhost=brovar.example.com,
doomzoo.example.com,kepler.example.com