-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat Virtualization
24.3. Associating Tags
24.3.1. Associating Tags With a Host, User or VM
The collection referenced by
link rel="tags"
from a host
, user
or vms
represents the set of tags associated with the entity.
These
tag
representations also contain a host id
, user id
or vm id
reference to the entity in question.
Associating a tag with an entity is achieved by
POST
ing a tag reference (identifying the tag either by its id
or name
) to the collection.
Example 24.2. Associating a tag with a virtual machine
POST /ovirt-engine/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags HTTP/1.1 Accept: application/xml Content-Type: application/xml <tag> <name>Finance</name> </tag> HTTP/1.1 201 Created Content-Type: application/xml <tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e" href="/ovirt-engine/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags/ f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"> <name>Finance</name> <description>Resources for the Finance department</description> <vm id="5114bb3e-a4e6-44b2-b783-b3eea7d84720" href="/ovirt-engine/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720"/> </tag>
24.3.2. Removing a Tag
Removing an association is achieved with a
DELETE
request to the appropriate element in the collection.
Example 24.3. Removing a tag from a virtual machine
DELETE /ovirt-engine/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags/f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e HTTP/1.1 HTTP/1.1 204 No Content
24.3.3. Querying a Collection for Tagged Resources
To query the set of entities associated with a given tag, the
collection/search
URI template for the appropriate collection should be used to search for entities matching tag=MyTag
.
Example 24.4. Querying a collection for tagged resources
GET /ovirt-engine/api/vms?search=tag%3DFinance HTTP/1.1 Accept: application/xml HTTP/1.1 200 OK Content-Type: application/xml <vms> <vm id="5114bb3e-a4e6-44b2-b783-b3eea7d84720" href="/ovirt-engine/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720"> ... </vm> ... </vms>