From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/subnet.rst | 374 ++++++++++++++++++++++++++++++ 1 file changed, 374 insertions(+) create mode 100644 doc/source/cli/command-objects/subnet.rst (limited to 'doc/source/cli/command-objects/subnet.rst') diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst new file mode 100644 index 00000000..4e609361 --- /dev/null +++ b/doc/source/cli/command-objects/subnet.rst @@ -0,0 +1,374 @@ +====== +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 + +.. program:: subnet create +.. code:: bash + + openstack subnet create + [--project [--project-domain ]] + [--subnet-pool | --use-default-subnet-pool [--prefix-length ]] + [--subnet-range ] + [--allocation-pool start=,end=] + [--dhcp | --no-dhcp] + [--dns-nameserver ] + [--gateway ] + [--host-route destination=,gateway=] + [--ip-version {4,6}] + [--description ] + [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + [--network-segment ] + [--service-type ] + --network + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --subnet-pool + + Subnet pool from which this subnet will obtain a CIDR (name or ID) + +.. option:: --use-default-subnet-pool + + Use default subnet pool for :option:`--ip-version` + +.. option:: --prefix-length + + Prefix length for subnet allocation from subnet pool + +.. option:: --subnet-range + + Subnet range in CIDR notation + (required if :option:`--subnet-pool` is not specified, optional otherwise) + +.. option:: --allocation-pool start=,end= + + 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) + +.. option:: --dhcp + + Enable DHCP (default) + +.. option:: --no-dhcp + + Disable DHCP + +.. option:: --dns-nameserver + + DNS server for this subnet (repeat option to set multiple DNS servers) + +.. option:: --gateway + + Specify a gateway for the subnet. The three options are: + : 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'). + +.. option:: --host-route destination=,gateway= + + 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) + +.. option:: --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. + +.. option:: --description + + Set subnet description + +.. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 RA (Router Advertisement) mode, + valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --network-segment + + Network segment to associate with this subnet (name or ID) + +.. option:: --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) + +.. option:: --network + + Network this subnet belongs to (name or ID) + +.. _subnet_create-name: +.. describe:: + + Name of subnet to create + +subnet delete +------------- + +Delete subnet(s) + +.. program:: subnet delete +.. code:: bash + + openstack subnet delete + [ ...] + +.. _subnet_delete-subnet: +.. describe:: + + Subnet(s) to delete (name or ID) + +subnet list +----------- + +List subnets + +.. program:: subnet list +.. code:: bash + + openstack subnet list + [--long] + [--ip-version {4,6}] + [--dhcp | --no-dhcp] + [--project [--project-domain ]] + [--network ] + [--gateway ] + [--name ] + [--subnet-range ] + +.. option:: --long + + List additional fields in output + +.. option:: --ip-version {4, 6} + + List only subnets of given IP version in output. + Allowed values for IP version are 4 and 6. + +.. option:: --dhcp + + List subnets which have DHCP enabled + +.. option:: --no-dhcp + + List subnets which have DHCP disabled + +.. option:: --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) + +.. option:: --project + + List only subnets which belong to a given project in output (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --network + + List only subnets which belong to a given network in output (name or ID) + +.. option:: --gateway + + List only subnets of given gateway IP in output + +.. option:: --name + + List only subnets of given name in output + +.. option:: --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 + +.. program:: subnet set +.. code:: bash + + openstack subnet set + [--allocation-pool start=,end=] + [--no-allocation-pool] + [--dhcp | --no-dhcp] + [--dns-nameserver ] + [--no-dns-nameserver] + [--gateway ] + [--host-route destination=,gateway=] + [--no-host-route] + [--service-type ] + [--name ] + [--description ] + + +.. option:: --allocation-pool start=,end= + + 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) + +.. option:: --no-allocation-pool + + Clear associated allocation pools from this subnet. + Specify both :option:`--allocation-pool` and :option:`--no-allocation-pool` + to overwrite the current allocation pool information. + +.. option:: --dhcp + + Enable DHCP + +.. option:: --no-dhcp + + Disable DHCP + +.. option:: --dns-nameserver + + DNS server for this subnet (repeat option to set multiple DNS servers) + +.. option:: --no-dns-nameservers + + Clear existing information of DNS servers. + Specify both :option:`--dns-nameserver` and :option:`--no-dns-nameservers` + to overwrite the current DNS server information. + +.. option:: --gateway + + Specify a gateway for the subnet. The options are: + : 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``. + +.. option:: --host-route destination=,gateway= + + 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 + +.. option:: --no-host-route + + Clear associated host routes from this subnet. + Specify both :option:`--host-route` and :option:`--no-host-route` + to overwrite the current host route information. + +.. option:: --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) + +.. option:: --description + + Set subnet description + +.. option:: --name + + Updated name of the subnet + +.. _subnet_set-subnet: +.. describe:: + + Subnet to modify (name or ID) + + +subnet show +----------- + +Display subnet details + +.. program:: subnet show +.. code:: bash + + openstack subnet show + + +.. _subnet_show-subnet: +.. describe:: + + Subnet to display (name or ID) + +subnet unset +------------ + +Unset subnet properties + +.. program:: subnet unset +.. code:: bash + + openstack subnet unset + [--allocation-pool start=,end= [...]] + [--dns-nameserver [...]] + [--host-route destination=,gateway= [...]] + [--service-type ] + + +.. option:: --dns-nameserver + + DNS server to be removed from this subnet + (repeat option to unset multiple DNS servers) + +.. option:: --allocation-pool start=,end= + + 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) + +.. option:: --host-route destination=,gateway= + + 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) + +.. option:: --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_unset-subnet: +.. describe:: + + Subnet to modify (name or ID) -- cgit v1.2.1