python-openstackclient/doc/source/command-objects/ip-availability.rst
Huanxuan Ao ca5e8e6c85 Add default IP version and fix help messages for "ip availability list"
There was not a default IP version in "ip availability list"
command, if we used this command without "--ip-version" option,
the output was different from the outputs with the option
"--ip-version 4" and "--ip-version 6" and it is not right.
This patch add default IP version (default is 4) in ``ip
availability list`` command and make this command work properly
without ``--ip-version`` option. And also fix the help message.

Change-Id: Idc08ab6eaf05946eb2ab59bfb3d4497a383d987d
Closes-Bug: #1592761
2016-06-15 20:33:09 +08:00

61 lines
1.3 KiB
ReStructuredText

===============
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)