Developer Documentation
List Clusters Software Components
Released in v7.0.0Returns a list of components in the desired software specification. 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/components
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Response
Response
Response BodyResponse Body
200 OK returns
map of
SettingsComponentInfo
of type application/json
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. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.component.
{
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
}| Property Name | Type | Description |
|---|---|---|
| details | SettingsComponentDetails |
Details about the component. unset if component is not present in the depot. |
| version | string |
Version of the component. unset if version is not specified. |
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 some 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. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
