REST API - list

esx settings clusters software components: list

Returns a list of components in the desired software specification.

Request:

HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/components

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103"{
        "details"{
            "vendor""string",
            "display_version""string",
            "display_name""string"
        },
        "version""string"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component.Object with element values of type component_info.
-.* component_info
-.*.version string Version of the component.

Optional. unset if version is not specified.

-.*.details component_details Details about the component.

Optional. unset if component is not present in the depot.

-.*.details.display_name string Display name of the component.

-.*.details.vendor string Vendor of the component.

-.*.details.display_version string Human readable version of the component.

Optional. unset if no version is provided for the component.

Errors:

HTTP Status Code Type Description
500 error If there is some unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.