Agency Update | Virtual Infrastructure JSON API

Agency Update

Updates the agency configuration used by this Agency to deploy agents and VIBs.

vSphere ESX Agent Manager generates a diff between the old configuration and the new one and updates the Agency accordingly.

Requires modify privileges.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/eam/Agency/{moId}/Update

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Agency/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body

UpdateRequestType of type(s) application/json

Required

"UpdateRequestType Object"

config

Required

The new configuration for this Agency

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidAgentConfiguration: Thrown if one or more agent configurations are invalid.

InvalidAgencyScope: Thrown if one or more compute resources in the scope cannot be found in vCenter or there is no configured resource pool or folder where the VMs to be deployed.

EamInvalidUrl: Thrown if either the agent virtual machine URL or VIB URL cannot be parsed or if the resource refered to cannot be downloaded.

Returns EamFault of type(s) application/json

This response body class contains all of the following: InlineEamFault0

"EamFault Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/eam/Agency/{moId}/Update

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Esx Agent Manager Api Operations