Loading...

Available Parameters for Subclient Configuration (VMware command line)

The following table describes the XML parameters used to modify a subclient.

Parameter

Description of Parameter Values

appName

Name of the application. In this case it would be 'Virtual Server'.

instanceName

Name of the Virtual Server instance (VMware).

backupSetName

Name of the backup set.

clientName

Name of the virtualization client.

subclientName

Name of the subclient.

newName

New name of the subclient.

storagePolicyName

Name of the storage policy to be associated with the subclient for backup.

numberOfBackupStreams

Number of simultaneous backup data streams allowed for the subclient.

vmContentOperationType

Type of operation that you want to perform to the subclient content. Valid values are:

ADD, to add content to the subclient

OVERWRITE, to overwrite contents to the subclient.

DELETE, to delete the contents from the subclient.

vmContent/children/type

Type of content to be added to the subclient. Valid values are:

VMName - to add a virtual machine to the subclient content

DATASTORE - to add a datastore to the subclient content

FOLDER - to add a VM folder to the subclient content

VMCustomAttribute - to add a custom attribute to VMs in the subclient

For a complete list of values, see VSA Object Types.

vmContent/children/displayName

Display name of the virtual machine, datastore, or other entity, depending on the content type defined in the vmContent/children/type parameter.

vmContent/children/name

Name of the virtual machine, datastore, or other entity, depending on the content type defined in the vmContent/children/type parameter.

vmContent/children/value

Value assigned for the entry identified by the vmContent/children/name parameter.

vmContent/children/allOrAnyChildren

Applies rules to selected virtual machines in the subclient. If you specify multiple rules, the following values determine which virtual machines are selected:

0 - Select virtual machines that meet any of the rules.

1 - Select virtual machines that meet all of the rules.

vmFilterOperationType

Type of operation that you want to perform to the subclient filters. Valid values are:

ADD, to add filters to the subclient

OVERWRITE, to overwrite filters to the subclient.

DELETE, to delete the filters from the subclient.

vmFilter/children/displayName

Display name of the virtual machine, datastore, or other entity, depending on the content type defined in the vmContent/children/type parameter.

vmFilter/children/type

Type of filter to be added to the subclient filters. You can add virtual machines to the subclient filters. Adding datastore disks is currently not supported.

Specify 'VMName' to add a virtual machine to the filters.

For a complete list of values, see VSA Object Types.

transportModeForVMWare

Option to set the transport mode of your environment. Valid values are:

  • AUTO, to allow the software to automatically set the transport mode based on your setup.
  • SAN
  • HOT_ADD
  • NBD_SSL
  • NBD
  • NAS

enableDeduplication

Option to enable deduplication on subclient.

Valid values are True/False.

vsInstance/clientName

Destination virtualization client name used to mount a snapshot or datastore on an ESX proxy.

vsInstance/instanceName

Name of the destination instance (VMware) used to mount a snapshot or datastore on an ESX proxy.

snapFailoverESXHosts

Name or IP address for the ESX host used to mount a snapshot or datastore. Verify the value for the ESX host before executing the command.

generateSignature

A component of deduplication performed on the client or MediaAgent computer. Valid values are:

  • ON_CLIENT, to enable signature generation on the client.
  • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.
  • OFF, to disable signature generation.

Note: Use this parameter when the enableDeduplication parameter is set to "true".

datastoreFreespaceCheck

Option to set a threshhold for free space on a datastore. If the datastore for a virtual machine under the subclient does not have enough free space for a snapshot of the VM, the backup of that VM is skipped. Checking for freespace before running the backup avoids errors during the backup job.

Valid values are 0 (disabled) or 1 (enabled).

datastoreFreespaceRequired

Percentage of free space that is required on the hosting datastores for snapshots of virtual machines under the subclient.

Valid values are 10 through 100.

quiesceGuestFileSystemAndApplications

The option to cause the VMware tools on the guest VM to quiesce the operating system and applications on each virtual machine when you back up the subclient. The backup process may slow down because of the quiescing.

Valid values are True/False.

useChangedTrackingOnVM

The option to use Changed Block Tracking (CBT) for all backups of virtual machines (VMs) under the subclient. CBT optimizes backups by reading only the allocated and modified portions of virtual machine disks.

Valid values are True/False.

VSA Object Types

The following object types can be used when specifying entities for subclient content or filters. You can use the numeric or text value.

Some object types are only applicable for specific hypervisors.

Object

Numeric Value

Text Value

Server Host Name or IP Address

1

SERVER

Resource Pool

2

RES_POOL

vApp

3

VAPP

Datacenter

4

DATACENTER

Folder

5

FOLDER

Cluster

6

CLUSTER

Datastore Name

7

DATASTORE

Datastore Cluster

8

DATASTORE_CLUSTER

Virtual Machine GUID

9

VM

Virtual Machine Name or Pattern

10

VMName

Virtual Machine Guest OS

11

VMGuestOS

Virtual Machine Guest Host Name

12

VMGuestHostName

Cluster Shared Volumes

13

ClusterSharedVolumes

Local Disk

14

LocalDisk

Cluster Disk

15

ClusterDisk

Unprotected VMs

16

UnprotectedVMs

All

17

ROOT

File Server

18

FileServer

Share

19

SMBShare

Types

20

TypesFolder

VMs

21

VMFolder

Servers

22

ServerFolder

Custom Templates

23

TemplateFolder

Datastore List

24

StorageRepositoryFolder

vApp List

25

VAppFolder

Datacenters

26

DatacenterFolder

Clusters

27

ClusterFolder

Virtual Machine Power State

28

VMPowerState

Virtual Machine Notes

29

VMNotes

Virtual Machine Custom Attribute

30

VMCustomAttribute

Network Adapter

31

Network

User

32

User

Virtual Machine Template

33

VMTemplate

Tag

34

Tag

Tag Category

35

TagCategory

Subclient

36

Subclient

Client Group

37

ClientGroup

Protection Domain

38

ProtectionDomain

Consistency Group

39

ConsistencyGroup

Instance Size

40

InstanceSize

Organization

41

Organization

Last modified: 5/2/2019 6:12:14 PM