Agent Get Runtime

Runtime information for this agent.

This includes important information about the current deployment of the agent's VIB, virtual machine, and host.

Requires view privileges.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/eam/Agent/{moId}/runtime

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This Agent's runtime information.

Returns AgentRuntimeInfo of type(s) application/json

This response body class contains all of the following: EamObjectRuntimeInfo

{
    "_typeName": "string",
    "status": "string",
    "issue": [
        {
            "_typeName": "string",
            "key": 0,
            "description": "string",
            "time": "string"
        }
    ],
    "goalState": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vmPowerState": "string",
    "receivingHeartBeat": false,
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vmIp": "string",
    "vmName": "string",
    "esxAgentResourcePool": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "esxAgentFolder": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "installedBulletin": [
        "string"
    ],
    "installedVibs": [
        {
            "_typeName": "string",
            "id": "string",
            "name": "string",
            "version": "string",
            "vendor": "string",
            "summary": "string",
            "softwareTags": {
                "_typeName": "string",
                "tags": [
                    "string"
                ]
            },
            "releaseDate": "string"
        }
    ],
    "agency": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vmHook": {
        "_typeName": "string",
        "vm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "vmState": "string"
    }
}

VirtualMachinePowerState_enum

vmPowerState

Required

The PowerState type defines a simple set of states for a virtual machine: poweredOn, poweredOff, and suspended.

This type does not model substates, such as when a task is running to change the virtual machine state. If the virtual machine is in a state with a task in progress, it transitions to a new state when the task completes. For example, a virtual machine continues to be in the poweredOn state while a suspend task is running, and changes to the suspended state once the task finishes.

As a consequence of this approach, clients interested in monitoring the status of a virtual machine should typically track the activeTask data object in addition to the powerState object.

Possible values: