Scripting Object - VcHostSystem

Scripting-object corresponding to
HostSystem
Attribute of
VcActiveVMsBlockingEVC, VcAnswerFileStatusResult, VcAnswerFileValidationResultMap, VcApplyHostProfileConfigurationResult, VcApplyHostProfileConfigurationSpec, VcCannotEnableVmcpForCluster, VcCheckResult, VcClusterComputeResource, VcClusterComputeResourceFtCompatibleDatastoresResult, VcClusterComputeResourceFtCompatibleHostResult, VcClusterDasAamNodeState, VcClusterDasFailoverLevelAdvancedRuntimeInfoHostSlots, VcClusterDasFdmHostState, VcClusterDasHostRecommendation, VcClusterDasVmcpPrecheckResult, VcClusterDpmHostConfigInfo, VcClusterDrsMigration, VcClusterEVCManagerCheckResult, VcClusterFailoverHostAdmissionControlInfoHostStatus, VcClusterFailoverHostAdmissionControlPolicy, VcClusterHostGroup, VcClusterHostRecommendation, VcClusterInitialPlacementAction, VcClusterTransitionalEVCManagerCheckResult, VcComputeResource, VcComputeResourceHostSPBMLicenseInfo, VcContext, VcCpuCompatibilityUnknown, VcCpuIncompatible, VcCpuIncompatible1ECX, VcCpuIncompatible81EDX, VcDasHeartbeatDatastoreInfo, VcDatastoreHostMount, VcDatastoreNotWritableOnHost, VcDiagnosticManagerBundleInfo, VcDiagnosticManagerFileHashSpec, VcDisallowedOperationOnFailoverHost, VcDistributedVirtualPort, VcDistributedVirtualPortgroup, VcDistributedVirtualSwitchHostMemberConfigInfo, VcDistributedVirtualSwitchHostMemberConfigSpec, VcDistributedVirtualSwitchManagerCompatibilityResult, VcDistributedVirtualSwitchManagerHostArrayFilter, VcDistributedVirtualSwitchPortCriteria, VcDrsVmotionIncompatibleFault, VcDVSOpaqueCommandResultInfo, VcDVSOpaqueDataConfigInfo, VcDvsOperationBulkFaultFaultOnHost, VcDVSSummary, VcEnvironmentBrowserConfigOptionQuerySpec, VcEVCModeUnsupportedByHosts, VcEVCUnsupportedByHostHardware, VcEVCUnsupportedByHostSoftware, VcFaultToleranceAntiAffinityViolated, VcFaultToleranceCpuIncompatible, VcFeatureRequirementsNotMet, VcFtIssuesOnHost, VcFullStorageVMotionNotSupported, VcHostConfigInfo, VcHostEventArgument, VcHostListSummary, VcHostMemberRuntimeInfo, VcHostMemberSelection, VcHostProfile, VcHostProfileCompleteConfigSpec, VcHostProfileHostBasedConfigSpec, VcHostProfileManagerHostToConfigSpecMap, VcHostProfileSerializedHostProfileSpec, VcHostProtocolEndpoint, VcHostSpecification, VcHostSpecificationOperationFailed, VcHostVmfsRescanResult, VcHostVMotionCompatibility, VcIncompatibleHostForFtSecondary, VcIndependentDiskVMotionNotSupported, VcInsufficientHostCapacityFault, VcInsufficientHostCpuCapacityFault, VcInsufficientHostMemoryCapacityFault, VcInsufficientPerCpuCapacity, VcInvalidHostConnectionState, VcInvalidHostState, VcInvalidProfileReferenceHost, VcIoFilterHostIssue, VcIORMNotSupportedHostOnDatastore, VcMigrationFeatureNotSupported, VcMisfeaturedHostsBlockingEVC, VcNetwork, VcNoCompatibleHost, VcNoCompatibleHostWithAccessToDevice, VcNodeDeploymentSpec, VcNonHomeRDMVMotionNotSupported, VcNotEnoughLogicalCpus, VcNotSupportedDeviceForFT, VcOpaqueNetwork, VcOvfCreateImportSpecParams, VcPassiveNodeDeploymentSpec, VcPlacementAction, VcPlacementSpec, VcProfileReferenceHostChangedEvent, VcQuiesceDatastoreIOForHAFailed, VcRuleViolation, VcStoragePlacementSpec, VcStorageVMotionNotSupported, VcSwapDatastoreNotWritableOnHost, VcThirdPartyLicenseAssignmentFailed, VcUnsharedSwapVMotionNotSupported, VcVAppCloneSpec, VcVirtualHardwareVersionNotSupported, VcVirtualMachineConfigOptionDescriptor, VcVirtualMachineRelocateSpec, VcVirtualMachineRuntimeInfo, VcVmAlreadyExistsInDatacenter, VcVMotionAcrossNetworkNotSupported, VcVMotionInterfaceIssue, VcVMotionLinkCapacityLow, VcVMotionLinkDown, VcVMotionNotConfigured, VcVMotionNotLicensed, VcVMotionNotSupported, VcVmWwnConflict, VcVsanHostConfigInfo, VcVsanUpgradeSystemAPIBrokenIssue, VcVsanUpgradeSystemAutoClaimEnabledOnHostsIssue, VcVsanUpgradeSystemHostsDisconnectedIssue, VcVsanUpgradeSystemMissingHostsInClusterIssue, VcVsanUpgradeSystemNetworkPartitionInfo, VcVsanUpgradeSystemUpgradeHistoryDiskGroupOp, VcVsanUpgradeSystemUpgradeHistoryItem, VcVsanUpgradeSystemUpgradeHistoryPreflightFail, VcVsanUpgradeSystemWrongEsxVersionIssue, VcVVolHostPE
Parameter to
applyHostConfig_Task, browseDiagnosticLog, certMgrRefreshCACertificatesAndCRLs_Task, certMgrRefreshCertificates_Task, certMgrRevokeCertificates_Task, checkAnswerFileStatus_Task, checkCompatibility_Task, checkLicenseFeature, checkMigrate_Task, clusterEnterMaintenanceMode, configureLicenseSource, createChildVM_Task, createChildVM_Task, createSecondaryVM_Task, createSecondaryVMEx_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVvolDatastoreOnHosts_Task, deleteHostSpecification, deleteHostSubSpecification, disableFeature, drsQueryWorkloadCharacterization, enableFeature, enableSecondaryVM_Task, executeHostProfile, exportAnswerFile_Task, generateConfigTaskList, generateHostProfileTaskList_Task, generateLogBundles_Task, importOvf, importVApp, importVApp, lookupVmOverheadMemory, markAsVirtualMachine, migrateVM_Task, moveHostInto_Task, moveInto_Task, nfcFileManagement, nfcGetServerNfcLibVersion, nfcGetVmFiles, nfcPutVmFiles, nfcRandomAccessFile, nfcRandomAccessOpenDisk, nfcRandomAccessOpenReadonly, nfcSystemManagement, performVsanUpgrade_Task, powerOnPaused_Task, powerOnVM_Task, queryAccessToService, queryAnswerFileStatus, queryConfigOption, queryConfigTarget, queryConfigTargetSpec, queryDescriptions, queryDvsConfigTarget, queryIORMConfigOption, queryLicenseSourceAvailability, queryLicenseUsage, queryProvisioningPolicy, querySupportedFeatures, queryTargetCapabilities, queryVMotionCompatibility, queryVMotionCompatibilityEx_Task, rectifyDvsHost_Task, rectifyDvsHost_Task, rectifyDvsOnHost_Task, registerChildVM_Task, registerChildVM_Task, registerVM_Task, registerVM_Task, registerVM_Task, registerVM_Task, registerVM_Task, registerVM_Task, registerVM_Task, removeVVolDatastore_Task, resolveInstallationErrorsOnHost_Task, retrieveAnswerFile, retrieveAnswerFileForProfile, retrieveHostCustomizations, retrieveHostCustomizationsForProfile, retrieveHostSpecification, revertToCurrentSnapshot_Task, revertToSnapshot_Task, setLicenseEdition, updateAnswerFile_Task, updateHostSpecification, updateHostSubSpecification, updateReferenceHost, validateAnswerFile, validateHost, validateMigration, verifyFaultToleranceConfigSpec
Returned by
getAllHostSystems, getAllHostSystems, hostSpecGetUpdatedHosts, queryCompatibleHostForExistingDvs, queryCompatibleHostForNewDvs, queryHostAssociatedWithLun, queryUnmonitoredHosts

