|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Every Datacenter has the following set of dedicated folders. These folders are empty until you create entities for the Datacenter.
For a visual representation of the organization of objects in a vCenter hierarchy, see the description of the ServiceInstance object.
Properties
| Name | Type | Description |
|---|---|---|
| datastore* | ManagedObjectReference[]
to a Datastore[] |
A collection of references to the datastore objects
available in this datacenter.
|
| datastoreFolder P | ManagedObjectReference
to a Folder |
A reference to the folder hierarchy that contains
the datastores for this datacenter.
This folder is guaranteed to exist. Since vSphere API 4.0 |
| hostFolder P | ManagedObjectReference
to a Folder |
A reference to the folder hierarchy that contains
the compute resources, including hosts and clusters, for this datacenter.
This folder is guaranteed to exist.
|
| network* | ManagedObjectReference[]
to a Network[] |
A collection of references to the network objects
available in this datacenter.
|
| networkFolder P | ManagedObjectReference
to a Folder |
A reference to the folder hierarchy that contains the network entities
for this datacenter. The folder can include Network,
DistributedVirtualSwitch, and
DistributedVirtualPortgroup objects.
This folder is guaranteed to exist. Since vSphere API 4.0 |
| vmFolder P | ManagedObjectReference
to a Folder |
A reference to the folder hierarchy that contains VirtualMachine
virtual machine templates (identified by the template
property, and VirtualApp objects for this datacenter.
Note that a VirtualApp that is a child of a ResourcePool may also be visible in this folder. VirtualApp objects can be nested, but only the parent VirtualApp can be visible in the folder.
This folder is guaranteed to exist.
|
| Properties inherited from ManagedEntity | ||
| alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
| Properties inherited from ExtensibleManagedObject | ||
| availableField, value | ||
Methods
| Methods defined in this Managed Object |
|---|
| PowerOnMultiVM_Task, QueryConnectionInfo |
| Methods inherited from ManagedEntity |
| Destroy_Task, Reload, Rename_Task |
| Methods inherited from ExtensibleManagedObject |
| setCustomValue |
If any virtual machine in the list is manually managed by DRS, or DRS has to migrate any manually managed virtual machine or power on any manually managed host in order to power on these virtual machines, a DRS recommendation will be generated, and the users need to manually apply the recommendation for actually powering on these virtual machines. Otherwise, all the virtual machine will be automatically powered on. The virtual machines on stand alone hosts or DRS disabled will be powered-on on the current host. The DRS automatically managed virtual machines will be powered-on on the recommended hosts.
When powering on a virtual machine in a cluster, the system might do an implicit relocation of the virtual machine to another host.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Datacenter used to make the method call. |
| vm P | ManagedObjectReference[]
to a VirtualMachine[] |
The virtual machines to power on.
|
| option* | OptionValue[] |
An array of OptionValue options
for this power-on session. The names and values of the
options are defined in
ClusterPowerOnVmOption.
Since vSphere API 4.1 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation, and also a ClusterPowerOnVmResult object. |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown for unknown option keys or bad values. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Datacenter used to make the method call. |
| hostname | xsd:string |
The target of the query.
|
| port | xsd:int |
The port number of the target host. For ESX 2.x this is the authd port
(902 by default). For ESX 3.x and above and for VMware Server hosts
this is the https port (443 by default). You can specify -1 to have the
vCenter Server try the default ports.
|
| username | xsd:string |
The name of the user.
|
| password | xsd:string |
The password of the user.
|
| sslThumbprint* | xsd:string |
The expected SSL thumbprint of the host's certificate
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| HostConnectInfo |
Faults
| Type | Description |
|---|---|
| AlreadyConnected | Thrown if the host is already being managed by this server. |
| HostConnectFault | Thrown if an error occurred when querying about a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown. |
| InvalidLogin | Thrown if unable to authenticate with the host. |
| NoHost | Thrown if unable to contact the host. |
| NotSupported | Thrown if called directly on a host. |
| NotSupportedHost | Thrown if the software version on the host is not supported. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| SSLDisabledFault | Thrown if the host has ssl access disabled |
| SSLVerifyFault | Thrown if the host certificate could not be authenticated |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |