Command Line Interface - XML Scripts

Topics | QCommands | Save As Script | XML Scripts | QScripts | QAPI Developers Guide | How To | Troubleshoot | Support | Related Topics


Overview

User-Created XML Scripts

Associating/Disassociating User Group to a Client

Associating/Disassociating User Group to a Client Group

Associating/Disassociating User to a Client

Associate/Disassociate User to a Client Computer Group

Enable/Disable Source Side Deduplication

Enable Signature Caching on the Client

Content Indexing RMS Protected Files

Modify Registry Key Settings for Multiple Clients

Enable SRM for File System Agents

Get the Existing Security/Properties of a Client

To Empty the Contents of the Existing Owners or User Groups


Overview

In addition to generating the xml scripts using the Save As Script option, you can also create user-defined xml scripts. These scripts are executed using the qoperation execute command. Following is the list of user-created xml scripts:

User-Created XML Scripts

The following table specifies the user-created scripts:

Operation Name

Dialog Box

User Administration and Security
Client Configuration

Associating/Disassociating User Group to a Client

Use the following steps to associate or disassociate an existing User Group to a client computer. The following steps can also be used overwrite all user groups associated with a client to a different user group or set of user groups.

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the names of the client computers for which you want to associate/disassociate the user groups.

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

      <entity>

      <clientName>client1</clientName>

      </entity>

      <entity>

      <clientName>client2</clientName>

      </entity>

    • userGroupName - Specify the user group to which you want to associate to the client.

      For example: If you wish to associate usergroup1 to the above clients, then you must add the following:

      <userGroupName>usergroup1</userGroupName>

    • associatedUserGroupsOperationType - Indicate one of the following operation types:

      ADD - To associate the User Group to a Client

      DELETE - To disassociate the User Group to a Client

      OVERWRITE - To associate the user group mentioned above and disassociate all the user group available on the client computer. For example:

      If usergroup2 and usergroup3 are already associated on client1, and you wish to overwrite the available user groups with usergroup4. This operation associates usergroup4 to the client1 and disassociates usergroup2 and usergroup3.

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify the user group associated to a client from Associated Groups.
    • From the CommCell Browser, right-click the <Client> and then click Properties.
    • Click Security tab.
    • The User Group specified above will be listed in the Associated Groups.
 

            View Sample XML File

Associating/Disassociating User Group to a Client Group

Use the following steps to associate or disassociate an existing User Group to a Client Computer Group. The following steps can also be used to overwrite the associated user groups available on the client group with a given user group.

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientGroupName - Specify the names of the client computer group that you want to associate to the user group.

      For example: If you wish to associate a user group to clientgroup1, clientgroup2 and clientgroupx then your element will appear as follows:

      <entity>

      <clientGroupName>clientGroup1</clientGroupName>

      </entity>

      <entity>

      <clientGroupName>clientGroup2</clientGroupName>

      </entity>

    • userGroupName - Specify the user group which you want to associate to the client group.

      For example: If you wish to associate usergroup1 to the above client group, then you must add the following:

      <userGroupName>usergroup1</userGroupName>

    • associatedUserGroupsOperationType - Indicate one of the following operation types:

      ADD - To associate the User Group to a Client Computer Group

      DELETE - To disassociate the User Group to a Client Computer Group

      OVERWRITE - To associate the user group mentioned above and disassociate all the user groups available on the client computer group. For example:

      If usergroup2 and usergroup3 are already associated to clientgroup1, and you wish to overwrite the available user groups with the usergroup4. This operation associates usergroup4 to the clientgroup1 and disassociates usergroup2 and usergroup3.

  3. Save the file as input.xml
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and CommCell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify the user group associated to a client from Associated Groups.
    • From the CommCell Browser, right-click the <Client_Computer_Group>, and then click Properties.
    • Click Security tab.
    • The User Group specified above will be listed in the Associated Groups.
 

            View Sample XML File

Associating/Disassociating User to a Client

Use the following steps to associate or disassociate a user to a client computer. This association makes the user(s) the owner of the client computer. A Client Computer Owner receives all the capabilities designated by the administrator.

