Get Clusters Software Reports Hardware Compatibility Details

Returns the HCL validation check detailed results. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.

Request

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details

Copy

Path Parameters

string

cluster Required

identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Header Parameters

string

vmware-api-session-id Required

Required session ID, acquired from Create Session API under CIS product

vmware-api-session-id example

"b00db39f948d13ea1e59b4d6fce56389"

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK returns SettingsClustersSoftwareReportsCheckResult of type application/json

CheckResult HCL validation result.

{
	"base_image_version": "string",
	"commit": "string",
	"note": {
		"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"
			}
		}
	},
	"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"
			}
		]
	},
	"pci_device_compliance": {
		"compatible_devices": [
			{
				"compatibility_guide_link": "string",
				"compatible_versions": [
					"string"
				],
				"device": {
					"did": "string",
					"display_name": "string",
					"driver_name": "string",
					"ssid": "string",
					"svid": "string",
					"vendor": "string",
					"vid": "string"
				},
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "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"
						}
					]
				},
				"status": "COMPATIBLE",
				"supported": [
					{
						"driver_name": "string",
						"driver_version": "string",
						"firmware_version": "string"
					}
				],
				"target": {
					"driver_name": "string",
					"driver_version": "string",
					"firmware_version": "string"
				}
			}
		],
		"incompatible_devices": [
			{
				"compatibility_guide_link": "string",
				"compatible_versions": [
					"string"
				],
				"device": {
					"did": "string",
					"display_name": "string",
					"driver_name": "string",
					"ssid": "string",
					"svid": "string",
					"vendor": "string",
					"vid": "string"
				},
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "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"
						}
					]
				},
				"status": "COMPATIBLE",
				"supported": [
					{
						"driver_name": "string",
						"driver_version": "string",
						"firmware_version": "string"
					}
				],
				"target": {
					"driver_name": "string",
					"driver_version": "string",
					"firmware_version": "string"
				}
			}
		],
		"incompatible_driver_firmware": [
			{
				"compatibility_guide_link": "string",
				"compatible_versions": [
					"string"
				],
				"device": {
					"did": "string",
					"display_name": "string",
					"driver_name": "string",
					"ssid": "string",
					"svid": "string",
					"vendor": "string",
					"vid": "string"
				},
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "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"
						}
					]
				},
				"status": "COMPATIBLE",
				"supported": [
					{
						"driver_name": "string",
						"driver_version": "string",
						"firmware_version": "string"
					}
				],
				"target": {
					"driver_name": "string",
					"driver_version": "string",
					"firmware_version": "string"
				}
			}
		],
		"status": "COMPATIBLE"
	},
	"scan_time": "string",
	"status": "COMPATIBLE",
	"storage_device_compliance": {
		"compatible_devices": [
			{
				"detail": "CERTIFIED",
				"firmware_version": "string",
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "string"
					}
				},
				"matches": [
					{
						"compatibility_guide_link": "string",
						"compatible_versions": [
							"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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"
					}
				],
				"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"
						}
					]
				},
				"status": "COMPATIBLE",
				"storage_device_info": {
					"capacity": 0,
					"model": "string",
					"part_number": "string",
					"vendor": "string"
				},
				"used_by_vsan": false
			}
		],
		"incompatible_devices": [
			{
				"detail": "CERTIFIED",
				"firmware_version": "string",
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "string"
					}
				},
				"matches": [
					{
						"compatibility_guide_link": "string",
						"compatible_versions": [
							"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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"
					}
				],
				"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"
						}
					]
				},
				"status": "COMPATIBLE",
				"storage_device_info": {
					"capacity": 0,
					"model": "string",
					"part_number": "string",
					"vendor": "string"
				},
				"used_by_vsan": false
			}
		],
		"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"
				}
			]
		},
		"status": "COMPATIBLE",
		"unknown_devices": [
			{
				"detail": "CERTIFIED",
				"firmware_version": "string",
				"host_info": {
					"key": {
						"is_vsan_witness": false,
						"name": "string"
					}
				},
				"matches": [
					{
						"compatibility_guide_link": "string",
						"compatible_versions": [
							"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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": {
													"Std_NestedLocalizableMessage": "Too large to render past this point..."
												},
												"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"
					}
				],
				"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"
						}
					]
				},
				"status": "COMPATIBLE",
				"storage_device_info": {
					"capacity": 0,
					"model": "string",
					"part_number": "string",
					"vendor": "string"
				},
				"used_by_vsan": false
			}
		]
	},
	"updated_since_last_check": false,
	"v_san_data_only": false
}

string

base_image_version Required

Target base image version E.g., version = BaseImageSpec->Version BaseImageSpec.version structure

StdLocalizableMessage

note Required

Localizable disclaimer notice to show on the UI detailing the type of checks are done by the HCL Validaiton. Example : HCL Validation is only done on storage and network controllers.

SettingsNotifications

notifications Required

Notifications returned by the HCL Validation operation.

string

scan_time Required

HCL Validation check time.

SettingsClustersSoftwareReportsComplianceStatus

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

string

commit Optional

Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation. This field will be unset if validation was performed against a draft. 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.commit. 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.commit.

SettingsClustersSoftwareReportsPciDeviceCompliance

pci_device_compliance Optional

Compliance result for the Pci Devices that are present in all hosts of the cluster. This field will be unset if Pci device compliance was not computed.

SettingsClustersSoftwareReportsStorageDeviceCompliance

storage_device_compliance Optional

Compliance result for storage devices in all the hosts of the cluster. Currently only includes SAS/SATA storage devices. This field will be unset if storage device compliance was not computed.

boolean

updated_since_last_check Optional

Flag to indicate if there were any hardware compatibility overrides were performed after the last check operation. This field is optional because it was added in a newer version than its parent node.

boolean

v_san_data_only Optional

HCL Validation Computed only for vSAN Clusters. unset to show vSAN in UI

Errors

Error

401

com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.

Error

404

com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if desired software document is not found.

Error

500

com.vmware.vapi.std.errors.error : If there is some other unknown internal error. The accompanying error message will give more details about the failure and any possible resolution(s).

Error

503

com.vmware.vapi.std.errors.service_unavailable : If the service is not available.

Code Samples

PowerCLI Client SDK Example

Invoke-GetClusterSoftwareReportsHardwareCompatibilityDetails -Cluster "MyCluster"

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: get

Availability

Added in 7.0.0

Get Clusters Software Reports Hardware Compatibility Details

On This Page

Request

URL

Path Parameters

Header Parameters

vmware-api-session-id example

Authentication

api_key

Response

Response Body

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

Availability

On This Page

Was this page helpful?