Get Clusters Software Add On

Released in v7.0.0

Returns the desired OEM add-on specification for a given cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Request

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/software/add-on

Path Parameters

Required	Parameter Name	Type	Description
required	cluster	string	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Header Parameters

Required	Parameter Name	Type	Description
required	vmware-api-session-id	string	Required session ID, obtained by first calling Create Session API

Response

Response Body

200 OK returns SettingsAddOnInfo of type application/json

Desired OEM add-on specification.

{
    "details": {
        "display_name": "string",
        "display_version": "string",
        "vendor": "string"
    },
    "name": "string",
    "version": "string"
}

Property Name	Type	Description
name	string	Name of the add-on
version	string	Version of the add-on
details	SettingsAddOnDetails	Details about the add-on. unset if add-on is not present in the depot.

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/add-on

Errors

Code	Returns	Description
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.
404	Error	com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. \| com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if desired OEM add-on specification is not found.
503	Error	com.vmware.vapi.std.errors.service_unavailable : If the service is not available.
default	Error	Not available