This operation returns the properties associated with a client computer group.
Request
Syntax
GET <webservice>/ClientGroup/{clientGroupId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
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 computer 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. |
Response
Response Parameters
Name |
Description |
Elements |
Parent Element |
---|---|---|---|
description |
The description of the client computer group. |
clientGroupDetail |
App_PerformClientGroupResp |
claQuota |
The size in gigabytes of data that is backed up for tenants in a client computer group. |
clientGroupDetail |
App_PerformClientGroupReq |
edcSupportedInstanceType |
clientGroupDetail |
App_PerformClientGroupResp |
|
isAddinClientGroup |
Valid values are True/False. |
clientGroupDetail |
App_PerformClientGroupResp |
isEDCInstanceAssociated |
Valid values are True/False. |
clientGroupDetail |
App_PerformClientGroupResp |
isEDCInstanceDeleted |
Valid values are True/False. |
clientGroupDetail |
App_PerformClientGroupResp |
isNetworkThrottleEnabled |
The option to use network throttling. For information on network throttling, see Configuring Network Throttling. Valid values are True/False. |
clientGroupDetail |
App_PerformClientGroupResp |
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_PerformClientGroupResp |
clientId |
The system-generated ID assigned to the client. |
associatedClients |
clientGroupDetail |
clientName |
The name of the client. |
associatedClients |
clientGroupDetail |
hostName |
The long name of the client, for example, client.domain.company.com. |
associatedClients |
clientGroupDetail |
clientGroupId |
The system-generated ID assigned to the client computer group. |
clientGroup |
clientGroupDetail |
clientGroupName |
The name of the client computer group. |
clientGroup |
clientGroupDetail |
activityType |
The client computer group activities. Valid values are:
|
activityControlOptions |
clientGroupActivityControl |
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 |
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:
|
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:
|
dateTime |
activityControlOptions |
_type_ |
The CommCell objects associated with the client computer group security. Valid value is USERGROUP_ENTITY. |
associatedUserGroups |
clientGroupSecurity |
userGroupId |
The system-generated ID assigned to the user group associated with the client computer group. |
associatedUserGroups |
clientGroupSecurity |
userGroupName |
The name of the user group associated with the client computer group. |
associatedUserGroups |
clientGroupSecurity |
val |
The capabilities of the client computer owners associated with the client group. |
individualCapabilities |
ownerCapabilities |
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 |
dlpScanIntervalMinsadmin |
The number of minutes the DLP scan waits between scans for new or unlocked content. |
dlpPropertise |
clientGroupDetail |
dlpStolen |
The settings related to the Data Loss Prevention (DLP) feature. 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 |
configureFirewallSettings |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallConfiguration |
clientGroupDetail |
isTrivialConfig |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallConfiguration |
clientGroupDetail |
extendedProperties |
The attribute is a string built using the following: version, encoding, standalone, App_FirewallExtendedProperties, and defaultOutgoingProtocol. For example, extendedProperties="<?xml version="1.0" encoding="UTF-8" standalone="no" ?><App_FirewallExtendedProperties defaultOutgoingProtocol="0"/>" |
firewallOptions |
firewallConfiguration |
foreceSSL |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallOptions |
clientGroupDetail |
isDMZ |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallOptions |
clientGroupDetail |
isRoamingClient |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallOptions |
clientGroupDetail |
keepAliveSeconds |
The settings related to Firewall Configuration. |
firewallOptions |
clientGroupDetail |
lockdown |
The settings related to Firewall Configuration. Valid values are True/False. |
firewallOptions |
clientGroupDetail |
tunnelInitSeconds |
The settings related to Firewall Configuration. |
firewallOptions |
clientGroupDetail |
tunnelconnectionPort |
The settings related to Firewall Configuration. |
firewallOptions |
clientGroupDetail |
connectionType |
The settings related to Firewall Configuration. |
firewallTrivialDetailsCS |
fwTrivialConfig |
networkType |
The settings related to Firewall Configuration. |
firewallTrivialDetailsCS |
fwTrivialConfig |
_type_ |
The settings related to Firewall Configuration. |
proxyEntity |
firewallTrivialDetailsCS |
clientSidePackage |
The settings related to Firewall Configuration. Valid values are True/False. |
proxyEntity |
firewallTrivialDetailsCS |
consumeLicense |
The settings related to Firewall Configuration. Valid values are True/False. |
proxyEntity |
firewallTrivialDetailsCS |
type |
The settings related to Firewall Configuration. |
proxyEntity |
firewallTrivialDetailsCS |
connectionType |
The settings related to Firewall Configuration. |
firewallTrivialDetailsMA |
fwTrivialConfig |
networkType |
The settings related to Firewall Configuration. |
firewallTrivialDetailsMA |
fwTrivialConfig |
_type_ |
The settings related to Firewall Configuration. |
proxyEntity |
firewallTrivialDetailsMA |
clientSidePackage |
The settings related to Firewall Configuration. Valid values are True/False. |
proxyEntity |
firewallTrivialDetailsMA |
consumeLicense |
The settings related to Firewall Configuration. Valid values are True/False. |
proxyEntity |
firewallTrivialDetailsMA |
type |
The settings related to Firewall Configuration. |
proxyEntity |
firewallTrivialDetailsMA |
enableThrottle |
The option to use network throttling. For information on network throttling, see Configuring Network Throttling. Valid values are True/False. |
networkThrottle |
clientGroupDetail |
_type_ |
The CommCell objects that are throttled. This attribute is returned when the enableThrottle parameter equals "true." Valid value is CLIENT_ENTITY. |
clientList |
networkThrottle |
clientId |
The system-generated ID assigned to the client. TThis attribute is returned when the enableThrottle parameter equals "true." |
clientList |
networkThrottle |
clientName |
The name of the client. This attribute is returned when the enableThrottle parameter equals "true." |
clientList |
networkThrottle |
hostName |
The long name of the client, for example, client.domain.company.com. This attribute is returned when the enableThrottle parameter equals "true." |
clientList |
networkThrottle |
shareBandwidth |
The option to enable all throttled clients to share allocated bandwidth. This attribute is returned when the enableThrottle parameter equals "true." Valid values are True/False. |
throttle |
networkThrottle |
days |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
endTime |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
isAbsolute |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." Valid values are True/False. |
throttle |
throttle |
recvRate |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
recvRatePercent |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
sendRate |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
sendRatePercent |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
startTime |
The settings related to Network Throttle. This attribute is returned when the enableThrottle parameter equals "true." |
throttle |
throttle |
deleted |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
enabled |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
isInheritedFromClientGroup |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
keyName |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
relativepath |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
type |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
value |
The options related to Additional Settings. |
registryKeys |
clientGroupDetail |
op |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
scgRule |
clientGroupDetail |
op |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
filterID |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
propID |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
propType |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
secValue |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
value |
The rules related to the Smart Client Computer Group (SCG) feature. This attribute is returned when the isSmartClientGroup parameter equals "true." |
rule |
rules |
clientId |
The system-generated ID assigned to the client. |
webSearchServer |
clientGroupDetail |
clientName |
The name of the client. |
webSearchServer |
clientGroupDetail |
Examples
Sample Request
GET <webservice>/ClientGroup/3 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
This is the response when the client computer group does not use automatic associations.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_PerformClientGroupResp>
<clientGroupDetail description="" claQuota="" edcSupportedInstanceType="" isAddinClientGroup="false" isEDCInstanceAssociated="false" isEDCInstanceDeleted="false" isNetworkThrottleEnabled="true" isSmartClientGroup="false">
<associatedClients clientId="2" clientName="client001" hostName="DOCLABHVHOST.commcell.com"/>
<clientGroup clientGroupId="3" clientGroupName="lbstest"/>
<clientGroupActivityControl>
<activityControlOptions activityType="BACKUP" enableActivityType="true" enableAfterADelay="false"/>
<activityControlOptions activityType="RESTORE" enableActivityType="true" enableAfterADelay="false"/>
</clientGroupActivityControl>
<clientGroupSecurity>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
<ownerCapabilities/>
</clientGroupSecurity>
<dlpPropertise dlpEnableClientKeys="false" dlpMinFileAgeMins="5" dlpScanIntervalMins="15" dlpStolen="false" enableDLP="true">
<dlpFilters val="*.bat"/>
<dlpFilters val="*.dll"/>
<dlpFilters val="*.exe"/>
<dlpFilters val="*.ini"/>
<dlpFilters val="*.lnk"/>
<dlpFilters val="*.tmp"/>
<dlpFilters val="~$*"/>
</dlpPropertise>
<firewallConfiguration configureFirewallSettings="false" isTrivialConfig="true">
<firewallOptions extendedProperties="<?xml version="1.0" encoding="UTF-8" standalone="no" ?><App_FirewallExtendedProperties defaultOutgoingProtocol="0"/>" foreceSSL="false" isDMZ="false" isRoamingClient="false" keepAliveSeconds="600" lockdown="false" tunnelInitSeconds="30" tunnelconnectionPort="8403"/>
<fwTrivialConfig>
<firewallTrivialDetailsCS connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
<proxyEntity _type_="ROOT_ENTITY" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</firewallTrivialDetailsCS>
<firewallTrivialDetailsMA connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
<proxyEntity _type_="ROOT_ENTITY" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</firewallTrivialDetailsMA>
</fwTrivialConfig>
</firewallConfiguration>
<networkThrottle enableThrottle="true">
<clientList _type_="CLIENT_ENTITY" clientId="2" clientName="client001" hostName="DOCLABHVHOST.commcell.com"/>
<throttle shareBandwidth="true">
<throttle days="1" endTime="0" isAbsolute="true" recvRate="-1" recvRatePercent="40" sendRate="1024" sendRatePercent="40" startTime="0"/>
</throttle>
</networkThrottle>
<registryKeys deleted="0" enabled="1" isInheritedFromClientGroup="false" keyName="ts1" relativepath="DataClassification" type="BOOLEAN" value="true"/>
</clientGroupDetail>
</App_PerformClientGroupResp>
This is the response when the client computer group does use automatic associations.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_PerformClientGroupResp>
<clientGroupDetail description="" claQuota="" edcSupportedInstanceType="" isAddinClientGroup="false" isEDCInstanceAssociated="false" isEDCInstanceDeleted="false" isNetworkThrottleEnabled="true" isSmartClientGroup="true">
<associatedClients clientId="2" clientName="client001" hostName="DOCLABHVHOST.commcell.com"/>
<clientGroup clientGroupId="3" clientGroupName="lbstest"/>
<clientGroupActivityControl>
<activityControlOptions activityType="BACKUP" enableActivityType="true" enableAfterADelay="false"/>
<activityControlOptions activityType="RESTORE" enableActivityType="true" enableAfterADelay="false"/>
</clientGroupActivityControl>
<clientGroupSecurity>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
<ownerCapabilities/>
</clientGroupSecurity>
<dlpPropertise dlpEnableClientKeys="false" dlpMinFileAgeMins="5" dlpScanIntervalMins="15" dlpStolen="false" enableDLP="true">
<dlpFilters val="*.bat"/>
<dlpFilters val="*.dll"/>
<dlpFilters val="*.exe"/>
<dlpFilters val="*.ini"/>
<dlpFilters val="*.lnk"/>
<dlpFilters val="*.tmp"/>
<dlpFilters val="~$*"/>
</dlpPropertise>
<firewallConfiguration configureFirewallSettings="false" isTrivialConfig="true">
<firewallOptions extendedProperties="<?xml version="1.0" encoding="UTF-8" standalone="no" ?><App_FirewallExtendedProperties defaultOutgoingProtocol="0"/>" foreceSSL="false" isDMZ="false" isRoamingClient="false" keepAliveSeconds="600" lockdown="false" tunnelInitSeconds="30" tunnelconnectionPort="8403"/>
<fwTrivialConfig>
<firewallTrivialDetailsCS connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
<proxyEntity _type_="ROOT_ENTITY" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</firewallTrivialDetailsCS>
<firewallTrivialDetailsMA connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
<proxyEntity _type_="ROOT_ENTITY" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</firewallTrivialDetailsMA>
</fwTrivialConfig>
</firewallConfiguration>
<networkThrottle enableThrottle="true">
<clientList _type_="CLIENT_ENTITY" clientId="2" clientName="client001" hostName="DOCLABHVHOST.commcell.com"/>
<throttle shareBandwidth="true">
<throttle days="1" endTime="0" isAbsolute="true" recvRate="-1" recvRatePercent="40" sendRate="1024" sendRatePercent="40" startTime="0"/>
</throttle>
</networkThrottle>
<registryKeys deleted="0" enabled="1" isInheritedFromClientGroup="false" keyName="ts1" relativepath="DataClassification" type="BOOLEAN" value="true"/>
<scgRule op="SCGP_AND">
<rules>
<rule op="SCGP_AND">
<rules>
<rule filterID="100" propID="2" propType="SCGP_ENUM" secValue="Installed" value="1"/>
</rules>
</rule>
</rules>
</scgRule>
</clientGroupDetail>
</App_PerformClientGroupResp>
<