Command Line Interface - CommServe XML Files

Table of Contents

Overview

In addition to generating the XML files using the Save As Script option, you can perform CommCell operations using user-defined XML files. These XML files are executed using the qoperation execute command, for example:

C:\>cd C:\Program Files\Company\Software\Base
C:\Program Files\Company\Software\Base> qlogin -cs commserve001 -u admin
Password:
User logged in successfully.
C:\Program Files\Company\Software\Base> qoperation execute -af C:\input.xml

Logging On to the CommServe

To run command line operations, you must first login to the CommServe.

From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:

qlogin -cs <commserve name> -u <user name>

For example, to log on to CommServe 'server1' with username 'user1':

qlogin -cs server1 -u user1

User Administration and Security

For other user administration and security operations using XML files, see Command Line Operations for Managing Users.

Updating a User Group on a Client or Client Computer Group

Use the following steps to:

  • Associate an existing user group with a client or client computer group
  • Remove a user group from a client or client computer group
  • Replace all user groups associated with a client or client computer group with a different user group
  1. Download one of the following files to the computer from where you will run the command:
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. On the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type one of the following commands after substituting the XML parameters:

    qoperation execute -af ug_to_client.xml

    qoperation execute -af ug_to_clientgroup.xml

  1. Verify the user group is associated with the client or client computer group:
    1. From the CommCell Browser, right-click the client or the client computer group and then click Properties.

      The Client Computer Properties dialog box appears.

    2. Click the Security tab.
    3. The user group appears in the Associated Groups pane.

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description of Parameter Values
clientName Use with the ug_to_client.xml template. Names of the client computers to modify.

To modify multiple clients, add an <entity> and a <clientName> element for each client, for example:

<entity>
<clientName>client1</clientName>
</entity>
<entity>
<clientName>client2</clientName>
</entity>

clientGroupName Use with the ug_to_clientgroup.xml template. Names of the client computer groups to modify.

To modify multiple client computer groups, add an <entity> and a <clientGroupName> element for each client computer group, for example:

<entity>
<clientGroupName>clientGroup1</clientGroupName>
</entity>
<entity>
<clientGroupName>clientGroup2</clientGroupName>
</entity>

userGroupName Name of the user group to associate with the client or client computer group.
associatedUserGroupsOperationType The operation to perform on the user group. Valid values are:
  • ADD, to associate the user group with a client or a client computer group.
  • DELETE, to remove the user group from a client or a client computer group.
  • OVERWRITE, to replace all user groups associated with a client or a client computer group with a different user group. For example: usergroup2 and usergroup3 are associated with client1. Use the "overwrite" operation to replace these user groups with usergroup4.

Updating Client Owners on a Client or Client Computer Group

Use the following steps to:

  • Add an existing user to a client computer or a client computer group as the client owner

    The client owner has access to the client or the client computer group and can perform backup and restore operations. A client owner receives all of the capabilities designated by the administrator.

  • Remove a client owner from a client computer or a client computer group
  • Replace all client owners on a client or a client computer group with a different client owner
  1. Download one of the following files to the computer from where you will run the command:
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type one of the following command after substituting the XML parameters:

    qoperation execute -af user_to_client.xml

    qoperation execute -af user_to_clientgroup.xml

  5. Verify the user is a client owner on the client or the client computer group:
    1. From the CommCell Browser, right-click the client and then click Properties.

      The Client Computer Properties dialog box appears.

    2. Click the Security tab.
    3. The user appears in the Users pane of the Client Owners section.

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description of Parameter Values
clientName Use with the user_to_client.xml template. Names of the client computers to modify.

To modify multiple clients, add an <entity> and a <clientName> element for each client, for example:

<entity>
<clientName>client1</clientName>
</entity>
<entity>
<clientName>client2</clientName>
</entity>

clientGroupName Use with the user_to_clientgroup.xml template. Names of the client computer groups to modify.

To modify multiple client computer groups, add an <entity> and a <clientGroupName> element for each client computer group, for example:

<entity>
<clientGroupName>clientGroup1</clientGroupName>
</entity>
<entity>
<clientGroupName>clientGroup2</clientGroupName>
</entity>

