Host System Get Capability

Host System Get Capability

Host capabilities.

This might not be available for a disconnected host.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/capability
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostCapability of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "recursiveResourcePoolsSupported": false,
    "cpuMemoryResourceConfigurationSupported": false,
    "rebootSupported": false,
    "shutdownSupported": false,
    "vmotionSupported": false,
    "standbySupported": false,
    "ipmiSupported": false,
    "maxSupportedVMs": 0,
    "maxRunningVMs": 0,
    "maxSupportedVcpus": 0,
    "maxRegisteredVMs": 0,
    "datastorePrincipalSupported": false,
    "sanSupported": false,
    "nfsSupported": false,
    "iscsiSupported": false,
    "vlanTaggingSupported": false,
    "nicTeamingSupported": false,
    "highGuestMemSupported": false,
    "maintenanceModeSupported": false,
    "suspendedRelocateSupported": false,
    "restrictedSnapshotRelocateSupported": false,
    "perVmSwapFiles": false,
    "localSwapDatastoreSupported": false,
    "unsharedSwapVMotionSupported": false,
    "backgroundSnapshotsSupported": false,
    "preAssignedPCIUnitNumbersSupported": false,
    "screenshotSupported": false,
    "scaledScreenshotSupported": false,
    "storageVMotionSupported": false,
    "vmotionWithStorageVMotionSupported": false,
    "vmotionAcrossNetworkSupported": false,
    "maxNumDisksSVMotion": 0,
    "maxVirtualDiskDescVersionSupported": 0,
    "hbrNicSelectionSupported": false,
    "vrNfcNicSelectionSupported": false,
    "recordReplaySupported": false,
    "ftSupported": false,
    "replayUnsupportedReason": "string",
    "replayCompatibilityIssues": [
        "string"
    ],
    "smpFtSupported": false,
    "ftCompatibilityIssues": [
        "string"
    ],
    "smpFtCompatibilityIssues": [
        "string"
    ],
    "maxVcpusPerFtVm": 0,
    "loginBySSLThumbprintSupported": false,
    "cloneFromSnapshotSupported": false,
    "deltaDiskBackingsSupported": false,
    "perVMNetworkTrafficShapingSupported": false,
    "tpmSupported": false,
    "tpmVersion": "string",
    "txtEnabled": false,
    "supportedCpuFeature": [
        {
            "_typeName": "string",
            "level": 0,
            "vendor": "string",
            "eax": "string",
            "ebx": "string",
            "ecx": "string",
            "edx": "string"
        }
    ],
    "virtualExecUsageSupported": false,
    "storageIORMSupported": false,
    "vmDirectPathGen2Supported": false,
    "vmDirectPathGen2UnsupportedReason": [
        "string"
    ],
    "vmDirectPathGen2UnsupportedReasonExtended": "string",
    "supportedVmfsMajorVersion": [
        0
    ],
    "vStorageCapable": false,
    "snapshotRelayoutSupported": false,
    "firewallIpRulesSupported": false,
    "servicePackageInfoSupported": false,
    "maxHostRunningVms": 0,
    "maxHostSupportedVcpus": 0,
    "vmfsDatastoreMountCapable": false,
    "eightPlusHostVmfsSharedAccessSupported": false,
    "nestedHVSupported": false,
    "vPMCSupported": false,
    "interVMCommunicationThroughVMCISupported": false,
    "scheduledHardwareUpgradeSupported": false,
    "featureCapabilitiesSupported": false,
    "latencySensitivitySupported": false,
    "storagePolicySupported": false,
    "accel3dSupported": false,
    "reliableMemoryAware": false,
    "multipleNetworkStackInstanceSupported": false,
    "messageBusProxySupported": false,
    "vsanSupported": false,
    "vFlashSupported": false,
    "hostAccessManagerSupported": false,
    "provisioningNicSelectionSupported": false,
    "nfs41Supported": false,
    "nfs41Krb5iSupported": false,
    "turnDiskLocatorLedSupported": false,
    "virtualVolumeDatastoreSupported": false,
    "markAsSsdSupported": false,
    "markAsLocalSupported": false,
    "smartCardAuthenticationSupported": false,
    "pMemSupported": false,
    "pMemSnapshotSupported": false,
    "cryptoSupported": false,
    "oneKVolumeAPIsSupported": false,
    "gatewayOnNicSupported": false,
    "upitSupported": false,
    "cpuHwMmuSupported": false,
    "encryptedVMotionSupported": false,
    "encryptionChangeOnAddRemoveSupported": false,
    "encryptionHotOperationSupported": false,
    "encryptionWithSnapshotsSupported": false,
    "encryptionFaultToleranceSupported": false,
    "encryptionMemorySaveSupported": false,
    "encryptionRDMSupported": false,
    "encryptionVFlashSupported": false,
    "encryptionCBRCSupported": false,
    "encryptionHBRSupported": false,
    "ftEfiSupported": false,
    "unmapMethodSupported": "string",
    "maxMemMBPerFtVm": 0,
    "virtualMmuUsageIgnored": false,
    "virtualExecUsageIgnored": false,
    "vmCreateDateSupported": false,
    "vmfs3EOLSupported": false,
    "ftVmcpSupported": false,
    "quickBootSupported": false,
    "encryptedFtSupported": false,
    "assignableHardwareSupported": false,
    "suspendToMemorySupported": false,
    "useFeatureReqsForOldHWv": false,
    "markPerenniallyReservedSupported": false,
    "hppPspSupported": false,
    "deviceRebindWithoutRebootSupported": false,
    "storagePolicyChangeSupported": false,
    "precisionTimeProtocolSupported": false,
    "remoteDeviceVMotionSupported": false,
    "maxSupportedVmMemory": 0,
    "ahDeviceHintsSupported": false,
    "nvmeOverTcpSupported": false,
    "nvmeStorageFabricServicesSupported": false,
    "assignHwPciConfigSupported": false,
    "timeConfigSupported": false,
    "nvmeBatchOperationsSupported": false,
    "pMemFailoverSupported": false,
    "hostConfigEncryptionSupported": false,
    "maxSupportedSimultaneousThreads": 0,
    "ptpConfigSupported": false,
    "maxSupportedPtpPorts": 0,
    "sgxRegistrationSupported": false,
    "pMemIndependentSnapshotSupported": false,
    "iommuSLDirtyCapable": false,
    "vmknicBindingSupported": false,
    "ultralowFixedUnmapSupported": false,
    "nvmeVvolSupported": false,
    "fptHotplugSupported": false,
    "mconnectSupported": false,
    "vsanNicMgmtSupported": false,
    "vvolNQNSupported": false,
    "stretchedSCSupported": false,
    "vmknicBindingOnNFSv41": false,
    "vpStatusCheckSupported": false,
    "nConnectSupported": false,
    "userKeySupported": false,
    "ndcmSupported": false,
    "uefiSecureBoot": false
}
boolean
recursiveResourcePoolsSupported
Required

