SettingsClustersSoftwareReportsStorageDeviceCompatibility

The StorageDeviceCompatibility structure contains information that describe the compliance of a storage device with respect to the component present in the target software specification.

Properties

string as uri

compatibility_guide_link Required

Provides link to the VMware Compatibility Guide (VCG) listing for further information on the compatibility.

array of string

compatible_versions Optional

List of vSphere Versions compatible for this storage device. This field will be unset if the storage device is certified for the target ESXi version.

array of SettingsClustersSoftwareReportsStorageDeviceConstraint

constraints Optional

List of Supported Firmware Versions and corresponding supported features from VMware Compatibility Guide (VCG) listing for the given vSphere version. This field is optional because it was added in a newer version than its parent node.

string

model Required

Model name of the storage device as listed in the VMware Compatibility Guide (VCG) listing. This may not be the same as the StorageDeviceInfo.model

SettingsNotifications

notifications Optional

VMware compatibility Guide (VCG) listing specific notifications describing the compliance result. This field will be unset if there are no notifications

string

partner Required

OEM partner name of the storage device as listed in the VMware Compatibility Guide (VCG) listing.

SettingsClustersSoftwareReportsComplianceStatus Enum

status Required

The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
COMPATIBLE : Target hardware is compliant with VMware Compatibility Guide (VCG)
INCOMPATIBLE : Target hardware is not (recognizably) compliant with VMware Compatibility Guide (VCG)
HCL_DATA_UNAVAILABLE : HCL data can not be fetched to validate cluster hardware.
UNAVAILABLE : Target hardware compliance with VMware Compatibility Guide (VCG) cannot be determined.
NO_FIRMWARE_PROVIDER : No Firmware HSM present in Software Spec to get Firmware Details HardwareSupportPackageInfo structure

Possible values are: COMPATIBLE , INCOMPATIBLE , HCL_DATA_UNAVAILABLE , UNAVAILABLE , NO_FIRMWARE_PROVIDER

array of string

supported_firmware_versions Optional

List of minimum firmware versions supported from VMware Compatibility Guide (VCG) listing for the given vSphere version. This field will be unset if the storage device is not certified for the target ESXi version or the storage device is only certified in combination with specific driver versions, in which case listedDriverFirmwareVersions below will be set.

boolean

used_for_compliance Required

Flag to indicate whether this VMware compatibility Guide (VCG) listing was used to compute the overall compatibility of the storage device.

boolean

user_selected Required

Flag to indicate if the user has selected this VMware Compatibility Guide (VCG) listing to be considered to compute the overall compatibility of the storage device.

string

vcg_product Required

Identifier of the VMware Compatibility Guide (VCG) listing for the product. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.vcg_product. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.vcg_product.

JSON Example

Show optional properties

{
	"compatibility_guide_link": "string",
	"model": "string",
	"partner": "string",
	"status": "COMPATIBLE",
	"used_for_compliance": false,
	"user_selected": false,
	"vcg_product": "string"
}

{
	"compatibility_guide_link": "string",
	"compatible_versions": [
		"string"
	],
	"constraints": [
		{
			"driver_name": "string",
			"driver_version": "string",
			"firmware_version": "string",
			"firmware_version_match": "EXACT",
			"supported_features": {
				"key": "string"
			}
		}
	],
	"model": "string",
	"notifications": {
		"errors": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"info": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"warnings": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		]
	},
	"partner": "string",
	"status": "COMPATIBLE",
	"supported_firmware_versions": [
		"string"
	],
	"used_for_compliance": false,
	"user_selected": false,
	"vcg_product": "string"
}

SettingsClustersSoftwareReportsStorageDeviceCompatibility

Properties

JSON Example

Was this page helpful?