Update Clusters Software Drafts Software Components
Updates 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
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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
SettingsClustersSoftwareDraftsSoftwareComponentsUpdateSpec of mimetype application/json
Required
Update specification containing list of components to add and/or delete.
{
"components_to_delete": [
"string"
],
"components_to_set": {
"key": "string"
}
}
array of
string
components_to_delete
Optional
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.
map of
string
components_to_set
Optional
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
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 some unknown internal error. The accompanying error message will give more details about the failure.
Availability
Added in 7.0.0