Scripting 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. Invoking destroy on a failover host throws a {@link vim.fault.DisallowedOperationOnFailoverHost} fault. See {@link vim.cluster.FailoverHostAdmissionControlPolicy}.

Attributes

Name Type Description
alarmActionsEnabledBoolean

@since vSphere API 4.0
availableFieldVcCustomFieldDef []

@since VI API 2.5
capabilityVcHostCapability

@since VI API 2.5
configVcHostConfigInfo

@since VI API 2.5
configIssueVcEvent []

@since VI API 2.5
configManagerVcHostConfigManager

@since VI API 2.5
configStatusVcManagedEntityStatus

@since VI API 2.5
customValueVcCustomFieldValue []

@since VI API 2.5
datastoreVcDatastore []

@since VI API 2.5
datastoreBrowserVcHostDatastoreBrowser

@since VI API 2.5
declaredAlarmStateVcAlarmState []

@since VI API 2.5
disabledMethodString []

@since VI API 2.5
effectiveRoleNumber []

@since VI API 2.5
hardwareVcHostHardwareInfo

@since VI API 2.5
idString

@since Unknown
licensableResourceVcHostLicensableResourceInfo

@since vSphere API 5.0
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
nameString

@since VI API 2.5
networkVcNetwork []

@since VI API 2.5
network_DistributedVirtualPortgroupObject [] Deprecated.

