openstack/python-openstackclient
Code Issues Proposed changes
bf32cdf3a9
python-openstackclient/doc/source/cli/command-objects/ip-availability.rst

61 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
===============
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
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack ip availability list
Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
[--ip-version {4,6}]
[--project <project>]
.. option:: --ip-version {4,6}
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
2016-04-14 20:45:27 +00:00
List IP availability of given IP version networks
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 13:57:39 +08:00
(default is 4)
Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
.. option:: --project <project>
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
2016-04-14 20:45:27 +00:00
List IP availability of given project
Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
(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
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack ip availability show
Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
<network>
Fill the missing colon This patch fills the missing colon in ip-availability.rst Change-Id: Icc7c8cc04fdfeb00051392f560bedcde62cfcee7
2016-11-22 04:07:28 +08:00
.. _ip_availability_show-network:
Spec to Implement IP Availability Specification to lay out new commands to be added to OSC. New feature has been implemented and released for Neutron and python-neutronclient to display IP usages. Commands will display the IP usage across all networks, or detailed IP usage specifics for a given network Partially Implements Blueprint: neutron-ip-capacity Change-Id: I1c25de1bd924d92a96c20d60fa24d9e966b92dcd
2016-03-29 10:51:06 -06:00
.. describe:: <network>
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
2016-04-14 20:45:27 +00:00
Show IP availability for a specific network (name or ID)
Copy Permalink