Managed Object -
Agent
- Property of
-
Agency, AgentIssue, ExtensibleIssue
- Returned by
-
QueryAgent, RegisterAgentVm
- Extends
-
EamObject
- See also
-
AgentConfigInfo, AgentRuntimeInfo
Managed Object Description
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 Agent#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, disabled, 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).
disabled. Behavior is the same as for enabled, but the agent does not power
on the agent virtual machine. If the goal state changes from enabled to disabled, the agent
will make sure that its virtual machine is powered off.
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 RuntimeInfo#issue in Agent#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.
Properties
|
Name
|
Type
|
Description
|
| config | AgentConfigInfo |
The configuration of this Agent.
|
| runtime | AgentRuntimeInfo |
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.
|
|
Properties inherited from EamObject |
| None |
Methods
AgentQueryConfig
The configuration of this Agent.
- Required Privileges
- None
Parameters
| Name | Type | Description |
| _this | vmodl.ManagedObjectReference |
A reference to the
Agent
used to make the method call.
|
Return Value
Faults
Events
Show WSDL type definition
AgentQueryRuntime
Runtime information for the agent. This includes important information about the current
deployment of the agent's VIB, virtual machine, and host.
Requires view privileges.
- Required Privileges
- None
Parameters
| Name | Type | Description |
| _this | vmodl.ManagedObjectReference |
A reference to the
Agent
used to make the method call.
|
Return Value
Faults
Events
Show WSDL type definition
MarkAsAvailable
Mark this agent as available. Used when the agency this agent belongs to has
manuallyMarkAgentVmAvailableAfterProvisioning or
manuallyMarkAgentVmAvailableAfterPowerOn set to true.
- Required Privileges
- None
Parameters
| Name | Type | Description |
| _this | vmodl.ManagedObjectReference |
A reference to the
Agent
used to make the method call.
|
Return Value
Faults
Events
Show WSDL type definition