Updating a Client Computer Group Using the Command Line Interface

Updated

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.

    Parameter Table

    Name

    Description

    Elements

    Parent Element

    associatedClientsOperationType

    Option to determine whether to add, delete or overwrite the client computers in the client computer group. Valid values are:

    • 1, to OVERWRITE the existing client computers and replace with the specified client computers.

    • 2, to ADD client computers to the existing list of client computers.

    • 3, to DELETE client computers from the existing list of client computers.

      For example: You have client1 and client2 already associated with clientgroup1, and you want to add client3 to the list of client computers. This operation adds client3 to the client computers list.

    clientGroupDetail

    App_PerformClientGroupReq

    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

    • 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.

    This option is supported only for SQL Server Agent.

    overrideHigherLevelSettings

    clientGroupDetail

    useLocalSystemAccount

    The option to use the local system account when overriding higher level settings.

    This option is supported only for SQL Server Agent.

    overrideHigherLevelSettings

    clientGroupDetail

    userName

    The name of the user.

    This option is supported only for SQL Server Agent.

    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. Run the qlogin command to log on to the CommServe computer.

  5. 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.

Was this page helpful?