The following steps can also be used to overwrite the users available on the client with a given user.

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the names of the client computer group that you want to associate to the user.

      For example: If you wish to associate user to client1, client2 and clientx then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

      <entity>

      <clientName>client2</clientName>

      </entity>

      <entity>

      <clientName>clientx</clientName>

      </entity>

    • clientOwners - Specify the user to which you want to associate to the client.

      For example: If you wish to associate user1 to above clients, then you must add the following:

      <clientOwners>USER1</clientOwners>

    • clientOwnersOperationType - Indicate one of the following operation types:

      ADD - This will associate the user to a client computer

      DELETE - This will disassociate the user to a client computer

      OVERWRITE - To associate the user mentioned above and disassociate all the users available on the client computer. For example:

      If user2 and user3 are already associated to client1, and you wish to overwrite the available users with user4. This operation associates user4 to the client1 and disassociates user2 and user3.

  3. Save the file as input.xml
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify the user associated to a client from Client Owners.
    • From the CommCell Browser, right-click the <Client> and then click Properties.
    • Click Security tab.
    • The user specified above will be listed in the Client Owners.
 

            View Sample XML File

Associate/Disassociate User to a Client Computer Group

Use the following steps to associate/disassociate a owner to clients in the client computer group.

Once this is done, this newly associated user will have access to the client computer group and can perform backup and restore operations on this client.

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clienGrouptName - Specify the client computer group to which you want to associate the user.

      For example: If you wish to associate a user to clientgroup1, then you must add the following:

      <entity>

      <clientGroupName>clientgroup1</clientGroupName>

      </entity>

    • clientOwners - Specify the user to which you want to associate to the client computer group.

      For example: If you wish to associate user1 to the above client computer group, then you must add the following:

      <clientOwners>USER1</clientOwners>

    • clientOwnersOperationType - Indicate one of the following operation types:

      ADD - To associate the client owner to a Client Computer Group

      DELETE - To disassociate the client owner to a Client Computer Group

      OVERWRITE - To associate the owner mentioned above and disassociate all the users available on the client computer group. For example:

      If user2 and user3 are already associated on clientgroup1, and you wish to overwrite the available users with user4. This operation associates user4 to the client1 and disassociate user2 and user3.

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and CommCell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify the user associated to a client from Client Owners.
    • From the CommCell Browser, navigate to Client Computer Groups, right-click the <Client> and then click Properties.
    • Click the Security tab.
    • The user specified above will be listed under Client Owners.
 

            View Sample XML File

Enable/Disable Source Side Deduplication

Use the following steps to enable/disable source side deduplication at the client level.

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the client computer to which you want to enable deduplication.

      For example: If you wish to enable source side deduplication to client1, then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • performClientSideDeduplication - To enable/disable source side deduplication.

      For example: If you wish to enable source side deduplication then you must add the following:

      <performClientSideDeduplication>true</performClientSideDeduplication>

      For example: If you wish to disable source side deduplication then you must add the following:

      <performClientSideDeduplication>false</performClientSideDeduplication>

    • clientsidededuplication - To enable/disable client side disk cache.

      For example: If you wish to enable client side disk cache then you must add the following:

      <enableClientSideDiskCache>true</enableClientSideDiskCache>

      For example: If you wish to disable client side disk cache then you must add the following:

      <enableClientSideDiskCache>false</enableClientSideDiskCache>

    • maxCacheDb - To set the Max cache-database size

      For example: If you wish to specify the maximum cache database then you must add the following:

      <maxCacheDb>1079</maxCacheDb>

    • enableVariableContentAlignment - To enable/disable the Variable Content Alignment.

      For example: If you wish to enable variable content alignment, then you must add the following:

      <enableVariableContentAlignment>true</enableVariableContentAlignment>

      For example: If you wish to disable variable content alignment,  then you must add the following:

      <enableVariableContentAlignment>false</enableVariableContentAlignment>

  3. Save the file as input.xml.
  4. From the Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify deduplication options at the client computer which is part of the above specified client computer group.
    • From the CommCell Browser, right-click the <Client_Computer> and then click Properties.
    • Click Source Side Deduplication tab.
    • The Perform client side Deduplication and Enable Client Side Disk Cache will be selected.
 

            View Sample XML File

Enable Signature Caching on the Client