recursiveResourcePoolsSupported

boolean
cpuMemoryResourceConfigurationSupported
Required

Flag indicating whether cpu and memory resource configuration is supported.

If this is set to false, ResourcePool.UpdateConfig, ResourcePool.UpdateChildResourceConfiguration cannot be used for changing the cpu/memory resource configurations.

boolean
rebootSupported
Required

Flag indicating whether rebooting the host is supported.

boolean
shutdownSupported
Required

Flag indicating whether the host can be powered off

boolean
vmotionSupported
Required

Flag indicating whether you can perform VMotion.

boolean
standbySupported
Required

Flag indicating whether you can put the host in a power down state, from which it can be powered up automatically.

boolean
ipmiSupported
Optional

Flag indicating whether the host supports IPMI (Intelligent Platform Management Interface).

XXX - Make ipmiSupported optional until there is a compatible hostagent.

integer As int32 As int32
maxSupportedVMs
Optional

The maximum number of virtual machines that can exist on this host.

If this capability is not set, the number of virtual machines is unlimited.

integer As int32 As int32
maxRunningVMs
Optional

The maximum number of virtual machines that can be running simultaneously on this host.

If this capability is not set, the number of virtual machines running simultaneously is unlimited.

integer As int32 As int32
maxSupportedVcpus
Optional

The maximum number of virtual CPUs supported per virtual machine.

If this capability is not set, the number is unlimited.

integer As int32 As int32
maxRegisteredVMs
Optional

The maximum number of registered virtual machines supported by the host.

If this limit is exceeded, the management agent will be at risk of running out of system resources. configIssue will be posted on HostSystem in this case.

If this capability is not set, the number is unknown.

boolean
datastorePrincipalSupported
Required

