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 this Agent. It can be enabled or uninstalled:
  • enabled. The Agent deploys its VIB, its agent virtual machine, and powers on the agent virtual machine. The Agent 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. The Agent uninstalls any installed VIB and power off and delete the deployed agent virtual machine.
• status. The status of the Agent regarding the given goal state. Status can be either red, yellow or green:
  • red. An issue is preventing the Agent from reaching its desired goal state. See issue in runtime for the types of issues that can block this Agent.
  • yellow. The Agent is actively working to reach the desired goal state. For the enabled goal state, this means that this Agent is installing its VIB, deploying the agent virtual machine, and powering it on.
  • green. The Agent has reached the desired goal state. The Agent is no longer actively scheduling new tasks but is monitoring vCenter for changes that might conflict with this Agent's goal state.