From 0981931628cdea07793850631595cf7299badeaa Mon Sep 17 00:00:00 2001
From: Ankur Gupta <ankur.gupta@intel.com>
Date: Tue, 20 Sep 2016 12:29:08 -0500
Subject: Add --description to Neutron commands

Added simple option for floating ip description when creating
a floating ip.

Added option for create and set router as well.

Partially Implements: blueprint neutron-client-descriptions
Partially Implements: blueprint network-commands-options

Change-Id: Ib8cd8af449e9ff33b980017b2527a6b196894a00
---
 doc/source/command-objects/floating-ip.rst |  6 ++++++
 doc/source/command-objects/router.rst      | 10 ++++++++++
 2 files changed, 16 insertions(+)

(limited to 'doc/source/command-objects')

diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst
index 093bb8e4..2ab21f36 100644
--- a/doc/source/command-objects/floating-ip.rst
+++ b/doc/source/command-objects/floating-ip.rst
@@ -17,6 +17,7 @@ Create floating IP
         [--port <port>]
         [--floating-ip-address <floating-ip-address>]
         [--fixed-ip-address <fixed-ip-address>]
+        [--description <description>]
         <network>
 
 .. option:: --subnet <subnet>
@@ -39,6 +40,11 @@ Create floating IP
     Fixed IP address mapped to the floating IP
     *Network version 2 only*
 
+.. option:: --description <description>
+
+    Set floating IP description
+    *Network version 2 only*
+
 .. describe:: <network>
 
     Network to allocate floating IP from (name or ID)
diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst
index bbdca054..13a75158 100644
--- a/doc/source/command-objects/router.rst
+++ b/doc/source/command-objects/router.rst
@@ -64,6 +64,7 @@ Create new router
         [--project <project> [--project-domain <project-domain>]]
         [--enable | --disable]
         [--distributed]
+        [--description <description>]
         [--availability-zone-hint <availability-zone>]
         <name>
 
@@ -88,6 +89,10 @@ Create new router
 
     Create a distributed router
 
+.. option:: --description <description>
+
+    Set router description
+
 .. option:: --availability-zone-hint <availability-zone>
 
     Availability Zone in which to create this router
@@ -186,6 +191,7 @@ Set router properties
         [--name <name>]
         [--enable | --disable]
         [--distributed | --centralized]
+        [--description <description>]
         [--route destination=<subnet>,gateway=<ip-address> | --no-route]
         <router>
 
@@ -209,6 +215,10 @@ Set router properties
 
     Set router to centralized mode (disabled router only)
 
+.. option:: --description <description>
+
+    Set router description
+
 .. option:: --route destination=<subnet>,gateway=<ip-address>
 
     Routes associated with the router
-- 
cgit v1.2.1