From 0aa2304f38da0696576827fc4d71f2cf7cc13ad6 Mon Sep 17 00:00:00 2001 From: Tang Chen Date: Fri, 17 Jun 2016 15:06:40 +0800 Subject: 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 --- doc/source/command-objects/floating-ip.rst | 82 ++++++++++++++++++++++++++++++ doc/source/command-objects/ip-floating.rst | 4 ++ 2 files changed, 86 insertions(+) create mode 100644 doc/source/command-objects/floating-ip.rst (limited to 'doc/source/command-objects') 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 ] + [--port ] + [--floating-ip-address ] + [--fixed-ip-address ] + + +.. option:: --subnet + + Subnet on which you want to create the floating IP (name or ID) + *Network version 2 only* + +.. option:: --port + + Port to be associated with the floating IP (name or ID) + *Network version 2 only* + +.. option:: --floating-ip-address + + Floating IP address + *Network version 2 only* + +.. option:: --fixed-ip-address + + Fixed IP address mapped to the floating IP + *Network version 2 only* + +.. describe:: + + 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 [ ...] + +.. describe:: + + 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 + +.. describe:: + + Floating IP to display (IP address or ID) diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 378812d1..7b38a382 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -29,6 +29,7 @@ ip floating create ------------------ Create new floating IP address +(Deprecated, please use ``floating ip create`` instead) .. program:: ip floating create .. code:: bash @@ -68,6 +69,7 @@ ip floating delete ------------------ Delete floating IP(s) +(Deprecated, please use ``floating ip delete`` instead) .. program:: ip floating delete .. code:: bash @@ -83,6 +85,7 @@ ip floating list ---------------- List floating IP addresses +(Deprecated, please use ``floating ip list`` instead) .. program:: ip floating list .. code:: bash @@ -114,6 +117,7 @@ ip floating show ---------------- Display floating IP details +(Deprecated, please use ``floating ip show`` instead) .. program:: ip floating show .. code:: bash -- cgit v1.2.1