Developer Documentation
Apply Tags To Enforcement Point VM
Allows an admin to apply multiple tags to a virtual machine. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/virtual-machines?action=update_tags
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
Request Body
Request Body
Contains
VirtualMachineTagsUpdate
(required)
{
"tags": [
{}
],
"virtual_machine_id": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | tags | array of Tag |
List of tags to be applied on the virtual machine |
| required | virtual_machine_id | string |
The identifier that is used in the enforcement point that uniquely identifies the virtual machine. In case of NSXT it would be the value of the external_id of the virtual machine. |
Errors
| Code | Returns | Description |
|---|---|---|
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | Nothing | Bad Request |
