Delete Clusters Software Solutions Task
Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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/solutions/{solution}?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
solution
Required
Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.
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"
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. ID of the newly created commit. The result will be an identifier for the resource type: com.vmware.esx.settings.commit.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteClusterSolutionAsync -Cluster "MyCluster" -Solution "MySolution"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}?vmw-task=true
Errors
400
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 ValidateResult.
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no solution associated with solution 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.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete_task
Availability
Added in 7.0.0
