| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
*May not be presentP Required privilege: System.ViewMethods
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 |
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 ConverterTask |
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 |
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
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 |
---|---|
None |
Faults
Type | Description |
---|---|
HostConfigFault | |
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. |
timeout P | xsd:int |
Since null |
evacuatePoweredOffVms* P | xsd:boolean |
Since null |
maintenanceSpec* P | HostMaintenanceSpec |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
InvalidState | |
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 |
---|---|
HostConfigFault | |
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. |
timeout P | xsd:int |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
InvalidState | |
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. |
timeoutSec P | xsd:int |
Since VI API 2.5 |
evacuatePoweredOffVms* P | xsd:boolean |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
HostPowerOpFailed | |
InvalidState | |
NotSupported | |
RequestCanceled | |
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. |
timeoutSec P | xsd:int |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
HostPowerOpFailed | |
InvalidState | |
NotSupported | |
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 | |
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 |
Since null |
videoRamSize* P | xsd:int |
Since null |
numVcpus P | xsd:int |
Since null |
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. |
vmConfigInfo P | VirtualMachineConfigInfo |
Since VI API 2.5 |
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:string |
Faults
Type | Description |
---|---|
HostConfigFault | |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
force P | xsd:boolean |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
InvalidState | |
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 ConverterTask |
Faults
Type | Description |
---|---|
DasConfigFault | |
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. |
cnxSpec* P | HostConnectSpec |
Since null |
reconnectSpec* P | HostSystemReconnectSpec |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
HostConnectFault | |
InvalidLogin | |
InvalidName | |
InvalidState | |
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 |
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. |
force P | xsd:boolean |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
InvalidState | |
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 | |
InvalidIpmiMacAddress | |
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. |
path P | xsd:string |
Since vSphere API 6.7.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
FileNotFound | |
HostConfigFault | |
InvalidArgument | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostSystem used to make the method call. |
resourceInfo P | HostSystemResourceInfo |
Since null |
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 |
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 |