Agent Get Runtime

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://{api_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 9.0.0.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

This Agent's runtime information.

Returns AgentRuntimeInfo of type(s) application/json
This response body class contains all of the following: InlineAgentRuntimeInfo0 
"AgentRuntimeInfo Object"
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 object
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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/eam/Agent/{moId}/runtime
On This Page
Esx Agent Manager Api Operations
POST
Agent Mark As Available
POST
Agent Agent Query Config
Deprecated
POST
Agent Query Issue
POST
Agent Agent Query Runtime
Deprecated
POST
Agent Resolve
POST
Agent Resolve All
GET
Agent Get Config
GET
Agent Get Runtime