Set Clusters Software Drafts Software Base Image
Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
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
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
PowerCLI Client SDK Example
$SettingsBaseImageSpec = Initialize-SettingsBaseImageSpec -Version "MyVersion"
Invoke-SetClusterDraftSoftwareBaseImage -Cluster "MyCluster" -Draft "MyDraft" -SettingsBaseImageSpec $SettingsBaseImageSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"version":"string"}' 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 some unknown internal error. The accompanying error message will give more details about the failure.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.0
