Esx Agent Manager Api Agent APIs
An Agent
is the vSphere ESX Agent Manager managed object responsible for deploying an Agency
on a single host.
The Agent
maintains the state of the current deployment in its runtime information (see runtime).
An Agent
has the same goalState
and status
properties as an Agency
, that are used in the same way:
goalState
. The goal state describes the overall goal of thisAgent
. It can beenabled
oruninstalled
:enabled
. TheAgent
deploys its VIB, its agent virtual machine, and powers on the agent virtual machine. TheAgent
monitors in vCenter the status of the installation of the VIB (in case it is uninstalled outside of vSphere ESX Agent Manager) and of the agent virtual machine (in case an operation is performed on it outside of vSphere ESX Agent Manager).uninstalled
. TheAgent
uninstalls any installed VIB and power off and delete the deployed agent virtual machine.
status
. The status of theAgent
regarding the given goal state. Status can be either red, yellow or green:red
. An issue is preventing theAgent
from reaching its desired goal state. See issue in runtime for the types of issues that can block thisAgent
.yellow
. TheAgent
is actively working to reach the desired goal state. For theenabled
goal state, this means that thisAgent
is installing its VIB, deploying the agent virtual machine, and powering it on.green
. TheAgent
has reached the desired goal state. TheAgent
is no longer actively scheduling new tasks but is monitoring vCenter for changes that might conflict with thisAgent
's goal state.
Operations
POST
Agent Agent Query Config
The configuration of this <code>Agent</code>.
POST
Agent Agent Query Runtime
Runtime information for the agent.
GET
Agent Get Config
The configuration of this <code>Agent</code>.
GET
Agent Get Runtime
Runtime information for this agent.
POST
Agent Mark As Available
Mark this agent's VM as available.
POST
Agent Query Issue
Current issues that have been detected for this entity.
POST
Agent Resolve
Resolves the issues specified in the input.
POST
Agent Resolve All
Resolve all outstanding issues.