V11 SP8
Loading...

REST API - POST Client Group Properties

This operation updates the properties associated with a client computer group.

Request

Syntax

POST <webservice>/ClientGroup/{clientGroupId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<update_client_computer_group_template.xml>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name Description Required
clientGroupId The client group ID for the client computer group. If the client computer group ID is not known, use the GET Client Group API to retrieve it. Yes

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type The media type contained in the request body.

XML

Download the update_client_computer_group_template.xml file required for this request. The following table displays the parameters for the update_client_computer_group_template.xml file.

Name Description Elements Parent Element
clientGroupOperationType The operation to update a client computer group.

Valid value is Update.

App_PerformClientGroupReq  
associatedClientsOperationType The operation to perform on the clients in the clientName parameter in the <associatedClients> element.

Valid values:

  • 0, no change to the clients
  • 1, overwrites clients
  • 2, adds clients
  • 3, removes clients
  • 4, removes all clients
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 to be acted on by the individualCapabilitiesOperationType parameter. ownerCapabilities clientGroupSecurity
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 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

Response

Response Parameters

Parameter Description Element
errorCode The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.
App_GenericResp
errorMessage The description of the error code. Not all error codes have an error message. App_GenericResp

Examples

Sample Request

XML

This request updates the client computer group description. The client computer group description is in the Description attribute in the clientGroupDetail element.

POST <webservice>/ClientGroup/3 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_PerformClientGroupReq>
  <clientGroupOperationType>Update</clientGroupOperationType>
  <clientGroupDetail>
    <clientGroup>
      <clientGroupName>sales_group</clientGroupName>
    </clientGroup>
    <description>client computer group description modified with rest api POST client group</description>
  </clientGroupDetail>
</App_PerformClientGroupReq>

JSON

This request removes clients from the client computer group.

POST <webservice>/ClientGroup/3 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

{
  "clientGroupOperationType":Update,
  "clientGroupDetail":{
    "description":"client group description",
    "clientGroup":{
      "clientGroupName":"CG001"
    },
    "associatedClientsOperationType":3,
    "associatedClients":[
      {
        "clientName":"test001"
      },
      {
        "clientName":"test002"
      }
    ]
  }
}

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0" errorMessage="Client group updated successfully"/>