clientOwners Name of the user to add as a client owner.
clientOwnersOperationType The operation to perform on the user. Valid values are:
  • ADD, to add the user as a client owner
  • DELETE, to remove the user as the client owner
  • OVERWRITE, to replace all client owners on a client or client computer group with a different client owner. For example: owner2 and owner3 are client owners on client1. Use the "overwrite" operation to replace these client owners with owner4.

Updating Client Owner User Groups on a Client

Use the following steps to:

  • Add existing user groups to a client computer as client owners

    Client owners have access to the client computer and can perform backup and restore operations on the client.

  • Remove client owner user groups from a client computer
  • Replace all client owner user groups on a client computer with different client owner user groups
  1. Download the ug_owners_to_client.xml file to the computer from where you will run the command.
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type the following command after substituting the XML parameters:

    qoperation execute -af ug_owners_to_client.xml

  5. Verify the user group is a client owner on the client:
    1. From the CommCell Browser, right-click the client and then click Properties.

      The Client Computer Properties dialog box appears.

    2. Click the Security tab.
    3. The user group appears in the User Groups pane of the Client Owners section.

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description and Parameter Values
clientName Name of the client computers to modify.

To modify multiple clients, add an <entity> and a <clientName> element for each client, for example:

<entity>
<clientName>client1</clientName>
</entity>
<entity>
<clientName>client2</clientName>
</entity>

clientUserGroupOwners Name of the user groups to add as a client owner.

To modify multiple user groups, add a <clientUserGroupOwners> element for each user group, for example:

<clientUserGroupOwners>UserGroup1</clientUserGroupOwners>
<clientUserGroupOwners>UserGroup2</clientUserGroupOwners>

clientUserGroupOwnersOperationType The operation to perform on the user group. Valid values are:
  • ADD, to add the user group as a client owner
  • DELETE, to remove the user group as the client owner
  • OVERWRITE, to replace all client owner user groups on a client computer with a different client owner user group. For example: owner_user_group2 and owner_user_group3 are client owner user groups on client1. Use the "overwrite" operation to replace these client owner user groups with owner_user_group4.

Updating Client Owner User Groups on a Client Computer Group

Use the following steps to:

  • Add existing user groups to a client computer group as client owners

    Client owners have access to the client computer group and can perform backup and restore operations on the clients that belong to the client computer group.

  • Remove client owner user groups from a client computer group
  • Replace all client owner user groups on a client computer group with different client owner user groups
  1. Download the ug_owners_to_clientgroup.xml file to the computer from where you will run the command.
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type the following command after substituting the XML parameters:

    qoperation execute -af ug_owners_to_clientgroup.xml

  5. Verify the user group is a client owner on clients in the client computer group:
    1. From the CommCell Browser, right-click one client and then click Properties.

      The Client Computer Properties dialog box appears.

    2. Click the Security tab.
    3. The user group appears in the User Groups pane of the Client Owners section.

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description and Parameter Values
clientGroupName Name of the client computer groups to modify.

To modify multiple client computer groups, add an <entity> and a <clientGroupName> element for each client computer group, for example:

<entity>
<clientGroupName>clientGroup1</clientGroupName>
</entity>
<entity>
<clientGroupName>clientGroup2</clientGroupName>
</entity>

clientUserGroupOwners Name of the user groups to add as a client owner.

To modify multiple user groups, add a <clientUserGroupOwners> element for each user group, for example:

<clientUserGroupOwners>UserGroup1</clientUserGroupOwners>
<clientUserGroupOwners>UserGroup2</clientUserGroupOwners>

clientUserGroupOwnersOperationType The operation to perform on the user group. Valid values are:
  • ADD, to add the user group as a client owner
  • DELETE, to remove the user group as the client owner
  • OVERWRITE, to replace all client owner user groups on a client computer group with a different client owner user group. For example: owner_user_group2 and owner_user_group3 are client owner user groups on clientgroup1. Use the "overwrite" operation to replace these client owner user groups with owner_user_group4.

Empty the Contents of the Existing Client Owners or User Groups

