vSAN Management API


Data Object - VsanHclControllerInfo(vim.host.VsanHclControllerInfo)

Property of
VsanHostHclInfo
Extends
DynamicData
See also
KeyValue, LocalizedMethodFault, VsanHclDiskInfo, VsanHclDriverInfo, VsanHostCimProviderInfo, VsanVcgDeviceInfo
Since
vSphere API Release 5.5

Data Object Description

Captures all vSAN HCL related information about particular SCSI/RAID controller.

Properties

Name Type Description
cacheConfig*xsd:string

This field is not used.
cacheConfigOnHcl*xsd:string[]

Ignore this value.
cacheConfigSupported*xsd:boolean

Ignore this value.
cimProviderInfo*VsanHostCimProviderInfo

This field is not used.
controllerType*xsd:string

Refer to VsanControllerType
See VsanControllerType

Since vSAN 7.0U3
deviceDisplayName*xsd:string

The human friendly product model description by which the controller announces itself, e.g., "Intel Corporation PIIX4 ...".
deviceId*xsd:long

The deviceId of the PCI device, e.g. 48.
deviceNamexsd:string

The device name used by ESX to refer to the device right now, e.g. vmhba1.
deviceOnHcl*xsd:boolean

If the device shows up on the HCL at all.
diskCapacity*xsd:long

The capacity of a disk under the controller. The Unit is byte. Only applicable for devices like NVMe.

Since vSAN 7.0U3
diskMode*xsd:string

The disk mode (all flash or hybrid) for the disks on the controller.

Since 6.6
diskModeOnHcl*xsd:string[]

If the device shows up on the HCL, and is supported for the release of ESXi, this field will show the supported disk mode on HCL.

Since 6.6
diskModeSupported*xsd:boolean

If the device shows up on the HCL, and is supported for the release of ESXi, this field checks if the disk mode of the controller is supported.

Since 6.6
disks*VsanHclDiskInfo[]

Additional information about disks behind this controller, if available.

Since 6.6
driverName*xsd:string

The name of the driver, e.g. mpt2sas.
driversOnHcl*VsanHclDriverInfo[]

If the device shows up on the HCL, and is supported for the release of ESXi, this field will list the supported driver versions, as well as additional information for each driver, like associated firmware.

Since 6.6
driverVersion*xsd:string

The version of the driver as reported by the driver kernel module, e.g. '4.23.01.00-9vmw'.
driverVersionsOnHcl*xsd:string[]

If the device shows up on the HCL, and is supported for the release of ESXi, this field will list the supported driver versions.
driverVersionSupported*xsd:boolean

If the device shows up on the HCL, and is supported for the release of ESXi, and the driver version is detected to be supported
extraInfo*KeyValue[]

Any additional information not explicitly modeled in API. Can be used for vendor specific information about features of a controller.
fwAuxVersion*xsd:string

Auxiliary firmware version. Some controllers use an additional firmware version, e.g. a "bundle version" or "build version". If present, its populated here.

Since 6.6
fwVersion*xsd:string

Ignore this value.
fwVersionOnHcl*xsd:string[]

Ignore this value.
fwVersionSupported*xsd:boolean

Ignore this value.
issues*LocalizedMethodFault[]

Any issues detected with the configuration of the the controller.

Since 6.6
productId*xsd:string

The product ID of a controller. Only applicable for devices like NVMe.

Since vSAN 7.0U3
queueDepth*xsd:long

The maximum supported queue depth for the controller.

Since 6.6
queueDepthOnHcl*xsd:long

If the device shows up on the HCL, and is supported for the release of ESXi, this field will show the supported queue depth for the controller.

Since 6.6
queueDepthSupported*xsd:boolean

If the device shows up on the HCL, and is supported for the release of ESX, this field checks if the controller's queue depth is supported.

Since 6.6
raidConfig*xsd:string

This field is not used.
raidConfigOnHcl*xsd:string[]

Ignore this value.
raidConfigSupported*xsd:boolean

Ignore this value.
releasesOnHcl*xsd:string[]

If the device is on the HCL, this holds the names of the supported releases.
releaseSupported*xsd:boolean

If the device is on the HCL and the release of ESXi in use is supported.
remediableIssues*xsd:string[]

Keys of issues which can be remediated.

Since 6.6
subDeviceId*xsd:long

The subDeviceId of the PCI device, e.g. 5549.
subVendorId*xsd:long

The subVendorId of the PCI device, e.g. 6518.
toolName*xsd:string

The name of the vendor tool. E.g., perccli.

Since vSAN 6.7U3
toolVersion*xsd:string

The version of the vendor tool.

Since vSAN 6.7U3
usedByVsan*xsd:boolean

Used by vSAN. If not set, "True" should be assumed.

Since 6.6
userSelectedVcgId*xsd:int

The vSAN VCG ID selected by the user. This field will be empty if user has never made a selection, or this controller has a unique mapping to its vSAN VCG entry originally.

Since vSAN 7.0U3
vcgEntryInfo*VsanVcgDeviceInfo[]

A list of the matching models in vSAN VCG, the length of the list will be larger than 1 if this controller's PCI ID is used by other devices like NVMe on the vSAN VCG. Otherwise, the length will be 1, which means there is a unique mapping from this controller to a vSAN VCG entry.

Since vSAN 7.0U3
vendorId*xsd:long

The vendorId of the PCI device, e.g. 4096.
vsanCompatibility*xsd:string[]

A list of vSAN configurations supported by this controller.
See VsanConfigType

Since 8.0.0.1
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition