REST API - GET Virtual Server Agent Clients

This operation returns a list of clients where the Virtual Server agent is installed. The list includes the clients the logged on user has access to.

Request

Syntax

GET webservice/VSAclientlist 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 Header

Name	Description
Host	The host name of the Web Server or the Command Center 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
clientId	The system-generated ID assigned to the client.	clients
clientName	The name of the client.	clients
_type_		clients
hostName	The long name of the client, for example, client.domain.company.com.	clients
csGUID		clients

Examples

Sample Request

GET webservice/VSAclientlist HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GetClientsForPackage> <clients clientId="5" clientName="client001" _type_="3" hostName="DOCLABHVHOST.commcell.com" csGUID="35504XXD-E20A-4XDB-A1D4-F9ZTEST8CCDA" /> <clients clientId="4568" clientName="client002" _type_="3" hostName="DOCLAB2HVHOST.commcell.com" csGUID="96AC4448-595E-4500-B5C6-6CAETEST1F59" />
</TMMsg_GetClientsForPackage>