Commit Clusters Software Drafts Task
Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}?action=commit&vmw-task=true
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 draft. 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
SettingsClustersSoftwareDraftsCommitSpec of mimetype application/json
Required
The spec to be used to create the commit.
{
"message": "string"
}
string
message
Optional
Message to include with the commit. If unset, message is set to empty string.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. Identifier of the commit. The result will be an identifier for the resource type: com.vmware.esx.settings.commit.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If there is another operation in progress. | com.vmware.vapi.std.errors.invalid_argument : If validation of the software document fails. The value of the data field of Error will be a structure that contains all the fields defined in Drafts.ValidateResult.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$SettingsClustersSoftwareDraftsCommitSpec = Initialize-SettingsClustersSoftwareDraftsCommitSpec -Message "MyMessage"
Invoke-CommitClusterDraftAsync -Cluster "MyCluster" -Draft "MyDraft" -SettingsClustersSoftwareDraftsCommitSpec $SettingsClustersSoftwareDraftsCommitSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"message":"string"}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}?action=commit&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: commit_task
Availability
Added in 7.0.0.0
