summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/ip-availability.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/ip-availability.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
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>
Diffstat (limited to 'doc/source/cli/command-objects/ip-availability.rst')
-rw-r--r--doc/source/cli/command-objects/ip-availability.rst60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/ip-availability.rst b/doc/source/cli/command-objects/ip-availability.rst
new file mode 100644
index 00000000..dd39e649
--- /dev/null
+++ b/doc/source/cli/command-objects/ip-availability.rst
@@ -0,0 +1,60 @@
+===============
+ip availability
+===============
+
+Network v2
+
+ip availability list
+--------------------
+
+List IP availability for network
+
+This command retrieves information about IP availability.
+Useful for admins who need a quick way to check the
+IP availability for all associated networks.
+List specifically returns total IP capacity and the
+number of allocated IP addresses from that pool.
+
+.. program:: ip availability list
+.. code:: bash
+
+ openstack ip availability list
+ [--ip-version {4,6}]
+ [--project <project>]
+
+.. option:: --ip-version {4,6}
+
+ List IP availability of given IP version networks
+ (default is 4)
+
+.. option:: --project <project>
+
+ List IP availability of given project
+ (name or ID)
+
+ip availability show
+--------------------
+
+Show network IP availability details
+
+This command retrieves information about IP availability.
+Useful for admins who need a quick way to
+check the IP availability and details for a
+specific network.
+
+This command will return information about
+IP availability for the network as a whole, and
+return availability information for each individual
+subnet within the network as well.
+
+
+.. program:: ip availability show
+.. code:: bash
+
+ openstack ip availability show
+ <network>
+
+.. _ip_availability_show-network:
+.. describe:: <network>
+
+ Show IP availability for a specific network (name or ID)