Use the following steps to modify the associated client owners or user groups of a client computer.

  1. Download the modify_owners_list.xml file to the computer from where you will run the command.
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command prompt, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type the following command after substituting the XML parameters:

    qoperation execute -af modify_owners_list.xml

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description of Parameter Values
clientName Name of the client computers for which you want to modify the list of client owners.

For example: If you wish to associate a user group with client1, client2 and client_x then you must add the following:

<entity>
<clientName>client1</clientName>
</entity>
<entity>
<clientpName>client2</clientName>
</entity>
<entity>
<clientpName>client_x</clientName>
</entity>

clientOwners Name of the client owners for which you want to empty the contents.
clientOwnersOperationType Option to determine whether to add, delete or overwrite the client owner list. Valid values are:
  • ADD, to add user(s) to the existing list of Client Owners.
  • DELETE, to delete user(s) from the existing list of Client Owners.
  • OVERWRITE, to clear the existing client owners and replace with the specified owner. For example:

    You have user2 and user3 already associated with client1 and listed as Client Owners, and you want to add user4 to the list of Client Owners. This operation adds user4 to the Client Owners list and removes any previous owners.

Client Computer Group Configuration

Client computer groups can be updated using XML. The XML parameters can be part of the file, but in cases where the parameters frequently change, specify them on the command line.

  1. Download the update_client_computer_group_template.xml file to the computer from where you will run the command.
  2. Open the XML file and update the parameters as needed using the table below as reference.
    Expand All

    Parameter Table

    Name Description Elements Parent Element
    clientName The name of the client. To add multiple clients to a client computer group, add <associatedClients> and <clientName> elements for each client, for example:

    <associatedClients>
    <clientName>client1</clientName>
    </associatedClients>
    <associatedClients>
    <clientName>client3</clientName>
    </associatedClients>

    associatedClients clientGroupDetail
    clientGroupName The name of the client computer group. clientGroup clientGroupDetail
    newName The new name of the client computer group if the name should be updated. clientGroup clientGroupDetail
    activityType The client computer group 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 clientGroupActivityControl
    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 clientGroupActivityControl
    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 clientGroupActivityControl
    userGroupName The name of the user group associated with the client computer group. associatedUserGroups clientGroupSecurity
    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.
    clientGroupSecurity clientGroupDetail
    individualCapabilities The capabilities of the client computer owners associated with the client computer group. ownerCapabilities clientGroupSecurity
    description The description of the client computer group. clientGroupDetail App_PerformClientGroupReq
    dlpEnableClientKeys The option to unlock files before backups are performed and to allow users to open locked files without entering a pass-key.

    Valid values are True/False.

    dlpPropertise clientGroupDetail
    dlpMinFileAgeMins The age in minutes of a document (created or modified) before it is locked during a DLP scan. dlpPropertise clientGroupDetail
    dlpScanIntervalMins The number of minutes the DLP scan waits between scans for new or unlocked content. dlpPropertise clientGroupDetail
    dlpStolen The option to mark the client as stolen.

    Valid values are True/False.

    dlpPropertise clientGroupDetail
    enableDLP The option to enable Data Loss Prevention (DLP).

    Valid values are True/False.

    dlpPropertise clientGroupDetail
    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
    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
    isAddinClientGroup Valid values are True/False. clientGroupDetail App_PerformClientGroupReq
    isEDCInstanceAssociated Valid values are True/False. clientGroupDetail App_PerformClientGroupReq
    isEDCInstanceDeleted Valid values are True/False. clientGroupDetail App_PerformClientGroupReq
    isNetworkThrottleEnabled The option to use network throttling. For information on network throttling, see Configuring Network Throttling.

    Valid values are True/False.

    clientGroupDetail App_PerformClientGroupReq
    isSmartClientGroup The option to use automatic associations. For information on automatic associations, see Smart Client Groups using Automatic Association.

    Valid values are True/False.

    clientGroupDetail App_PerformClientGroupReq
    overrideGlobalAuthentication The option to override Global Authentication.

    Valid values are True/False.

    overrideHigherLevelSettings clientGroupDetail
    useLocalSystemAccount The option to use the local system account when overriding higher level settings. overrideHigherLevelSettings clientGroupDetail
    userName The name of the user. userAccount overrideHigherLevelSettings
    op The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." scgRule clientGroupDetail
    op The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    filterID The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    propID The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    propType The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    secValue The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    value The rules related to the Smart Client Computer Group (SCG) feature. Use this attribute when the isSmartClientGroup parameter equals "true." rule rules
    clientName The name of the client. webSearchServer clientGroupDetail
    clientGroupOperationType The operation to update a client computer group.

    Valid value is Update.

    App_PerformClientGroupReq  
  3. Save the changes to the XML file.
  4. From the command line, go to software_installation_directory/Base and type the following command:

    qoperation execute -af xml_path\update_client_computer_group_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

