This operation returns a list of agents for a client.
Request
Syntax
Send the request using either the ID or the name:
ID
GET <webservice>/Agent?clientId={clientId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>Name
GET <webservice>/Agent?clientName={clientName} 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 |
|---|---|---|
clientId | The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. | Yes-for the request by ID |
clientName | The client name for the client. If the client name is not known, use the GET Client API to retrieve it. | Yes-for the request by name |
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
Parameter | Description | Element | |||
|---|---|---|---|---|---|
agentArchivePropertiesFlag | The option to enable archiving for the agent. Valid values are True/False. | AgentProperties | |||
agentVersion | The Agent software version installed on the client computer or application server. | AgentProperties | |||
appPriority |
| AgentProperties | |||
appTypePathnameOrder |
| AgentProperties | |||
appTypePathnameSeperator | This is the character that is used to specify the different directories in a path name. The default is a backslash (\). | AgentProperties | |||
appTypepathnameCaseSensitive | Indicates if the path name is case sensitive. Valid values are 0/1. | AgentProperties | |||
archiveGroup | The name of the Archive Group. | AgentProperties | |||
createIndexOnFail | The option to convert to a full backup on indexing failures. Valid values are True/False. | AgentProperties | |||
createIndexOnFull | The option to create an index on a full backup. Valid values are True/False. | AgentProperties | |||
enableOCSOnBackupAgent | The option to enable the Office Communications Server backup. Valid values are True/False. | AgentProperties | |||
installDate | The installation date of the agent. Valid values are UNIX-style timestamps (seconds since January 1, 1970). | AgentProperties | |||
isArchiverDriverEnabled | The option to enable the recall driver. Valid values are True/False. | AgentProperties | |||
isExplorerBasedRecall | The option to enable Explorer-based recall. Valid values are True/False. | AgentProperties | |||
isMarkedDeleted | The option that marks the agent as deleted. Valid values are True/False. | AgentProperties | |||
isNDMPRestore | Valid values are True/False. | AgentProperties | |||
isNeedMoreconfig | Valid values are True/False. | AgentProperties | |||
maxSimultaneousStubRecoveries | The upper limit for the number of stubs to be recovered for this agent. | AgentProperties | |||
objectServerInterval | An internal reference number. Valid value is 5. | AgentProperties | |||
patchStatus |
| AgentProperties | |||
prepostUsername | The name of the user with permission to run the pre or post commands. | AgentProperties | |||
qsnapMaxCacheSize | The maximum cache size for QSnap. | AgentProperties | |||
qsnapMinCacheSize | The minimum cache for QSnap. | AgentProperties | |||
timeBetweenRecalls | The time between recall jobs. | AgentProperties | |||
timeToWaitAfterMax | The number of seconds that this agent must wait before additional stub recovery jobs can begin after the upper limit has been reached. | AgentProperties | |||
useSnapShotWriter | Valid values are True/False. | AgentProperties | |||
userDescription | A general description of the user. | AgentProperties | |||
storagePolicyId | The internal storage policy ID. | indexStoragePolicy | |||
storagePolicyName | The storage policy name visible to the user. | indexStoragePolicy | |||
activityType | The agent activities. Valid values are:
| activityControlOptions | |||
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 | |||
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 | |||
enableActivityType | The option to enable or disable an activity for a client. Valid values are True/False. | activityControlOptions | |||
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 | |||
appName | The name of the application. Valid values for the applicationId and appName parameters:
| idaEntity | |||
applicationId | The ID of the application. For a list of application IDs, see the valid values for the appName parameter. | idaEntity | |||
clientId | The system-generated ID assigned to the client. | idaEntity | |||
clientName | The name of the client. | idaEntity | |||
commCellId | The CommCell ID of the CommServe. Valid value is 2. | idaEntity | |||
_type_ | The CommCell objects associated with the agent security. Valid value is USERGROUP_ENTITY. | associatedUserGroups | |||
userGroupId | The system-generated ID assigned to the user group associated with the agent. | associatedUserGroups | |||
userGroupName | The name of the user group associated with the agent. | associatedUserGroups | |||
ownerCapabilities | The capabilities of the client computer owners associated with the agent. | idaSecurity |
Examples
Sample Request
This request uses the ID.
GET <webservice>/Agent?clientId=2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8This request uses the name.
GET <webservice>/Agent?clientName=client001 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GetAgentPropertiesResponse>
<agentProperties>
<AgentProperties agentArchivePropertiesFlag="false" agentVersion="10(BUILD116)" appPriority="6" appTypePathnameOrder="1" appTypePathnameSeperator="\\" appTypepathnameCaseSensitive="0" archiveGroup="3" createIndexOnFail="false" createIndexOnFull="true" enableOCSOnBackupAgent="false" installDate="1373479931" isArchiverDriverEnabled="false" isExplorerBasedRecall="false" isMarkedDeleted="false" isNDMPRestore="true" isNeedMoreconfig="false" maxSimultaneousStubRecoveries="4294967295" objectServerInterval="5" patchStatus="0" prepostUsername="" qsnapMaxCacheSize="4294967295" qsnapMinCacheSize="4294967295" timeBetweenRecalls="4294967295" timeToWaitAfterMax="4294967295" useSnapShotWriter="false" userDescription="">
<indexStoragePolicy storagePolicyId="1" storagePolicyName="CV_DEFAULT"/>
</AgentProperties>
<idaActivityControl>
<activityControlOptions activityType="BACKUP" enableActivityType="true" enableAfterADelay="false"/>
<activityControlOptions activityType="RESTORE" enableActivityType="true" enableAfterADelay="false"/>
</idaActivityControl>
<idaEntity appName="File System" applicationId="33" clientId="2" clientName="client001" commCellId="2"/>
<idaSecurity>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
<associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
<ownerCapabilities/>
</idaSecurity>
</agentProperties>
</App_GetAgentPropertiesResponse>