Chapter 63. subnet

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

name

New subnet name

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--ip-version {4,6}

Ip version (default is 4). note that when subnet pool is specified, IP version is determined from the subnet pool and this option is ignored.

--host-route destination=<subnet>,gateway=<ip-address>

Additional route for this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to add multiple routes)

--gateway <gateway>

Specify a gateway for the subnet. the three options are: <ip-address>: Specific IP address to use as the gateway, auto: Gateway address should automatically be chosen from within the subnet itself, none: This subnet will not use a gateway, e.g.: --gateway 192.168.9.1, --gateway auto, --gateway none (default is auto).

--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 ra (router advertisement) mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]

--service-type <service-type>

Service type for this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to set multiple service types)

--subnet-range <subnet-range>

Subnet range in cidr notation (required if --subnet- pool is not specified, optional otherwise)

--project <project>

Owner’s project (name or id)

--network <network>

Network this subnet belongs to (name or id)

--prefix-length <prefix-length>

Prefix length for subnet allocation from subnet pool

--use-prefix-delegation USE_PREFIX_DELEGATION

Use prefix-delegation if ip is ipv6 format and ip would be delegated externally

--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]

-h, --help

Show this help message and exit

--description <description>

Set subnet description

--project-domain <project-domain>

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

--use-default-subnet-pool

Use default subnet pool for --ip-version

--no-dhcp

Disable dhcp

--dhcp

Enable dhcp (default)

--no-tag

No tags associated with the subnet

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses for this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to add multiple IP addresses)

--subnet-pool <subnet-pool>

Subnet pool from which this subnet will obtain a cidr (Name or ID)

--tag <tag>

Tag to be added to the subnet (repeat option to set multiple tags)

--dns-nameserver <dns-nameserver>

Dns server for this subnet (repeat option to set multiple DNS servers)

--network-segment <network-segment>

Network segment to associate with this subnet (name or ID)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<subnet>

Subnet(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--noindent

Whether to disable indenting the json

--no-dhcp

List subnets which have dhcp disabled

--ip-version <ip-version>

List only subnets of given ip version in output.Allowed values for IP version are 4 and 6.

--not-any-tags <tag>[,<tag>,…​]

Exclude subnets which have any given tag(s) (comma- separated list of tags)

--name <name>

List only subnets of given name in output

--tags <tag>[,<tag>,…​]

List subnets which have all given tag(s) (comma- separated list of tags)

--project-domain <project-domain>

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

--subnet-range <subnet-range>

List only subnets of given subnet range (in cidr notation) in output e.g.: --subnet-range 10.10.0.0/16

--long

List additional fields in output

--project <project>

List only subnets which belong to a given project in output (name or ID)

--any-tags <tag>[,<tag>,…​]

List subnets which have any given tag(s) (comma- separated list of tags)

--network <network>

List only subnets which belong to a given network in output (name or ID)

--not-tags <tag>[,<tag>,…​]

Exclude subnets which have all given tag(s) (comma- separated list of tags)

--gateway <gateway>

List only subnets of given gateway ip in output

-h, --help

Show this help message and exit

--service-type <service-type>

List only subnets of a given service type in output e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to list multiple service types)

--dhcp

List subnets which have dhcp enabled

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<name>

Name of the new subnet pool

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--share

Set this subnet pool as shared

--no-share

Set this subnet pool as not shared

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

Set subnet pool minimum prefix length

--no-tag

No tags associated with the subnet pool

--default-quota <num-ip-addresses>

Set default quota for subnet pool as the number ofip addresses allowed in a subnet

--tag <tag>

Tag to be added to the subnet pool (repeat option to set multiple tags)

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

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

Set subnet pool maximum prefix length

--pool-prefix <pool-prefix>

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

--no-default

Set this as a non-default subnet pool

--default

Set this as a default subnet pool

-h, --help

Show this help message and exit

--description <description>

Set subnet pool description

--project <project>

Owner’s project (name or id)

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

Set subnet pool default prefix length

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<subnet-pool>

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--noindent

Whether to disable indenting the json

--share

List subnet pools shared between projects

