python-openstackclient/doc/source/command-objects/ip-floating.rst
Kevin_Zheng 847da51dea change os in command example to openstack(2)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00

130 lines
2.5 KiB
ReStructuredText

===========
ip floating
===========
Compute v2, Network v2
ip floating add
---------------
Add floating IP address to server
(Deprecated, please use ``server add floating ip`` instead)
.. program:: ip floating add
.. code:: bash
openstack 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
(Deprecated, please use ``floating ip create`` instead)
.. program:: ip floating create
.. code:: bash
openstack ip floating create
[--subnet <subnet>]
[--port <port>]
[--floating-ip-address <floating-ip-address>]
[--fixed-ip-address <fixed-ip-address>]
<network>
.. option:: --subnet <subnet>
Subnet on which you want to create the floating IP (name or ID)
(Network v2 only)
.. option:: --port <port>
Port to be associated with the floating IP (name or ID)
(Network v2 only)
.. option:: --floating-ip-address <floating-ip-address>
Floating IP address
(Network v2 only)
.. option:: --fixed-ip-address <fixed-ip-address>
Fixed IP address mapped to the floating IP
(Network v2 only)
.. describe:: <network>
Network to allocate floating IP from (name or ID)
ip floating delete
------------------
Delete floating IP(s)
(Deprecated, please use ``floating ip delete`` instead)
.. program:: ip floating delete
.. code:: bash
openstack ip floating delete
<floating-ip> [<floating-ip> ...]
.. describe:: <floating-ip>
Floating IP(s) to delete (IP address or ID)
ip floating list
----------------
List floating IP addresses
(Deprecated, please use ``floating ip list`` instead)
.. program:: ip floating list
.. code:: bash
openstack ip floating list
ip floating remove
------------------
Remove floating IP address from server
(Deprecated, please use ``server remove floating ip`` instead)
.. program:: ip floating remove
.. code:: bash
openstack 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)
ip floating show
----------------
Display floating IP details
(Deprecated, please use ``floating ip show`` instead)
.. program:: ip floating show
.. code:: bash
openstack ip floating show <floating-ip>
.. describe:: <floating-ip>
Floating IP to display (IP address or ID)