Client Configuration

Updating Client Properties for Multiple Clients

Use the following steps to update client properties for clients in a client computer group.

  1. Download the update_multiple_clients_template.xml file to the computer where you will run the command.
  2. Open the XML file and update the parameters as needed using the table below as reference.
    Expand All

    Parameter Table

    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
    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 Event Manager Service (EvMgrC). 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
    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
    EnableRetryOnNetworkError The option to enable retry on network errors.

    Valid values are True/False.

    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.

    Valid values are:

    3-DES cipher

    • 192

    AES (Rijndael), Blowfish, Serpent, and TwoFish ciphers

    • 128
    • 256
    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
    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
    recallService The complete address of the proxy service installed with the Web Console. 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
  3. Save the changes to the XML file.
  4. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  5. From software_installation_directory/Base type the following command:

    qoperation execute -af xml_path\update_multiple_clients_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the preceding example) does not need to be included on the command line.

Setting Client Deduplication Options

Use the following steps to set client deduplication options. For information on setting options for multiple clients, see Updating Client Properties for Multiple Clients. For information on deduplication, see Deduplication Overview.

  1. Run the qlogin command to log on to the CommServe computer.
  2. Download the update_client_template.xml file and save it on the computer from where the command will be executed.
  3. To define the parameter values, do one of the following:
    • Open the .xml file and update the XML parameters.
    • Type the parameters on the command line using the following format: -parameter_name parameter_value.

    For information on XML command line syntax, see Command Syntax for XML Commands.

  4. From software_installation_directory/Base type the following command and include any parameters not defined in the .xml file:

    qoperation execute -af update_client_template.xml

    Example

    The following command disables the client side disk cache option for client001. In this example, the parameters are listed on the command line:

    qoperation execute -af update_client_template.xml -entity/clientName client001 -enableClientSideDiskCache false

The following table displays the XML parameters needed before running the qoperation command:

Attribute Description
clientName Name of the client computers for which you want to enable deduplication.
cacheBufferSize The option to set the cache buffer size.
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
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.

enableHighLatencyOptimization The option to enable high latency optimization. Use this parameter when the enableClientSideDiskCache parameter is set to "true."

Valid values are True/False.

enableVariableContentAlignment The option to enable variable content alignment.

Valid values are True/False.

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
performClientSideDeduplication The option to enable or disable source side deduplication.

Valid values are True/False.

Modifying Additional Settings for Multiple Clients

Use the following steps to modify (add, edit, or delete) the additional setting details for one or more clients.

  1. Download the additional_settings.xml file and save it on the computer from where the command will be executed.
  2. Open the .xml file and provide the respective values for the XML parameters listed in the table below.

    Notes:

    • The additional setting is added if it does not exist and the registryKeys/deleted parameter is set to 0.
    • The additional setting is updated if it does exist and the registryKeys/deleted parameter is set to 0.
  3. Run the qlogin command to log on to the CommServe computer.
  4. Execute the following command after updating the XML file:

    qoperation execute -af additional_settings.xml

  1. You can verify the changes that you performed on the clients using the steps below:
    1. From the CommCell Browser, right-click the client and then click Properties.
    2. Click Advanced.
    3. Click the Additional Settings tab. The changes should be displayed.

The following table displays the XML parameters that need to be provided before running the qoperation command:

Parameter Description of Parameter Values
clientName Name of the client computers for which you want to add, modify or delete an additional setting.
keyName Name of the additional setting.
type Type of the additional setting. Valid values are:
  • INTEGER
  • STRING
  • BOOLEAN
