summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/ip-floating.rst
diff options
context:
space:
mode:
authorRichard Theis <rtheis@us.ibm.com>2015-11-24 10:31:07 -0600
committerRichard Theis <rtheis@us.ibm.com>2015-11-24 14:03:51 -0600
commit325420f6d166aef0b58242918fac464642395b5d (patch)
tree625cd78e31b2c74958c5e5eb26fdd91b453a78ee /doc/source/command-objects/ip-floating.rst
parentbfa223f61591cf7515265c0ddcacc02797cee055 (diff)
downloadpython-openstackclient-325420f6d166aef0b58242918fac464642395b5d.tar.gz
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
Diffstat (limited to 'doc/source/command-objects/ip-floating.rst')
-rw-r--r--doc/source/command-objects/ip-floating.rst85
1 files changed, 85 insertions, 0 deletions
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
+ <ip-address>
+ <server>
+
+.. describe:: <ip-address>
+
+ IP address to add to server (name only)
+
+.. describe:: <server>
+
+ 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
+ <pool>
+
+.. describe:: <pool>
+
+ 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
+ <ip-address>
+
+.. describe:: <ip-address>
+
+ 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
+ <ip-address>
+ <server>
+
+.. describe:: <ip-address>
+
+ IP address to remove from server (name only)
+
+.. describe:: <server>
+
+ Server to remove the IP address from (name or ID)