|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Invoking destroy on a HostSystem of standalone type throws a NotSupported fault. A standalone HostSystem can be destroyed only by invoking destroy on its parent ComputeResource. Invoking destroy on a failover host throws a DisallowedOperationOnFailoverHost fault. See ClusterFailoverHostAdmissionControlPolicy.
Properties
| Name | Type | Description |
|---|---|---|
| capability* | HostCapability |
Host capabilities. This might not be available for a
disconnected host.
|
| config* | HostConfigInfo |
Host configuration information. This might not be available for a disconnected
host.
|
| configManager | HostConfigManager |
Host configuration systems.
|
| datastore* P | ManagedObjectReference[]
to a Datastore[] |
A collection of references to the subset of datastore objects in the datacenter
that are available in this HostSystem.
|
| datastoreBrowser P | ManagedObjectReference
to a HostDatastoreBrowser |
DatastoreBrowser to browse datastores for this host.
|
| hardware* | HostHardwareInfo |
Hardware configuration of the host. This might not be available for a
disconnected host.
|
| network* P | ManagedObjectReference[]
to a Network[] |
A collection of references to the subset of network objects in the datacenter that
are available in this HostSystem.
|
| runtime | HostRuntimeInfo |
Runtime state information about the host such as connection state.
|
| summary | HostListSummary |
Basic information about the host, including connection state.
|
| systemResources* | HostSystemResourceInfo |
Reference for the system resource hierarchy, used for configuring the set of
resources reserved to the system and unavailable to virtual machines.
|
| vm* | ManagedObjectReference[]
to a VirtualMachine[] |
List of virtual machines associated with this host.
|
| 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 |
|---|
| AcquireCimServicesTicket, DisconnectHost_Task, EnterMaintenanceMode_Task, ExitMaintenanceMode_Task, PowerDownHostToStandBy_Task, PowerUpHostFromStandBy_Task, QueryHostConnectionInfo, QueryMemoryOverhead, QueryMemoryOverheadEx, RebootHost_Task, ReconfigureHostForDAS_Task, ReconnectHost_Task, ShutdownHost_Task, UpdateFlags, UpdateIpmi, UpdateSystemResources |
| Methods inherited from ManagedEntity |
| Destroy_Task, Reload, Rename_Task |
| Methods inherited from ExtensibleManagedObject |
| setCustomValue |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| HostServiceTicket |
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. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem 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 |
|---|---|
| NotSupported | Thrown if run directly on an ESX Server host. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
The task completes once there are no powered-on virtual machines on the host and no provisioning operations in progress on the host. The operation does not directly initiate any operations to evacuate or power-down powered-on virtual machines. However, if the host is part of a cluster with VMware DRS enabled, DRS provides migration recommendations to evacuate the powered-on virtual machines. If DRS is in fully-automatic mode, these are automatically scheduled.
If the host is part of a cluster and the task is issued through VirtualCenter with evacuatePoweredOffVms set to true, the task will not succeed unless all the powered-off virtual machines are reregistered to other hosts. If VMware DRS is enabled, VC will automatically evacuate powered-off virtual machines. The task is cancellable.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| timeout | xsd:int |
The task completes when the host successfully enters maintenance
mode or the timeout expires, and in the latter case the task
contains a Timeout fault. If the timeout is less than or equal to
zero, there is no timeout. The timeout is specified in seconds.
|
| evacuatePoweredOffVms* | xsd:boolean |
This is a parameter only supported by VirtualCenter.
If set to true, for a DRS disabled cluster, the task will not
succeed unless all powered-off virtual machines have been manually
reregistered; for a DRS enabled cluster, VirtualCenter will
automatically reregister powered-off virtual machines and a
powered-off virtual machine may remain at the host only for two
reasons: (a) no compatible host found for reregistration, (b) DRS
is disabled for the virtual machine. If set to false, powered-off
virtual machines do not need to be moved.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the host is already in maintenance mode. |
| RequestCanceled | Thrown if the operation is canceled. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout | Thrown if the operation timed out. |
The task is cancellable.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| timeout | xsd:int |
Number of seconds to wait for the exit maintenance mode to
succeed. If the timeout is less than or equal to zero, there
is no timeout.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the host is not in maintenance mode. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout |
The task completes only if there are no powered-on virtual machines on the host, no provisioning operations in progress on the host, and the host stopped responding. The operation does not directly initiate any operations to evacuate or power-down powered-on virtual machines. However, if a dynamic recommendation generation module is running, if possible, it will provide, and depending on the automation level, it will execute migrations of powered-on virtual machine. Furthermore, VMware power management module may evacute and put a host in standby mode to save power. If the host is part of a cluster and the task is issued through VirtualCenter with evacuatePoweredOffVms set to true, the task will not succeed unless all the powered-off virtual machines are reregistered to other hosts. If VMware DRS is enabled, VC will automatically evacuate powered-off virtual machines.
The task is cancellable.
This command is not supported on all hosts. Check the host capability standbySupported.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| timeoutSec | xsd:int |
The task completes when the host successfully
enters standby mode and stops sending heartbeat signals.
If heartbeats are still coming after timeoutSecs seconds,
the host is declared timedout, and the task is assumed
failed.
|
| evacuatePoweredOffVms* | xsd:boolean |
This is a parameter used only by VirtualCenter. If
set to true, for a DRS disabled cluster, the task will not
succeed unless all powered-off virtual machines have been manually
reregistered; for a DRS enabled cluster, VirtualCenter will
automatically reregister powered-off virtual machines and a
powered-off virtual machine may remain at the host only for two
reasons: (a) no compatible host found for reregistration, (b) DRS
is disabled for the virtual machine.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| HostPowerOpFailed | Thrown if the standby operation fails. |
| InvalidState | Thrown if the host is already in standby mode, or disconnected. |
| NotSupported | Thrown if the host does not support standby mode. |
| RequestCanceled | Thrown if the operation is canceled. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout |
Note that, depending on the implementation of the wakeup method, the client may never receive an indicator of success in the returned task. In some cases, it is not even possible to ensure that the wakeup request has made it to the host.
The task is cancellable.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| timeoutSec | xsd:int |
The task completes when the host successfully
exits standby state and sends a heartbeat signal. If nothing is
received from the host for timeoutSec seconds, the host is
declared timedout, and the task is assumed failed.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| HostPowerOpFailed | Thrown if the standby operation fails. |
| InvalidState | Thrown if the host is in a state from which it cannot be woken up (e.g., disconnected, poweredOff) |
| NotSupported | Thrown if the host does not support standby mode. |
| RequestCanceled | Thrown if the operation is canceled. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| HostConnectInfo |
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. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| memorySize | xsd:long |
The amount of virtual system RAM, in bytes. For an existing
virtual machine, this value can be found (in megabytes) as the memoryMB
property of the VirtualHardware.
|
| videoRamSize* | xsd:int |
The amount of virtual video RAM, in bytes. For an existing
virtual machine on a host that supports advertising this property, this
value can be found (in kilobytes) as the videoRamSizeInKB property of the
VirtualMachineVideoCard. If this parameter is left unset, the
default video RAM size for virtual machines on this host is assumed.
|
| numVcpus | xsd:int |
The number of virtual CPUs. For an existing virtual machine, this
value can be found as the numCPU property of the
VirtualHardware.
|
Return Value
| Type | Description |
|---|---|
| xsd:long | The amount of overhead memory required to power on such a virtual machine, in bytes. |
Faults
| Type | Description |
|---|---|
| NotSupported | Thrown if the host does not have memory resource allocation features. |
| 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 HostSystem used to make the method call. |
| vmConfigInfo | VirtualMachineConfigInfo |
The configuration of the virtual machine.
|
Return Value
| Type | Description |
|---|---|
| xsd:long | The amount of overhead memory required to power on such a virtual machine, in bytes. |
Faults
| Type | Description |
|---|---|
| NotSupported | Thrown if the host does not have memory resource allocation features. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
This command is not supported on all hosts. Check the host capability vim.host.Capability.rebootSupported.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| force | xsd:boolean |
Flag to specify whether or not the host should be rebooted
regardless of whether it is in maintenance mode. If true, the host
is rebooted, even if there are virtual machines running or other
operations in progress.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if "force" is false and the host is not in maintenance mode. |
| NotSupported | Thrown if the host does not support the reboot operation. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
If the host is part of a HA cluster, this operation reconfigures the host for HA. For example, this operation may be used if a host is added to a HA enabled cluster and the automatic HA configuration system task fails. Automatic HA configuration may fail for a variety of reasons. For example, the host is configured incorrectly.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem 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 |
|---|---|
| DasConfigFault | Thrown if there is a problem reconfiguring the host for HA. |
| NotSupported | Thrown if run directly on an ESX Server host. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
The client can change the IP address and port of the host when doing a reconnect operation. This can be useful if the client wants to preserve existing metadata, even though the host is changing its IP address. For example, clients could preserve existing statistics, alarms, and privileges.
This method can also be used to change the SSL thumbprint of a connected host without disconnecting it.
This method is only supported through VirtualCenter.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| cnxSpec* | HostConnectSpec |
Includes the parameters to use, including user name and password,
when reconnecting to the host. If this parameter is not specified,
the default connection parameters is used.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| AlreadyBeingManaged | Thrown if host is already being managed by another VirtualCenter server |
| HostConnectFault | Thrown if an error occurred when attempting to reconnect to a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown. |
| InvalidLogin | Thrown if the method fails to authenticate with the host. |
| InvalidName | Thrown if the host name is invalid. |
| InvalidState | Thrown if the host is not disconnected. |
| NoHost | Thrown if the method is unable to contact the server. |
| NotEnoughLicenses | Thrown if there are not enough licenses to add this host. |
| NotSupported | Thrown if no host can be added to this group. This is the case if the ComputeResource is a standalone type. |
| NotSupportedHost | Thrown if the host is running a software version that 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. |
| SSLVerifyFault | Thrown if the host certificate could not be authenticated |
This command is not supported on all hosts. Check the host capability shutdownSupported.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| force | xsd:boolean |
Flag to specify whether or not the host should be shut down
regardless of whether it is in maintenance mode.
If true, the host is shut down, even if there are
virtual machines running or other operations in progress.
|
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if "force" is false and the host is not in maintenance mode. |
| NotSupported | Thrown if the host does not support shutdown. |
| 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 HostSystem used to make the method call. |
| flagInfo | HostFlagInfo |
|
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. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
| ipmiInfo | HostIpmiInfo |
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidIpmiLoginInfo | Thrown if the supplied user ID and/or password is invalid. |
| InvalidIpmiMacAddress | Thrown if the supplied MAC address is invalid. |
| 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 HostSystem used to make the method call. |
| resourceInfo | HostSystemResourceInfo |
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown if the resource specification is invalid. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |