REST API - get
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software

esx settings clusters software: get

Returns the complete desired software specification.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "hardware_support" : {
        "packages" : {
            "obj-103" : {
                "pkg" : "obj-103",
                "version" : "string"
            }
        }
    },
    "components" : {
        "obj-103" : {
            "details" : {
                "vendor" : "string",
                "display_version" : "string",
                "display_name" : "string"
            },
            "version" : "string"
        }
    },
    "base_image" : {
        "details" : {
            "release_date" : "2015-01-01T22:13:05.651Z",
            "display_version" : "string",
            "display_name" : "string"
        },
        "version" : "string"
    },
    "solutions" : {
        "obj-103" : {
            "components" : [
                {
                    "component" : "obj-103"
                },
                {
                    "component" : "obj-103"
                }
            ],
            "details" : {
                "components" : [
                    {
                        "component" : "obj-103",
                        "display_version" : "string",
                        "vendor" : "string",
                        "display_name" : "string"
                    },
                    {
                        "component" : "obj-103",
                        "display_version" : "string",
                        "vendor" : "string",
                        "display_name" : "string"
                    }
                ],
                "display_version" : "string",
                "display_name" : "string"
            },
            "version" : "string"
        }
    },
    "add_on" : {
        "name" : "string",
        "details" : {
            "vendor" : "string",
            "display_version" : "string",
            "display_name" : "string"
        },
        "version" : "string"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- software_info Cluster software specification.
-.base_image base_image_info Base image of the ESX.
-.base_image.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.
-.base_image.details.display_name string Display name of the base-image.
-.base_image.details.display_version string Human readable version of the base-image.
-.base_image.details.release_date date_time Release date of the base-image.
-.base_image.version string Version of the base-image
-.add_on add_on_info OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

Optional. If unset, no OEM customization will be applied.
-.add_on.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.
-.add_on.details.display_name string Display name of the OEM add-on.
-.add_on.details.vendor string Vendor of the OEM add-on.
-.add_on.details.display_version string Human readable version of the OEM add-on.
-.add_on.name string Name of the add-on
-.add_on.version string Version of the add-on
-.components object Information about the components in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info.
-.components.* component_info
-.components.*.version string Version of the component.

Optional. unset if version is not specified.
-.solutions object Information about the solutions in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.solution.Object with element values of type solution_info.
-.hardware_support hardware_support_info Information about the Hardware Support Packages (HSP) configured.

Optional. If unset, no Hardware Support Package (HSP) is specified for the cluster.
-.hardware_support.packages object Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.Object with element values of type hardware_support_package_info.

Errors:

HTTP Status Code Type Description
500 error If there is 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.