Flag indicating whether datastore principal user is supported on the host.

boolean
sanSupported
Required

Flag indicating whether access to SAN devices is supported.

boolean
nfsSupported
Required

Is access to NFS devices supported.

boolean
iscsiSupported
Required

Is access to iSCSI devices supported.

boolean
vlanTaggingSupported
Required

Is VLAN Tagging supported.

boolean
nicTeamingSupported
Required

Is NIC teaming supported.

boolean
highGuestMemSupported
Required

Is high guest memory supported.

boolean
maintenanceModeSupported
Required

Is maintenance mode supported

boolean
suspendedRelocateSupported
Required

Indicates whether this host supports relocation of suspended virtual machines.

Must be true on the source and destination hosts for the relocation to work.

boolean
restrictedSnapshotRelocateSupported
Required

Indicates whether this host supports relocation of virtual machines with snapshots.

Must be true on the source and destination hosts for the relocation to work. Even if this is true, the following conditions must hold: 1) All the the vm's files are in one directory prior to the relocate. 2) All of the vm's files will be in one directory after the relocate. 3) The source and destination hosts are the same product version.

boolean
perVmSwapFiles
Required

Flag indicating whether virtual machine execution on this host involves a swapfile for each virtual machine.

If true, the swapfile placement for a powered-on virtual machine is advertised in its FileLayout by the swapFile property.

boolean
localSwapDatastoreSupported
Required

Flag indicating whether the host supports selecting a datastore that that may be used to store virtual machine swapfiles.

boolean
unsharedSwapVMotionSupported
Required

Flag indicating whether the host supports participating in a VMotion where the virtual machine swapfile is not visible to the destination.

boolean
backgroundSnapshotsSupported
Required

Flag indicating whether background snapshots are supported on this host.

boolean
preAssignedPCIUnitNumbersSupported
Required

Flag to indicate whether the server returns unit numbers in a pre-assigned range for devices on the PCI bus.

When the server supports this flag, the device unit number namespace is partitioned by device type. Different types of devices will sit in a specific range of unit numbers that may not correspond to physical slots in the pci bus but present a relative ordering of the devices with respect to other devices of the same type. Note that this does not mean that the user can set the relative ordering between device types, but only allows stable orderings between devices of the same type. The unit number will now clearly represent an ordering between devices of the same type. VirtualDevice.unitNumber This property is only available for devices on the pci controller.

boolean
screenshotSupported
Required

Indicates whether the screenshot retrival over https is supported for this host's virtual machines.

If true, a screenshot can be retrieved at the HTTPS relative path /screen?id=<managed object ID of virtual machine or snapshot>. If any of the optional parameters 'top', 'left', 'bottom', and 'right' is specified, the returned image will be cropped from the rectangle with upper left corner (left, top) and bottom right corner (right - 1, bottom - 1). These values default to the top, left, bottom and right edges of the image. The client must use an authenticated session with privilege VirtualMachine.Interact.ConsoleInteract on the requested virtual machine or, in the case of a snapshot, the virtual machine associated with that snapshot.

boolean
scaledScreenshotSupported
Required

Indicates whether scaling is supported for screenshots retrieved over https.

If true, screenshot retrieval supports the additional optional parameters 'width' and 'height'. After cropping, the returned image will be scaled to these dimensions. If only one of these parameters is specified, default behavior is to return an image roughly proportional to the source image.

boolean
storageVMotionSupported
Required

Indicates whether the storage of a powered-on virtual machine may be relocated.

boolean
vmotionWithStorageVMotionSupported
Required

Indicates whether the storage of a powered-on virtual machine may be relocated while simultaneously changing the execution host of the virtual machine.

boolean
vmotionAcrossNetworkSupported
Optional

Indicates whether the network of a powered-on virtual machine can be changed while simultaneously changing the execution host of the virtual machine.

integer As int32 As int32
maxNumDisksSVMotion
Optional

Maximum number of migrating disks allowed of a migrating VM during SVMotion.

If this capability is not set, then the maximum is considered to be 64.

integer As int32 As int32
maxVirtualDiskDescVersionSupported
Optional

Maximum version of vDiskVersion supported by this host.

If this capability is not set, then the maximum is considered to be 6.

Since: vSphere API Release 8.0.1.0

boolean
hbrNicSelectionSupported
Required

Indicates whether a dedicated nic can be selected for vSphere Replication LWD traffic, i.e., from the primary host to the VR server.

boolean
vrNfcNicSelectionSupported
Required

Indicates whether a dedicated nic can be selected for vSphere Replication NFC traffic, i.e., from the VR server to the secondary host.

boolean
recordReplaySupported
Required

Deprecated as of vSphere API 6.0.

Indicates whether this host supports record and replay

boolean
ftSupported
Required

Deprecated as of vSphere API 6.0.

Indicates whether this host supports Fault Tolerance There can be many reasons why a host does not support Fault Tolerance, which includes CPU compatibility, product compatibility as well as other host configuration settings.

For specific reasons, look into HostCapability.replayCompatibilityIssues and HostCapability.ftCompatibilityIssues 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. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

string
replayUnsupportedReason
Optional

Deprecated as of vSphere API 4.1, use HostCapability.replayCompatibilityIssues.

For a host whose CPU doesn't support replay, indicates the reason for the incompatibility.

HostReplayUnsupportedReasonEnum represents the set of possible values.

array of string
replayCompatibilityIssues
Optional

Deprecated as of vSphere API 6.0.

For a host which doesn't support replay, indicates all the reasons for the incompatibility.

HostReplayUnsupportedReasonEnum lists the set of possible values.

boolean
smpFtSupported
Required

Indicates whether this host supports smp fault tolerance

array of string
ftCompatibilityIssues
Optional

Deprecated as of vSphere API 6.0.

For a host which doesn't support Fault Tolerance, indicates all the reasons for the incompatibility.

HostCapabilityFtUnsupportedReasonEnum lists the set of possible values.

array of string
smpFtCompatibilityIssues
Optional

For a host which doesn't support smp fault tolerance, indicates all the reasons for the incompatibility.

HostCapabilityFtUnsupportedReasonEnum lists the set of possible values.

integer As int32 As int32
maxVcpusPerFtVm
Optional

The maximum number of vCPUs allowed for a fault-tolerant virtual machine.

boolean
loginBySSLThumbprintSupported
Optional

Flag indicating whether this host supports SSL thumbprint authentication

boolean
cloneFromSnapshotSupported
Required

Indicates whether or not cloning a virtual machine from a snapshot point is allowed.

This property must be true on the host where the virtual machine is currently residing. This property need not be true on the destination host for the clone.

See also VirtualMachineCloneSpec.snapshot.

boolean
deltaDiskBackingsSupported
Required

Flag indicating whether explicitly creating arbirary configurations of delta disk backings is supported.

A delta disk backing is a way to preserve a virtual disk backing at some point in time. A delta disk backing is a file backing which in turn points to the original virtual disk backing (the parent). After a delta disk backing is added, all writes go to the delta disk backing. All reads first try the delta disk backing and then try the parent backing if needed.

If this property is false, then delta disk backings can only be implicitly created through using snapshot operations and two virtual machines cannot safely share a parent disk backing.

If this property is true, then delta disk backings can be explicitly created and managed, and two virtual machines may safely share a parent disk backing.

In the context above, "safely" means that performing operations on one of the virtual machines will not affect the operation of the other virtual machine.

See also VirtualDiskSparseVer1BackingInfo.parent, VirtualDiskSparseVer2BackingInfo.parent, VirtualDiskFlatVer1BackingInfo.parent, VirtualDiskFlatVer2BackingInfo.parent, VirtualDiskRawDiskMappingVer1BackingInfo.parent, VirtualMachine.PromoteDisks_Task, VirtualMachineRelocateSpec.diskMoveType, VirtualMachineRelocateSpecDiskLocator.diskMoveType.

boolean
perVMNetworkTrafficShapingSupported
Required

Indicates whether network traffic shaping on a per virtual machine basis is supported.

boolean
tpmSupported
Required

Flag indicating whether this host supports the integrity measurement using a TPM device.

string
tpmVersion
Optional

TPM version if supported by this host.

boolean
txtEnabled
Optional

Flag indicating whether Intel TXT is enabled on this host.

TPM attestation may be used to definitively determine the Intel TXT Measured Launch Environment (MLE) details.

supportedCpuFeature
Optional

Deprecated as of vSphere API 6.5 use featureCapability.

CPU feature set that is supported by the virtualization platform.

