Loading...

REST API - GET Virtualization Clients

Description

This operation returns a list of virtualization clients, including clients with VMware or Microsoft Hyper-V instances and clients with the V9 Virtual Server agent installed.

Request

Syntax

GET <webservice>/Client/VMPseudoClient 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 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.

XML

An .xml file is not needed.

Response

Response Parameters

Parameter Description Element
VSInstanceType   VSPseudoClientsList
clientId The system-generated ID assigned to the virtualization client. client
clientName The name of the virtualization client. client
hostName The long name of the client, for example, client.domain.company.com. client
clientGUID The globally unique identifier for the virtualization client. client
_type_   entity
activityType The virtualization client activities.

Valid values are:

  • 1, for backup
  • 2, for restore
activityControlOptions
enableActivityType The option to enable or disable an activity for a virtualization client.

Valid values are True/False.

activityControlOptions
enableAfterADelay The option to enable an activity for a virtualization client on a date and time defined in the Enable Backup dialog box.

Valid values are True/False.

activityControlOptions

Examples

Sample Request

GET <webservice>/Client/VMPseudoClient HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_VSPseudoClientsResponse>
  <VSPseudoClientsList VSInstanceType="2">
    <client clientGUID="E4AEC929-0F5C-4013-8B2E-EATEST123655" clientName="Vclient001" hostName="DOCLABHVHOST.commvault.com" clientId="2" />
    <clientActivityControl>
      <entity _type_="3" />
      <activityControlOptions enableAfterADelay="0" enableActivityType="1" activityType="1" />
      <activityControlOptions activityType="2" enableActivityType="1" enableAfterADelay="0" />
    </clientActivityControl>
  </VSPseudoClientsList>
  <VSPseudoClientsList VSInstanceType="1">
    <client clientId="3" clientName="Vclient002" hostName="DOCLABFVHOST.commvault.com" clientGUID="657015DE-F2AA-4C25-AE14-FC8TEST15FC4" />
    <clientActivityControl>
      <entity _type_="3" />
      <activityControlOptions activityType="1" enableActivityType="1" enableAfterADelay="0" />
      <activityControlOptions activityType="2" enableActivityType="1" enableAfterADelay="0" />
    </clientActivityControl>
  </VSPseudoClientsList>
  <VSPseudoClientsList VSInstanceType="1">
    <client clientId="19" clientName="Vclient003" hostName="DOCLABCVHOST.commvault.com" clientGUID="5D578C54-18F0-41B6-8310-3ABETESTCA0B" />
    <clientActivityControl>
      <entity _type_="3" />
      <activityControlOptions activityType="1" enableActivityType="1" enableAfterADelay="0" />
      <activityControlOptions activityType="2" enableActivityType="1" enableAfterADelay="0" />
    </clientActivityControl>
  </VSPseudoClientsList>
</App_VSPseudoClientsResponse>