Managed Object - HostSystem

Property of: ActiveVMsBlockingEVC, AnswerFileStatusResult, ApplyHostProfileConfigurationResult, ApplyHostProfileConfigurationSpec, CannotEnableVmcpForCluster, CheckResult, ClusterClusterInitialPlacementAction, ClusterComputeResourceClusterConfigResult, ClusterComputeResourceHCIConfigInfo, ClusterComputeResourceHostConfigurationInput, ClusterComputeResourceHostConfigurationValidation, ClusterComputeResourceVcsSlots, ClusterDasAamNodeState, ClusterDasFailoverLevelAdvancedRuntimeInfoHostSlots, ClusterDasFdmHostState, ClusterDasHostRecommendation, ClusterDpmHostConfigInfo, ClusterDrsMigration, ClusterEVCManagerCheckResult, ClusterFailoverHostAdmissionControlInfoHostStatus, ClusterFailoverHostAdmissionControlPolicy, ClusterHostGroup, ClusterHostRecommendation, ClusterInitialPlacementAction, ComputeResource, ComputeResourceHostSPBMLicenseInfo, ConverterAgentInternalManagedVMOptions, ConverterTargetVmSpecManagedVmLocation, CpuIncompatible, CryptoManagerKmipCryptoKeyStatus, DasHeartbeatDatastoreInfo, DatastoreHostMount, DatastoreNotWritableOnHost, DiagnosticManagerBundleInfo, DisallowedOperationOnFailoverHost, DistributedVirtualPort, DistributedVirtualSwitchHostMemberConfigInfo, DistributedVirtualSwitchHostMemberConfigSpec, DistributedVirtualSwitchManagerCompatibilityResult, DistributedVirtualSwitchManagerHostArrayFilter, DistributedVirtualSwitchPortCriteria, DrsVmotionIncompatibleFault, DVSManagerPhysicalNicsList, DvsOperationBulkFaultFaultOnHost, DVSSummary, EnvironmentBrowserConfigOptionQuerySpec, EVCModeUnsupportedByHosts, EVCUnsupportedByHostHardware, EVCUnsupportedByHostSoftware, FaultsByHost, FaultToleranceAntiAffinityViolated, FeatureRequirementsNotMet, FolderBatchAddHostsToClusterResult, FolderBatchAddStandaloneHostsResult, FolderFailedHostResult, FtIssuesOnHost, HostConfigInfo, HostEventArgument, HostListSummary, HostMemberRuntimeInfo, HostProfile, HostProfileCompleteConfigSpec, HostProfileHostBasedConfigSpec, HostProfileManagerHostToConfigSpecMap, HostProfileSerializedHostProfileSpec, HostProfileValidationFailureInfo, HostProtocolEndpoint, HostSpecification, HostSpecificationOperationFailed, HostVmfsRescanResult, HostVMotionCompatibility, IncompatibleHostForFtSecondary, InsufficientHostCapacityFault, InvalidHostState, InvalidProfileReferenceHost, IoFilterHostIssue, IORMNotSupportedHostOnDatastore, MigrationFeatureNotSupported, Network, NoCompatibleHost, NodeDeploymentSpec, NotEnoughLogicalCpus, NotSupportedDeviceForFT, OvfCreateImportSpecParams, PlacementAction, PlacementSpec, ProfileReferenceHostChangedEvent, QuiesceDatastoreIOForHAFailed, RuleViolation, StoragePlacementSpec, ThirdPartyLicenseAssignmentFailed, VAppCloneSpec, VirtualHardwareVersionNotSupported, VirtualMachineConfigOptionDescriptor, VirtualMachineRelocateSpec, VirtualMachineRuntimeInfo, VmAlreadyExistsInDatacenter, VMotionInterfaceIssue, VmWwnConflict, VsanHostConfigInfo, VsanUpgradeSystemAPIBrokenIssue, VsanUpgradeSystemAutoClaimEnabledOnHostsIssue, VsanUpgradeSystemHostsDisconnectedIssue, VsanUpgradeSystemMissingHostsInClusterIssue, VsanUpgradeSystemNetworkPartitionInfo, VsanUpgradeSystemUpgradeHistoryItem, VsanUpgradeSystemWrongEsxVersionIssue, VVolHostPE
Parameter to: ApplyHostConfig_Task, BatchAddHostsToCluster_Task, BrowseDiagnosticLog, CertMgrRefreshCACertificatesAndCRLs_Task, CertMgrRefreshCertificates_Task, CertMgrRevokeCertificates_Task, CheckAnswerFileStatus_Task, CheckCompatibility_Task, CheckLicenseFeature, CheckMigrate_Task, CheckPowerOn_Task, CheckVmConfig_Task, ClusterEnterMaintenanceMode, ConfigureLicenseSource, CreateChildVM_Task, CreateSecondaryVM_Task, CreateSecondaryVMEx_Task, CreateVM_Task, DeleteHostSpecification, DeleteHostSubSpecification, DisableFeature, EnableFeature, EnableSecondaryVM_Task, ExecuteHostProfile, ExportAnswerFile_Task, GenerateConfigTaskList, GenerateHostProfileTaskList_Task, GenerateLogBundles_Task, ImportVApp, LookupVmOverheadMemory, MarkAsVirtualMachine, MigrateVM_Task, MoveHostInto_Task, MoveInto_Task, PerformVsanUpgrade_Task, PowerOnVM_Task, QueryAnswerFileStatus, QueryCompatibleVmnicsFromHosts, QueryConfigOption, QueryConfigTarget, QueryDescriptions, QueryDvsConfigTarget, QueryIORMConfigOption, QueryLicenseSourceAvailability, QueryLicenseUsage, QuerySupportedFeatures, QueryTargetCapabilities, QueryVMotionCompatibility, QueryVMotionCompatibilityEx_Task, RectifyDvsHost_Task, RectifyDvsOnHost_Task, RegisterChildVM_Task, RegisterVM_Task, ResolveInstallationErrorsOnHost_Task, RetrieveAnswerFile, RetrieveAnswerFileForProfile, RetrieveHostCustomizations, RetrieveHostCustomizationsForProfile, RetrieveHostSpecification, RevertToCurrentSnapshot_Task, RevertToSnapshot_Task, SetLicenseEdition, UpdateAnswerFile_Task, UpdateHostSpecification, UpdateHostSubSpecification, UpdateReferenceHost, ValidateHCIConfiguration, ValidateHost, ValidateMigration
Returned by: AddHost_Task, HostSpecGetUpdatedHosts, QueryCompatibleHostForExistingDvs, QueryCompatibleHostForNewDvs, QueryHostsWithAttachedLun, QueryUnmonitoredHosts
Extends: ManagedEntity
See also: AnswerFileStatusResult, ApplyHostProfileConfigurationResult, ApplyHostProfileConfigurationSpec, ComplianceResult, CryptoKeyId, CryptoKeyPlain, Datastore, HostCapability, HostConfigInfo, HostConfigManager, HostConnectInfo, HostConnectSpec, HostDatastoreBrowser, HostFlagInfo, HostHardwareInfo, HostIpmiInfo, HostLicensableResourceInfo, HostListSummary, HostMaintenanceSpec, HostRuntimeInfo, HostServiceTicket, HostSystemComplianceCheckState, HostSystemReconnectSpec, HostSystemRemediationState, HostSystemResourceInfo, HostSystemSwapConfiguration, HostTpmAttestationReport, Network, VirtualMachine, VirtualMachineConfigInfo
Since: null

