summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/ip-availability.rst
blob: dd39e649fecbba6745d0f274ea2e53d9c5ec5cf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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)