Get Cluster Software Reports Hardware Compatibility Details

Get Cluster 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
URI
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.


Authentication
This operation uses the following authentication methods.
Responses
200

CheckResult HCL validation result.

Returns Settings_Clusters_Software_Reports_CheckResult of type(s) application/json
{
    "status": "string",
    "scan_time": "string",
    "updated_since_last_check": false,
    "v_san_data_only": false,
    "commit": "string",
    "base_image_version": "string",
    "pci_device_compliance": {
        "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
        "compatible_devices": [
            {
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "device": {
                    "display_name": "string",
                    "driver_name": "string",
                    "vendor": "string",
                    "vid": "string",
                    "did": "string",
                    "svid": "string",
                    "ssid": "string"
                },
                "compatible_versions": [
                    "string"
                ],
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "target": {
                    "driver_version": "string",
                    "firmware_version": "string",
                    "driver_name": "string"
                },
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "supported": [
                    {
                        "driver_version": "string",
                        "firmware_version": "string",
                        "driver_name": "string"
                    }
                ],
                "constraints": [
                    {
                        "firmware_version": "string",
                        "firmware_version_match": "string",
                        "driver_name": "string",
                        "driver_version": "string",
                        "supported_features": {
                            "supported_features": [
                                "string"
                            ]
                        }
                    }
                ],
                "compatibility_guide_link": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "incompatible_devices": [
            {
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "device": {
                    "display_name": "string",
                    "driver_name": "string",
                    "vendor": "string",
                    "vid": "string",
                    "did": "string",
                    "svid": "string",
                    "ssid": "string"
                },
                "compatible_versions": [
                    "string"
                ],
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "target": {
                    "driver_version": "string",
                    "firmware_version": "string",
                    "driver_name": "string"
                },
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "supported": [
                    {
                        "driver_version": "string",
                        "firmware_version": "string",
                        "driver_name": "string"
                    }
                ],
                "constraints": [
                    {
                        "firmware_version": "string",
                        "firmware_version_match": "string",
                        "driver_name": "string",
                        "driver_version": "string",
                        "supported_features": {
                            "supported_features": [
                                "string"
                            ]
                        }
                    }
                ],
                "compatibility_guide_link": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "incompatible_driver_firmware": [
            {
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "device": {
                    "display_name": "string",
                    "driver_name": "string",
                    "vendor": "string",
                    "vid": "string",
                    "did": "string",
                    "svid": "string",
                    "ssid": "string"
                },
                "compatible_versions": [
                    "string"
                ],
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "target": {
                    "driver_version": "string",
                    "firmware_version": "string",
                    "driver_name": "string"
                },
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "supported": [
                    {
                        "driver_version": "string",
                        "firmware_version": "string",
                        "driver_name": "string"
                    }
                ],
                "constraints": [
                    {
                        "firmware_version": "string",
                        "firmware_version_match": "string",
                        "driver_name": "string",
                        "driver_version": "string",
                        "supported_features": {
                            "supported_features": [
                                "string"
                            ]
                        }
                    }
                ],
                "compatibility_guide_link": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": {
                                            "id": "string",
                                            "params": {
                                                "params": "Std_LocalizationParam Object"
                                            }
                                        },
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ]
    },
    "storage_device_compliance": {
        "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
        "compatible_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "detail": "string",
                "host_info": {
                    "host_info": "Settings_HostInfo Object"
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
                                "driver_name": "string",
                                "driver_version": "string",
                                "supported_features": {
                                    "supported_features": [
                                        "string"
                                    ]
                                }
                            }
                        ],
                        "vcg_product": "string",
                        "model": "string",
                        "partner": "string",
                        "compatibility_guide_link": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notifications": "Settings_Notifications Object"
                    }
                ],
                "used_by_vsan": false,
                "notifications": "Settings_Notifications Object"
            }
        ],
        "incompatible_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "detail": "string",
                "host_info": {
                    "host_info": "Settings_HostInfo Object"
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
                                "driver_name": "string",
                                "driver_version": "string",
                                "supported_features": {
                                    "supported_features": [
                                        "string"
                                    ]
                                }
                            }
                        ],
                        "vcg_product": "string",
                        "model": "string",
                        "partner": "string",
                        "compatibility_guide_link": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notifications": "Settings_Notifications Object"
                    }
                ],
                "used_by_vsan": false,
                "notifications": "Settings_Notifications Object"
            }
        ],
        "unknown_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                "detail": "string",
                "host_info": {
                    "host_info": "Settings_HostInfo Object"
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
                                "driver_name": "string",
                                "driver_version": "string",
                                "supported_features": {
                                    "supported_features": [
                                        "string"
                                    ]
                                }
                            }
                        ],
                        "vcg_product": "string",
                        "model": "string",
                        "partner": "string",
                        "compatibility_guide_link": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notifications": "Settings_Notifications Object"
                    }
                ],
                "used_by_vsan": false,
                "notifications": "Settings_Notifications Object"
            }
        ],
        "notifications": "Settings_Notifications Object"
    },
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": {
                                "id": "string",
                                "params": {
                                    "params": "Std_LocalizationParam Object"
                                }
                            },
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ]
    },
    "note": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    }
}
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

string As date-time
scan_time
Required

HCL Validation check time.

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

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.

string
base_image_version
Required

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

pci_device_compliance
Optional

The PciDeviceCompliance structure contains information that describe the compliance result of all pci device from all hosts in the clsuter with respect to the component present in the target software specification.

storage_device_compliance
Optional

The StorageDeviceCompliance structure contains information that describe the compliance result of all storage devices from all hosts in the cluster with respect to the storage device model and the firmware certification

notifications
Required

The Notifications structure contains info/warning/error messages that can be reported by the task.

note
Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.


401

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

Returns Std_Errors_Error of type(s) application/json
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
messages
Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

error_type
Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.


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.

Returns Std_Errors_Error of type(s) application/json
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
messages
Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

error_type
Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.


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).

Returns Std_Errors_Error of type(s) application/json
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
messages
Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

error_type
Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.


503

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

Returns Std_Errors_Error of type(s) application/json
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
messages
Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

error_type
Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.


default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
messages
Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

error_type
Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.