value Value of the additional setting. Depending on type, the value could be numerical, a numeric range, or character string.
relativepath The relative location of the additional setting in the instance. For example, if the additional setting is created on the CommServe, then the relative path will be CommServe.
registryKeys/deleted Option to remove the additional setting. Valid values are:
  • 1, to remove the additional setting
  • 0, to retain the additional setting
registryKeys/enabled Option to enable the additional setting. Valid values are:
  • 1, to enable the additional setting
  • 0, to disable the additional setting

Getting the Existing Security Details of a Client

You can view the security details of a client computer from the command prompt. Use the following steps to view the client computer's security details such as Associated Groups, Client Owners, etc.

  1. Download the client_security.xml file and save it on the computer from where the command will be executed.
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command prompt, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type the following command:

    qoperation execute -af client_security.xml

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description of Parameter Values
clientName Name of the client computers for which you want to get the existing security details.

For example: If you want to get the security details of client1, client2 and client_x then you must add the following:

<entity>
<clientName>client1</clientName>
</entity>
<entity>
<clientpName>client2</clientName>
</entity>
<entity>
<clientpName>client_x</clientName>
</entity>

Releasing a License on a Client

Use the following steps to release a license on a client.

  1. Download the release_client_license_template.xml file and save it on the computer from where the command will be executed.
  2. Open the XML file and update the parameters as needed using the table below as reference.
    Parameter Description Element
    clientName The name of the client. clientEntity
    hostName The long name of the client, for example, client.domain.company.com. clientEntity
  3. Save the changes to the XML file.
  4. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  5. From software_installation_directory/Base type the following command:

    qoperation execute -af xml_path\release_client_license_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

Client Certificates

Revoking a Client Certificate

If you suspect that the security of a client computer has been compromised, use the following steps to revoke the certificate of a client.

  1. Download the revoke_certificate_template.xml file, saving it to the <Software_Installation_Directory>/Base folder on the computer where you will be running the command.
  2. Open a command window on that computer and change to the <Software_Installation_Directory>/Base folder.
  3. Execute this command, replacing <clientname> with the name of the client computer for which you want to revoke all certificates:

    qoperation execute -af revoke_certificate_template.xml -clientName <clientname>

Subclient Configuration

Updating Subclient Common Properties

Use the following steps to update the common properties for all of the subclients in a client computer group.

  1. Download the update_subclients_batch_template.xml file and save it on the computer from where the command will be executed.
  2. Open the XML file and update the parameters as needed using the table below as reference.
    Parameter Description Element
    clientGroupName The name of the client computer group. All of the subclients in the client computer group are updated when the XML is used with the qoperation execute command. If needed, add additional client computer group names to the XML file by adding clientGroupName parameters within entity elements:

    <entity>
      <clientGroupName>client_group_001</clientGroupName>
    </entity>
    <entity>
      <clientGroupName>client_group_089</clientGroupName>
    </entity>

    entity
    encryptionFlag The option to set the encryption points during backups.

    Valid values are:

    • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.
    • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.
    • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.
    • ENC_NONE, to disable data encryption.
    commonProperties
    description The description of the subclient. commonProperties
    enableBackup The option to enable/disable backup.

    Valid values are True/False.

    commonProperties
    networkAgents The option to specify the number of processes the subclient uses to transfer data over a network.

    Valid values are 1-4 on Windows computers or 1-2 on UNIX computers.

    storageDevice
    softwareCompression The option to enable compression on the client or the MediaAgent computer.

    Valid values are:

    • ON_CLIENT, to enable software compression on the client.
    • ON_MEDIAAGENT, to enable software compression on the MediaAgent.
    • USE_STORAGE_POLICY_SETTINGS, to use the software compression options defined on the storage policy.
    • OFF, to disable software compression.
    storageDevice
    throttleNetworkBandwidth The option to enhance backup performance by reducing network bandwidth overhead.

    Valid values are 0/1.

    storageDevice
    applicableReadSize The amount of application data backup jobs will read for each unit transferred to the MediaAgent.

    Valid kilobyte values are 64, 128, 256, 512, 1024, 2048, or 4096.

    storageDevice
    storagePolicyName The name of the storage policy associated with the subclient backup. dataBackupStoragePolicy
    enableDeduplication The option to enable deduplication on the subclient.

    Valid values are True/False.

    deDuplicationOptions
    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.
    deDuplicationOptions
    isSnapBackupEnabled The option to enable or disable an SnapProtect backup.

    Valid values are True/False.

    snapCopyInfo
    snapShotEngineName The name of the engine used for an SnapProtect backup. snapToTapeSelectedEngine
    clientName The name of the client. snapToTapeProxyToUse
    snapToTapeProxyToUseSource The option to enable or disable using the source if the proxy is unreachable.

    Valid values are True/False.

    snapCopyInfo
    isRMANEnableForTapeMovement The option to enable or disable using RMAN for the backup copy. snapCopyInfo
    preScanCommand The path to the preprocess script that runs before the scan phase. prepostProcess
    postScanCommand The path to the post process script that runs after the scan phase. prepostProcess
    preBackupCommand The path to the preprocess script that runs before the backup. prepostProcess
    postBackupCommand The path to the post process script that runs after the backup. prepostProcess
    runPostBackup The option to run a process after the backup completes.

    Valid values are Yes/No.

    prepostProcess
    runAs The option to specify the user name who has permission to run the pre/post process scripts.

    Valid values are:

    • USE_IMPERSONATION, to specify a user with the permission to run the scripts. When using this value, provide the user credentials.
    • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.
    prepostProcess
    userName The name of the user with permission to run the scripts defined in the prepostProcess element. This parameter must be used when the runAs parameter is set to USE_IMPERSONATION. prepostUserName
  3. Save the changes to the XML file.
  4. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  5. From software_installation_directory/Base type the following command:

    qoperation execute -af xml_path\update_subclients_batch_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

