Set Vmtags

The set vmtags command creates backup management tags and categories that can be added to VMware virtual machines. You can manage Tivoli® Storage Manager backups of virtual machines by specifying these tags with tools such as VMware vSphere PowerCLI version 5.5 R2 or later.

If you are using the IBM® Data Protection extension to manage backups, you do not need to run the set vmtags command first. The tags and categories are created for you.

If you are writing scripts to apply these tags to virtual machines, you need only to issue the set vmtags command once so that backup management tags are created before they are added to the virtual machines.

When you run this command, the following categories and tags are created:

Category	Tag	Tag description
`Backup Management (IBM Spectrum Protect)`	`Excluded`	`The object is excluded from backups by IBM Spectrum Protect`
`Management Class (IBM Spectrum Protect)`	`Management_class_name`	`The policy used for retention settings in IBM Spectrum Protect`

Where:

Excluded: Excludes a virtual machine from scheduled backup services.

Management_class_name: The name of the retention policy that defines how long backup versions are kept on the Tivoli Storage Manager server or how many backup versions can exist on the server before they are expired.
If you do not use the Management_class_name tag value, the default retention policy for the VMware datacenter node is used.

Then, you can use scripts to apply these tags to virtual machines to exclude the virtual machines from scheduled backup services, or to specify the retention policy for the backups on the Tivoli Storage Manager server.

If the backup management tags already exist, running the set vmtags command does not create the tags again.

Requirements: Before you run the set vmtags command, ensure that the following requirements are met:

VMware vCenter Server must be at Version 6.0 Update 1 or later.
The vmchost option must be configured in the dsm.opt file on Windows clients or dsm.sys file on Linux clients. The user name and password that are associated with the vmchost value must also be set. If not already set, you can use the dsmc set password command to set the user name and password.

Supported clients

Linux operating systems This command is valid only on supported Linux x86_64 clients that are installed on a vStorage backup server that protects VMware virtual machines.

Windows operating systems This command is valid on supported Windows 64-bit clients that are installed on a vStorage backup server that protects VMware virtual machines.

Syntax


>>-SET VMTAGS--------------------------------------------------><

Parameters

No parameters are required for this command.

Examples

Task

Create backup management tags and categories that can be added to virtual machines:

dsmc set vmtags