Windows operating systemsLinux operating systems

Include.vmlocalsnapshot

This option specifies the management class that is applied to local backups of a VMware virtual machine. The management class defines the retention policies for the local backups.

Data moverThis feature is available only if the client operates as a data mover for IBM Storage Protect for Virtual Environments.

You can use this option only for virtual machines that are stored in a virtual volume (VVOL) datastore.

Supported Clients

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

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

Options File

Set this option in the client options file.

Syntax

Read syntax diagramSkip visual syntax diagram INCLUDE.VMLOCALSNAPSHOT   vmname   mgmtclassname

Parameters

vmname
Specifies the name of a virtual machine that you want to bind to the specified management class for local backup operations. The name is the virtual machine display name.
Only one virtual machine can be specified on each INCLUDE.VMLOCALSNAPSHOT statement. However, you can specify as many INCLUDE.VMLOCALSNAPSHOT statements as needed to bind each VM 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
Specifies the management class to use for local backups of the virtual machine. 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 Storage Protect server:
  • MCFORTESTVMS
  • MCFORPRODVMS
  • MCUNIQUEVM
Example 1
The following INCLUDE.VMLOCALSNAPSHOT statement in the client options file binds all virtual machines that have names that begin with VMTEST to the management class called MCFORTESTVMS:
include.vmlocalsnapshot vmtest* MCFORTESTVMS
Example 2
The following INCLUDE.VMLOCALSNAPSHOT statement in the client options file binds a virtual machine that is named WHOPPER VM1 [PRODUCTION] to the management class called MCFORPRODVMS:
include.vmlocalsnapshot "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.VMLOCALSNAPSHOT statement in the client options file binds a virtual machine that is named VM1 to a management class that is named MCUNIQUEVM:
include.vmlocalsnapshot VM1 MCUNIQUEVM