summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-11-24 23:08:55 +0000
committerGerrit Code Review <review@openstack.org>2015-11-24 23:08:55 +0000
commitb42396d445de9536660ff6930aa572c8ff99b4da (patch)
tree61c2ef09d505aa1e58f0b18229a7bd49c2eb0950 /doc/source/command-objects
parent11ea5b31af324918885f94746c7da586996a1020 (diff)
parent325420f6d166aef0b58242918fac464642395b5d (diff)
downloadpython-openstackclient-b42396d445de9536660ff6930aa572c8ff99b4da.tar.gz
Merge "Doc: Update and add IP address"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/ip-fixed.rst45
-rw-r--r--doc/source/command-objects/ip-floating-pool.rst15
-rw-r--r--doc/source/command-objects/ip-floating.rst (renamed from doc/source/command-objects/floatingip.rst)36
3 files changed, 78 insertions, 18 deletions
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
+ <network>
+ <server>
+
+.. describe:: <network>
+
+ Network to fetch an IP address from (name or ID)
+
+.. describe:: <server>
+
+ 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
+ <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)
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/floatingip.rst b/doc/source/command-objects/ip-floating.rst
index 1ae3041e..6bfd7f44 100644
--- a/doc/source/command-objects/floatingip.rst
+++ b/doc/source/command-objects/ip-floating.rst
@@ -1,24 +1,24 @@
-==========
-floatingip
-==========
+===========
+ip floating
+===========
Compute v2
ip floating add
---------------
-Add floating-ip to server
+Add floating IP address to server
.. program:: ip floating add
.. code:: bash
os ip floating add
- <ip_address>
+ <ip-address>
<server>
-.. describe:: <ip_address>
+.. describe:: <ip-address>
- IP address to add to server
+ IP address to add to server (name only)
.. describe:: <server>
@@ -27,7 +27,7 @@ Add floating-ip to server
ip floating create
------------------
-Create new floating-ip
+Create new floating IP address
.. program:: ip floating create
.. code:: bash
@@ -37,27 +37,27 @@ Create new floating-ip
.. describe:: <pool>
- Pool to fetch floating IP from
+ Pool to fetch IP address from (name or ID)
ip floating delete
------------------
-Delete a floating-ip
+Delete a floating IP address
.. program:: ip floating delete
.. code:: bash
os ip floating delete
- <ip_address>
+ <ip-address>
-.. describe:: <ip_address>
+.. describe:: <ip-address>
- IP address to delete
+ IP address to delete (ID only)
ip floating list
----------------
-List floating-ips
+List floating IP addresses
.. program:: ip floating list
.. code:: bash
@@ -67,18 +67,18 @@ List floating-ips
ip floating remove
------------------
-Remove floating-ip from server
+Remove floating IP address from server
.. program:: ip floating remove
.. code:: bash
os ip floating remove
- <ip_address>
+ <ip-address>
<server>
-.. describe:: <ip_address>
+.. describe:: <ip-address>
- IP address to remove from server
+ IP address to remove from server (name only)
.. describe:: <server>