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

subnet

A subnet is a block of IP addresses and associated configuration state. Subnets are used to allocate IP addresses when new ports are created on a network.

Network v2

subnet create

Create new subnet

subnet create

openstack 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}]
    [--description <description>]
    [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    [--network-segment <network-segment>]
    [--service-type <service-type>]
    --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 (repeat option to add multiple IP addresses)

--dhcp

Enable DHCP (default)

--no-dhcp

Disable DHCP

--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 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 (repeat option to add multiple routes)

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

--description <description>

Set subnet description

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

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

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

--network <network>

Network this subnet belongs to (name or ID)

Name of subnet to create

subnet delete

Delete subnet(s)

subnet delete

openstack subnet delete
    <subnet> [<subnet> ...]




Subnet(s) to delete (name or ID)

subnet list

List subnets

subnet list

openstack subnet list
    [--long]
    [--ip-version {4,6}]
    [--dhcp | --no-dhcp]
    [--project <project> [--project-domain <project-domain>]]
    [--network <network>]
    [--gateway <gateway>]
    [--name <name>]
    [--subnet-range <subnet-range>]

--long

List additional fields in output

--ip-version {4, 6}

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

--dhcp

List subnets which have DHCP enabled

--no-dhcp

List subnets which have DHCP disabled

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

--project <project>

List only subnets which belong to a given project (name or ID) 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.

--network <network>

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

--gateway <gateway>

List only subnets of given gateway IP in output

--name <name>

List only subnets of given name in output

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

subnet set

Set subnet properties

subnet set

openstack subnet set
    [--allocation-pool start=<ip-address>,end=<ip-address>]
    [--no-allocation-pool]
    [--dhcp | --no-dhcp]
    [--dns-nameserver <dns-nameserver>]
    [--no-dns-nameserver]
    [--gateway <gateway-ip>]
    [--host-route destination=<subnet>,gateway=<ip-address>]
    [--no-host-route]
    [--service-type <service-type>]
    [--name <new-name>]
    [--description <description>]
    <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)

--no-allocation-pool

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

--dhcp

Enable DHCP

--no-dhcp

Disable DHCP

--dns-nameserver <dns-nameserver>

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

--no-dns-nameservers

Clear existing information of DNS servers. Specify both --dns-nameserver and --no-dns-nameservers to overwrite the current DNS server information.

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

--no-host-route

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

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

--description <description>

Set subnet description

--name

Updated name of the subnet

Subnet to modify (name or ID)

subnet show

Display subnet details

subnet show

openstack subnet show
    <subnet>




Subnet to display (name or ID)

subnet unset

Unset subnet properties

subnet unset

openstack subnet unset
    [--allocation-pool start=<ip-address>,end=<ip-address> [...]]
    [--dns-nameserver <dns-nameserver> [...]]
    [--host-route destination=<subnet>,gateway=<ip-address> [...]]
    [--service-type <service-type>]
    <subnet>

--dns-nameserver <dns-nameserver>

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

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

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

Subnet to modify (name or ID)