From 57e5840710c3b2b74d31bfd6a0da739e0fc747ed Mon Sep 17 00:00:00 2001
From: Akihiro Motoki <amotoki@gmail.com>
Date: Sat, 29 Apr 2017 00:32:32 +0000
Subject: Network tag support

Neutron tag mechanism now supports network, subnet, port,
subnetpool and router. Tag support for more resources is planned.

This commit introduces a common mixin class to implement
tag operation and individual resource consumes it.

To support tag remove, network unset command is added.

Implements blueprint neutron-client-tag
Change-Id: Iad59d052f46896d27d73c22d6d4bb3df889f2352
---
 doc/source/cli/command-objects/router.rst | 47 +++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

(limited to 'doc/source/cli/command-objects/router.rst')

diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst
index 8bdf81db..9c9364bc 100644
--- a/doc/source/cli/command-objects/router.rst
+++ b/doc/source/cli/command-objects/router.rst
@@ -67,6 +67,7 @@ Create new router
         [--ha | --no-ha]
         [--description <description>]
         [--availability-zone-hint <availability-zone>]
+        [--tag <tag> | --no-tag]
         <name>
 
 .. option:: --project <project>
@@ -121,6 +122,14 @@ Create new router
     (Router Availability Zone extension required,
     repeat option to set multiple availability zones)
 
+.. option:: --tag <tag>
+
+    Tag to be added to the router (repeat option to set multiple tags)
+
+.. option:: --no-tag
+
+    No tags associated with the router
+
 .. _router_create-name:
 .. describe:: <name>
 
@@ -156,6 +165,8 @@ List routers
         [--long]
         [--project <project> [--project-domain <project-domain>]]
         [--agent <agent-id>]
+        [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
+        [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
 
 .. option:: --agent <agent-id>
 
@@ -186,6 +197,22 @@ List routers
     Domain the project belongs to (name or ID).
     This can be used in case collisions between project names exist.
 
+.. option:: --tags <tag>[,<tag>,...]
+
+    List routers which have all given tag(s)
+
+.. option:: --any-tags <tag>[,<tag>,...]
+
+    List routers which have any given tag(s)
+
+.. option:: --not-tags <tag>[,<tag>,...]
+
+    Exclude routers which have all given tag(s)
+
+.. option:: --not-any-tags <tag>[,<tag>,...]
+
+    Exclude routers which have any given tag(s)
+
 router remove port
 ------------------
 
@@ -246,6 +273,7 @@ Set router properties
         [--route destination=<subnet>,gateway=<ip-address> | --no-route]
         [--ha | --no-ha]
         [--external-gateway <network> [--enable-snat|--disable-snat] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]]
+        [--tag <tag>] [--no-tag]
         <router>
 
 .. option:: --name <name>
@@ -311,6 +339,15 @@ Set router properties
     subnet=<subnet>,ip-address=<ip-address>
     (repeat option to set multiple fixed IP addresses)
 
+.. option:: --tag <tag>
+
+    Tag to be added to the router (repeat option to set multiple tags)
+
+.. option:: --no-tag
+
+    Clear tags associated with the router. Specify both --tag
+    and --no-tag to overwrite current tags
+
 .. _router_set-router:
 .. describe:: <router>
 
@@ -343,6 +380,7 @@ Unset router properties
     openstack router unset
         [--route destination=<subnet>,gateway=<ip-address>]
         [--external-gateway]
+        [--tag <tag> | --all-tag]
         <router>
 
 .. option:: --route destination=<subnet>,gateway=<ip-address>
@@ -356,6 +394,15 @@ Unset router properties
 
     Remove external gateway information from the router
 
+.. option:: --tag <tag>
+
+    Tag to be removed from the router
+    (repeat option to remove multiple tags)
+
+.. option:: --all-tag
+
+    Clear all tags associated with the router
+
 .. _router_unset-router:
 .. describe:: <router>
 
-- 
cgit v1.2.1