VsanHclControllerInfo

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

AllOf

This class requires all of the following:

JSON Example

{
    "_typeName": "string",
    "deviceName": "string",
    "deviceDisplayName": "string",
    "driverName": "string",
    "driverVersion": "string",
    "vendorId": 0,
    "deviceId": 0,
    "subVendorId": 0,
    "subDeviceId": 0,
    "extraInfo": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "deviceOnHcl": false,
    "releaseSupported": false,
    "releasesOnHcl": [
        "string"
    ],
    "driverVersionsOnHcl": [
        "string"
    ],
    "driverVersionSupported": false,
    "fwVersionSupported": false,
    "fwVersionOnHcl": [
        "string"
    ],
    "cacheConfigSupported": false,
    "cacheConfigOnHcl": [
        "string"
    ],
    "raidConfigSupported": false,
    "raidConfigOnHcl": [
        "string"
    ],
    "fwVersion": "string",
    "raidConfig": "string",
    "cacheConfig": "string",
    "cimProviderInfo": {
        "_typeName": "string",
        "cimProviderSupported": false,
        "installedCIMProvider": "string",
        "cimProviderOnHcl": [
            "string"
        ],
        "cimProviderLinksOnHcl": [
            {
                "_typeName": "string",
                "url": "string",
                "sha1sum": "string",
                "formatType": "string",
                "itemId": "string"
            }
        ]
    },
    "usedByVsan": false,
    "disks": [
        {
            "_typeName": "string",
            "deviceName": "string",
            "model": "string",
            "isSsd": false,
            "vsanDisk": false,
            "issues": [
                {
                    "_typeName": "string",
                    "faultCause": "MethodFault Object",
                    "faultMessage": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "arg": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "value": {
                                        "_typeName": "string"
                                    }
                                }
                            ],
                            "message": "string"
                        }
                    ]
                }
            ],
            "remediableIssues": [
                "string"
            ],
            "uuid": "string",
            "capacity": 0,
            "vsanCompatibility": [
                "string"
            ]
        }
    ],
    "issues": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "remediableIssues": [
        "string"
    ],
    "driversOnHcl": [
        {
            "_typeName": "string",
            "driverVersion": "string",
            "driverLink": {
                "_typeName": "string",
                "url": "string",
                "sha1sum": "string",
                "formatType": "string",
                "itemId": "string"
            },
            "fwVersion": "string",
            "fwLinks": [
                {
                    "_typeName": "string",
                    "url": "string",
                    "sha1sum": "string",
                    "formatType": "string",
                    "itemId": "string"
                }
            ],
            "toolsLinks": [
                {
                    "_typeName": "string",
                    "url": "string",
                    "sha1sum": "string",
                    "formatType": "string",
                    "itemId": "string"
                }
            ],
            "eula": "string",
            "driverType": "string",
            "driverName": "string",
            "diskModes": [
                "string"
            ],
            "supportedFeatures": [
                "string"
            ]
        }
    ],
    "fwAuxVersion": "string",
    "queueDepth": 0,
    "queueDepthOnHcl": 0,
    "queueDepthSupported": false,
    "diskMode": "string",
    "diskModeOnHcl": [
        "string"
    ],
    "diskModeSupported": false,
    "toolName": "string",
    "toolVersion": "string",
    "productId": "string",
    "diskCapacity": 0,
    "vcgEntryInfo": [
        {
            "_typeName": "string",
            "vcgId": 0,
            "vcgModelName": "string"
        }
    ],
    "controllerType": "string",
    "userSelectedVcgId": 0,
    "vsanCompatibility": [
        "string"
    ]
}

string

deviceName

Required

The device name used by ESX to refer to the device right now, e.g.

vmhba1.

string

deviceDisplayName

Optional

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

string

driverName

Optional

The name of the driver, e.g.

mpt2sas.

string

driverVersion

Optional

The version of the driver as reported by the driver kernel module, e.g.

'4.23.01.00-9vmw'.

integer As int64 As int64

vendorId

Optional

The vendorId of the PCI device, e.g.

integer As int64 As int64

deviceId

Optional

The deviceId of the PCI device, e.g.

integer As int64 As int64

subVendorId

Optional

The subVendorId of the PCI device, e.g.

integer As int64 As int64

subDeviceId

Optional

The subDeviceId of the PCI device, e.g.

array of KeyValue

extraInfo

Optional

Any additional information not explicitly modeled in API.

Can be used for vendor specific information about features of a controller.

boolean

deviceOnHcl

Optional

If the device shows up on the HCL at all.

boolean

releaseSupported

Optional

If the device is on the HCL and the release of ESXi in use is supported.

array of string

releasesOnHcl

Optional

If the device is on the HCL, this holds the names of the supported releases.

array of string

driverVersionsOnHcl

Optional

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

boolean

driverVersionSupported

Optional

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

boolean

fwVersionSupported

Optional

Ignore this value.

array of string

fwVersionOnHcl

Optional

Ignore this value.

boolean

cacheConfigSupported

Optional

Ignore this value.

array of string

cacheConfigOnHcl

Optional

Ignore this value.

boolean

raidConfigSupported

Optional

Ignore this value.

array of string

raidConfigOnHcl

Optional

Ignore this value.

string

fwVersion

Optional

Ignore this value.

string

raidConfig

Optional

This field is not used.

string

cacheConfig

Optional

This field is not used.

cimProviderInfo

Optional

This field is not used.

boolean

usedByVsan

Optional

Used by vSAN.

If not set, "True" should be assumed.

array of VsanHclDiskInfo

disks

Optional

Additional information about disks behind this controller, if available.

array of MethodFault

issues

Optional

Any issues detected with the configuration of the the controller.

array of string

remediableIssues

Optional

Keys of issues which can be remediated.

array of VsanHclDriverInfo

driversOnHcl

Optional

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.

string

fwAuxVersion

Optional

Auxiliary firmware version.

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

integer As int64 As int64

queueDepth

Optional

The maximum supported queue depth for the controller.

integer As int64 As int64

queueDepthOnHcl

Optional

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.

boolean

queueDepthSupported

Optional

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.

string

diskMode

Optional

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

array of string

diskModeOnHcl

Optional

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.

boolean

diskModeSupported

Optional

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.

string

toolName

Optional

The name of the vendor tool.

E.g., perccli.

string

toolVersion

Optional

The version of the vendor tool.

string

productId

Optional

The product ID of a controller.

Only applicable for devices like NVMe.

integer As int64 As int64

diskCapacity

Optional

The capacity of a disk under the controller.

The Unit is byte. Only applicable for devices like NVMe.

array of VsanVcgDeviceInfo

vcgEntryInfo

Optional

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.

string

controllerType

Optional

Refer to VsanControllerTypeEnum