summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/ip-availability.rst
diff options
context:
space:
mode:
authorManjeet Singh Bhatia <manjeet.s.bhatia@intel.com>2016-04-14 20:45:27 +0000
committerManjeet Singh Bhatia <manjeet.s.bhatia@intel.com>2016-06-03 16:47:56 +0000
commiteab6cdebdc28c7eaaf330bbf6c9261c4eedf4dce (patch)
tree0072bd62bbd08e7b0fa0c78863040afd0c92f3e2 /doc/source/command-objects/ip-availability.rst
parent17bc850440045128871c381244540eeedaa569a7 (diff)
downloadpython-openstackclient-eab6cdebdc28c7eaaf330bbf6c9261c4eedf4dce.tar.gz
Add network availability for osc
This patch implements openstack client for network ip availability. Implements: blueprint neutron-ip-capacity Depends-On: I3b40d8edea87c068c4e8133e436511765064d5f8 Change-Id: Iffaa2e20ff495fbd205d3397e027e8141d04385e
Diffstat (limited to 'doc/source/command-objects/ip-availability.rst')
-rw-r--r--doc/source/command-objects/ip-availability.rst60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/source/command-objects/ip-availability.rst b/doc/source/command-objects/ip-availability.rst
new file mode 100644
index 00000000..55b78427
--- /dev/null
+++ b/doc/source/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
+
+ os 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
+
+ os ip availability show
+ <network>
+
+.. _ip_availability_show-network
+.. describe:: <network>
+
+ Show IP availability for a specific network (name or ID)