Update Clusters Software Drafts Software Components
Released in v7.0.0Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. 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
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
| required |
|
string | Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains SettingsClustersSoftwareDraftsSoftwareComponentsUpdateSpec
of type application/json
(required)
{
"components_to_delete": [
"string"
],
"components_to_set": {
"key": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | components_to_delete | array of string |
List of components to be removed. If unset, no components will be removed. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.esx.settings.component. |
| optional | components_to_set | map of string |
List of components to be updated. If the component already exists in the draft, the version is updated, else it is added. If a component is provided without version, then its version will be chosen based on constraints in the system. If unset, no components will be added or updated. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.esx.settings.component. |
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"components_to_delete":["string"],"components_to_set":{"key":"string"}}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no draft associated with draft in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
