REST API - remove-task
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software
  6. solutions
  7. solutions internal

esx settings clusters software solutions solutions internal: remove-task

Remove solution's software components associated with the given cluster from hosts within the cluster. 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. This operation was added in vSphere API 7.0.1.0.

Request:

HTTP request

POST https://{server}/api/esx/settings/clusters/{cluster}/software/solutions-internal

?action=remove
&vmw-task=true
{
    "solution" : "obj-103",
    "hosts" : [
        "obj-103",
        "obj-103"
    ]
}

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Body Parameters:

Name Type Description
bold = required
- remove_spec esx.settings.clusters.software.solutions.solutions_internal.remove_spec specification.
-.solution string Solution identifier that corresponds to the solution whose components will be removed. This attribute was added in vSphere API 7.0.1.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.solution.
-.hosts string[] Hosts for which the solution components need to be removed. This attribute was added in vSphere API 7.0.1.0.

Optional. if unset or empty, solution is removed from all the hosts in the cluster.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string The result of the operation.

Errors:

HTTP Status Code Type Description
400 already_in_desired_state If the solution components have already been removed.
500 error If there is an internal error.
400 invalid_argument If spec specifies an invalid argument (eg. NSX-T solution Components Not removed from desired software spec).
404 not_found If there is no cluster associated with cluster in the system, or if the hosts in hosts cannot be found.
400 not_allowed_in_current_state If there is another operation in progress.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.