Managed Object Description

Properties

Name	Type	Description
answerFileValidationResult*	AnswerFileStatusResult	*Since* vSphere API 6.7
answerFileValidationState*	AnswerFileStatusResult	*Since* vSphere API 6.7
capability*	HostCapability
complianceCheckResult*	ComplianceResult	*Since* vSphere API 6.7
complianceCheckState*	HostSystemComplianceCheckState	*Since* vSphere API 6.7
config*	HostConfigInfo
configManager	HostConfigManager
datastore* P	ManagedObjectReference[] to a Datastore[]
datastoreBrowser P	ManagedObjectReference to a HostDatastoreBrowser
hardware*	HostHardwareInfo
licensableResource	HostLicensableResourceInfo	*Since* vSphere API 5.0
network* P	ManagedObjectReference[] to a Network[]
precheckRemediationResult*	ApplyHostProfileConfigurationSpec	*Since* vSphere API 6.7
remediationResult*	ApplyHostProfileConfigurationResult	*Since* vSphere API 6.7
remediationState*	HostSystemRemediationState	*Since* vSphere API 6.7
runtime	HostRuntimeInfo
summary	HostListSummary
systemResources*	HostSystemResourceInfo
vm*	ManagedObjectReference[] to a VirtualMachine[]
Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
AcquireCimServicesTicket, ConfigureCryptoKey, DisconnectHost_Task, EnableCrypto, EnterLockdownMode, EnterMaintenanceMode_Task, ExitLockdownMode, ExitMaintenanceMode_Task, PowerDownHostToStandBy_Task, PowerUpHostFromStandBy_Task, PrepareCrypto, QueryHostConnectionInfo, QueryMemoryOverhead, QueryMemoryOverheadEx, QueryProductLockerLocation, QueryTpmAttestationReport, RebootHost_Task, ReconfigureHostForDAS_Task, ReconnectHost_Task, RetrieveFreeEpcMemory, RetrieveHardwareUptime, ShutdownHost_Task, UpdateFlags, UpdateIpmi, UpdateProductLockerLocation_Task, UpdateSystemResources, UpdateSystemSwapConfiguration
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AcquireCimServicesTicket

