From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Tue, 13 Jun 2017 15:55:33 -0400
Subject: reorganize existing documentation according to the new standard
 layout

Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
---
 doc/source/cli/command-objects/floating-ip.rst | 205 +++++++++++++++++++++++++
 1 file changed, 205 insertions(+)
 create mode 100644 doc/source/cli/command-objects/floating-ip.rst

(limited to 'doc/source/cli/command-objects/floating-ip.rst')

diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst
new file mode 100644
index 00000000..f2f101d3
--- /dev/null
+++ b/doc/source/cli/command-objects/floating-ip.rst
@@ -0,0 +1,205 @@
+===========
+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 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)
-- 
cgit v1.2.1