Set Clusters Software Drafts Software Components
Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. 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/components/{component}
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.
string
component
Required
Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.
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
string of mimetype application/json
Required
Component version. This field is currently required. In the future,if this field is unset then version is chosen based on the constraints in the system.
Authentication
This operation uses the following authentication methods.
Errors
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.
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
Invoke-SetClusterDraftComponentSoftware -Cluster "MyCluster" -Draft "MyDraft" -Component "MyComponent" -Body "MyBody"
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.0.0
