1686dc54f0
Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
159 lines
3.2 KiB
ReStructuredText
159 lines
3.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 <ip-address>]
|
|
[--fixed-ip-address <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 <ip-address>
|
|
|
|
Floating IP address
|
|
*Network version 2 only*
|
|
|
|
.. option:: --fixed-ip-address <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 <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 <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 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)
|