Esx. Settings. Clusters. Software. Drafts Create

Esx. Settings. Clusters. Software. Drafts Create

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this operation will create an empty draft.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error 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
URI
POST
https://{api_host}/esx/settings/clusters/{cluster}/software/drafts
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster

The parameter must be an identifier for the resource type: ClusterComputeResource.

Authentication
This operation uses the following authentication methods.
Responses
201

Identifier of the working copy of the document.

The response will be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

If there is already a draft created by this user.

Returns Vapi.Std.Errors.AlreadyExists of type(s) application/json 
"Vapi.Std.Errors.AlreadyExists Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated 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 -X POST -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/software/drafts
On This Page
Esx.settings.clusters.software.drafts Operations
GET
Esx. Settings. Clusters. Software. Drafts List
POST
Esx. Settings. Clusters. Software. Drafts Create
GET
Esx. Settings. Clusters. Software. Drafts Get
DELETE
Esx. Settings. Clusters. Software. Drafts Delete
POST
Esx. Settings. Clusters. Software. Drafts Import Software Spec
POST
Esx. Settings. Clusters. Software. Drafts Commit$ Task
POST
Esx. Settings. Clusters. Software. Drafts Validate$ Task
POST
Esx. Settings. Clusters. Software. Drafts Scan$ Task
POST
Esx. Settings. Clusters. Software. Drafts Check$ Task