This feature set may reflect characteristics of the product capabilities and licensing. For any feature marked '-', reference the cpuFeature array of the host's HardwareInfo to determine the correct value.

boolean
virtualExecUsageSupported
Required

Indicates whether the host supports configuring hardware virtualization (HV) support for virtual machines.

boolean
storageIORMSupported
Required

Deprecated as of vSphere8.0 U3, and there is no replacement for it.

Indicates whether the host supports storage I/O resource management.

boolean
vmDirectPathGen2Supported
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

Indicates whether the host supports network passthrough using VMDirectPath Gen 2.

Note that this is a general capability for the host and is independent of support by a given physical NIC. If false, the reason(s) for lack of support will be provided in HostCapability.vmDirectPathGen2UnsupportedReason and/or in HostCapability.vmDirectPathGen2UnsupportedReasonExtended.

See also PhysicalNic.vmDirectPathGen2Supported.

array of string
vmDirectPathGen2UnsupportedReason
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

If HostCapability.vmDirectPathGen2Supported is false, this array will be populated with reasons for the lack of support (chosen from HostCapabilityVmDirectPathGen2UnsupportedReasonEnum).

If there is a reason for the lack of support that cannot be described by the available constants, HostCapability.vmDirectPathGen2UnsupportedReasonExtended will be populated with an additional explanation provided by the platform.

Note that this list of reasons is not guaranteed to be exhaustive.

If the reason "hostNptIncompatibleProduct" is provided, then that will be the only provided reason, as the host software is incapable of providing additional information.

string
vmDirectPathGen2UnsupportedReasonExtended
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

If HostCapability.vmDirectPathGen2Supported is false, this property may contain an explanation provided by the platform, beyond the reasons (if any) enumerated in HostCapability.vmDirectPathGen2UnsupportedReason.

array of integer
supportedVmfsMajorVersion
Optional

List of VMFS major versions supported by the host.

boolean
vStorageCapable
Required

Indicates whether the host supports vStorage Hardware acceleration.

boolean
snapshotRelayoutSupported
Required

Indicates whether this host supports unrestricted relocation of virtual machines with snapshots.

Only needs to be true on the destination host for the unrestricted relocation to work. The full snapshot relocation does not restrict the layout of snapshot files or disks of the virtual machine, nor its power state. If the virtual machine is powered on, a storage vmotion will be performed to relocate its snapshots and disks.

boolean
firewallIpRulesSupported
Optional

Indicates whether this host supports ip address based restrictions in the firewall configuration.

boolean
servicePackageInfoSupported
Optional

Indicates whether this host supports package information in service configuration.

integer As int32 As int32
maxHostRunningVms
Optional

The maximum number of virtual machines that can be run on the host.

An unset value indicates that the value could not be obtained. In contrast to HostCapability.maxRunningVMs, this value is the minimum of (i) the maximum number supported by the hardware and (ii) the maximum number permitted by the host license.

integer As int32 As int32
maxHostSupportedVcpus
Optional

The maximum number of virtual CPUs that can be run on the host.

An unset value indicates that the value could not be obtained. In contrast to HostCapability.maxSupportedVcpus, this value is the minimum of (i) the maximum number supported by the hardware and (ii) the maximum number permitted by the host license.

boolean
vmfsDatastoreMountCapable
Required

Indicates whether the host is capable of mounting/unmounting VMFS datastores.

boolean
eightPlusHostVmfsSharedAccessSupported
Required

Indicates whether the host is capable of accessing a VMFS disk when there are eight or more hosts accessing the disk already.

boolean
nestedHVSupported
Required

Indicates whether the host supports nested hardware-assisted virtualization.

boolean
vPMCSupported
Required

Indicates whether the host supports virtual CPU performance counters.

boolean
interVMCommunicationThroughVMCISupported
Required

Indicates whether the host supports VMCI for communication between virtual machines.

boolean
scheduledHardwareUpgradeSupported
Optional

Indicates whether the host supports scheduled hardware upgrades.

See also VirtualMachineConfigInfo.scheduledHardwareUpgradeInfo.

boolean
featureCapabilitiesSupported
Required

Indicated whether the host supports feature capabilities for EVC mode.

boolean
latencySensitivitySupported
Required

Indicates whether the host supports latency sensitivity for the virtual machines.

boolean
storagePolicySupported
Optional

Indicates that host supports Object-based Storage System and Storage-Profile based disk provisioning.

