| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Most Virtual Infrastructure managed object types extend this type.
Properties
Name | Type | Description |
---|---|---|
alarmActionsEnabled* P | xsd:boolean |
Whether alarm actions are enabled for this entity.
True if enabled; false otherwise.
Since vSphere API 4.0 |
configIssue* | Event[] |
Current configuration issues that have been detected for this entity. Typically,
these issues have already been logged as events. The entity stores these
events as long as they are still current. The
ConfigStatus property provides an overall status
based on these events.
|
configStatus | ManagedEntityStatus |
The configStatus indicates whether or not the system has detected a configuration
issue involving this entity. For example, it might have detected a
duplicate IP address or MAC address, or a host in a cluster
might be out of compliance. The meanings of the configStatus values are:
The ConfigIssue property contains a list of the
problems that have been detected.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter. Any other version value will not
produce any property values as no updates are generated.
|
customValue* P | CustomFieldValue[] |
Custom field values.
|
declaredAlarmState* P | AlarmState[] |
A set of alarm states for alarms that apply to this managed entity.
The set includes alarms defined on this entity
and alarms inherited from the parent entity,
or from any ancestors in the inventory hierarchy.
Alarms are inherited if they can be triggered by this entity or its descendants.
This set does not include alarms that are defined on descendants of this entity.
|
disabledMethod* | xsd:string[] |
List of operations that are disabled, given the current runtime
state of the entity. For example, a power-on operation always fails if a
virtual machine is already powered on. This list can be used by clients to
enable or disable operations in a graphical user interface.
Note: This list is determined by the current runtime state of an entity, not by its permissions. This list may include the following operations for a HostSystem:
This list may include the following operations for a VirtualMachine:
This list may include the following operations for a ResourcePool: This list may include the following operations for a VirtualApp:
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter. Any other version value will not
produce any property values as no updates are generated.
|
effectiveRole* P | xsd:int[] |
Access rights the current session has to this entity.
|
name P | xsd:string |
Name of this entity, unique relative to its parent.
Any / (slash), \ (backslash), character used in this
name element will be escaped. Similarly, any % (percent) character used in
this name element will be escaped, unless it is used to start an escape
sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or
%5c, and a percent is escaped as %25.
|
overallStatus | ManagedEntityStatus |
General health of this managed entity.
The overall status of the managed entity is computed as the worst status
among its alarms and the configuration issues detected on the entity.
The status is reported as one of the following values:
|
parent* P | ManagedObjectReference
to a ManagedEntity |
Parent of this entity.
This value is null for the root object and for
VirtualMachine objects that are part of
a VirtualApp.
|
permission* | Permission[] |
List of permissions defined for this entity.
|
recentTask* | ManagedObjectReference[]
to a Task[] |
The set of recent tasks operating on this managed entity. This is a subset
of RecentTask belong to this entity. A task in this
list could be in one of the four states: pending, running, success or error.
This property can be used to deduce intermediate power states for a virtual machine entity. For example, if the current powerState is "poweredOn" and there is a running task performing the "suspend" operation, then the virtual machine's intermediate state might be described as "suspending."
Most tasks (such as power operations) obtain exclusive access to the virtual
machine, so it is unusual for this list to contain more than one running task.
One exception, however, is the task of cloning a virtual machine.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter. Any other version value will not
produce any property values as no updates are generated.
|
tag* P | Tag[] |
The set of tags associated with this managed entity.
Experimental. Subject to change.
Since vSphere API 4.0 |
triggeredAlarmState* P | AlarmState[] |
A set of alarm states for alarms triggered by this entity
or by its descendants.
Triggered alarms are propagated up the inventory hierarchy
so that a user can readily tell when a descendant has triggered an alarm.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter. Any other version value will not
produce any property values as no updates are generated.
|
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
Destroy_Task, Reload, Rename_Task |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
NOTE: The appropriate privilege must be held on the parent of the destroyed entity as well as the entity itself.
This method can throw one of several exceptions. The exact set of exceptions depends on the kind of entity that is being removed. See comments for each entity for more information on destroy behavior.Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ManagedEntity used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VimFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ManagedEntity used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
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 |
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
See Name
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ManagedEntity used to make the method call. |
newName P | xsd:string |
See Name Since 2.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
DuplicateName | Thrown if another object in the same folder has the target name. See Name |
InvalidName | Thrown if the new name is not a valid entity name. See Name |
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 |