|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
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:
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.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 | ||
Methods
| Methods defined in this Managed Object |
|---|
| CreateAgency, GetMaintenanceModePolicy, QueryAgency, ScanForUnknownAgentVm, SetMaintenanceModePolicy |
| Methods inherited from EamObject |
| QueryIssue, Resolve, ResolveAll |
InvalidArgument if the
agencyName is not set in the agencyConfigInfo.
Requires modify privileges.
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 |
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 | |
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 | |
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.
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 | |
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 | |
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 |
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 | |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |