Agency Register Agent Vm

Agency Register Agent Vm

Deprecated use automatically provisioned VMs and register hooks to have control post provisioning and power on.

Adds an agent VM to this agency.

Used if manuallyProvisioned is set to true. The method does nothing if the agent VM is already registered with this agency.

Requires modify privileges.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/eam/Agency/{moId}/RegisterAgentVm
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 8.0.3.0 APIs.


Request Body
RegisterAgentVmRequestType of type(s) application/json
Required

Show optional properties

{
    "agentVm": {}
}
{
    "agentVm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
agentVm
Required

Reference to an instance of the VirtualMachine managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MoRefAgent of type(s) application/json
This response body class contains all of the following: MoRefEamObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

ManagedObjectNotFound: Thrown if agentVm does not exist in vCenter.

Returns ManagedObjectNotFound of type(s) application/json
This response body class contains all of the following: RuntimeFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "obj": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
obj
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.