Updating Subclient Agent-Specific Properties

The update_subclients_batch_template.xml file can be modified to include subclient properties for a specific agent. The agent-specific elements are placed after the <commonProperties> element, for example:

<commonProperties>
  <encryptionFlag/>
  <description/>
  <enableBackup/>
  <storageDevice>
  ...
  ...
</commonProperties>
<oracleSubclientProp>
  <backupControlFile>true</backupControlFile>
</oracleSubclientProp>

If the client computer group identified in the <clientGroupName> element contains agents of different types and agent-specific elements are in the XML file, the applicable subclients are updated and the inapplicable subclients are skipped. For example, in the following situation, only Windows file system agents are configured to backup the system state:

  • The client computer group defined in the <clientGroupName> element includes Windows file system agents and Oracle agents
  • The following elements are included in the XML file:

    <fsSubClientProp>
      <backupSystemState>true</backupSystemState>
    </fsSubClientProp>

Procedure

Use the following steps to update agent-specific properties for the applicable subclients in a client computer group.

  1. Download the update_subclients_batch_template.xml file and save it on the computer from where the command will be executed.
  2. Open the XML file and add the agent-specific parameters as needed.

    See the command line interface documentation for your agent for the list of subclient parameters to use with your agent. For example, for Windows subclient parameters, see Available Parameters for Subclient Configuration.

  3. Save the changes to the XML file.
  4. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  5. From software_installation_directory/Base type the following command:

    qoperation execute -af xml_path\update_subclients_batch_template.xml

    If the XML file is saved in the software_installation_directory/Base directory, the file path (xml_path in the example above) does not need to be included on the command line.

Services

Restarting Client Services

Use the following steps to restart the SnapProtect services of a client computer.

  1. Download the restart_client.xml file to the computer from where you will run the command.
  2. From the command prompt, go to software_installation_directory/Base and type the following command:

    qlogin -u user_name

  3. From software_installation_directory/Base type the following command to restart the services of a client:

    qoperation execute -af restart_client.xml -clientName client_name

    where client_name is the name of the client where you want to restart services.

Job Management

Resubmitting a Job

  1. Download the resubmit_job_template.xml file to the computer from where you will run the command.
  2. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  3. From software_installation_directory/Base type the following command to resubmit a job:

    qoperation execute -af resubmit_job_template.xml -jobId job_ID

    where job_ID is the job ID of the job you want to resubmit.

