Vsan Vc Cluster Health System Vsan Get Hcl Constraints

Vsan Vc Cluster Health System Vsan Get Hcl Constraints
Get the HCL driver/firmware constraints for PCIe devices used by vSAN in the cluster.

Get the HCL driver/firmware constraints for PCIe devices used by vSAN in the cluster.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetHclConstraints
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanVcClusterHealthSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body
VsanGetHclConstraintsRequestType of type(s) application/json
Required

Show optional properties

{
    "cluster": {},
    "release": "string"
}
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "release": "string"
}
cluster
Required

The target vSAN cluster

Required privileges: System.Read

string
release
Required

The target vSphere release

Authentication
This operation uses the following authentication methods.
Responses
200

The HCL driver constraints for all the PCIe device used by vSAN, and current firmware versions of that device in the cluster.

Returns VsanHclReleaseConstraint of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "release": "string",
    "hostDevices": [
        {
            "_typeName": "string",
            "hostname": "string",
            "devices": [
                {
                    "_typeName": "string",
                    "deviceName": "string",
                    "pciId": "string",
                    "fwVersion": "string",
                    "features": [
                        "string"
                    ]
                }
            ]
        }
    ],
    "constraints": [
        {
            "_typeName": "string",
            "pciId": "string",
            "vcgLink": "string",
            "similarVcgLinks": [
                "string"
            ],
            "compliantFirmwares": [
                {
                    "_typeName": "string",
                    "firmwareVersion": "string",
                    "compliantDrivers": [
                        {
                            "_typeName": "string",
                            "driverName": "string",
                            "driverVersion": "string",
                            "supportedFeatures": [
                                "string"
                            ]
                        }
                    ]
                }
            ],
            "vcgId": 0,
            "model": "string",
            "partner": "string",
            "partNumber": "string",
            "release": "string"
        }
    ]
}
cluster
Required

The vSAN cluster.

string
release
Required

Target vSphere release.

array of object
hostDevices
Optional

Host devices.

array of object
constraints
Optional

PCI Device HCL constraints.


500

NotSupported: if run directly on an ESX Server host.

NotFound:

VsanFault: If unexpected error happened during the query, such as the cluster HCL info is unable to be retrieved, etc.

NotSupported:

Returns MethodFault of type(s) application/json
This response body class contains all of the following: Any 
{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}","release":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetHclConstraints
On This Page
V San Service Api Operations
POST
Vsan Vc Cluster Health System Vsan Attach Vsan Support Bundle To Sr
POST
Vsan Vc Cluster Health System Vsan Download And Install Vendor Tool Task
Deprecated
POST
Vsan Vc Cluster Health System Vsan Download Hcl File Task
Deprecated
POST
Vsan Vc Cluster Health System Vsan Get Hcl Constraints
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Get Hcl Info
POST
Vsan Vc Cluster Health System Vsan Get Release Recommendation
POST
Vsan Vc Cluster Health System Vsan Get Disk Hcl Constraints
POST
Vsan Vc Cluster Health System Vsan Get Hcl Info For Eligible Disks
POST
Vsan Vc Cluster Health System Vsan Health Get Vsan Cluster Silent Checks
POST
Vsan Vc Cluster Health System Vsan Health Is Rebalance Running
POST
Vsan Vc Cluster Health System Vsan Purge Hcl Files
Deprecated
POST
Vsan Vc Cluster Health System Vsan Query All Supported Health Checks
POST
Vsan Vc Cluster Health System Vsan Query Attach To Sr History
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Create Vm Health History Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Create Vm Health Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Health Summary
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Health Summary Task
POST
Vsan Vc Cluster Health System Vsan Query Cluster Historical Health
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf History Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf Task
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Vmdk Load History Test
Deprecated
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Vmdk Workload Types
Deprecated
POST
Vsan Vc Cluster Health System Vsan Cluster Query File Service Health Summary
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Smart Stats Summary
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Query Verify Health System Versions
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Cluster Health Check Interval
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Cluster Health Config
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Obj Ext Attrs
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Proxy Config
POST
Vsan Vc Cluster Health System Vsan Rebalance Cluster
POST
Vsan Vc Cluster Health System Vsan Health Repair Cluster Objects Immediate
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Run Vmdk Load Test
Deprecated
POST
Vsan Vc Cluster Health System Vsan Health Send Vsan Telemetry
POST
Vsan Vc Cluster Health System Vsan Health Set Log Level
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Health Check Interval
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Silent Checks
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Telemetry Config
POST
Vsan Vc Cluster Health System Set Vsan Vcg Mapping For Hw Devices
POST
Vsan Vc Cluster Health System Vsan Stop Rebalance Cluster
POST
Vsan Vc Cluster Health System Vsan Health Test Vsan Cluster Telemetry Proxy
POST
Vsan Vc Cluster Health System Vsan Health Update Default DS Policy Recommendation
POST
Vsan Vc Cluster Health System Vsan Vc Update Hcl Db From Web
POST
Vsan Vc Cluster Health System Vsan Vc Upload Hcl Db