Required Privileges: Host.Cim.CimInteraction
Since: VI API 2.5

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

ConfigureCryptoKey

Required Privileges: Cryptographer.RegisterHost
Since: vSphere API 6.5

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

*Need not be set P Required privilege: keyId

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

DisconnectHost_Task

Required Privileges: Host.Config.Connection

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

EnableCrypto

Required Privileges: Cryptographer.RegisterHost
Since: vSphere API 6.5

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

P Required privilege: keyPlain

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

EnterLockdownMode

Deprecated.

Required Privileges: Host.Config.Settings
Since: vSphere API 4.1

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

EnterMaintenanceMode_Task

Required Privileges: Host.Config.Maintenance

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

*Need not be set PRequired privilege - see tooltip for details

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

ExitLockdownMode

Deprecated.

Required Privileges: Host.Config.Settings
Since: vSphere API 4.1

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

ExitMaintenanceMode_Task

Required Privileges: Host.Config.Maintenance

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

timeout P

xsd:int

Since null

P Required privilege: timeout

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

PowerDownHostToStandBy_Task

Required Privileges: Host.Config.Maintenance
Since: VI API 2.5

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

*Need not be set PRequired privilege - see tooltip for details

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

PowerUpHostFromStandBy_Task

Required Privileges: Host.Config.Maintenance
Since: VI API 2.5

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

P Required privilege: timeoutSec

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

PrepareCrypto

Required Privileges: Cryptographer.RegisterHost
Since: vSphere API 6.5

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

QueryHostConnectionInfo

Required Privileges: System.Read

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

QueryMemoryOverhead

Deprecated.

Required Privileges: System.Read

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

*Need not be set PRequired privilege - see tooltip for details

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

QueryMemoryOverheadEx

Deprecated.

Required Privileges: System.Read
Since: VI API 2.5

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

P Required privilege: vmConfigInfo

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

QueryProductLockerLocation

Required Privileges: System.Read
Since: vSphere API 6.7.1

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

QueryTpmAttestationReport

Required Privileges: System.Read
Since: vSphere API 5.1

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

RebootHost_Task

Required Privileges: Host.Config.Maintenance

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

force P

xsd:boolean

Since null

P Required privilege: force

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

ReconfigureHostForDAS_Task

Required Privileges: Host.Config.Connection

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

ReconnectHost_Task

Required Privileges: Host.Config.Connection

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

*Need not be set PRequired privilege - see tooltip for details

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

RetrieveFreeEpcMemory

Required Privileges: System.Read
Since: vSphere API 7.0

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

RetrieveHardwareUptime

Required Privileges: System.Read
Since: vSphere API 4.1

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

ShutdownHost_Task

Required Privileges: Host.Config.Maintenance

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

force P

xsd:boolean

Since null

P Required privilege: force

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

UpdateFlags

Required Privileges: Host.Config.Settings
Since: VI API 2.5

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

P Required privilege: flagInfo

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

UpdateIpmi

Required Privileges: Host.Config.Settings
Since: vSphere API 4.0

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

P Required privilege: ipmiInfo

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

UpdateProductLockerLocation_Task

Required Privileges: Host.Config.ProductLocker
Since: vSphere API 6.7.1

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

P Required privilege: path

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