summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/subnet-pool.rst
blob: 439c4f50336a9b8d9ad2c072b5ec3f4d379d46f8 (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
===========
subnet pool
===========

Network v2

subnet pool create
------------------

Create subnet pool

.. program:: subnet pool create
.. code:: bash

    os subnet pool create
        [--pool-prefix <pool-prefix> [...]]
        [--default-prefix-length <default-prefix-length>]
        [--min-prefix-length <min-prefix-length>]
        [--max-prefix-length <max-prefix-length>]
        <name>

.. option:: --pool-prefix <pool-prefix>

    Set subnet pool prefixes (in CIDR notation).
    Repeat this option to set multiple prefixes.

.. option:: --default-prefix-length <default-prefix-length>

    Set subnet pool default prefix length

.. option:: --min-prefix-length <min-prefix-length>

    Set subnet pool minimum prefix length

.. option:: --max-prefix-length <max-prefix-length>

    Set subnet pool maximum prefix length

.. _subnet_pool_create-name:
      .. describe:: <name>

    Name of the new subnet pool

subnet pool delete
------------------

Delete subnet pool

.. program:: subnet pool delete
.. code:: bash

    os subnet pool delete
        <subnet-pool>

.. _subnet_pool_delete-subnet-pool:
.. describe:: <subnet-pool>

    Subnet pool to delete (name or ID)

subnet pool list
----------------

List subnet pools

.. program:: subnet pool list
.. code:: bash

    os subnet pool list
        [--long]

.. option:: --long

    List additional fields in output

subnet pool set
---------------

Set subnet pool properties

.. program:: subnet pool set
.. code:: bash

    os subnet pool set
        [--name <name>]
        [--pool-prefix <pool-prefix> [...]]
        [--default-prefix-length <default-prefix-length>]
        [--min-prefix-length <min-prefix-length>]
        [--max-prefix-length <max-prefix-length>]
        <subnet-pool>

.. option:: --name <name>

    Set subnet pool name

.. option:: --pool-prefix <pool-prefix>

    Set subnet pool prefixes (in CIDR notation).
    Repeat this option to set multiple prefixes.

.. option:: --default-prefix-length <default-prefix-length>

    Set subnet pool default prefix length

.. option:: --min-prefix-length <min-prefix-length>

    Set subnet pool minimum prefix length

.. option:: --max-prefix-length <max-prefix-length>

    Set subnet pool maximum prefix length

.. _subnet_pool_set-subnet-pool:
   .. describe:: <subnet-pool>

    Subnet pool to modify (name or ID)

subnet pool show
----------------

Display subnet pool details

.. program:: subnet pool show
.. code:: bash

    os subnet pool show
        <subnet-pool>

.. _subnet_pool_show-subnet-pool:
.. describe:: <subnet-pool>

    Subnet pool to display (name or ID)