Managed Object - HostSystem

Property of
ClusterDpmHostConfigInfo, ClusterDrsMigration, ClusterHostRecommendation, ClusterInitialPlacementAction, ComputeResource, CpuIncompatible, DatastoreHostMount, DatastoreNotWritableOnHost, DiagnosticManagerBundleInfo, HostConfigInfo, HostEventArgument, HostListSummary, HostVMotionCompatibility, InsufficientHostCapacityFault, InvalidHostState, MigrationFeatureNotSupported, Network, NotEnoughLogicalCpus, RuleViolation, VirtualHardwareVersionNotSupported, VirtualMachineConfigOptionDescriptor, VirtualMachineRelocateSpec, VirtualMachineRuntimeInfo, VMotionInterfaceIssue, VmWwnConflict
Parameter to
BrowseDiagnosticLog, CheckLicenseFeature, ConfigureLicenseSource, CreateVM_Task, DisableFeature, EnableFeature, GenerateLogBundles_Task, MarkAsVirtualMachine, MigrateVM_Task, MoveHostInto_Task, MoveInto_Task, PowerOnVM_Task, QueryConfigOption, QueryConfigTarget, QueryDescriptions, QueryLicenseSourceAvailability, QueryLicenseUsage, QuerySupportedFeatures, QueryVMotionCompatibility, RegisterVM_Task, RevertToCurrentSnapshot_Task, RevertToSnapshot_Task, SetLicenseEdition, ValidateMigration
Returned by
AddHost_Task
Extends
ManagedEntity
See also
Datastore, HostCapability, HostConfigInfo, HostConfigManager, HostConnectInfo, HostConnectSpec, HostDatastoreBrowser, HostFlagInfo, HostHardwareInfo, HostListSummary, HostRuntimeInfo, HostServiceTicket, HostSystemResourceInfo, Network, VirtualMachine, VirtualMachineConfigInfo


Managed Object Description

The HostSystem managed object type provides access to a virtualization host platform.

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.

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.
configManagerHostConfigManager

Host configuration systems.
datastore*ManagedObjectReference[]
to a Datastore[]

A collection of references to the subset of datastore objects in the datacenter that are available in this HostSystem.
datastoreBrowserManagedObjectReference
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*ManagedObjectReference[]
to a Network[]

A collection of references to the subset of network objects in the datacenter that are available in this HostSystem.
runtimeHostRuntimeInfo

Runtime state information about the host such as connection state.
summaryHostListSummary

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
configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

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, UpdateSystemResources
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AcquireCimServicesTicket

Creates and returns a one-time credential used to establish a remote connection to a CIM interface. The port to connect to is the standard well known port for the service.
Required Privileges
Host.Cim.CimInteraction
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.

Return Value

Type Description
HostServiceTicket

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



DisconnectHost_Task

Disconnects from a host and instructs the server to stop sending heartbeats.
Required Privileges
Host.Config.Connection

Parameters

NameTypeDescription
_thisManagedObjectReference 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
NotSupportedThrown if run directly on an ESX Server host.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



EnterMaintenanceMode_Task

Puts the host in maintenance mode. While this task is running and when the host is in maintenance mode, no virtual machines can be powered on and no provisioning operations can be performed on the host. Once the call completes, it is safe to turn off a host without disrupting any virtual machines.

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.

Required Privileges
Host.Config.Maintenance

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
timeoutxsd: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.
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
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
InvalidStateThrown if the host is already in maintenance mode.
RequestCanceledThrown if the operation is canceled.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TimedoutThrown if the operation timed out.

Show WSDL type definition



ExitMaintenanceMode_Task

Takes the host out of maintenance mode. This blocks if any concurrent running maintenance-only host configurations operations are being performed. For example, if VMFS volumes are being upgraded.

The task is cancellable.

Required Privileges
Host.Config.Maintenance

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
timeoutxsd: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
InvalidStateThrown if the host is not in maintenance mode.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout

Show WSDL type definition



PowerDownHostToStandBy_Task

Puts the host in standby mode, a mode in which the host is in a standby state from which it can be powered up remotely. While this task is running, no virtual machines can be powered on and no provisioning operations can be performed on the host.

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.

Required Privileges
Host.Config.Maintenance
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
timeoutSecxsd:int

The task completes when the host successfully enters stanby mode and stops sending heartbeats signal. 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.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
HostPowerOpFailedThrown if the standby operation fails.
InvalidStateThrown if the host is already in standby mode, or disconnected.
NotSupportedThrown if the host does not support standby mode.
RequestCanceledThrown if the operation is canceled.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout

