python-openstackclient/doc/source/command-objects/subnet-pool.rst

subnet pool

A subnet pool contains a collection of prefixes in CIDR notation that are available for IP address allocation.

Network v2

subnet pool create

Create subnet pool

subnet pool create

os subnet pool create
    [--default-prefix-length <default-prefix-length>]
    [--min-prefix-length <min-prefix-length>]
    [--max-prefix-length <max-prefix-length>]
    [--description <description>]
    [--project <project> [--project-domain <project-domain>]]
    [--address-scope <address-scope>]
    [--default | --no-default]
    [--share | --no-share]
    --pool-prefix <pool-prefix> [...]
    <name>

--default-prefix-length <default-prefix-length>

Set subnet pool default prefix length

--min-prefix-length <min-prefix-length>

Set subnet pool minimum prefix length

--max-prefix-length <max-prefix-length>

Set subnet pool maximum prefix length

--description <description>

Set subnet pool description

--project <project>

Owner's project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--address-scope <address-scope>

Set address scope associated with the subnet pool (name or ID), prefixes must be unique across address scopes

--default

Set this as a default subnet pool

--no-default

Set this as a non-default subnet pool

--share

Set this subnet pool as shared

--no-share

Set this subnet pool as not shared

--pool-prefix <pool-prefix>

Set subnet pool prefixes (in CIDR notation) (repeat option to set multiple prefixes)

Name of the new subnet pool

subnet pool delete

Delete subnet pool(s)

subnet pool delete

os subnet pool delete
    <subnet-pool> [<subnet-pool> ...]




Subnet pool(s) to delete (name or ID)

subnet pool list

List subnet pools

subnet pool list

os subnet pool list
    [--long]
    [--share | --no-share]
    [--default | --no-default]
    [--project <project> [--project-domain <project-domain>]]
    [--name <name>]
    [--address-scope <address-scope>]

--long

List additional fields in output

--share

List subnets shared between projects

--no-share

List subnets not shared between projects

--default

List subnets used as the default external subnet pool

--no-default

List subnets not used as the default external subnet pool

--project <project>

List subnets according to their project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--name <name>

List only subnets of given name in output

--address-scope <address-scope>

List only subnets of given address scope (name or ID) in output

subnet pool set

Set subnet pool properties

subnet pool set

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>]
    [--address-scope <address-scope> | --no-address-scope]
    [--default | --no-default]
    [--description <description>]
    <subnet-pool>

--name <name>

Set subnet pool name

--pool-prefix <pool-prefix>

Set subnet pool prefixes (in CIDR notation) (repeat option to set multiple prefixes)

--default-prefix-length <default-prefix-length>

Set subnet pool default prefix length

--min-prefix-length <min-prefix-length>

Set subnet pool minimum prefix length

--max-prefix-length <max-prefix-length>

Set subnet pool maximum prefix length

--address-scope <address-scope>

Set address scope associated with the subnet pool (name or ID), prefixes must be unique across address scopes

--no-address-scope

Remove address scope associated with the subnet pool

--default

Set this as a default subnet pool

--no-default

Set this as a non-default subnet pool

--description <description>

Set subnet pool description

Subnet pool to modify (name or ID)

subnet pool show

Display subnet pool details

subnet pool show

os subnet pool show
    <subnet-pool>




Subnet pool to display (name or ID)

subnet pool unset

Unset subnet pool properties

subnet pool unset

os subnet pool unset
    [--pool-prefix <pool-prefix> [...]]
    <subnet-pool>

--pool-prefix <pool-prefix>

Remove subnet pool prefixes (in CIDR notation). (repeat option to unset multiple prefixes).

Subnet pool to modify (name or ID)