|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| 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. |
| 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 |
| 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.
|
| 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 |
| 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 |
| highGuestMemSupported | xsd:boolean |
Is high guest memory supported.
|
| 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.
|
| 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
|
| 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.
|
| 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.
|
| nfsSupported | xsd:boolean |
Is access to NFS devices supported.
|
| nicTeamingSupported | xsd:boolean |
Is NIC teaming supported.
|
| 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 |
| 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 |
| 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 |
|
| 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 |
| 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 |
| shutdownSupported | xsd:boolean |
Flag indicating whether the host can be powered off
|
| 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 |
| storageVMotionSupported | xsd:boolean |
Indicates whether the storage of a powered-on virtual machine may be
relocated.
Since vSphere API 4.0 |
| supportedCpuFeature* | HostCpuIdInfo[] |
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 |
| 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 |
| 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 |
| virtualExecUsageSupported | xsd:boolean |
Indicates whether the host supports configuring hardware
virtualization (HV) support for virtual machines.
Since vSphere API 4.0 |
| vlanTaggingSupported | xsd:boolean |
Is VLAN Tagging supported.
|
| 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 |
| 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 |
| 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 |