Data Object - HostCapability

Property of
HostSystem
Extends
DynamicData

Data Object Description

Specifies the capabilities of the particular host. This set of capabilities is referenced in other parts of the API specification to indicate under what circumstances an API will throw a NotSupported fault.

Properties

Name Type Description
backgroundSnapshotsSupportedxsd:boolean

Flag indicating whether background snapshots are supported on this host.

Since VI API 2.5
cpuMemoryResourceConfigurationSupportedxsd: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
datastorePrincipalSupportedxsd:boolean

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

Is high guest memory supported.
iscsiSupportedxsd:boolean

Is access to iSCSI devices supported.
localSwapDatastoreSupportedxsd: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
maintenanceModeSupportedxsd: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.
nfsSupportedxsd:boolean

Is access to NFS devices supported.
nicTeamingSupportedxsd:boolean

Is NIC teaming supported.
perVmSwapFilesxsd: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
preAssignedPCIUnitNumbersSupportedxsd: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
rebootSupportedxsd:boolean

Flag indicating whether rebooting the host is supported.
recursiveResourcePoolsSupportedxsd:boolean


restrictedSnapshotRelocateSupportedxsd: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
sanSupportedxsd:boolean

Flag indicating whether access to SAN devices is supported.
scaledScreenshotSupportedxsd: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
screenshotSupportedxsd: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
shutdownSupportedxsd:boolean

Flag indicating whether the host can be powered off
standbySupportedxsd: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
suspendedRelocateSupportedxsd: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.
unsharedSwapVMotionSupportedxsd: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
vlanTaggingSupportedxsd:boolean

Is VLAN Tagging supported.
vmotionSupportedxsd:boolean

Flag indicating whether you can perform VMotion.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition