summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorSindhu Devale <sindhu.devale@intel.com>2016-10-06 10:01:59 -0500
committerDean Troyer <dtroyer@gmail.com>2017-04-05 16:12:40 +0000
commit763c8c5670f238920398165e670592e006213f32 (patch)
treec8b6c7f1dce72d35dc77389a488f5312d88d6cfa /doc/source/command-objects
parent0e42ea3ae325cf5b168bb966e62cd6b8e9ee0159 (diff)
downloadpython-openstackclient-763c8c5670f238920398165e670592e006213f32.tar.gz
"floating ip set/unset port" for OSC
Implements Neutron feature of floating ip associate/disassociate into OpenStack Client. Previously, network.find_ip() function only supported to search floating ip by UUID. Hence, _find_floating_ip() function is used in floating_ip.py, to search fip both by UUID and ip_address. [1] adds the ability to find fip object using both UUID and ip_address. This functionality however, won't be available until the SDK is released. Hence, we continue to use _find_floating_ip() method, which was cleaned up by [2] to remove the use of ip_cache. Once, the SDK is released, we will remove all the usage of _find_floating_ip() method and instead only use network.find_ip(). [1] https://review.openstack.org/#/c/449879/2 [2] https://review.openstack.org/#/c/447938/ Change-Id: I6c5222287c46ca42365917d2deae70bdb626347 Co-Authored-By: Reedip<reedip.banerjee@nectechnologies.in> Co-Authored-By: RuiChen<chenrui.momo@gmail.com> Closes-Bug: #1560297
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/floating-ip.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst
index 5a38bc1b..5e126fe3 100644
--- a/doc/source/command-objects/floating-ip.rst
+++ b/doc/source/command-objects/floating-ip.rst
@@ -143,6 +143,32 @@ List floating IP(s)
*Network version 2 only*
+floating ip set
+---------------
+
+Set floating IP properties
+
+.. program:: floating ip set
+.. code:: bash
+
+ openstack floating ip set
+ --port <port>
+ [--fixed-ip-address <ip-address>]
+ <floating-ip>
+
+.. option:: --port <port>
+
+ Assocaite the floating IP with port (name or ID)
+
+.. option:: --fixed-ip-address <ip-address>
+
+ Fixed IP of the port (required only if port has multiple IPs)
+
+.. _floating_ip_set-floating-ip:
+.. describe:: <floating-ip>
+
+ Floating IP to associate (IP address or ID)
+
floating ip show
----------------
@@ -156,3 +182,24 @@ Display floating IP details
.. describe:: <floating-ip>
Floating IP to display (IP address or ID)
+
+floating ip unset
+-----------------
+
+Unset floating IP Properties
+
+.. program:: floating ip unset
+.. code:: bash
+
+ openstack floating ip unset
+ --port
+ <floating-ip>
+
+.. option:: --port
+
+ Disassociate any port associated with the floating IP
+
+.. _floating_ip_unset-floating-ip:
+.. describe:: <floating-ip>
+
+ Floating IP to disassociate (IP address or ID)