Apply Tags To Enforcement Point VM
DescriptionAllows 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
string
enforcement-point-name
Required
This parameter has no documentation
Request Body
Request Body
VirtualMachineTagsUpdate of type(s) application/json
Required
List of tags applied to the virtual machine. Based on the enforcement point, the virtual_machine_id will be different. It could be an external id for NSX T or a moid for NSX V
(The request body parameter is missing description)
{
"tags": [
{}
],
"virtual_machine_id": "string"
}
string
virtual_machine_id
Required
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.
Authentication
This operation uses the following authentication methods.
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"tags":[{"scope":"string","tag":"string"}],"virtual_machine_id":"string"}' https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/virtual-machines?action=update_tags
Errors
400
Bad Request
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: apply-tags-to-enforcement-point-vm
x-vmw-nsx-module: PolicyRealizedState
