| 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 |
---|---|---|
answerFileValidationResult* | AnswerFileStatusResult |
Host answer file validation result.
Since vSphere API 6.7 |
answerFileValidationState* | AnswerFileStatusResult |
Host answer file validation state.
Since vSphere API 6.7 |
capability* | HostCapability |
Host capabilities. This might not be available for a
disconnected host.
|
complianceCheckResult* | ComplianceResult |
The host profile compliance check result.
Since vSphere API 6.7 |
complianceCheckState* | HostSystemComplianceCheckState |
The host profile compliance check state.
Since vSphere API 6.7 |
config* | HostConfigInfo |
Host configuration information. This might not be available for a disconnected
host.
|
configManager | HostConfigManager |
Host configuration systems.
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.
|
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.
|
licensableResource | HostLicensableResourceInfo |
Information about all licensable resources, currently present on this host.
This information is used mostly by the modules, manipulating information in the LicenseManager. Developers of such modules should use this property instead of Hardware. NOTE: The values in this property may not be accurate for pre-5.0 hosts when returned by vCenter 5.0 Since vSphere API 5.0 |
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.
|
precheckRemediationResult* | ApplyHostProfileConfigurationSpec |
The host profile precheck-remediation result.
Since vSphere API 6.7 |
remediationResult* | ApplyHostProfileConfigurationResult |
The host profile remediation result.
Since vSphere API 6.7 |
remediationState* | HostSystemRemediationState |
The host profile remediation state.
Since vSphere API 6.7 |
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
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
keyId* P | CryptoKeyId |
The key to be used for coredump encryption. If unset, uses
existing host or cluster key or new key is generated from
the default KMIP server.
Since vSphere API 6.5 |
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 |
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 |
---|---|
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 HostSystem used to make the method call. |
keyPlain P | CryptoKeyPlain |
The key to be used for coredump encryption
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the host is in vim.HostSystem.CryptoState#incapable state |
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 |
Access via a VI client connected to the host is blocked. Access though other services running on the host is also blocked.
If the operation is successful, adminDisabled
will be set to true. This API is not supported on the host, If invoked
directly on a host, a NotSupported fault will be thrown.
See AuthorizationManager
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
AdminDisabled | Thrown if the host's Administrator permission has been disabled. See AuthorizationManager |
DisableAdminNotSupported | Thrown if invoked directly on the host or the host doesn't support this operation. See AuthorizationManager |
HostConfigFault | See AuthorizationManager |
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 |
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, vCenter Server will automatically evacuate powered-off virtual machines.
If this API is called directly on the ESXi host, then the user is responsible for powering off, suspending or evacuating all powered-on virtual machines. The task is cancellable.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
timeout P | 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.
Since 2.0 |
evacuatePoweredOffVms* P | 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 2.0 |
maintenanceSpec* P | HostMaintenanceSpec |
Any additional actions to be taken by the host upon
entering maintenance mode. If omitted, default actions will
be taken as documented in the HostMaintenanceSpec.
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 |
---|---|
InvalidState | Thrown if the host is already 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 | Thrown if the operation timed out. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
AdminNotDisabled | Thrown if the host's Administrator permission is not disabled. See AuthorizationManager |
DisableAdminNotSupported | Thrown if invoked directly on the host or the host doesn't support this operation. See AuthorizationManager |
HostConfigFault | See AuthorizationManager |
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 |
The task is cancellable.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
timeout P | 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.
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 |
---|---|
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 |
Events
Type | |
---|---|
None |
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, vCenter Server 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 P | 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.
Since VI API 2.5 |
evacuatePoweredOffVms* P | 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.
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 |
---|---|
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 |
Events
Type | |
---|---|
None |
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 P | 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.
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 |
---|---|
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. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the host is not in vim.HostSystem.CryptoState#incapable state |
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 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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
memorySize P | 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.
Since 2.0 |
videoRamSize* P | 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.
Since 2.0 |
numVcpus P | xsd:int |
The number of virtual CPUs. For an existing virtual machine, this
value can be found as the numCPU property of the
VirtualHardware.
Since 2.0 |
Return Value
Type | Description |
---|---|
xsd:long | The amount of overhead memory required to power on such a virtual machine, in bytes. |
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 HostSystem used to make the method call. |
vmConfigInfo P | VirtualMachineConfigInfo |
The configuration of the virtual machine.
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
xsd:long | The amount of overhead memory required to power on such a virtual machine, in bytes. |
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 HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:string | The absolute path currently set for the VMware Tools repository on the host. |
Faults
Type | Description |
---|---|
HostConfigFault | Thrown if the configuration could not be read. |
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 HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
HostTpmAttestationReport |
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 |
This command is not supported on all hosts. Check the host capability rebootSupported.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
force P | 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.
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 |
---|---|
InvalidState | Thrown if "force" is false and 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. |
Events
Type | |
---|---|
None |
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. |
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 |
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.
Any changes made to the resource hierarchy on the host when the host was disconnected are overriden by VirtualCenter settings on reconnect.
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* P | 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.
Since 2.0 |
reconnectSpec* P | HostSystemReconnectSpec |
Includes connection parameters specific to
reconnect. This will mainly be used to indicate how to
handle divergence between the host settings and vCenter Server
settings when the host was disconnected.
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 |
---|---|
AlreadyBeingManaged | Thrown if host is already being managed by another VirtualCenter server |
GatewayConnectFault | Thrown if the host is managed via host gateway and any error occurred during the communication with the gateway |
GatewayHostNotReachable | Thrown if the host is managed via host gateway and the gateway server cannot connect to the host |
GatewayNotFound | Thrown if the host is managed via host gateway and no available gateway server is found for the given parameters |
GatewayNotReachable | Thrown if the host is managed via host gateway and vCenter Server cannot establish a network connection to the gateway server, or verify the gateway server's identity |
GatewayOperationRefused | Thrown if the gateway server cannot accept more host connections |
GatewayToHostAuthFault | Thrown if the host is managed via host gateway and the gateway server needs additional information to authenticate before the host |
GatewayToHostTrustVerifyFault | Thrown if the host is managed via host gateway and the gateway server cannot verify that the host is trusted |
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. |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:long |
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 HostSystem used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:long |
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 |
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 P | 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.
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 |
---|---|
InvalidState | Thrown if "force" is false and 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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
flagInfo P | HostFlagInfo |
Since VI API 2.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
ipmiInfo P | HostIpmiInfo |
Since vSphere API 4.0 |
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. |
Events
Type | |
---|---|
None |
This task is not cancellable and cannot be reverted once started.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
path P | xsd:string |
The absolute path for the VMware Tools repository
on the host. It should have "/vmfs/volumes/" prefix and
it should be a valid existing path, or it could be
empty to restore to default value.
Since vSphere API 6.7.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. The result property in the Task contains the stable vmfs path of the VMware Tools repository upon success. A stable vmfs path is of the form: /vmfs/volumes/[datastore-uuid]/[path/inside/datastore] or empty to indicate restoring to default value. |
Faults
Type | Description |
---|---|
FileNotFound | Thrown if the path does not exist. |
HostConfigFault | Thrown if the configuration could not be written. |
InvalidArgument | Thrown if the path does not have "/vmfs/volumes/" prefix and is not empty. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if there is another task configuring the VMware Tools repository on the host. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
resourceInfo P | HostSystemResourceInfo |
Since 2.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
sysSwapConfig P | HostSystemSwapConfiguration |
Contains a list of system swap options that
configure the system swap functionality. See HostSystemSwapConfiguration Since vSphere API 5.1 |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |