vSphere ESX Agent Manager API

		Local Properties	Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - EsxAgentManager

Extends

EamObject

See also

Agency, AgencyConfigInfo, Issue

Since

1.0

Managed Object Description

The EsxAgentManager is the main entry point for a solution to create agencies in the vSphere ESX Agent Manager server.

In vCenter 6.0, a solution is either a vCenter extension or a regular user.

The vSphere ESX Agent Manager VMODL API distinguishes between two types of users: VC extensions and regular vCenter users. These users have different privileges in the vSphere ESX Agent Manager VMODL API:

• VC extensions have the privileges to call anything in the vSphere ESX Agent Manager VMODL API.
• Regular vCenter users have restrictions on what methods they can call. The methods that a vCenter user that is not an extension can call are annotated with two types of privileges, Eam.View and Eam.Modify:
  • Eam.View. If a method has the Eam.View privilege, a user can call that method if they have the EAM.View privilege in vCenter.
  • Eam.Modify. Similarly to Eam.View, if a method has the Eam.Modify privilege, a user can call that method if they have the EAM.Modify privilege in vCenter. If a user has the EAM.Modify privilege, they automatically have EAM.View.

In vCenter 6.5 every solution, which is making VMODL API calls to EsxAgentManager, should be aware of the posibility, that the data from vCenter database might not be fully loaded. In all such cases the clients will receive an ESX Agent Manager runtime fault: EamServiceNotInitialized. NOTE: No issues are associated with EsxAgentManager any longer.

Properties

Name	Type	Description
agency*	vmodl.ManagedObjectReference to a Agency[]	An array of all Agency objects. If called by a vCenter user with the vCenter EAM.View or EAM.Modify privilege, this returns all agencies registered in vSphere ESX Agent Manager. If called by a solution, this property only returns the agencies created by the solution (and only those which have not been destroyed). Requires view privileges.
issue*	Issue[]	Deprecated. This method is deprecated since the EAM object does not handles issue anymore. At the moment the implementation returns an empty array of issues. 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.
Properties inherited from EamObject
None

*May not be present

Methods

Methods defined in this Managed Object
CreateAgency, GetMaintenanceModePolicy, QueryAgency, ScanForUnknownAgentVm, SetMaintenanceModePolicy
Methods inherited from EamObject
QueryIssue, Resolve, ResolveAll

CreateAgency

Creates an Agency. The initial goal state is given to the method by the second parameter. Throws InvalidArgument if the agencyName is not set in the agencyConfigInfo.

Requires modify privileges.

Required Privileges

None

Parameters

Name	Type	Description
_this	vmodl.ManagedObjectReference	A reference to the EsxAgentManager used to make the method call.
agencyConfigInfo P	AgencyConfigInfo	The configuration that describes how to deploy the agents in the created agency. Since 1.0
initialGoalState P	xsd:string	Deprecated. No sence to create agency in other state than enabled. disabled is deprecated whereas uninstalled is useless. The initial goal state of the agency. See EamObjectRuntimeInfoGoalState. Since 1.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
vmodl.ManagedObjectReference to a Agency	The created agency.

Faults

Type	Description
InvalidAgencyScope	Thrown if one or more compute resources in the scope cannot be found in vCenter or there is no configured resource pool or folder where the VMs to be deployed.
InvalidAgentConfiguration	Thrown if the agent configuration is empty or if one or more agent configurations are invalid.
InvalidUrl	Thrown if either the agent virtual machine URL or VIB URL cannot be parsed or if the resource refered to cannot be downloaded.
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="CreateAgency" type="eam:CreateAgencyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="CreateAgencyResponse"> <complexType> <sequence> <element name="returnval" type="vim25:ManagedObjectReference"/> </sequence> </complexType> </element>

GetMaintenanceModePolicy

Obtains maintenance policy for for clusters not managed by vSphere Lifecycle Manasger.
See EsxAgentManagerMaintenanceModePolicy

Required Privileges

None

Since

vEAM API 7.4

Parameters

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

Return Value

Type	Description
xsd:string	Currently configured policy.

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="GetMaintenanceModePolicy" type="eam:GetMaintenanceModePolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="GetMaintenanceModePolicyResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string"/> </sequence> </complexType> </element>

QueryAgency

Deprecated. Use #agency() instead

An array of all Agency objects. If called by a vCenter user with the vCenter EAM.View or EAM.Modify privilege, this returns all agencies registered in vSphere ESX Agent Manager. If called by a solution, this property only returns the agencies created by the solution (and only those which have not been destroyed).

Requires view privileges.

Required Privileges

None

Parameters

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

Return Value

Type	Description
vmodl.ManagedObjectReference to a Agency[]	The possibly empty set of agencies registered in the vSphere ESX Agent Manager server.

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="QueryAgency" type="eam:QueryAgencyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="QueryAgencyResponse"> <complexType> <sequence> <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

ScanForUnknownAgentVm

Deprecated. Presence of unknown VMs is no more acceptable

Scans the vCenter inventory for any unknown agent virtual machine. An issue is generated for each unknown agent virtual machine found during this scan.

Requires view privileges.

Required Privileges

None

Parameters

Name	Type	Description
_this	vmodl.ManagedObjectReference	A reference to the EsxAgentManager 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="ScanForUnknownAgentVm" type="eam:ScanForUnknownAgentVmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="ScanForUnknownAgentVmResponse"> <complexType/> </element>

SetMaintenanceModePolicy

Configures maintenance mode policy for clusters not managed by vSphere Lifecycle Manasger.
See EsxAgentManagerMaintenanceModePolicy

Required Privileges

None

Since

vEAM API 7.4

Parameters

Name	Type	Description
_this	vmodl.ManagedObjectReference	A reference to the EsxAgentManager used to make the method call.
policy P	xsd:string	The policy to use. See EsxAgentManagerMaintenanceModePolicy Since vEAM API 7.4

P Required privilege: policy

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="SetMaintenanceModePolicy" type="eam:SetMaintenanceModePolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:eam="urn:eam" xmlns:vim25="urn:vim25" xmlns:reflect="urn:reflect" name="SetMaintenanceModePolicyResponse"> <complexType/> </element>

Top of page		Local Properties	Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods