Get Clusters Software Drafts Software Base Image
Returns the base-image specification in a software draft. 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/drafts/{draft}/software/base-image
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
draft
Required
Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
Settings_BaseImageInfo of type application/json
Base-image specification.
PowerCLI Client SDK Example
Invoke-GetClusterDraftSoftwareBaseImage -Cluster "MyCluster" -Draft "MyDraft"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no draft associated with draft in the system.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
Availability
Added in 7.0.0
