vSphere ESX Agent Manager API

Managed Object - EamObject

Property of: EamObjectRuntimeInfo
Extended by: Agency, Agent, EsxAgentManager
See also: Issue
Since: 1.0

Managed Object Description

Base class for the Agent, Agency and EsxAgentManager classes.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
QueryIssue, Resolve, ResolveAll

QueryIssue

Current issues that have been detected for this entity. Each issue can be remediated by invoking EamObject#resolve(int[]) or EamObject#resolveAll().

Requires view privileges.

Required Privileges: None

Parameters

Name

Type

Description

_this

vmodl.ManagedObjectReference

A reference to the EamObject used to make the method call.

issueKey* P

xsd:int[]

An optional array of issue keys. If not set, all issues for this entity are returned.

Since 1.0

*Need not be set P Required privilege: issueKey

Return Value

Type	Description
Issue[]	A possibly empty array of issues that match the input `issueKey` array. Note that the returned array can be smaller than `issueKey` if one or more issue keys refers to issues that this entity does not have.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="QueryIssue" type="eam:QueryIssueRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="QueryIssueResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="eam:Issue" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Resolve

Resolves the issues specified in the input. If an issue is remediable, ESX Agent Manager tries to resolve the misconfiguration that caused the issue. If it is not remediable, the offending issue is removed and ESX Agent Manager assumes that the issue has been resolved.

Requires modify privileges.
See Issue

Required Privileges: None

Parameters

Name

Type

Description

_this

vmodl.ManagedObjectReference

A reference to the EamObject used to make the method call.

issueKey P

xsd:int[]

A non-empty array of issue keys.
See Issue

Since 1.0

P Required privilege: issueKey

Return Value

Type	Description
xsd:int[]	A possibly empty array of issue keys for the issues that were not found on the entity. This can happen if `resolve` is called with issue keys that were resolved just prior to calling `resolve` or if an issue is currenly not resolvable.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="Resolve" type="eam:ResolveRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="ResolveResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:int" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ResolveAll

Resolve all outstanding issues. The method calls EamObject#resolve(int[]) with all issues the EsxAgentManager, Agency, or Agent have encountered. It is the equivalent of calling the following methods:

agent.resolve(getIssueKeys(agent.getRuntime().getIssue())); for Agent objects
agency.resolve(getIssueKeys(agency.getRuntime().getIssue())); for Agency objects
esxAgentManager.resolve(getIssueKeys(esxAgentManager.getIssue())); for the EsxAgentManager object.

Requires modify privileges.
See Issue

Required Privileges: None

Parameters

Name	Type	Description
_this	vmodl.ManagedObjectReference	A reference to the EamObject used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="ResolveAll" type="eam:ResolveAllRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="ResolveAllResponse">
            <complexType/>
         </element>