esx settings hosts software drafts software components: update
Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
PATCH https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components
{
"components_to_set" : {
"obj-103" : "string"
},
"components_to_delete" : [
"obj-103",
"obj-103"
]
}
"components_to_set" : {
"obj-103" : "string"
},
"components_to_delete" : [
"obj-103",
"obj-103"
]
}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| host | string | Identifier of the host. |
| draft | string | Identifier of the working copy document. |
Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | update_spec | Update specification containing list of components to add and/or delete. |
| -.components_to_set | object | 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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. 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 key/value pairs 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 key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component. |
| -.components_to_set.* | string | Optional. |
| -.components_to_delete | string[] | List of components to be removed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. 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. |
Response:
HTTP Status Code: 204
Headers:
NoneType:
NoneErrors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | If there is some unknown internal error. The accompanying error message will give more details about the failure. |
| 404 | not_found | If there is no host associated with host or no draft associated with draft in the system. |
| 503 | service_unavailable | If the service is not available. |
| 401 | unauthenticated | If the caller is not authenticated. |
| 400 | unsupported | If the host is not a standlone host, but instead part of a cluster. |