Updating Jobs

Use the following steps to suspend, kill, or resume one or more jobs or to update the reason for suspending, killing, or resuming the jobs.

  1. Download the update_job_template.xml file to the computer where you will run the command.
  2. Open the .xml file and update the XML parameters listed in the table below.
  3. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  4. From software_installation_directory/Base type the following command after substituting the XML parameters:

    qoperation execute -af update_job_template.xml

  5. Optional: Verify the jobs were updated by viewing the jobs in the CommCell Console Job Controller window.

The following table displays the XML parameters needed before running the qoperation command:

Parameter Description of Parameter Values
message The jobs that will be updated.

Valid values are:

  • ALL_JOBS, the operation in the operationType parameter will affect all jobs
  • ALL_SELECTED_JOBS, the operation in the operationType parameter will affect the jobs defined in the jobId parameter
operationDescription The reason for suspending, killing, or resuming the job.
operationType The operation to perform on the job.

Valid values are:

  • JOB_SUSPEND
  • JOB_RESUME
  • JOB_KILL
jobId The job IDs for the jobs that will be suspended, killed, or resumed. Use the jobId parameter when the message parameter is set to ALL_SELECTED_JOBS. To add more than one job, add the following line for each job:

<jobs jobId="job_ID" />

Log Files

Viewing the Job Log Files

You can view the log files for a specific backup, restore, AuxCopy or NAS job that is active, completed or failed. Use this when you know the job ID, but do not know the client that ran the job or the time the job was run.

You can use this for jobs run on the following agents:

  • Oracle
  • Unix File System
  • Exchange

The following table displays the XML attributes.

Parameter Description of Parameter Values
jobId The job ID for which you want to view the logs.
  1. Run the qlogin command to log on to the CommServe computer.
  2. Download the get_job_logs_template.xml file to the computer where you will run the command.
  3. On the command line, go to Software_Installation_Directory/Base and type the command.

    qoperation execute -af get_job_logs_template.xml -jobID job_id

Reporting

Generating Reports

You can generate reports from the command line by creating an XML from the CommCell Console using the Save As Script option. The XML can be executed from the command line or it can be integrated into scripts.

  1. From the CommCell Console toolbar menu, click the Reports tab and then click the report that you want to run.
  2. From the Report Selection window, select the options that you want to apply to your report.

    For example, click the Output tab and select the output format of the report (HTML, TEXT, or PDF).

  3. After selecting the report options, click Save As at the bottom of the window.

    The Save As dialog box appears.

  4. Enter the appropriate settings to generate a script file.
    1. From the Client list, select the name of the client where you want to save the script.
    2. In the Path box, enter the file path where you want to save the script, and then enter a name for the script file at the end of the path.

      Ensure that the name of the file contains the .xml extension

    3. Click OK to create the script.

      A message appears that says that the script saved successfully

    4. Click OK.

    The Save As dialog boxes closes. Click Close from the Report Selection window.

Schedule and Schedule Policy

List All Schedule Policies in the CommCell

  1. Download the all_sched_policy_associations.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder:

    qoperation execute –af all_sched_policy_associations.xml

List Schedules and Schedule Policies from Different CommCell Levels

You can send a request to get the schedules and schedule policy details at the following levels:

At the CommCell Level

  1. Download the schedules_commserve_level.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute –af schedules_commserve_level.xml

At the Client Level

  1. Download the schedules_client_level.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute –af schedules_client_level.xml -clientName xxxxx

At the Backup Set Level

  1. Download the schedules_backupset_level.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute –af schedules_backupset_level.xml -appName xxxxx -clientName xxxxx -backupsetName xxxxx

At the Subclient Level

  1. Download the schedules_subclient_level.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute –af schedules_csubclient_level.xml -appName xxxxx -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx

Available Command Parameters

When sending the request for a specific CommCell level, you may need to specify the following parameters:

Parameter Description and Parameter Values
clientName Name of the client computer.
appName Name of the Agent. For example, 'File System' for the Windows or Unix File System Agent.
backupsetName Name of the backup set. If the backup set name is not specified in the command query, the default backup set is used by default.
subclientName Name of the subclient.

