From 325420f6d166aef0b58242918fac464642395b5d Mon Sep 17 00:00:00 2001 From: Richard Theis Date: Tue, 24 Nov 2015 10:31:07 -0600 Subject: Doc: Update and add IP address Fix the 'ip floating' command documentation file name. Add missing command list documentation for the 'ip fixed' and 'ip floating pool' commands. In addition, update the command description and argument help to fix minor issues and use consistent terminology. And finally, cleanup the Network command object formatting. Change-Id: I0168891bc674c9f0d4df4062f7e93f497dc8fe6f --- doc/source/command-objects/floatingip.rst | 85 ------------------------- doc/source/command-objects/ip-fixed.rst | 45 +++++++++++++ doc/source/command-objects/ip-floating-pool.rst | 15 +++++ doc/source/command-objects/ip-floating.rst | 85 +++++++++++++++++++++++++ 4 files changed, 145 insertions(+), 85 deletions(-) delete mode 100644 doc/source/command-objects/floatingip.rst create mode 100644 doc/source/command-objects/ip-fixed.rst create mode 100644 doc/source/command-objects/ip-floating-pool.rst create mode 100644 doc/source/command-objects/ip-floating.rst (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/floatingip.rst b/doc/source/command-objects/floatingip.rst deleted file mode 100644 index 1ae3041e..00000000 --- a/doc/source/command-objects/floatingip.rst +++ /dev/null @@ -1,85 +0,0 @@ -========== -floatingip -========== - -Compute v2 - -ip floating add ---------------- - -Add floating-ip to server - -.. program:: ip floating add -.. code:: bash - - os ip floating add - - - -.. describe:: - - IP address to add to server - -.. describe:: - - Server to receive the IP address (name or ID) - -ip floating create ------------------- - -Create new floating-ip - -.. program:: ip floating create -.. code:: bash - - os ip floating create - - -.. describe:: - - Pool to fetch floating IP from - -ip floating delete ------------------- - -Delete a floating-ip - -.. program:: ip floating delete -.. code:: bash - - os ip floating delete - - -.. describe:: - - IP address to delete - -ip floating list ----------------- - -List floating-ips - -.. program:: ip floating list -.. code:: bash - - os ip floating list - -ip floating remove ------------------- - -Remove floating-ip from server - -.. program:: ip floating remove -.. code:: bash - - os ip floating remove - - - -.. describe:: - - IP address to remove from server - -.. describe:: - - Server to remove the IP address from (name or ID) diff --git a/doc/source/command-objects/ip-fixed.rst b/doc/source/command-objects/ip-fixed.rst new file mode 100644 index 00000000..3a55b995 --- /dev/null +++ b/doc/source/command-objects/ip-fixed.rst @@ -0,0 +1,45 @@ +======== +ip fixed +======== + +Compute v2 + +ip fixed add +------------ + +Add fixed IP address to server + +.. program:: ip fixed add +.. code:: bash + + os ip fixed add + + + +.. describe:: + + Network to fetch an IP address from (name or ID) + +.. describe:: + + Server to receive the IP address (name or ID) + +ip fixed remove +--------------- + +Remove fixed IP address from server + +.. program:: ip fixed remove +.. code:: bash + + os ip fixed remove + + + +.. describe:: + + IP address to remove from server (name only) + +.. describe:: + + Server to remove the IP address from (name or ID) diff --git a/doc/source/command-objects/ip-floating-pool.rst b/doc/source/command-objects/ip-floating-pool.rst new file mode 100644 index 00000000..63a450eb --- /dev/null +++ b/doc/source/command-objects/ip-floating-pool.rst @@ -0,0 +1,15 @@ +================ +ip floating pool +================ + +Compute v2 + +ip floating pool list +--------------------- + +List pools of floating IP addresses + +.. program:: ip floating pool list +.. code:: bash + + os ip floating pool list diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst new file mode 100644 index 00000000..6bfd7f44 --- /dev/null +++ b/doc/source/command-objects/ip-floating.rst @@ -0,0 +1,85 @@ +=========== +ip floating +=========== + +Compute v2 + +ip floating add +--------------- + +Add floating IP address to server + +.. program:: ip floating add +.. code:: bash + + os ip floating add + + + +.. describe:: + + IP address to add to server (name only) + +.. describe:: + + Server to receive the IP address (name or ID) + +ip floating create +------------------ + +Create new floating IP address + +.. program:: ip floating create +.. code:: bash + + os ip floating create + + +.. describe:: + + Pool to fetch IP address from (name or ID) + +ip floating delete +------------------ + +Delete a floating IP address + +.. program:: ip floating delete +.. code:: bash + + os ip floating delete + + +.. describe:: + + IP address to delete (ID only) + +ip floating list +---------------- + +List floating IP addresses + +.. program:: ip floating list +.. code:: bash + + os ip floating list + +ip floating remove +------------------ + +Remove floating IP address from server + +.. program:: ip floating remove +.. code:: bash + + os ip floating remove + + + +.. describe:: + + IP address to remove from server (name only) + +.. describe:: + + Server to remove the IP address from (name or ID) -- cgit v1.2.1