Esx. Settings. Clusters. Software. Alternative Images List
Returns a list of image info of the alternative images for a given cluster.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error 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
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/software/alternative-images
COPY
Path Parameters
string
cluster
Required
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Responses
200
ListResult Image info of all the alternative images for a given cluster.
Returns
Esx.Settings.Clusters.Software.AlternativeImages.ListResult
of type(s)
application/json
"Esx.Settings.Clusters.Software.AlternativeImages.ListResult Object"
401
If the caller is not authenticated.
Returns
Vapi.Std.Errors.Unauthenticated
of type(s)
application/json
"Vapi.Std.Errors.Unauthenticated Object"
403
If the caller does not have the necessary privileges.
Returns
Vapi.Std.Errors.Unauthorized
of type(s)
application/json
"Vapi.Std.Errors.Unauthorized Object"
404
If there is no cluster associated with cluster in the system.
Returns
Vapi.Std.Errors.NotFound
of type(s)
application/json
"Vapi.Std.Errors.NotFound Object"
500
If there is unknown internal error. The accompanying error message will give more details about the failure.
Returns
Vapi.Std.Errors.Error
of type(s)
application/json
"Vapi.Std.Errors.Error Object"
503
If the service is not available.
Returns
Vapi.Std.Errors.ServiceUnavailable
of type(s)
application/json
"Vapi.Std.Errors.ServiceUnavailable Object"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/software/alternative-images
Esx.settings.clusters.software.alternative Images Operations
GET
Esx. Settings. Clusters. Software. Alternative Images Get
GET
Esx. Settings. Clusters. Software. Alternative Images List