Loading...

REST API - PUT Subclient Virtual Machine Content

This operation updates subclient content for a virtual machine. To add subclient content, see REST API - POST Subclient Properties.

Request

Syntax

PUT <webservice>/Subclient/{subclientId}/content HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<put_subclient_vm_content.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

subclientId

The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient 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.

Request Body

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

Name

Description

Element

Parent Element

appName

Valid value is Virtual Server.

entity

association

vmContentOperationType

The type of operation to perform on the subclient content.

Valid value is OVERWRITE, to overwrite content for the subclient.

subClientProperties

App_UpdateSubClientPropertiesRequest

displayName

The name of the virtual machine or datastore, depending on the content type defined in the type parameter.

To add more than one virtual machine or datastore, add a <children> element for each virtual machine:

<vmContent>
  <children displayName="VM001" equalsOrNotEquals="1" type="VMName" path="" />
  <children displayName="VM002" equalsOrNotEquals="1" type="VMName" path="" />
</vmContent>

children

vmContent

equalsOrNotEquals

Excludes the virtual machines, the datastore, or the ESX host that does not match the displayName parameter.

Valid value is 1.

children

vmContent

name

The globally unique identifier (GUID) for the virtual machine. The name parameter is needed if content is updated. If the name is not known, use the GET Virtual Machine Browse API to retrieve it from the strGUID parameter.

children

vmContent

type

The type of the content to be added to the subclient.

Valid values are:

  • VMName - to add a virtual machine to the subclient content.
  • DATASTORE - to add a datastore to the subclient content. This only applies to VMware agents.

    For a complete list of values, see VSA Object Types.

children

vmContent

Response

Response Parameters

Parameter

Description

Element

erorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

CVGui_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

CVGui_GenericResp

Examples

Sample Request

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

<?xml version="1.0" encoding="UTF-8"?>
<App_UpdateSubClientPropertiesRequest>
  <association>
    <entity>
      <appName>Virtual Server</appName>
    </entity>
  </association>
  <subClientProperties>
    <vmContentOperationType>OVERWRITE</vmContentOperationType>
    <vmContent>
      <children type="VMName" displayName="VM001" name="5039fb6c-TEST-1642-f42b-bc425121f01b" equalsOrNotEquals="1"/>
      <children type="VMName" displayName="VM002" name="501cb8c8-9293-test-d3f9-9c61402c2fc4" equalsOrNotEquals="1"/>
    </vmContent>
  </subClientProperties>
</App_UpdateSubClientPropertiesRequest>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<CVGui_GenericResp errorCode="0" errorMessage="" />

Last modified: 12/11/2019 7:40:15 PM