You can also set filters in the XML files to display specific schedule/schedule policy details. In the XML files provided above, the schedules, isCalendar and policy filters are provided by default:

<filter schedules="1" isCalendar="0" policy="1">

The following table lists all available filter parameters that you can define in the XML file, which you can enable or disable by setting them to '1' or '0' respectively:

Parameter Description
automaticSchedules Filter to display only automatic schedules.
EZPolicyFilter Filter to display only EZ schedules.
isCalendar Filter to display the schedule details in calendar view.
isSRMReports Filter to display only SRM report schedules.
otherReports Filter to display report schedules other than SRM report schedules.
policy Filter to display schedule policy associations.
savedReports Filter to display only schedules from saved reports.
schedules Filter to display schedule associations.

List the Details for a Schedule or Schedule Policy

  1. Download the schedule_details.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter value.

    qoperation execute –af schedule_details.xml

Available Command Parameters

When sending the request for a specific schedule or schedule policy, you need to specify the following parameter:

Parameter Description and Parameter Values
taskId The task ID for the schedule or schedule policy.

Workflow

Executing a Workflow

Note: Workflows must be deployed before they can be executed. For instructions on deploying a workflow, see Deploying a Workflow.

  1. Download the execute_workflow.xml file to the computer from where you will run the command.
  2. From the command line, go to software_installation_directory/Base and type the following command:

    qlogin -cs commserve_host_name -u user_name

  3. From software_installation_directory/Base type the following command after substituting the parameter values:

    qoperation execute -af execute_workflow.xml -associations/clientName workflow_engine -workflowName workflow_name -workflowJobOptions "<inputs><input_name>input_value</input_name></inputs>"

Examples

  • Demo_CheckReadiness workflow - Type the following to check the readiness of all clients in the "Laptop Clients" client computer group:

    qoperation execute -af execute_workflow.xml -associations/clientName workflow_engine -workflowName Demo_CheckReadiness -workflowJobOptions "<inputs><ClientGroupName>Laptop Clients</ClientGroupName></inputs>"

    where workflow_engine is the name of the workflow engine.

  • Demo - Client Group Policy workflow - Type the following to update the storage policy for all file system subclients in the "Laptop Clients" client computer group:

    qoperation execute -af execute_workflow.xml -associations/clientName workflow_engine -workflowName "Demo - Client Group Policy" -workflowJobOptions "<inputs><clientGroup>Laptop Clients</clientGroup><storagePolicy>SP_001</storagePolicy></inputs>"

    where workflow_engine is the name of the workflow engine.

  • A workflow that requires an encrypted input such as a password:

    qoperation execute -af execute_workflow.xml -associations/clientName workflow_engine -workflowName "New User" -workflowJobOptions "<inputs><userName>jdoe</userName><userEmail>jdoe@mycompany.com</userEmail><userPassword reencrypt="true">Y2hhbmdlbWU</userPassword></inputs>"

    where workflow_engine is the name of the workflow engine.

Available Command Parameters

The following table displays the XML parameters that need to be provided before running the qoperation command:

Parameter Description of Parameter Values
clientName The name of the workflow engine.
workflowName The name of the workflow.
workflowJobOptions The value of the workflow input needed to execute the workflow. If the workflow contains an encrypted input do the following:
  • Encode the input value using Base64 encoding
  • Add reencrypt="true" to the input as an attribute

For example: <inputs><password reencrypt="true">YmFzZV82NF9lbmNvZGVkX3ZhbHVl</password></inputs>

Defining Inputs in the XML File

If you define the inputs in the XML file, add an element for each input, for example:

<workflowJobOptions>
 <inputs>
  <input_name_1>input_value</input_name_1>
  <input_name_2>input_value</input_name_2>
  <input_name_3>input_value</input_name_3>
  <input_name_N>input_value</input_name_N>
  <input_name_S reencrypt="true">encoded_input_value</input_name_S>
 </inputs>
</workflowJobOptions>

where:

  • input_name_1 to input_name_N are the workflow inputs
  • input_value is the value for the workflow input defined as the element
  • input_name_S is the encrypted workflow input
  • encoded_input_value is the Base64 encoded value for the workflow input defined as the element