XML Parameters for Client Operations

Name	Description	Element	Parent Element
clientGroupName	The name of the client computer group.	entity	association
clientDescription	A general description of the client.	client	clientProperties
clientName	The name of the client.	clientEntity	client
displayName	The display name of the client.	clientEntity	client
commCellName	The name of the CommCell.	clientEntity	client
hostName	The long name of the client, for example, client.domain.company.com.	clientEntity	client
cvdPort	The TCP port number for the Communications Service (CVD).	client	clientProperties
evmgrcPort	The TCP port number for the Client Manager Service (ClMgrS). Applies to upgraded clients or clients from previous Commvault versions.	client	clientProperties
installDirectory	The directory where the base software and/or iDataAgent is installed.	client	clientProperties
path	The directory where the job results reside.	jobResulsDir	client
userName	The name of the user.	userAccount	jobResulsDir
clientGroupName	The name of the client computer group.	clientGroups	clientProperties
excludeFromSLA	The names of the individual client computers that must be excluded from the SLA percentage, separated by commas.	advancedClientProperties	clientProps
AltCachePartitionForQSnap	The location of the alternate cache partition used for QSnap.	clientProps	clientProperties
AutoUpdateLocation		clientProps	clientProperties
CDRLogFileLocation	The location of the ContinuousDataReplicator (CDR) log files.	clientProps	clientProperties
CenteraResourceFilename	The file name for the Centera resource.	clientProps	clientProperties
CipherType	The cipher to use for data encryption. Valid values are: 3-DES AES (Rijndael) Blowfish GOST Serpent TwoFish	clientProps	clientProperties
DirectMediaAccessFlag	The storage option for the data encryption key. Valid values are: Regular, for Via Media Password ViaPassPhrase, for Via Pass Phrase None, for No Access	clientProps	clientProperties
EnableCollectDelegateInfo	Valid values are True/False.	clientProps	clientProperties
EnableContentIndexing	The option to enable content indexing. Valid values are True/False.	clientProps	clientProperties
EnableEncryption	The option to enable data encryption. Valid values are True/False.	clientProps	clientProperties
EncryptionSettings	The option to enable data encryption. Valid values are: USE_SPSETTINGS, to encrypt data according to the settings in the storage policy copy ON_CLIENT, to set encryption on the client OFF, to disable encryption	clientProps	clientProperties
EnableSnapBackups	The option to enable snap backups. Valid values are True/False.	clientProps	clientProperties
EncryptKeyLength	The key length to use with the cipher in the CipherType parameter. For the valid key length for each cipher, see Data Encryption Algorithms.	clientProps	clientProperties
JobPriority	The option to set the job priority. Valid values are 0 to 9.	clientProps	clientProperties
JobResultsDiskCapThreshold	The percentage of disk capacity that is reached before job results are pruned.	clientProps	clientProperties
JobResultsRetentionDays	The number of days to retain job results.	clientProps	clientProperties
JobResultsThresholdMB	The low space threshold in MB for the job results folder.	clientProps	clientProperties
OptimizeDataForSearch	The option to optimize data for searching. Valid values are True/False.	clientProps	clientProperties
PathToExchangeMiningTool	The location of the Exchange Mining Tool.	clientProps	clientProperties
RestoreAccessFlag	The storage and accessibility of data encryption keys in the CommServe database. Valid values are: Regular, for storing keys scrambled in the CommServe database WithPassPhase, for storing keys locked with a user-supplied pass-phrase in the CommServe database If you are using "WithPassPhase," the DirectMediaAccessFlag parameter must be set to "ViaPassPhrase."	clientProps	clientProperties
RetryCountOnNetworkError	The number of times the Job Manager checks for network connectivity. Use this parameter when the EnableRetryOnNetworkError parameter is set to "true."	clientProps	clientProperties
RetryFrequencyInSecOnNetworkError	The interval (in seconds) the Job Manager checks for network connectivity. Use this parameter when the EnableRetryOnNetworkError parameter is set to "true."	clientProps	clientProperties
WebServer	The settings related to the Web Server.	clientProps	clientProperties
cacheSource	The source of the cache. Valid values are: COMMSERVE UPDATEAGENT	clientProps	clientProperties
activityType	The client activities. Valid values are: 1, for backup 2, for restore 4, for auxiliary copy 8, for disaster recovery backup 16, archive pruning 32, for media recycle 64, for synthetic full 28, all activity 256, for schedule 512, for online content indexing 1024, for offline content indexing	activityControlOptions	clientActivityControl
TimeZoneName	The time zone to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true." Sample values: (UTC) Coordinated Universal Time (UTC-05:00) Eastern Time (US & Canada)	dateTime	activityControlOptions
timeValue	The date and time to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true." Sample values: 2013-12-11 09:22:32 2014-01-01 17:22:32	dateTime	activityControlOptions
enableActivityType	The option to enable or disable an activity for a client. Valid values are True/False.	activityControlOptions	clientActivityControl
enableAfterADelay	The option to enable an activity for a client on a date and time defined in the Enable Backup dialog box. Valid values are True/False.	activityControlOptions	clientActivityControl
userGroupName	The name of the user group associated with the client.	associatedUserGroups	clientSecurity
associatedUserGroupsOperationType	The operation to perform on the user groups in the userGroupName parameter in the <associatedUserGroups> element. Valid values are: ADD, to associate new user groups OVERWRITE, to overwrite the existing user groups with new user groups DELETE, to delete one or more user groups	clientSecurity	clientProps
clientOwners	The user name to be acted on by the clientOwnersOperationType parameter.	clientSecurity	clientProps
clientOwnersOperationType	The operation to perform on the client owner in the clientOwners parameter in the <clientSecurity> element. Valid values are: ADD, to associate the user to a client computer OVERWRITE, to associate the user in the clientOwners parameter and to disassociate all existing users available on the client computer DELETE, to disassociate the user from a client computer	clientSecurity	clientProps
individualCapabilities	The capabilities of the client computer owners to be acted on by the individualCapabilitiesOperationType parameter.	ownerCapabilities	clientSecurity
individualCapabilitiesOperationType	The operation to perform on the capabilities in the individualCapabilities parameter in the <ownerCapabilities> element. Valid values are: ADD, to add capabilities OVERWRITE, to add the capabilities in the individualCapabilities parameter and to remove all existing capabilities from the client owner DELETE, to remove capabilities	ownerCapabilities	clientSecurity
cacheBufferSize	The option to set the cache buffer size.	deDuplicationProperties	clientProps
clientSideDeduplication	The option to enable Client Side Deduplication. Valid values are: USE_SPSETTINGS, to use storage policy settings ON_CLIENT, to enable client side deduplication OFF, to disable client side deduplication	deDuplicationProperties	clientProps
enableClientSideDiskCache	The option to enable a client side disk cache. Use this parameter when the clientSideDeduplication parameter is set to "ON_CLIENT." Valid values are True/False.	deDuplicationProperties	clientProps
enableHighLatencyOptimization	The option to enable high latency optimization. Use this parameter when the enableClientSideDiskCache parameter is set to "true." Valid values are True/False.	deDuplicationProperties	clientProps
enableVariableContentAlignment	The option to enable variable content alignment. Valid values are True/False.	deDuplicationProperties	clientProps
maxCacheDb	The option to set the maximum size in megabytes for the cache database . Use this parameter when the enableClientSideDiskCache parameter is set to "true." Valid values are: 1024 2048 4096 8192 16384 32768 65536 131072	deDuplicationProperties	clientProps
performClientSideDeduplication	The option to enable or disable source side deduplication. Valid values are True/False.	deDuplicationProperties	clientProps
networkThrottle	The options for network throttling. For example, isAbsolute.	clientProps	clientProperties
enableThrottle	The option to enable network throttling. Valid values are True/False.	networkThrottle	clientProps
dlpEnableClientKeys	The option to unlock files before backups are performed and to allow users to open locked files without entering a pass-key.	dlpPropertise	clientProps
dlpMinFileAgeMins	The age in minutes of a document (created or modified) before it is locked during a DLP scan.	dlpPropertise	clientProps
dlpRmNow	The option to erase the files listed in the val parameter in the dlpRmFilters element. This action is irreversible. Valid values are True/False.	dlpRMProperties	dlpPropertise
dlpRmOfflineDays	The number of days a client must be offline before files are erased.	dlpRMProperties	dlpPropertise
enableRmDLP	The option to enable the Secure Erase feature of Data Loss Prevention (DLP). Valid values are True/False.	dlpRMProperties	dlpPropertise
val	The path to the content that will be deleted when Secure Erase is activated.	dlpRmContent	dlpRMProperties
val	The paths or file extensions that should not be deleted when Secure Erase is activated, for example, *.exe.	dlpRmFilters	dlpRMProperties
dlpScanIntervalMins	The number of minutes the DLP scan waits between scans for new or unlocked content.	dlpPropertise	clientProps
dlpStolen	The option to mark the client as stolen. Valid values are True/False.	dlpPropertise	clientProps
enableDLP	The option to enable Data Loss Prevention (DLP). Valid values are True/False.	dlpPropertise	clientProps
val	The path to the content that should be locked when the DLP scan runs.	dlpContents	dlpPropertise
val	The paths or file extensions that should not be locked when the DLP scan runs, for example, *.dll.	dlpFilters	dlpPropertise
enableAccessControl	This option to enable access control. Valid values are True/False.	clientProps	clientProperties
fileLevelAnalyticsLicense	Valid values are True/False.	clientProps	clientProperties
isWebServerInstalled	Indicates whether a web server is installed. Valid values are True/False.	clientProps	clientProperties
overrideGlobalDesktopGuiProperties	Valid values are True/False.	clientProps	clientProperties
SMTPAddressOfTheRMSSuperUser	The SMTP address of the RMS (Rights Management Services) super user.	rightManagementServiceProperties	clientProps
decryptRMSDocumentDuringContentIndexing	The option to decrypt an RMS (Rights Management Services) document during content indexing. Valid values are True/False.	rightManagementServiceProperties	clientProps
userName	The name of the user.	rmsCredentials	rightManagementServiceProperties
smtpAddressOfRMSSuperUser	The SMTP address of the RMS (Rights Management Services) super user.	rightManagementServiceProperties	clientProps
enableOnlineSearch	The option to enable online searching. Valid values are True/False.	spWebServerProperties	clientProps
spWebServerUserPassword	The user password for the SharePoint web server.	spWebServerProperties	clientProps
clientName	The name of the client.	webSearchServer	clientProps
hostName	The long name of the client, for example, client.domain.company.com.	webSearchServer	clientProps
webSearchServerForSuperSearch	The web server used for the search.	clientProps	clientProperties
webSearchServiceUrl	The URL for the web search.	clientProps	clientProperties
configureClusterClient	The option to enable the cluster group configuration. Valid values are True/False.	clusterClientProperties	clientProperties
showAllAgents	The option to show all agents. Valid values are True/False.	clusterClientProperties	clientProperties
cvdPort	The TCP port number for the Communications Service (CVD).	openVMSProperties	pseudoClientInfo
userName	The name of the user.	userAccount	openVMSProperties