@since Unknown
network_NetworkObject [] Deprecated.

@since Unknown
overallStatusVcManagedEntityStatus

@since VI API 2.5
parentVcManagedEntity

@since VI API 2.5
permissionVcPermission []

@since VI API 2.5
recentTaskVcTask []

@since VI API 2.5
runtimeVcHostRuntimeInfo

@since VI API 2.5
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
stateString

@since Unknown
summaryVcHostListSummary

@since VI API 2.5
systemResourcesVcHostSystemResourceInfo

@since VI API 2.5
tagVcTag []

@since vSphere API 4.0
triggeredAlarmStateVcAlarmState []

@since VI API 2.5
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
uuidString

Hardware BIOS identification. @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
versionString

@since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown
vmVcVirtualMachine []

@since VI API 2.5

Methods

Methods defined in this Scripting Object
_getRef, acquireCimServicesTicket, addTag, applyEvcMode_Task, checkCertificateTrusted, configureCryptoKey, createTrigger, destroy_Task, disableAdmin, disconnectHost_Task, enableAdmin, enableCrypto, enterLockdownMode, enterMaintenanceMode_Task, exitLockdownMode, exitMaintenanceMode_Task, powerDownHostToStandBy_Task, powerUpHostFromStandBy_Task, prepareCrypto, queryHostConnectionInfo, queryMemoryOverhead, queryMemoryOverheadEx, queryMemoryOverheadEx2, queryTpmAttestationReport, rebootHost_Task, reconfigureHostForDAS_Task, reconnectHost_Task, reload, removeTag, rename_Task, retrieveCustomValues, retrieveDynamicTypeManager, retrieveHardwareUptime, retrieveInternalCapability, retrieveInternalConfigManager, retrieveManagedMethodExecuter, retrievePatchManager, sendWakeOnLanPacket, setCustomValue, shutdownHost_Task, testEvcMode_Task, updateFlags, updateIpmi, updateManagementServerIp, updateSslThumbprintInfo, updateSystemResources, updateSystemSwapConfiguration

updateManagementServerIp

Update information about the VirtualCenter server managing this host. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

applyEvcMode_Task

Tests the EVC mode's feature requirements and feature masks against the host's feature capabilities and active VM requirements, and applies the EVC mode masks to the host by removing the existing ones and applying the ones in the parameter. If requirement and mask parameters are not set, then the masks are removed (this would be the case where EVC is turned off or the host is removed from the EVC cluster). @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcEVCMode

arg1Boolean


Return Value

Type Description
VcTask

removeTag

Removes a set of tags from this object. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

retrieveManagedMethodExecuter

Returns a reference to Managed Method Executer {@link vmodl.reflect.ManagedMethodExecuter} @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcReflectManagedMethodExecuter

retrievePatchManager

Returns a reference to PatchManager @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostPatchManager

disableAdmin

Modify permissions on the host such that only the user account used for VirtualCenter operation will have Administrator permission. Any other Administrator permissions found on the host are removed on the host, but the information is kept in VirtualCenter so that the original permission can be restored by the {@link #enableAdmin} call.

If the operation succeeds, the host will be managable by VirtualCenter only. Administrator access via a VI client connected to the host is blocked. This operation only changes the permission for VI client or VIM SDK client access. It doesn't change permission in the host console OS context.

If the operation is successfull, {@link vim.host.ConfigInfo#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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

checkCertificateTrusted

Returns whether the specified certificate matches with the host certificate trusted by vCenter. This API is internal and intended to be used by VMware internal modules only. This method is only supported by VirtualCenter. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
Boolean

destroy_Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

NOTE: The appropriate privilege must be held on the parent of the destroyed entity as well as the entity itself.

This method can throw one of several exceptions. The exact set of exceptions depends on the kind of entity that is being removed. See comments for each entity for more information on destroy behavior. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

updateIpmi

Update fields that are part of the {@link vim.host.IpmiInfo} object. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostIpmiInfo


Return Value

Type Description
None

retrieveDynamicTypeManager

Returns a reference to Dynamic Type Manager {@link vmodl.reflect.DynamicTypeManager} @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcInternalDynamicTypeManager

retrieveHardwareUptime

Return the hardware uptime of the host in seconds. The harware uptime of a host is not affected by NTP and changes to its wall clock time and can be used by clients to provide a common time reference for all hosts. @since vSphere API 4.1

Parameters

NameTypeDescription
None

Return Value

Type Description
Number

queryMemoryOverhead

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Number

arg2Number


Return Value

Type Description
Number

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

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, 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 {@link vim.host.Capability#standbySupported}. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Boolean


Return Value

Type Description
VcTask

updateSystemResources

Update the configuration of the system resource hierarchy. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostSystemResourceInfo


Return Value

Type Description
None

queryHostConnectionInfo

Connection-oriented information about a host. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostConnectInfo

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, vCenter Server will automatically evacuate powered-off virtual machines. The task is cancellable. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Boolean

arg2VcHostMaintenanceSpec


Return Value

Type Description
VcTask

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.

@since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
VcTask

enableAdmin

Restore Administrator permission that was removed on the host from prior {@link #disableAdmin} call. If the operation is successfull, {@link vim.host.ConfigInfo#adminDisabled} will be set to false. This API is not supported on the host. If invoked directly on a host, a NotSupported fault will be thrown. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

exitLockdownMode

Restores Administrator permission for the local administrative account for the host that was removed by prior call to {@link vim.HostSystem#enterLockdownMode}. If the operation is successful, {@link vim.host.ConfigInfo#adminDisabled} will be set to false. This API is not supported on the host. If invoked directly on a host, a NotSupported fault will be thrown. @since vSphere API 4.1

Parameters

NameTypeDescription
None

Return Value

Type Description
None

updateSystemSwapConfiguration

Update the System Swap Configuration. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcHostSystemSwapConfiguration


Return Value

Type Description
None

queryMemoryOverheadEx

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachineConfigInfo


Return Value

Type Description
Number

enterLockdownMode

Modifies the permissions on the host, so that it will only be accessible through local console or an authorized centralized management application. Any user defined permissions found on the host are lost.

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, {@link vim.host.ConfigInfo#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. @since vSphere API 4.1

Parameters

NameTypeDescription
None

Return Value

Type Description
None

prepareCrypto

Prepare the host for receiving sensitive information and puts the host in {@link vim.HostSystem.CryptoState#prepared} mode Note: Must be invoked before {@link vim.HostSystem#enableCrypto} @since vSphere API 6.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

testEvcMode_Task

Tests the EVC mode's feature requirements and feature masks against the host's feature capabilities and active VM requirements. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcEVCMode


Return Value

Type Description
VcTask

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 {@link vim.host.Capability#rebootSupported vim.host.Capability.rebootSupported}. @since VI API 2.5

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
VcTask

enableCrypto

Sets/changes the key to be used for coredump encryption and puts the host in {@link vim.HostSystem.CryptoState#safe} mode Note: {@link vim.HostSystem#prepareCrypto} must be called before @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcCryptoKeyPlain


Return Value

Type Description
None

sendWakeOnLanPacket

Send Wake-on-LAN packet(s) to the physical NIC(s) specified in wakeOnLanConfig. If the target physical NIC supports Wake-on-LAN, the host will be powered-on from its standby state. The Wake-on-LAN packet will be sent via the NIC used for VMotion. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostWakeOnLanConfig []


Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

configureCryptoKey

Sets/changes the key to be used for coredump encryption and puts the host in {@link vim.HostSystem.CryptoState#safe} mode. This function will make the host crypto safe, and unlock all encrypted VMs on the host. When the encryption on the host is enabled for the first time after adding it to vCenter Server, this method will start sending asynchronously all the encryption keys for VMs on the host and cluster to unlock encrypted VMs. This API is not supported on the host. If invoked directly on a host, a NotSupported fault will be thrown. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcCryptoKeyId


Return Value

Type Description
None

reconfigureHostForDAS_Task

Reconfigures the host for vSphere 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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

updateSslThumbprintInfo

Update SSL thumbprint registry. This method registers new SSL thumbprints to the host or removes existing thumbprints depending on the operation type. Thumbprints registered will be persisted across agent restarts and host reboots.

Registering entries: The only supported principal is vpxuser. Duplicate thumbprints with the same owner tag will be silently ignored in registration. As duplicate tags will cause thumbprint life cycle mismanagement, it is important that solutions use this method to use an unique tag to identify itself. The thumbprints currently registered and corresponding owner tags are available at {@link vim.HostSystem#config}.

Unregistering entries: Entries are removed based on the thumbprint string and the owner tag. If removed, it will be removed from the persistent storage too. The server will silently ignore SSL thumbprints that are not in the registry, as well as those with an owner tag that is different from one specified in the request, except when the thumbprint list is empty which will clear the registry (see below). To clear the entire host thumbprint registry, specify a NULL sslThumbprintInfo. This should only be used by vCenter Server to remove all registered thumbprints from the host, for example, at add host time. To clear thumbprints associated with a specific owner, specify a NULL sslThumprints list along with the owner tag in sslThumbprintInfo. If the owner tag does not exist in the server's thumbprint registry, the request is ignored. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostSslThumbprintInfo

arg1String


Return Value

Type Description
None

reload

Reload the entity state. Clients only need to call this method if they changed some external state that affects the service without using the Web service interface to perform the change. For example, hand-editing a virtual machine configuration file affects the configuration of the associated virtual machine but the service managing the virtual machine might not monitor the file for changes. In this case, after such an edit, a client would call "reload" on the associated virtual machine to ensure the service and its clients have current data for the virtual machine. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

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 {@link vim.host.Capability#shutdownSupported}. @since VI API 2.5

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
VcTask

retrieveCustomValues

Retrieve Custom field values based on specified custom field keys. If there is no key specified, all custom values associated to this ManagedEntity will be returned. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0Number []


Return Value

Type Description
VcCustomFieldValue []

updateFlags

Update flags that are part of the {@link vim.host.FlagInfo} object. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostFlagInfo


Return Value

Type Description
None

queryMemoryOverheadEx2

Determines the amount of resources necessary to power on a virtual machine with the specified characteristics. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachineConfigInfo


Return Value

Type Description
VcVirtualMachineConfigInfoOverheadInfo

retrieveInternalConfigManager

Internal host configuration systems. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostInternalConfigManager

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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostServiceTicket

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 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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostConnectSpec

arg1VcHostSystemReconnectSpec


Return Value

Type Description
VcTask

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
VcTask

disconnectHost_Task

Disconnects from a host and instructs the server to stop sending heartbeats. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

retrieveInternalCapability

VirtualCenter specific internal host capabilities. This might not be available for a disconnected host. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostInternalCapability

addTag

Add a set of tags to this object that can be queried later. The tag must be of the form "system/" or "global/ Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

queryTpmAttestationReport

Basic information about TPM attestation state of the host. @since vSphere API 5.1

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostTpmAttestationReport

rename_Task

Renames this managed entity.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask