763c8c5670
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
206 lines
4.2 KiB
ReStructuredText
206 lines
4.2 KiB
ReStructuredText
===========
|
|
floating ip
|
|
===========
|
|
|
|
Compute v2, Network v2
|
|
|
|
floating ip create
|
|
------------------
|
|
|
|
Create floating IP
|
|
|
|
.. program:: floating ip create
|
|
.. code:: bash
|
|
|
|
openstack floating ip create
|
|
[--subnet <subnet>]
|
|
[--port <port>]
|
|
[--floating-ip-address <floating-ip-address>]
|
|
[--fixed-ip-address <fixed-ip-address>]
|
|
[--description <description>]
|
|
[--project <project> [--project-domain <project-domain>]]
|
|
<network>
|
|
|
|
.. option:: --subnet <subnet>
|
|
|
|
Subnet on which you want to create the floating IP (name or ID)
|
|
*Network version 2 only*
|
|
|
|
.. option:: --port <port>
|
|
|
|
Port to be associated with the floating IP (name or ID)
|
|
*Network version 2 only*
|
|
|
|
.. option:: --floating-ip-address <floating-ip-address>
|
|
|
|
Floating IP address
|
|
*Network version 2 only*
|
|
|
|
.. option:: --fixed-ip-address <fixed-ip-address>
|
|
|
|
Fixed IP address mapped to the floating IP
|
|
*Network version 2 only*
|
|
|
|
.. option:: --description <description>
|
|
|
|
Set floating IP description
|
|
*Network version 2 only*
|
|
|
|
.. option:: --project <project>
|
|
|
|
Owner's project (name or ID)
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --project-domain <project-domain>
|
|
|
|
Domain the project belongs to (name or ID).
|
|
This can be used in case collisions between project names exist.
|
|
|
|
*Network version 2 only*
|
|
|
|
.. describe:: <network>
|
|
|
|
Network to allocate floating IP from (name or ID)
|
|
|
|
floating ip delete
|
|
------------------
|
|
|
|
Delete floating IP(s)
|
|
|
|
.. program:: floating ip delete
|
|
.. code:: bash
|
|
|
|
openstack floating ip delete <floating-ip> [<floating-ip> ...]
|
|
|
|
.. describe:: <floating-ip>
|
|
|
|
Floating IP(s) to delete (IP address or ID)
|
|
|
|
floating ip list
|
|
----------------
|
|
|
|
List floating IP(s)
|
|
|
|
.. program:: floating ip list
|
|
.. code:: bash
|
|
|
|
openstack floating ip list
|
|
[--network <network>]
|
|
[--port <port>]
|
|
[--fixed-ip-address <fixed-ip-address>]
|
|
[--long]
|
|
[--status <status>]
|
|
[--project <project> [--project-domain <project-domain>]]
|
|
[--router <router>]
|
|
|
|
.. option:: --network <network>
|
|
|
|
List floating IP(s) according to given network (name or ID)
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --port <port>
|
|
|
|
List floating IP(s) according to given port (name or ID)
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --fixed-ip-address <fixed-ip-address>
|
|
|
|
List floating IP(s) according to given fixed IP address
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --long
|
|
|
|
List additional fields in output
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --status <status>
|
|
|
|
List floating IP(s) according to given status ('ACTIVE', 'DOWN')
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --project <project>
|
|
|
|
List floating IP(s) according to given project (name or ID)
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --project-domain <project-domain>
|
|
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names exist.
|
|
|
|
*Network version 2 only*
|
|
|
|
.. option:: --router <router>
|
|
|
|
List floating IP(s) according to given router (name or ID)
|
|
|
|
*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
|
|
----------------
|
|
|
|
Display floating IP details
|
|
|
|
.. program:: floating ip show
|
|
.. code:: bash
|
|
|
|
openstack floating ip show <floating-ip>
|
|
|
|
.. 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)
|