Resource tags
Various virtual networking resources support tags for use by external
systems or any other clients of the Networking service API.
All resources that support standard attributes are applicable for
tagging. This includes:
- networks
- subnets
- subnetpools
- ports
- routers
- floatingips
- logs
- security-groups
- security-group-rules
- segments
- policies
- trunks
- network_segment_ranges
Use cases
The following use cases refer to adding tags to networks, but the
same can be applicable to any other supported Networking service
resource:
- Ability to map different networks in different OpenStack locations
to one logically same network (for multi-site OpenStack). - Ability to map IDs from different management/orchestration systems
to OpenStack networks in mixed environments. For example, in the Kuryr
project, the Docker network ID is mapped to the Neutron network ID. - Ability to leverage tags by deployment tools.
- Ability to tag information about provider networks (for example,
high-bandwidth, low-latency, and so on).
Filtering with tags
The API allows searching/filtering of the
GET /v2.0/networks API. The following query parameters are
supported:
tagstags-anynot-tagsnot-tags-any
To request the list of networks that have a single tag,
tags argument should be set to the desired tag name.
Example:
GET /v2.0/networks?tags=redTo request the list of networks that have two or more tags, the
tags argument should be set to the list of tags, separated
by commas. In this case, the tags given must all be present for a
network to be included in the query result. Example that returns
networks that have the “red” and “blue” tags:
GET /v2.0/networks?tags=red,blueTo request the list of networks that have one or more of a list of
given tags, the tags-any argument should be set to the list
of tags, separated by commas. In this case, as long as one of the given
tags is present, the network will be included in the query result.
Example that returns the networks that have the “red” or the “blue”
tag:
GET /v2.0/networks?tags-any=red,blueTo request the list of networks that do not have one or more tags,
the not-tags argument should be set to the list of tags,
separated by commas. In this case, only the networks that do not have
any of the given tags will be included in the query results. Example
that returns the networks that do not have either “red” or “blue”
tag:
GET /v2.0/networks?not-tags=red,blueTo request the list of networks that do not have at least one of a
list of tags, the not-tags-any argument should be set to
the list of tags, separated by commas. In this case, only the networks
that do not have at least one of the given tags will be included in the
query result. Example that returns the networks that do not have the
“red” tag, or do not have the “blue” tag:
GET /v2.0/networks?not-tags-any=red,blueThe tags, tags-any, not-tags,
and not-tags-any arguments can be combined to build more
complex queries. Example:
GET /v2.0/networks?tags=red,blue&tags-any=green,orangeThe above example returns any networks that have the “red” and “blue”
tags, plus at least one of “green” and “orange”.
Complex queries may have contradictory parameters. Example:
GET /v2.0/networks?tags=blue¬-tags=blueIn this case, we should let the Networking service find these
networks. Obviously, there are no such networks and the service will
return an empty list.
User workflow
Add a tag to a resource:
$ openstack network set --tag red ab442634-1cc9-49e5-bd49-0dac9c811f69
$ openstack network show net
+---------------------------+----------------------------------------------------------------------------+
| Field | Value |
+---------------------------+----------------------------------------------------------------------------+
| admin_state_up | UP |
| availability_zone_hints | |
| availability_zones | nova |
| created_at | 2018-07-11T09:44:50Z |
| description | |
| dns_domain | None |
| id | ab442634-1cc9-49e5-bd49-0dac9c811f69 |
| ipv4_address_scope | None |
| ipv6_address_scope | None |
| is_default | None |
| is_vlan_transparent | None |
| mtu | 1450 |
| name | net |
| port_security_enabled | True |
| project_id | e6710680bfd14555891f265644e1dd5c |
| provider:network_type | vxlan |
| provider:physical_network | None |
| provider:segmentation_id | 1047 |
| qos_policy_id | None |
| revision_number | 5 |
| router:external | Internal |
| segments | None |
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | red |
| updated_at | 2018-07-16T06:22:01Z |
+---------------------------+----------------------------------------------------------------------------+Remove a tag from a resource:
$ openstack network unset --tag red ab442634-1cc9-49e5-bd49-0dac9c811f69
$ openstack network show net
+---------------------------+----------------------------------------------------------------------------+
| Field | Value |
+---------------------------+----------------------------------------------------------------------------+
| admin_state_up | UP |
| availability_zone_hints | |
| availability_zones | nova |
| created_at | 2018-07-11T09:44:50Z |
| description | |
| dns_domain | None |
| id | ab442634-1cc9-49e5-bd49-0dac9c811f69 |
| ipv4_address_scope | None |
| ipv6_address_scope | None |
| is_default | None |
| is_vlan_transparent | None |
| mtu | 1450 |
| name | net |
| port_security_enabled | True |
| project_id | e6710680bfd14555891f265644e1dd5c |
| provider:network_type | vxlan |
| provider:physical_network | None |
| provider:segmentation_id | 1047 |
| qos_policy_id | None |
| revision_number | 5 |
| router:external | Internal |
| segments | None |
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | |
| updated_at | 2018-07-16T06:32:11Z |
+---------------------------+----------------------------------------------------------------------------+Replace all tags on the resource:
$ openstack network set --tag red --tag blue ab442634-1cc9-49e5-bd49-0dac9c811f69
$ openstack network show net
+---------------------------+----------------------------------------------------------------------------+
| Field | Value |
+---------------------------+----------------------------------------------------------------------------+
| admin_state_up | UP |
| availability_zone_hints | |
| availability_zones | nova |
| created_at | 2018-07-11T09:44:50Z |
| description | |
| dns_domain | None |
| id | ab442634-1cc9-49e5-bd49-0dac9c811f69 |
| ipv4_address_scope | None |
| ipv6_address_scope | None |
| is_default | None |
| is_vlan_transparent | None |
| mtu | 1450 |
| name | net |
| port_security_enabled | True |
| project_id | e6710680bfd14555891f265644e1dd5c |
| provider:network_type | vxlan |
| provider:physical_network | None |
| provider:segmentation_id | 1047 |
| qos_policy_id | None |
| revision_number | 5 |
| router:external | Internal |
| segments | None |
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | blue, red |
| updated_at | 2018-07-16T06:50:19Z |
+---------------------------+----------------------------------------------------------------------------+Clear tags from a resource:
$ openstack network unset --all-tag ab442634-1cc9-49e5-bd49-0dac9c811f69
$ openstack network show net
+---------------------------+----------------------------------------------------------------------------+
| Field | Value |
+---------------------------+----------------------------------------------------------------------------+
| admin_state_up | UP |
| availability_zone_hints | |
| availability_zones | nova |
| created_at | 2018-07-11T09:44:50Z |
| description | |
| dns_domain | None |
| id | ab442634-1cc9-49e5-bd49-0dac9c811f69 |
| ipv4_address_scope | None |
| ipv6_address_scope | None |
| is_default | None |
| is_vlan_transparent | None |
| mtu | 1450 |
| name | net |
| port_security_enabled | True |
| project_id | e6710680bfd14555891f265644e1dd5c |
| provider:network_type | vxlan |
| provider:physical_network | None |
| provider:segmentation_id | 1047 |
| qos_policy_id | None |
| revision_number | 5 |
| router:external | Internal |
| segments | None |
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | |
| updated_at | 2018-07-16T07:03:02Z |
+---------------------------+----------------------------------------------------------------------------+Get list of resources with tag filters from networks. The networks
are: test-net1 with “red” tag, test-net2 with “red” and “blue” tags,
test-net3 with “red”, “blue”, and “green” tags, and test-net4 with
“green” tag.
Get list of resources with tags filter:
$ openstack network list --tags red,blue
+--------------------------------------+-----------+---------+
| ID | Name | Subnets |
+--------------------------------------+-----------+---------+
| 8ca3b9ed-f578-45fa-8c44-c53f13aec05a | test-net3 | |
| e736e63d-42e4-4f4c-836c-6ad286ffd68a | test-net2 | |
+--------------------------------------+-----------+---------+Get list of resources with any-tags filter:
$ openstack network list --any-tags red,blue
+--------------------------------------+-----------+---------+
| ID | Name | Subnets |
+--------------------------------------+-----------+---------+
| 30491224-3855-431f-a688-fb29df004d82 | test-net1 | |
| 8ca3b9ed-f578-45fa-8c44-c53f13aec05a | test-net3 | |
| e736e63d-42e4-4f4c-836c-6ad286ffd68a | test-net2 | |
+--------------------------------------+-----------+---------+Get list of resources with not-tags filter:
$ openstack network list --not-tags red,blue
+--------------------------------------+-----------+---------+
| ID | Name | Subnets |
+--------------------------------------+-----------+---------+
| 30491224-3855-431f-a688-fb29df004d82 | test-net1 | |
| cdb3ed08-ca63-4090-ba12-30b366372993 | test-net4 | |
+--------------------------------------+-----------+---------+Get list of resources with not-any-tags filter:
$ openstack network list --not-any-tags red,blue
+--------------------------------------+-----------+---------+
| ID | Name | Subnets |
+--------------------------------------+-----------+---------+
| cdb3ed08-ca63-4090-ba12-30b366372993 | test-net4 | |
+--------------------------------------+-----------+---------+Limitations
Filtering resources with a tag whose name contains a comma is not
supported. Thus, do not put such a tag name to resources.
Future support
In future releases, the Networking service may support setting tags
for additional resources.