boolean
accel3dSupported
Required

Indicates if 3D hardware acceleration for virtual machines is supported.

boolean
reliableMemoryAware
Optional

Indicates that this host uses a reliable memory aware allocation policy.

boolean
multipleNetworkStackInstanceSupported
Optional

Indicates whether the host supports Multiple Instance TCP/IP stack

boolean
messageBusProxySupported
Optional

Indicates whether the message bus proxy is supported

boolean
vsanSupported
Optional

Indicates whether the host supports VSAN functionality.

See also HostVsanSystem.

boolean
vFlashSupported
Optional

Indicates whether the host supports vFlash.

boolean
hostAccessManagerSupported
Optional

Whether this host supports HostAccessManager for controlling direct access to the host and for better lockdown mode management.

boolean
provisioningNicSelectionSupported
Required

Indicates whether a dedicated nic can be selected for vSphere Provisioning NFC traffic.

boolean
nfs41Supported
Optional

Whether this host supports NFS41 file systems.

boolean
nfs41Krb5iSupported
Optional

Whether this host support NFS41 Kerberos 5* security type.

boolean
turnDiskLocatorLedSupported
Optional

Indicates whether turning on/off local disk LED is supported on the host.

See also HostStorageSystem.TurnDiskLocatorLedOn_Task, HostStorageSystem.TurnDiskLocatorLedOff_Task.

boolean
virtualVolumeDatastoreSupported
Optional

Indicates whether this host supports VirtualVolume based Datastore.

boolean
markAsSsdSupported
Optional

Indicates whether mark disk as SSD or Non-SSD is supported on the host.

See also HostStorageSystem.MarkAsSsd_Task, HostStorageSystem.MarkAsNonSsd_Task.

boolean
markAsLocalSupported
Optional

Indicates whether mark disk as local or remote is supported on the host.

See also HostStorageSystem.MarkAsLocal_Task, HostStorageSystem.MarkAsNonLocal_Task.

boolean
smartCardAuthenticationSupported
Optional

Deprecated as of vSphere API 8.0U3, and there is no replacement for it.

Indicates whether this host supports local two-factor user authentication using smart cards.

See also HostActiveDirectoryAuthentication.EnableSmartCardAuthentication.

boolean
pMemSupported
Optional

Indicates whether this host supports persistent memory.

If value is not specified, it should be considered as not supported.

boolean
pMemSnapshotSupported
Optional

Indicates whether this host supports snapshots for VMs with virtual devices backed by persistent memory.

If value is not specified, it should be considered as not supported.

boolean
cryptoSupported
Optional

Flag indicating whether Cryptographer feature is supported.

boolean
oneKVolumeAPIsSupported
Optional

Indicates whether this host supports granular datastore cache update.

If value is not specified, it should be considered as not supported.

boolean
gatewayOnNicSupported
Optional

Flag indicating whether default gateway can be configured on a vmkernel nic.

boolean
upitSupported
Optional

Deprecated as of vSphere API 8.0, and there is no replacement for it.

Indicate whether this host supports UPIT

boolean
cpuHwMmuSupported
Optional

Indicates whether this host supports hardware-based MMU virtualization.

boolean
encryptedVMotionSupported
Optional

Indicates whether this host supports encrypted vMotion.

boolean
encryptionChangeOnAddRemoveSupported
Optional

Indicates whether this host supports changing the encryption state of a virtual disk when the disk is being added or removed from a virtual machine configuration.

boolean
encryptionHotOperationSupported
Optional

Indicates whether this host supports changing the encryption state of a virtual machine, or virtual disk, while the virtual machine is powered on.

boolean
encryptionWithSnapshotsSupported
Optional

Indicates whether this host supports changing the encryption state state of a virtual machine, or virtual disk, while the virtual machine has snapshots present.

boolean
encryptionFaultToleranceSupported
Optional

Indicates whether this host supports enabling Fault Tolerance on encrypted virtual machines.

boolean
encryptionMemorySaveSupported
Optional

Indicates whether this host supports suspending, or creating with-memory snapshots, encrypted virtual machines.

boolean
encryptionRDMSupported
Optional

Indicates whether this host supports encrypting RDM backed virtual disks.

boolean
encryptionVFlashSupported
Optional

Indicates whether this host supports encrypting virtual disks with vFlash cache enabled.

boolean
encryptionCBRCSupported
Optional

Indicates whether this host supports encrypting virtual disks with Content Based Read Cache (digest disks) enabled.

boolean
encryptionHBRSupported
Optional

Indicates whether this host supports encrypting virtual disks with Host Based Replication enabled.

boolean
ftEfiSupported
Optional

Indicates whether this host supports Fault Tolerance VMs that have specified UEFI firmware.

string
unmapMethodSupported
Optional

Indicates which kind of VMFS unmap method is supported.

See HostCapabilityUnmapMethodSupportedEnum

integer As int32 As int32
maxMemMBPerFtVm
Optional

Indicates maximum memory allowed for Fault Tolerance virtual machine.

boolean
virtualMmuUsageIgnored
Optional

Indicates that VirtualMachineFlagInfo.virtualMmuUsage is ignored by the host, always operating as if "on" was selected.

boolean
virtualExecUsageIgnored
Optional

Indicates that VirtualMachineFlagInfo.virtualExecUsage is ignored by the host, always operating as if "hvOn" was selected.

boolean
vmCreateDateSupported
Optional

Indicates that createDate feature is supported by the host.

boolean
vmfs3EOLSupported
Optional

Indicates whether this host supports VMFS-3 EOL.

If value is not specified, it should be considered as not supported.

boolean
ftVmcpSupported
Optional

Indicates whether this host supports VMCP for Fault Tolerance VMs.

boolean
quickBootSupported
Optional

Indicates whether this host supports the LoadESX feature which allows faster reboots.

See also HostLoadEsxManager.QueryLoadEsxSupported.

boolean
encryptedFtSupported
Optional

Indicates whether this host supports encrypted Fault Tolerance.

Since: vSphere API Release 7.0.2.0

boolean
assignableHardwareSupported
Optional

Indicates whether this host supports Assignable Hardware.

boolean
suspendToMemorySupported
Optional

Indicates whether this host supports suspending virtual machines to memory.

Since: vSphere API Release 7.0.2.0

boolean
useFeatureReqsForOldHWv
Optional

Indicates whether this host uses vmFeatures for compatibility checking of old (≤8) virtual hardware version VMs.

boolean
markPerenniallyReservedSupported
Optional

Indicates whether this host supports marking specified LUN as perennially reserved.

boolean
hppPspSupported
Optional

Indicates whether this host supports HPP path selection policy settings.

boolean
deviceRebindWithoutRebootSupported
Optional

Indicates whether device rebind without reboot is supported.

This is the capability which enables PCI passthrough and SR-IOV configuration without reboot.

boolean
storagePolicyChangeSupported
Optional

Indicates whether this host supports storage policy change.

boolean
precisionTimeProtocolSupported
Optional

Indicates whether this host supports date time synchronization over Precision Time Protocol (PTP).

boolean
remoteDeviceVMotionSupported
Optional

Indicates whether vMotion of a VM with remote devices attached is supported.

This applies to CD-ROM and floppy devices backed by a remote client.

integer As int32 As int32
maxSupportedVmMemory
Optional

The maximum amount of virtual memory supported per virtual machine.

If this capability is not set, the size is limited by hardware version of the virtual machine only.

boolean
ahDeviceHintsSupported
Optional

Indicates if the host supports Assignable Hardware device hints.

Since: vSphere API Release 7.0.2.0

boolean
nvmeOverTcpSupported
Optional

Indicates if access to NVMe over TCP devices is supported.

Since: vSphere API Release 7.0.3.0

boolean
nvmeStorageFabricServicesSupported
Optional

Indicates whether NVMe Storage Fabrics Services (StFS) are supported.

Since: vSphere API Release 7.0.3.0

boolean
assignHwPciConfigSupported
Optional

Indicates if setting hardwareLabel using PciPassThrough is supported.

Since: vSphere API Release 7.0.2.0

boolean
timeConfigSupported
Optional

Indicates whether advanced timekeeping apis are supported

Since: vSphere API Release 7.0.3.0

boolean
nvmeBatchOperationsSupported
Optional

Indicates whether batch NVMe controller connection/disconnection is supported.

See HostStorageSystem.ConnectNvmeControllerEx_Task and HostStorageSystem.DisconnectNvmeControllerEx_Task.

Since: vSphere API Release 7.0.3.0

boolean
pMemFailoverSupported
Optional

Indicates whether this host supports failover for VMs with virtual devices backed by persistent memory.

If value is not specified, it should be considered as not supported.

Since: vSphere API Release 7.0.2.0

boolean
hostConfigEncryptionSupported
Optional

Indicates whether this host supports host configuration encryption.

Since: vSphere API Release 7.0.2.0

integer As int32 As int32
maxSupportedSimultaneousThreads
Optional

Max supported number of SMT (Simultaneous multithreading) threads.

If value is not specified, it should be considered as not supported.

Since: vSphere API Release 8.0.0.1

boolean
ptpConfigSupported
Optional

Indicates whether this host supports PTP (Precision Time Protocol) service configuration.

See HostPtpConfig. If value is not specified, it should be considered as not supported.

Since: vSphere API Release 7.0.3.0

integer As int32 As int32
maxSupportedPtpPorts
Optional

Number of PTP (Precision Time Protocol) ports supported by this host (See HostPtpConfig).

If this capability is not set, number of PTP ports in the host is 0.

Since: vSphere API Release 7.0.3.0

boolean
sgxRegistrationSupported
Optional

Indicates whether this host supports SGX registration.

Since: vSphere API Release 8.0.0.1

boolean
pMemIndependentSnapshotSupported
Optional

Indicates whether this host supports snapshots of VMs configured with independent vNVDIMMs.

If value is not specified, it should be considered as not supported. This support does not depend on HostCapability.pMemSnapshotSupported.

Since: vSphere API Release 7.0.3.0

boolean
iommuSLDirtyCapable
Optional

Indicates whether this host's IOMMUs are capable of tracking pages written by device DMAs using dirty bits in the second-level page tables.

If this value is not specified, it should be considered as not capable.

Since: vSphere API Release 8.0.0.1

boolean
vmknicBindingSupported
Optional

Indicates whether vmknic binding is supported over this host.

Since: vSphere API Release 8.0.1.0

boolean
ultralowFixedUnmapSupported
Optional

Indicates whether ultralow fixed unmap bandwidth is supported on this host.

Since: vSphere API Release 8.0.0.1

boolean
nvmeVvolSupported
Optional

Indicates whether mounting of NVMe vvol is supported on this host.

Since: vSphere API Release 8.0.0.0

boolean
fptHotplugSupported
Optional

Indicates whether FPT Hotplug is supported on this host.

Since: vSphere API Release 8.0.1.0

boolean
mconnectSupported
Optional

Indicates whether MCONNECT is supported on this host.

Since: vSphere API Release 8.0.1.0

boolean
vsanNicMgmtSupported
Optional

Indicates whether vSAN nic types can be managed by VirtualNicManager.

Since: vSphere API Release 8.0.2.0

boolean
vvolNQNSupported
Optional

Indicates whether vVol NQN is supported on this host.

Since: vSphere API Release 8.0.2.0

boolean
stretchedSCSupported
Optional

Indicates whether "stretched" vVol Storage Container is supported on this host.

Since: vSphere API Release 8.0.3.0

boolean
vmknicBindingOnNFSv41
Optional

Indicates whether vmknic binding is supported on NFSv41 over this host.

Since: vSphere API Release 8.0.3.0

boolean
vpStatusCheckSupported
Optional

Indicates whether VasaProvider Status can be monitored on the host.

Since: vSphere API Release 8.0.3.0

boolean
nConnectSupported
Optional

Indicates whether NFS41 NCONNECT is supported on this host.

Since: vSphere API Release 8.0.3.0

boolean
userKeySupported
Optional

Indicates whether user-provided private key installation is supported on this host.

Since: vSphere API Release 8.0.3.0

boolean
ndcmSupported
Optional

Indicates whether non-disruptive certificate management is supported on this host.

Since: vSphere API Release 8.0.3.0

boolean
uefiSecureBoot
Optional

Flag indicating that the firmware reports the use of UEFI Secure Boot during system boot.

TPM attestation may be used to definitively determine the boot time UEFI Secure Boot state and its complete configuration. An out-of-band management channel may also be considered.

Since: vSphere API Release 8.0.3.0


Virtual Infrastructure Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
POST
Host System Enter Maintenance Mode Task
POST
Host System Exit Lockdown Mode
POST
Host System Exit Maintenance Mode Task
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm
POST
Host System Power Down Host To Stand By Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
POST
Host System Query Memory Overhead Ex
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
POST
Host System Update System Swap Configuration