Use the following steps to enable signature caching on a client:

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the client computer to which you want to enable deduplication.

      For example: If you wish to enable deduplication to client to client1 then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • enableDeduplication - To enable/disable source side deduplication.

      For example: If you wish to enable deduplication then you must add the following:

      <enableDeduplication>true</enableDeduplication>

    • generateSignatureOnClient - To enable signature cache on client computer.

      For example: If you wish to enable signature caching on client computer then you must add the following:

      <generateSignature>ON_CLIENT</generateSignature>

    • generateSignatureOnMediaAgent - To enable signature cache on MediaAgent computer.

      For example: If you wish to enable signature caching on client computer then you must add the following:

      <generateSignatureOnMediaAgent>true</generateSignatureOnMediaAgent>

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify deduplication options at the client computer.
    • From the CommCell Browser, navigate to Client Computer | <Client> | File System | defaultBackupSet.
    • Right-click the subclient in the right pane and then click Properties.
    • Click the Storage Device tab.
    • Click the Deduplication tab.
    • Enable Deduplication check box will be selected and Generate Signature on Client or MediaAgent will be selected depending upon the options you specified in the XML file.
 

            View Sample XML File

Content Indexing RMS Protected Files

Rights Management Service (RMS) is a technology that works with RMS enabled applications (such as, Microsoft Office applications, Microsoft Exchange Server, and Microsoft SharePoint) to set usage rights on the documents or emails.

Use the following steps to enable content indexing for RMS protected files for a client:

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientGroupName - Specify the client computer to which you want to enable content indexing.

      For example: If you wish to enable content indexing to client group clientgroup1 then you must add the following:

      <entity>

      <clientGroupName>clientgroup1</clientGroupName>

      </entity>

    • EnableContentIndexing - To enable/disable content indexing engine.

      For example: If your wish to enable Content Indexing then you must add the following:

      <EnableContentIndexing>true</EnableContentIndexing>

    • SMTPAddressOfTheRMSSuperUser - Specify the SMTP address of the super user.

      For example: If the SMTP address is 1.23.45.67 then you must add the following:

      <SMTPAddressOfTheRMSSuperUser>1.23.45.67</SMTPAddressOfTheRMSSuperUser>

    • userName - Specify user account that has permission to access all RMS protected documents.

      For example: If the user name is username1 then you must add the following:

      <userName>username1</userName>

    • password - Specify password for the user account.

      For example: If the password is password1 then you must add the following:

      <password>password1</password>

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify content indexing options at the client computer which is part of the above specified client computer group.
    • From the CommCell Browser, right-click the <Client_Computer> and then click Properties.
    • Click Content Indexing tab.
    • The Enable Content Indexing check box and the Decrypt RMS document during content indexing check box will be selected.

      The SMTP Address of the RMS Superuser and user account details specified in the above xml file will be displayed.

 

            View Sample XML File

Modify Registry Key Settings for Multiple Clients

You can modify (add, edit, or delete) the registry key settings for multiple clients using the command prompt. Follow the steps given below to modify the registry key settings:

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the client computer to which you want to add, modify or delete a registry key.

      For example: If you wish to modify registry key to client client1 then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • keyName - Specify the name of the registry key.

      For example: If the registry key is nSQL then you must add the following:

      <keyName>nSQL</keyName>

    • type - Specify the registry key type.

      For example: If the type of the registry key you wish to add is REG_DWORD then you must add the following:

      <type>REG_DWORD</type>

    • value - Specify the value of the registry key. Depending on type, could be numerical, a numeric range, or character string.

      For example: If the value of the registry key is 1 then you must add the following:

      <value>1</value>

    • relativepath - Specify the relative location of the registry key in the instance.

      For example: If the location of the registry key is CommServe then you must add the following:

      <relativepath>CommServe</relativepath>

    • deleted - Specify to remove the registry key.

      For example: If your wish to delete the existing key then you must add the following:

      <deleted>true</deleted>

    • enabled - To enable the registry key.

      For example: To enable the registry key then you must add the following:

      <enabled>1</enabled>

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify registry key at the client computer properties.
    • From the CommCell Browser, right-click the <Client_Computer> and then click Properties.
    • Click Registry Key tab.
    • The key will be displayed in the Registry Key Settings.
            View Sample XML File

Enable SRM for File System Agents

SRM feature can be enabled for File System Agents for a sleek, versatile and easy-to-use reporting framework to view and analyze vital data.

