| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
A vSphere API client application begins by connecting to a server and obtaining a reference to the ServiceInstance. The client can then use the RetrieveServiceContent method to gain access to the various vSphere manager entities and to the root folder of the inventory.
When you create managed objects, the server adds them to the inventory. The inventory of managed objects includes instances the following object types:
The following figure shows the organization of managed objects in the vCenter hierarchy:
Every Datacenter has the following set of dedicated folders. These folders are empty until you create entities for the Datacenter.
The host agent hierarchy has the same general form as the vCenter hierarchy, but most of the objects are limited to one instance:
Properties
Name | Type | Description |
---|---|---|
capability P | Capability |
API-wide capabilities.
|
content P | ServiceContent |
The properties of the ServiceInstance managed object. The content property
is identical to the return value from the
RetrieveServiceContent method.
Use the content property with the PropertyCollector
to perform inventory traversal that includes the ServiceInstance.
(In the absence of a content property, a traversal that encounters
the ServiceInstance would require calling
the RetrieveServiceContent method,
and then invoking a second traversal to continue.)
|
serverClock P | xsd:dateTime |
Contains the time most recently obtained from the server.
The time is not necessarily current. This property is intended for use
with the PropertyCollector WaitForUpdates
method. The PropertyCollector will provide notification if some event occurs
that changes the server clock time in a non-linear fashion.
You should not rely on the serverClock property to get the current time
on the server; instead, use the CurrentTime method.
|
Methods
Methods defined in this Managed Object |
---|
CurrentTime, QueryVMotionCompatibility, RetrieveProductComponents, RetrieveServiceContent, ValidateMigration |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ServiceInstance used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:dateTime | The date and time on the server. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ServiceInstance used to make the method call. |
vm | ManagedObjectReference
to a VirtualMachine |
The virtual machine that is the designated VMotion candidate.
|
host | ManagedObjectReference[]
to a HostSystem[] |
The group of hosts to analyze for compatibility.
|
compatibility* | xsd:string[] |
The set of compatibility types to investigate.
Each is a string chosen from VMotionCompatibilityType. If this
argument is not set, then all compatibility types are
investigated.
|
Return Value
Type | Description |
---|---|
HostVMotionCompatibility[] | An array where each element, associated with one of the input hosts, specifies which of the requested compatibility types applies to that host. If an input host has never been connected and therefore has no information available for determining its compatibility, it is omitted from the return list. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ServiceInstance used to make the method call. |
Return Value
Type | Description |
---|---|
ProductComponentInfo[] |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ServiceInstance used to make the method call. |
Return Value
Type | Description |
---|---|
ServiceContent | The properties belonging to the service instance, including various object managers. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ServiceInstance used to make the method call. |
vm | ManagedObjectReference[]
to a VirtualMachine[] |
The set of virtual machines intended for migration.
|
state* | VirtualMachinePowerState |
The power state that the virtual machines must have. If
this argument is not set, each virtual machine is evaluated
according to its current power state.
|
testType* | xsd:string[] |
The set of tests to run. If this argument is not set, all
tests will be run.
|
pool* | ManagedObjectReference
to a ResourcePool |
The target resource pool for the virtual machines. If the
pool parameter is left unset, the target pool for each particular
virtual machine's migration will be that virtual machine's current
pool. If the virtual machine is a template then either this
parameter or the host parameter must be set; additionally if
resource tests are requested then this parameter is required.
|
host* | ManagedObjectReference
to a HostSystem |
The target host on which the virtual machines will run. The host
parameter may be left unset if the compute resource associated with
the target pool represents a stand-alone host or a DRS-enabled
cluster. In the former case the stand-alone host is used as the
target host. In the latter case, each connected host in the cluster
that is not in maintenance mode is tested as a target host.
If the virtual machine is a template then either this
parameter or the pool parameter must be set.
|
Return Value
Type | Description |
---|---|
Event[] | A set of events that describe the warnings or errors that would apply if the proposed set of migrations were executed. |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the target host(s) and target pool for a migration are not associated with the same compute resource, or if the host parameter is left unset when the target pool is associated with a non-DRS cluster. |
InvalidPowerState | Thrown if the state argument is set and at least one of the specified virtual machines is not in that power state. |
InvalidState | |
NoActiveHostInCluster | Thrown if a target host is not specified and a cluster associated with a target pool does not contain at least one potential target host. A host must be connected and not in maintenance mode in order to be considered as a potential target host. |
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 |