Show WSDL type definition



PowerUpHostFromStandBy_Task

Takes the host out of standby mode. If the command is successful, the host wakes up and starts sending heartbeats. This method may be called automatically by a dynamic recommendation generation module to add capacity to a cluster, if the host is not in maintenance mode.

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.

Required Privileges
Host.Config.Maintenance
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
timeoutSecxsd:int

The task completes when the host successfully exits stanby 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
HostPowerOpFailedThrown if the standby operation fails.
InvalidStateThrown if the host is in a state from which it can not be woken up (e.g., disconnected, poweredOff)
NotSupportedThrown if the host does not support standby mode.
RequestCanceledThrown if the operation is canceled.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout

Show WSDL type definition



QueryHostConnectionInfo

Connection-oriented information about a host.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.

Return Value

Type Description
HostConnectInfo

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryMemoryOverhead

Deprecated. As of VI API 2.5, use QueryMemoryOverheadEx.

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
memorySizexsd: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.
numVcpusxsd:int

The number of virtual CPUs. For an existing virtual machine, this value can be found as the numCPU property of the VirtualHardware.
*Need not be set

Return Value

Type Description
xsd:longThe amount of overhead memory required to power on such a virtual machine, in bytes.

Faults

Type Description
NotSupportedThrown if the host does not have memory resource allocation features.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryMemoryOverheadEx

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.
Required Privileges
System.Read
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
vmConfigInfoVirtualMachineConfigInfo

The configuration of the virtual machine.

Return Value

Type Description
xsd:longThe amount of overhead memory required to power on such a virtual machine, in bytes.

Faults

Type Description
NotSupportedThrown if the host does not have memory resource allocation features.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RebootHost_Task

Reboots a host. If the command is successful, then the host has been rebooted. If connected directly to the host, the client never receives an indicator of success in the returned task but simply loses connection to the host, upon success.

This command is not supported on all hosts. Check the host capability vim.host.Capability.rebootSupported.

Required Privileges
Host.Config.Maintenance

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
forcexsd: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
InvalidStateThrown if "force" is false and the host is not in maintenance mode.
NotSupportedThrown if the host does not support the reboot operation.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



ReconfigureHostForDAS_Task

Reconfigures the host for VMware HA.

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.

Required Privileges
Host.Config.Connection

Parameters

NameTypeDescription
_thisManagedObjectReference 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
DasConfigFaultThrown if there is a problem reconfiguring the host for HA.
NotSupportedThrown if run directly on an ESX Server host.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



ReconnectHost_Task

Reconnects to a host. This process reinstalls agents and reconfigures the host, if it has gotten out of date with VirtualCenter. The reconnection process goes through many of the same steps as addHost: ensuring the correct set of licenses for the number of CPUs on the host, ensuring the correct set of agents is installed, and ensuring that networks and datastores are discovered and registered with VirtualCenter.

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 is only supported through VirtualCenter.

Required Privileges
Host.Config.Connection

Parameters

NameTypeDescription
_thisManagedObjectReference 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.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
AlreadyBeingManagedThrown if host is already being managed by another VirtualCenter server
HostConnectFaultThrown if an error occurred when attempting to reconnect to a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown.
InvalidLoginThrown if the method fails to authenticate with the host.
InvalidNameThrown if the host name is invalid.
InvalidStateThrown if the host is not disconnected.
NoHostThrown if the method is unable to contact the server.
NotEnoughLicensesThrown if there are not enough licenses to add this host.
NotSupportedThrown if no host can be added to this group. This is the case if the ComputeResource is a standalone type.
NotSupportedHostThrown if the host is running a software version that is not supported.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SSLVerifyFaultThrown if the host certificate could not be authenticated

Show WSDL type definition



ShutdownHost_Task

Shuts down a host. If the command is successful, then the host has been shut down. Thus, the client never receives an indicator of success in the returned task if connected directly to the host.

This command is not supported on all hosts. Check the host capability shutdownSupported.

Required Privileges
Host.Config.Maintenance

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
forcexsd: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
InvalidStateThrown if "force" is false and the host is not in maintenance mode.
NotSupportedThrown if the host does not support shutdown.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateFlags

Update flags that are part of the HostFlagInfo object.
Required Privileges
Host.Config.Settings
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
flagInfoHostFlagInfo



Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateSystemResources

Update the configruration of the system resource hierarchy.
Required Privileges
Host.Config.Resources

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostSystem used to make the method call.
resourceInfoHostSystemResourceInfo



Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the resource specification is invalid.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition