|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| accel3dSupported | xsd:boolean |
Indicates if 3D hardware acceleration for virtual machines is supported.
Since vSphere API 5.1 |
| assignableHardwareSupported* | xsd:boolean |
Indicates whether this host supports Assignable Hardware.
Since vSphere API 7.0 |
| backgroundSnapshotsSupported | xsd:boolean |
Flag indicating whether background snapshots are supported on this host.
Since VI API 2.5 |
| cloneFromSnapshotSupported | xsd:boolean |
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. |
| cpuHwMmuSupported* | xsd:boolean |
Indicates whether this host supports hardware-based MMU virtualization.
Since vSphere API 6.5 |
| cpuMemoryResourceConfigurationSupported | xsd:boolean |
Flag indicating whether cpu and memory resource configuration is
supported. If this is set to false,
UpdateConfig,
UpdateChildResourceConfiguration
cannot be used for changing the cpu/memory resource configurations.
Since VI API 2.5 |
| cryptoSupported* | xsd:boolean |
Flag indicating whether Cryptographer feature is supported.
Since vSphere API 6.5 |
| datastorePrincipalSupported | xsd:boolean |
Flag indicating whether datastore principal user
is supported on the host.
|
| deltaDiskBackingsSupported | xsd:boolean |
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.
|
| deviceRebindWithoutRebootSupported* | xsd:boolean |
Indicates whether device rebind without reboot is supported. This is
the capability which enables PCI passthrough and SR-IOV configuration
without reboot.
Since vSphere API 7.0 |
| eightPlusHostVmfsSharedAccessSupported | xsd:boolean |
Indicates whether the host is capable of accessing a VMFS disk
when there are eight or more hosts accessing the disk already.
Since vSphere API 5.1 |
| encryptedVMotionSupported* | xsd:boolean |
Indicates whether this host supports encrypted vMotion.
Since vSphere API 6.5 |
| encryptionCBRCSupported* | xsd:boolean |
Indicates whether this host supports encrypting virtual disks with
Content Based Read Cache (digest disks) enabled.
Since vSphere API 6.5 |
| encryptionChangeOnAddRemoveSupported* | xsd:boolean |
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.
Since vSphere API 6.5 |
| encryptionFaultToleranceSupported* | xsd:boolean |
Indicates whether this host supports enabling Fault Tolerance on
encrypted virtual machines.
Since vSphere API 6.5 |
| encryptionHBRSupported* | xsd:boolean |
Indicates whether this host supports encrypting virtual disks with
Host Based Replication enabled.
Since vSphere API 6.5 |
| encryptionHotOperationSupported* | xsd:boolean |
Indicates whether this host supports changing the encryption state
of a virtual machine, or virtual disk, while the virtual machine
is powered on.
Since vSphere API 6.5 |
| encryptionMemorySaveSupported* | xsd:boolean |
Indicates whether this host supports suspending, or creating
with-memory snapshots, encrypted virtual machines.
Since vSphere API 6.5 |
| encryptionRDMSupported* | xsd:boolean |
Indicates whether this host supports encrypting RDM backed virtual
disks.
Since vSphere API 6.5 |
| encryptionVFlashSupported* | xsd:boolean |
Indicates whether this host supports encrypting virtual disks with
vFlash cache enabled.
Since vSphere API 6.5 |
| encryptionWithSnapshotsSupported* | xsd:boolean |
Indicates whether this host supports changing the encryption state
state of a virtual machine, or virtual disk, while the virtual
machine has snapshots present.
Since vSphere API 6.5 |
| featureCapabilitiesSupported | xsd:boolean |
Indicated whether the host supports feature capabilities
for EVC mode.
Since vSphere API 5.1 |
| firewallIpRulesSupported* | xsd:boolean |
Indicates whether this host supports ip address based restrictions in
the firewall configuration.
Since vSphere API 5.0 |
| ftCompatibilityIssues* | xsd:string[] | Deprecated.
as of vSphere API 6.0
For a host which doesn't support Fault Tolerance, indicates all the reasons
for the incompatibility. HostCapabilityFtUnsupportedReason
lists the set of possible values.
Since vSphere API 4.1 |
| ftEfiSupported* | xsd:boolean |
Indicates whether this host supports Fault Tolerance VMs that have
specified UEFI firmware.
Since vSphere API 6.7 |
| ftSupported | xsd:boolean | 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
replayCompatibilityIssues and
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.
Since vSphere API 4.0 |
| ftVmcpSupported* | xsd:boolean |
Indicates whether this host supports VMCP for Fault Tolerance VMs.
Since vSphere API 6.7 |
| gatewayOnNicSupported* | xsd:boolean |
Flag indicating whether default gateway can be configured on a
vmkernel nic.
Since vSphere API 6.5 |
| hbrNicSelectionSupported | xsd:boolean |
Indicates whether a dedicated nic can be selected for vSphere Replication
LWD traffic, i.e., from the primary host to the VR server.
Since vSphere API 5.1 |
| highGuestMemSupported | xsd:boolean |
Is high guest memory supported.
|
| hostAccessManagerSupported* | xsd:boolean |
Whether this host supports HostAccessManager for controlling direct
access to the host and for better lockdown mode management.
Since vSphere API 6.0 |
| hppPspSupported* | xsd:boolean |
Indicates whether this host supports HPP path selection policy
settings.
Since vSphere API 7.0 |
| interVMCommunicationThroughVMCISupported | xsd:boolean |
Indicates whether the host supports VMCI for communication
between virtual machines.
Since vSphere API 5.1 |
| ipmiSupported* | xsd:boolean |
Flag indicating whether the host supports
IPMI (Intelligent Platform Management Interface).
XXX - Make ipmiSupported optional until there is a compatible hostagent.
Since vSphere API 4.0 |
| iscsiSupported | xsd:boolean |
Is access to iSCSI devices supported.
|
| latencySensitivitySupported | xsd:boolean |
Indicates whether the host supports latency sensitivity for the
virtual machines.
Since vSphere API 5.1 |
| localSwapDatastoreSupported | xsd:boolean |
Flag indicating whether the host supports selecting a datastore that
that may be used to store virtual machine swapfiles.
Since VI API 2.5 |
| loginBySSLThumbprintSupported* | xsd:boolean |
Flag indicating whether this host supports SSL thumbprint authentication
Since vSphere API 4.0 |
| maintenanceModeSupported | xsd:boolean |
Is maintenance mode supported
|
| markAsLocalSupported* | xsd:boolean |
Indicates whether mark disk as local or remote is supported
on the host. See MarkAsLocal_Task See MarkAsNonLocal_Task Since vSphere API 6.0 |
| markAsSsdSupported* | xsd:boolean |
Indicates whether mark disk as SSD or Non-SSD is supported
on the host. See MarkAsSsd_Task See MarkAsNonSsd_Task Since vSphere API 6.0 |
| markPerenniallyReservedSupported* | xsd:boolean |
Indicates whether this host supports marking specified LUN as
perennially reserved.
Since vSphere API 6.7.2 |
| maxHostRunningVms* | xsd:int |
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 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.
Since vSphere API 5.0 |
| maxHostSupportedVcpus* | xsd:int |
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
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.
Since vSphere API 5.0 |
| maxMemMBPerFtVm* | xsd:int |
Indicates maximum memory allowed for Fault Tolerance virtual machine.
Since vSphere API 6.7 |
| maxNumDisksSVMotion* | xsd:int |
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.
Since vSphere API 6.0 |
| maxRegisteredVMs* | xsd:int |
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. Since vSphere API 5.1 |
| maxRunningVMs* | xsd:int |
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.
|
| maxSupportedVcpus* | xsd:int |
The maximum number of virtual CPUs supported per virtual machine.
If this capability is not set, the number is unlimited.
|
| maxSupportedVmMemory* | xsd:int |
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.
Since vSphere API 7.0 |
| maxSupportedVMs* | xsd:int |
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.
|
| maxVcpusPerFtVm* | xsd:int |
The maximum number of vCPUs allowed for a fault-tolerant virtual machine.
Since vSphere API 6.0 |
| messageBusProxySupported* | xsd:boolean |
Indicates whether the message bus proxy is supported
Since vSphere API 6.0 |
| multipleNetworkStackInstanceSupported* | xsd:boolean |
Indicates whether the host supports Multiple Instance TCP/IP stack
Since vSphere API 5.5 |
| nestedHVSupported | xsd:boolean |
Indicates whether the host supports nested hardware-assisted virtualization.
Since vSphere API 5.1 |
| nfs41Krb5iSupported* | xsd:boolean |
Whether this host support NFS41 Kerberos 5* security type.
Since vSphere API 6.5 |
| nfs41Supported* | xsd:boolean |
Whether this host supports NFS41 file systems.
Since vSphere API 6.0 |
| nfsSupported | xsd:boolean |
Is access to NFS devices supported.
|
| nicTeamingSupported | xsd:boolean |
Is NIC teaming supported.
|
| oneKVolumeAPIsSupported* | xsd:boolean |
Indicates whether this host supports granular datastore cache update.
If value is not specified, it should be considered as not supported.
Since vSphere API 6.5 |
| perVMNetworkTrafficShapingSupported | xsd:boolean |
Indicates whether network traffic shaping on a
per virtual machine basis is supported.
Since vSphere API 4.0 |
| perVmSwapFiles | xsd:boolean |
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.
Since VI API 2.5 |
| pMemSnapshotSupported* | xsd:boolean |
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.
Since vSphere API 6.7 |
| pMemSupported* | xsd:boolean |
Indicates whether this host supports persistent memory.
If value is not specified, it should be considered as not supported.
Since vSphere API 6.7 |
| preAssignedPCIUnitNumbersSupported | xsd:boolean |
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.
unitNumber
This property is only available for devices on the pci controller.
Since VI API 2.5 |
| precisionTimeProtocolSupported* | xsd:boolean |
Indicates whether this host supports date time synchronization over
Precision Time Protocol (PTP).
Since vSphere API 7.0 |
| provisioningNicSelectionSupported | xsd:boolean |
Indicates whether a dedicated nic can be selected for vSphere Provisioning
NFC traffic.
Since vSphere API 6.0 |
| quickBootSupported* | xsd:boolean |
Indicates whether this host supports the LoadESX feature
which allows faster reboots. See QueryLoadEsxSupported Since vSphere API 6.7.1 |
| rebootSupported | xsd:boolean |
Flag indicating whether rebooting the host is supported.
|
| recordReplaySupported | xsd:boolean | Deprecated.
as of vSphere API 6.0
Indicates whether this host supports record and replay
Since vSphere API 4.0 |
| recursiveResourcePoolsSupported | xsd:boolean |
|
| reliableMemoryAware* | xsd:boolean |
Indicates that this host uses a reliable memory aware allocation policy.
Since vSphere API 5.5 |
| remoteDeviceVMotionSupported* | xsd:boolean |
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.
Since vSphere API 7.0 |
| replayCompatibilityIssues* | xsd:string[] | Deprecated.
as of vSphere API 6.0
For a host which doesn't support replay, indicates all the reasons
for the incompatibility. HostReplayUnsupportedReason
lists the set of possible values.
Since vSphere API 4.1 |
| replayUnsupportedReason* | xsd:string | Deprecated.
As of vSphere API 4.1, use
replayCompatibilityIssues.
For a host whose CPU doesn't support replay, indicates the reason
for the incompatibility. HostReplayUnsupportedReason
represents the set of possible values.
Since vSphere API 4.0 |
| restrictedSnapshotRelocateSupported | xsd:boolean |
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.
Since VI API 2.5 |
| sanSupported | xsd:boolean |
Flag indicating whether access to SAN devices is supported.
|
| scaledScreenshotSupported | xsd:boolean |
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.
Since VI API 2.5 |
| scheduledHardwareUpgradeSupported* | xsd:boolean |
Indicates whether the host supports scheduled hardware upgrades. See scheduledHardwareUpgradeInfo Since vSphere API 5.1 |
| screenshotSupported | xsd:boolean |
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.
Since VI API 2.5 |
| servicePackageInfoSupported* | xsd:boolean |
Indicates whether this host supports package information in service
configuration.
Since vSphere API 5.0 |
| shutdownSupported | xsd:boolean |
Flag indicating whether the host can be powered off
|
| smartCardAuthenticationSupported* | xsd:boolean |
Indicates whether this host supports local two-factor user
authentication using smart cards. See EnableSmartCardAuthentication Since vSphere API 6.0 |
| smpFtCompatibilityIssues* | xsd:string[] |
For a host which doesn't support smp fault tolerance, indicates all the
reasons for the incompatibility.
HostCapabilityFtUnsupportedReason lists the set of possible
values.
Since vSphere API 6.0 |
| smpFtSupported | xsd:boolean |
Indicates whether this host supports smp fault tolerance
Since vSphere API 6.0 |
| snapshotRelayoutSupported | xsd:boolean |
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.
Since vSphere API 5.0 |
| standbySupported | xsd:boolean |
Flag indicating whether you can put the host in a power down
state, from which it can be powered up automatically.
Since VI API 2.5 |
| storageIORMSupported | xsd:boolean |
Indicates whether the host supports storage I/O resource
management.
Since vSphere API 4.1 |
| storagePolicyChangeSupported* | xsd:boolean |
Indicates whether this host supports storage policy change.
Since vSphere API 7.0 |
| storagePolicySupported* | xsd:boolean |
Indicates that host supports Object-based Storage System and
Storage-Profile based disk provisioning.
Since vSphere API 5.5 |
| storageVMotionSupported | xsd:boolean |
Indicates whether the storage of a powered-on virtual machine may be
relocated.
Since vSphere API 4.0 |
| supportedCpuFeature* | HostCpuIdInfo[] | 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.
Since vSphere API 4.0 |
| supportedVmfsMajorVersion* | xsd:int[] |
List of VMFS major versions supported by the host.
Since vSphere API 5.0 |
| suspendedRelocateSupported | xsd:boolean |
Indicates whether this host supports relocation of
suspended virtual machines. Must be true on the source
and destination hosts for the relocation to work.
|
| tpmSupported | xsd:boolean |
Flag indicating whether this host supports the integrity measurement using
a TPM device.
Since vSphere API 4.0 |
| tpmVersion* | xsd:string |
TPM version if supported by this host.
Since vSphere API 6.7 |
| turnDiskLocatorLedSupported* | xsd:boolean |
Indicates whether turning on/off local disk LED is supported
on the host. See TurnDiskLocatorLedOn_Task See TurnDiskLocatorLedOff_Task Since vSphere API 6.0 |
| txtEnabled* | xsd:boolean |
Flag indicating whether Intel TXT is enabled on this host.
Since vSphere API 6.7 |
| unmapMethodSupported* | xsd:string |
Indicates which kind of VMFS unmap method is supported. See
HostCapabilityUnmapMethodSupported
Since vSphere API 6.7 |
| unsharedSwapVMotionSupported | xsd:boolean |
Flag indicating whether the host supports participating in a VMotion
where the virtual machine swapfile is not visible to the destination.
Since VI API 2.5 |
| upitSupported* | xsd:boolean |
Indicate whether this host supports UPIT
Since vSphere API 6.5 |
| useFeatureReqsForOldHWv* | xsd:boolean |
Indicates whether this host uses vmFeatures for compatiblity checking
of old (<=8) virtual hardware version VMs.
Since vSphere API 6.8.7 |
| vFlashSupported* | xsd:boolean |
Indicates whether the host supports vFlash.
Since vSphere API 5.5 |
| virtualExecUsageIgnored* | xsd:boolean |
Indicates that virtualExecUsage is
ignored by the host, always operating as if "hvOn" was selected.
Since vSphere API 6.7 |
| virtualExecUsageSupported | xsd:boolean |
Indicates whether the host supports configuring hardware
virtualization (HV) support for virtual machines.
Since vSphere API 4.0 |
| virtualMmuUsageIgnored* | xsd:boolean |
Indicates that virtualMmuUsage is
ignored by the host, always operating as if "on" was selected.
Since vSphere API 6.7 |
| virtualVolumeDatastoreSupported* | xsd:boolean |
Indicates whether this host supports VirtualVolume based Datastore.
Since vSphere API 6.0 |
| vlanTaggingSupported | xsd:boolean |
Is VLAN Tagging supported.
|
| vmCreateDateSupported* | xsd:boolean |
Indicates that createDate feature is supported by the host.
Since vSphere API 6.7 |
| vmDirectPathGen2Supported | xsd:boolean |
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
vmDirectPathGen2UnsupportedReason and/or in
vmDirectPathGen2UnsupportedReasonExtended. See vmDirectPathGen2Supported Since vSphere API 4.1 |
| vmDirectPathGen2UnsupportedReason* | xsd:string[] |
If vmDirectPathGen2Supported is false, this array will be
populated with reasons for the lack of support (chosen from
VmDirectPathGen2UnsupportedReason). If there is a reason for
the lack of support that cannot be described by the available constants,
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. Since vSphere API 4.1 |
| vmDirectPathGen2UnsupportedReasonExtended* | xsd:string |
If vmDirectPathGen2Supported is false, this property may
contain an explanation provided by the platform, beyond the reasons (if
any) enumerated in vmDirectPathGen2UnsupportedReason.
Since vSphere API 4.1 |
| vmfs3EOLSupported* | xsd:boolean |
Indicates whether this host supports VMFS-3 EOL.
If value is not specified, it should be considered as not supported.
Since vSphere API 6.7 |
| vmfsDatastoreMountCapable | xsd:boolean |
Indicates whether the host is capable of mounting/unmounting
VMFS datastores.
Since vSphere API 5.0 |
| vmotionAcrossNetworkSupported* | xsd:boolean |
Indicates whether the network of a powered-on virtual machine can be
changed while simultaneously changing the execution host of the
virtual machine.
Since vSphere API 5.5 |
| vmotionSupported | xsd:boolean |
Flag indicating whether you can perform VMotion.
|
| vmotionWithStorageVMotionSupported | xsd:boolean |
Indicates whether the storage of a powered-on virtual machine may be
relocated while simultaneously changing the execution host of the
virtual machine.
Since vSphere API 4.0 |
| vPMCSupported | xsd:boolean |
Indicates whether the host supports virtual CPU performance counters.
Since vSphere API 5.1 |
| vrNfcNicSelectionSupported | xsd:boolean |
Indicates whether a dedicated nic can be selected for vSphere Replication
NFC traffic, i.e., from the VR server to the secondary host.
Since vSphere API 6.0 |
| vsanSupported* | xsd:boolean |
Indicates whether the host supports VSAN functionality. See HostVsanSystem Since vSphere API 5.5 |
| vStorageCapable | xsd:boolean |
Indicates whether the host supports vStorage Hardware
acceleration.
Since vSphere API 4.1 |
| Properties inherited from DynamicData | ||
| None | ||
| Top of page | Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |