Command Line Interface - Client Computer Groups

Table of Contents

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

Listing Client Groups (qlist clientgroup)

Description

This command lists names of all the client groups configured in the CommCell. When more than one client group is found, the name of each client groups is listed in its own line. No message is displayed when clients are not found.

In case of an error, an error code and description are displayed as: "clientgroup: Error errorcode: errordescription"

Usage

qlist clientgroup [-tf <tokenfile>] [-tk <token>] [-h]

Options

-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the client groups configured in the CommCell.

qlist clientgroup
Grp1
Grp2

Add or Delete a Client from a Client Group (qmodify clientgroup)

Description

This command adds or removes a client to/from a client group. Upon successful completion, qmodify clientgroup displays the message "qmodify clientgroup add/remove operation successful" on the console.

In case of an error, an error code and description are displayed as: "clientgroup: Error errorcode: errordescription"

Usage

qmodify clientgroup -o <add|delete> -c <client> -cg <clientgroup> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-o Operation to be performed on the client group. Valid values are:
  • add
  • delete
-c Client computer name
-cg Client group name
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

client [string] Client computer name
clientgroup [string] Client group name
operation [string] Operation to be performed on the client group. Valid values are:
  • add
  • delete
description [list<string>|multiline] Description provided by the user

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Add a client client1 to clientgroup clientgroup1.

E:\commandline>qmodify clientgroup -c client1 -cg clientgroup1 -o add

Configuring a Client Computer Group Using XML

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.

Updating a User Group on a Client Computer Group Using XML

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.