summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-07-23 16:14:56 +0000
committerGerrit Code Review <review@openstack.org>2015-07-23 16:14:56 +0000
commite54a15aabbfa8df04de53dcc53466e683e5f633b (patch)
tree28cfd6263852fa9db05b504dedaa7a24d7e11e7d /doc/source/command-objects
parent025d38040c8eb427e6c908374b9c6fb93b056036 (diff)
parenta5b0d9ab356f9d94f88feaae82bf80e46e81bc47 (diff)
downloadpython-openstackclient-e54a15aabbfa8df04de53dcc53466e683e5f633b.tar.gz
Merge "add doc for floatingip"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/floatingip.rst85
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/source/command-objects/floatingip.rst b/doc/source/command-objects/floatingip.rst
new file mode 100644
index 00000000..1ae3041e
--- /dev/null
+++ b/doc/source/command-objects/floatingip.rst
@@ -0,0 +1,85 @@
+==========
+floatingip
+==========
+
+Compute v2
+
+ip floating add
+---------------
+
+Add floating-ip to server
+
+.. program:: ip floating add
+.. code:: bash
+
+ os ip floating add
+ <ip_address>
+ <server>
+
+.. describe:: <ip_address>
+
+ IP address to add to server
+
+.. describe:: <server>
+
+ 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
+ <pool>
+
+.. describe:: <pool>
+
+ Pool to fetch floating IP from
+
+ip floating delete
+------------------
+
+Delete a floating-ip
+
+.. program:: ip floating delete
+.. code:: bash
+
+ os ip floating delete
+ <ip_address>
+
+.. describe:: <ip_address>
+
+ 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
+ <ip_address>
+ <server>
+
+.. describe:: <ip_address>
+
+ IP address to remove from server
+
+.. describe:: <server>
+
+ Server to remove the IP address from (name or ID)