Use the following steps to enable SRM feature for the File System Agents:

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the client computer to which you wish to enable SRM.

      For example: If you wish to enable SRM for client client1 then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • enableSRMFeatureAtAgent - Enables SRM Feature at the agent level of the client

      For example: To enable SRM feature at agent level then you must add the following:

      <enableSRMFeatureAtAgent>true</enableSRMFeatureAtAgent>

    • enableSRMDC - Enables the SRM Data Collection for an integrated SRM agent only.

      For example: To enable SRM Data Collection feature then you must add the following:

      <enableSRMDC>true</enableSRMDC>

    • enableDiscovery - Enable to collect less detailed information for the client.

      For example: To enable discovery feature then you must add the following:

      <enableDiscovery>true</enableDiscovery>

    • enableDiscoveryAndAnalysis - Enable to collect statistical data available for the client.

      For example: To enable discovery and analysis then you must add the following:

      <enableDiscoveryAndAnalysis>false</enableDiscoveryAndAnalysis>

    • enableFileLevelAnalytics - Enable to view file-level details for the specified client in various SRM Reports.

      For example: To enable file level analytics then you must add the following:

      <enableFileLevelAnalytics>false</enableFileLevelAnalytics>

  3. Save the file as input.xml.
  4. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  5. You can verify SRM Options at the client computer properties.
    • From the CommCell Browser, navigate to Client Computer | <Client> | File System | defaultBackupSet.
    • Right-click the subclient in the right pane and then click Properties.
    • Click the SRM Options tab.
    • The options specified in the above xml file will be selected in the Subclient Properties dialog box.
 

            View Sample XML File

Get 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. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor, and modify the following parameters:
    • clientName - Specify the name of the client computers for which you want to get the existing security details.

      For example: If you wish to get the existing security details of the client client1, then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • To get the existing security details for more than one client, add entity with the client name multiple times as shown below:

      <entity>

      <clientName>client2</clientName>

      </entity>

      <entity>

      <clientName>client3</clientName>

      </entity>

  3. Save the file as input.xml.
 

            View Sample XML File

  1. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and CommCell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  1. You can verify the client computer's security details such as, Available User groups, Associated User Groups and the Client Owners using the following steps:
    • From the CommCell Browser, right-click the <Client>, and then click Properties.
    • Click the Security tab.
    • The User Groups associated with this client computer will be listed under Associated Groups. The client Owners will be listed under Client Owners.

To empty the contents of the existing owners or User Groups

From the command prompt, you can modify the owners listed under Client Owners of a client computer. Use the following steps to modify the associated owners or user groups of a client computer:

  1. Right-click the View Sample XML File link and click Save Link As... or Save Target As... to save the XML file needed for this task.
  2. Open the .xml file using an XML editor and modify the following parameters:
    • clientName - Specify the name of the client computer for which you want to modify the list of Client Owners.

      For example: If you wish to modify the list of client owners for the client client1, then you must add the following:

      <entity>

      <clientName>client1</clientName>

      </entity>

    • To modify the list of client owners for more than one client, add entity with the client name multiple times:

      <entity>

      <clientName>client2</clientName>

      </entity>

      <entity>

      <clientName>client3</clientName>

      </entity>

    • clientOwners - Specifies the owner of the client for which you want to empty the contents.

      For example: If you wish to empty the contents of a client owner test1, then you must add the following:

      <clientOwners>test1</clientOwners>

    • clientOwnersOperationType - This operation type determines whether to add/delete or over write the owners list. Operation type can be one of the following types:

      ADD - To add the specified owner to the existing list of Client Owners

      DELETE - To delete the specified owner from the existing list of Client Owners.

      OVERWRITE - To clear the existing client owners and replace with the specified owner. If the owners user2 and user3 are already associated to client1 and listed under Client Owners, and if  you wish to add a new owner user3 to this Client Owners list, then, this operation adds the user4 to the Client Owners list and removes the existing owners under Client Owners.

      Using this xml script, you cannot empty the Master and View All groups association with clients.

  3. Save the file as input.xml
 

            View Sample XML File

  1. From Command prompt, navigate to <Software_Installation_Directory>/Base and then run the following command:
    • Login to the CommServe using the qlogin command and commcell credentials.

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

      C:\>qlogin -cs server1 -u user1

    • Run the XML using the qoperation command.

      For example, to run input.xml

      C:\>qoperation execute ľaf input.xml

  1. You can verify the list of Client Owners for a client:
    • From the CommCell Browser, right-click the <Client>, and then click Properties.
    • Click the Security tab.
    • List of Client Owners will be listed under Client Owners.