--not-any-tags <tag>[,<tag>,…​]

Exclude subnet pools which have any given tag(s) (Comma-separated list of tags)

--name <name>

List only subnet pools of given name in output

--tags <tag>[,<tag>,…​]

List subnet pools which have all given tag(s) (comma- separated list of tags)

--long

List additional fields in output

--project-domain <project-domain>

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

--any-tags <tag>[,<tag>,…​]

List subnet pools which have any given tag(s) (comma- separated list of tags)

--address-scope <address-scope>

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

--no-share

List subnet pools not shared between projects

--not-tags <tag>[,<tag>,…​]

Exclude subnet pools which have all given tag(s) (Comma-separated list of tags)

--no-default

List subnet pools not used as the default external subnet pool

--default

List subnet pools used as the default external subnet pool

-h, --help

Show this help message and exit

--project <project>

List subnet pools according to their project (name or ID)

<subnet-pool>

Subnet pool to modify (name or id)

--no-address-scope

Remove address scope associated with the subnet pool

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

Set subnet pool minimum prefix length

--no-tag

Clear tags associated with the subnet pool. specify both --tag and --no-tag to overwrite current tags

--name <name>

Set subnet pool name

--default-quota <num-ip-addresses>

Set default quota for subnet pool as the number ofip addresses allowed in a subnet

--tag <tag>

Tag to be added to the subnet pool (repeat option to set multiple tags)

--address-scope <address-scope>

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

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

Set subnet pool maximum prefix length

--pool-prefix <pool-prefix>

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

--no-default

Set this as a non-default subnet pool

--default

Set this as a default subnet pool

-h, --help

Show this help message and exit

--description <description>

Set subnet pool description

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

Set subnet pool default prefix length

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<subnet-pool>

Subnet pool to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<subnet-pool>

Subnet pool to modify (name or id)

--all-tag

Clear all tags associated with the subnet pool

-h, --help

Show this help message and exit

--pool-prefix <pool-prefix>

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

--tag <tag>

Tag to be removed from the subnet pool (repeat option to remove multiple tags)

<subnet>

Subnet to modify (name or id)

--no-allocation-pool

Clear associated allocation-pools from the subnet. Specify both --allocation-pool and --no-allocation- pool to overwrite the current allocation pool information.

--no-dhcp

Disable dhcp

--dhcp

Enable dhcp

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses for this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to add multiple IP addresses)

--no-tag

Clear tags associated with the subnet. specify both --tag and --no-tag to overwrite current tags

--name <name>

Updated name of the subnet

--no-host-route

Clear associated host-routes from the subnet. specify both --host-route and --no-host-route to overwrite the current host route information.

--host-route destination=<subnet>,gateway=<ip-address>

Additional route for this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to add multiple routes)

--dns-nameserver <dns-nameserver>

Dns server for this subnet (repeat option to set multiple DNS servers)

--gateway <gateway>

Specify a gateway for the subnet. the options are: <ip-address>: Specific IP address to use as the gateway, none: This subnet will not use a gateway, e.g.: --gateway 192.168.9.1, --gateway none.

--no-dns-nameservers

Clear existing information of dns nameservers. specify both --dns-nameserver and --no-dns-nameserver to overwrite the current DNS Nameserver information.

-h, --help

Show this help message and exit

--description <description>

Set subnet description

--service-type <service-type>

Service type for this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to set multiple service types)

--tag <tag>

Tag to be added to the subnet (repeat option to set multiple tags)

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<subnet>

Subnet to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<subnet>

Subnet to modify (name or id)

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses to be removed from this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to unset multiple allocation pools)

--host-route destination=<subnet>,gateway=<ip-address>

Route to be removed from this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to unset multiple host routes)

--dns-nameserver <dns-nameserver>

Dns server to be removed from this subnet (repeat option to unset multiple DNS servers)

--all-tag

Clear all tags associated with the subnet

-h, --help

Show this help message and exit

--service-type <service-type>

Service type to be removed from this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to unset multiple service types)

--tag <tag>

Tag to be removed from the subnet (repeat option to remove multiple tags)