diff options
| author | Tang Chen <chen.tang@easystack.cn> | 2016-06-17 15:06:40 +0800 |
|---|---|---|
| committer | Tang Chen <chen.tang@easystack.cn> | 2016-07-20 13:37:48 +0800 |
| commit | 0aa2304f38da0696576827fc4d71f2cf7cc13ad6 (patch) | |
| tree | 06913a21f43ff5aef1851a9ae955509816c89f1a /doc/source/command-objects/floating-ip.rst | |
| parent | 07e97b1a8ab76a253a483a5290bcf93fa41c7cc4 (diff) | |
| download | python-openstackclient-0aa2304f38da0696576827fc4d71f2cf7cc13ad6.tar.gz | |
Transfer "ip floating CRUD" to "floating ip CRUD"
This patch does the following things to transfer
"ip floating xxx" to "floating ip xxx":
* Add new command "floating ip create/delete/list/show", and doc.
* Deprecate "ip floating create/delete/list/show" command.
Change-Id: Ib071acaac81988431244e858bddafa7f93403df5
Implements: blueprint rework-ip-commands
Closes-bug: 1555990
Co-Authored-By: Dean Troyer <dtroyer@gmail.com>
Diffstat (limited to 'doc/source/command-objects/floating-ip.rst')
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst new file mode 100644 index 00000000..093bb8e4 --- /dev/null +++ b/doc/source/command-objects/floating-ip.rst @@ -0,0 +1,82 @@ +=========== +floating ip +=========== + +Compute v2, Network v2 + +floating ip create +------------------ + +Create floating IP + +.. program:: floating ip create +.. code:: bash + + os floating ip 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 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* + +.. describe:: <network> + + Network to allocate floating IP from (name or ID) + +floating ip delete +------------------ + +Delete floating IP(s) + +.. program:: floating ip delete +.. code:: bash + + os 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 + + os floating ip list + +floating ip show +---------------- + +Display floating IP details + +.. program:: floating ip show +.. code:: bash + + os floating ip show <floating-ip> + +.. describe:: <floating-ip> + + Floating IP to display (IP address or ID) |