AgentRuntimeInfo

AgentRuntimeInfo
AgentRuntimeInfo

Deprecated as of vSphere 9.0. Please refer to vLCM APIs.

Extends RuntimeInfo with information regarding the deployment of an agent on a specific host.

This structure may be used only with operations rendered under /eam.

AllOf
This class requires all of the following:
JSON Example
{
    "_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"
    }
}
vmPowerState
Required

Deprecated get that info calling the virtual machine VIM API.

The power state of an agent virtual machine.

boolean
receivingHeartBeat
Required

Deprecated get that info calling the virtual machine VIM API.

True if the vSphere ESX Agent Manager is receiving heartbeats from the agent virtual machine.

host
Optional

The agent host.

vm
Optional

The agent virtual machine.

string
vmIp
Optional

Deprecated get that info calling the virtual machine VIM API.

The IP address of the agent virtual machine

string
vmName
Required

Deprecated get that info calling the virtual machine VIM API.

The name of the agent virtual machine.

esxAgentResourcePool
Optional

Deprecated in order to retrieve agent resource pool use VIM API.

The ESX agent resource pool in which the agent virtual machine resides.

esxAgentFolder
Optional

Deprecated in order to retrieve agent VM folder use VIM API.

The ESX agent folder in which the agent virtual machine resides.

array of string
installedBulletin
Optional

Deprecated use AgentRuntimeInfo.installedVibs instead.

An optional array of IDs of installed bulletins for this agent.

array of VibVibInfo
installedVibs
Optional

Information about the installed vibs on the host.

agency
Optional

The agency this agent belongs to.

vmHook
Optional

Active VM hook.

If present agent is actively waiting for Agent.MarkAsAvailable. See AgentVmHook.

Deprecated
Property Of
Returned By