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

subnet

Network v2

subnet delete

Delete a subnet

subnet delete

os subnet delete
    <subnet>




Subnet to delete (name or ID)

subnet create

Create new subnet

subnet create

os subnet create
    [--project <project> [--project-domain <project-domain>]]
    [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]]
    [--subnet-range <subnet-range>]
    [--allocation-pool start=<ip-address>,end=<ip-address>]
    [--dhcp | --no-dhcp]
    [--dns-nameserver <dns-nameserver>]
    [--gateway <gateway>]
    [--host-route destination=<subnet>,gateway=<ip-address>]
    [--ip-version {4,6}]
    [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    --network <network>
    <name>

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

--subnet-pool <subnet-pool>

Subnet pool from which this subnet will obtain a CIDR (name or ID)

--use-default-subnet-pool

Use default subnet pool for --ip-version

--prefix-length <prefix-length>

Prefix length for subnet allocation from subnet pool

--subnet-range <subnet-range>

Subnet range in CIDR notation

(required if --subnet-pool is not specified, optional otherwise)

--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 (This option can be repeated)

--dhcp

Enable DHCP (default)

--no-dhcp

Disable DHCP

--dns-nameserver <dns-nameserver>

DNS name server for this subnet (This option can be repeated)

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

--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 (This option can be repeated)

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

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

IPv6 RA (Router Advertisement) mode,

valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]

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

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

--network <network>

Network this subnet belongs to (name or ID)

Name of subnet to create

subnet list

List subnets

subnet list

os subnet list
    [--long]

--long

List additional fields in output

subnet set

Set subnet properties

subnet set

os subnet set
    [--allocation-pool start=<ip-address>,end=<ip-address>]
    [--dhcp | --no-dhcp]
    [--dns-nameserver <dns-nameserver>]
    [--gateway <gateway-ip>]
    [--host-route destination=<subnet>,gateway=<ip-address>]
    [--name <new-name>]
    <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 (This option can be repeated)

--dhcp

Enable DHCP

--no-dhcp

Disable DHCP

--dns-nameserver <dns-nameserver>

DNS name server for this subnet (This option can be repeated)

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

--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 (This option can be repeated)

--name

Updated name of the subnet

Subnet to modify (name or ID)

subnet show

Show subnet details

subnet show

os subnet show
    <subnet>




Subnet to show (name or ID)