Include.vm

For virtual machine operations, this option overrides the management class that is specified on the vmmc option.

This feature is available only if the client operates as a data mover for IBM Spectrum Protect™ for Virtual Environments.

The management class specified on the vmmc option applies to all VMware backups.

The management class specified on the vmmc option applies to all Hyper-V backups.

You can use the include.vm option to override that management class, for one or more virtual machines. The include.vm option does not override or affect the management class that is specified by the vmctlmc option. The vmctlmc option binds backed-up virtual machine control files to a specific management class.

Supported Clients

Linux operating systems This option can be used with supported Linux clients that are configured to back up VMware virtual machines.

Windows operating systems This option can be used with supported Windows clients that are configured to back up VMware virtual machines.

Windows operating systems This option can be used with supported Windows clients that are configured to back up Hyper-V virtual machines.

Options File

Set this option in the client options file.

Syntax


>>-INCLUDE.VM-- --vmname-- --+---------------+-----------------><
                             '-mgmtclassname-'

Parameters

vmname: Required parameter. Specifies the name of a virtual machine that you want to bind to the specified management class. The name is the virtual machine display name. Only one virtual machine can be specified on each include.vm statement. However, you can specify as many include.vm statements as needed to bind each virtual machine to a specific management class.
You can include wildcards in the virtual machine name. An asterisk (*) matches any character string. A question mark (?) matches a single character. If the virtual machine name contains a space character, enclose the name in double quotation marks (").

Tip: If the virtual machine name contains special characters, type the question mark wildcard in place of the special characters when you specify the virtual machine name.
mgmtclassname: Optional parameter. Specifies the management class to use when the specified virtual machine is backed up. If this parameter is not specified, the management class defaults to the global virtual machine management class that is specified by the vmmc option.

Examples

Assume that the following management classes exist and are active on the IBM Spectrum Protect server:

MCFORTESTVMS
MCFORPRODVMS
MCUNIQUEVM

Example 1

The following include.vm statement in the client options file binds all virtual machines that have names that begin with VMTEST to the management class called MCFORTESTVMS:

include.vm vmtest* MCFORTESTVMS

Example 2

The following include.vm statement in the client options file binds a virtual machine that is named WHOPPER VM1 [PRODUCTION] to the management class called MCFORPRODVMS:

include.vm "WHOPPER VM1 ?PRODUCTION?" MCFORPRODVMS

The virtual machine name must be enclosed in quotation marks because it contains space characters. Also, the question mark wildcard is used to match the special characters in the virtual machine name.

Example 3

The following include.vm statement in the client options file binds a virtual machine that is named VM1 to a management class that is named MCUNIQUEVM:

include.vm VM1 MCUNIQUEVM