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-pool.rst | 269 +++++++++++++++++++++++++ 1 file changed, 269 insertions(+) create mode 100644 doc/source/cli/command-objects/subnet-pool.rst (limited to 'doc/source/cli/command-objects/subnet-pool.rst') diff --git a/doc/source/cli/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst new file mode 100644 index 00000000..3a60974a --- /dev/null +++ b/doc/source/cli/command-objects/subnet-pool.rst @@ -0,0 +1,269 @@ +=========== +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 + +.. program:: subnet pool create +.. code:: bash + + openstack subnet pool create + [--default-prefix-length ] + [--min-prefix-length ] + [--max-prefix-length ] + [--description ] + [--project [--project-domain ]] + [--address-scope ] + [--default | --no-default] + [--share | --no-share] + [--default-quota ] + --pool-prefix [...] + + +.. option:: --default-prefix-length + + Set subnet pool default prefix length + +.. option:: --min-prefix-length + + Set subnet pool minimum prefix length + +.. option:: --max-prefix-length + + Set subnet pool maximum prefix length + +.. option:: --description + + Set subnet pool description + +.. 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:: --address-scope + + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes + +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + +.. option:: --share + + Set this subnet pool as shared + +.. option:: --no-share + + Set this subnet pool as not shared + +.. option:: --default-quota + + Set default quota for subnet pool as the number of + IP addresses allowed in a subnet + +.. option:: --pool-prefix + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + +.. _subnet_pool_create-name: +.. describe:: + + Name of the new subnet pool + +subnet pool delete +------------------ + +Delete subnet pool(s) + +.. program:: subnet pool delete +.. code:: bash + + openstack subnet pool delete + [ ...] + +.. _subnet_pool_delete-subnet-pool: +.. describe:: + + Subnet pool(s) to delete (name or ID) + +subnet pool list +---------------- + +List subnet pools + +.. program:: subnet pool list +.. code:: bash + + openstack subnet pool list + [--long] + [--share | --no-share] + [--default | --no-default] + [--project [--project-domain ]] + [--name ] + [--address-scope ] + +.. option:: --long + + List additional fields in output + +.. option:: --share + + List subnet pools shared between projects + +.. option:: --no-share + + List subnet pools not shared between projects + +.. option:: --default + + List subnet pools used as the default external subnet pool + +.. option:: --no-default + + List subnet pools not used as the default external subnet pool + +.. option:: --project + + List subnet pools according to their 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:: --name + + List only subnet pools of given name in output + +.. option:: --address-scope + + List only subnet pools of given address scope in output (name or ID) + +subnet pool set +--------------- + +Set subnet pool properties + +.. program:: subnet pool set +.. code:: bash + + openstack subnet pool set + [--name ] + [--pool-prefix [...]] + [--default-prefix-length ] + [--min-prefix-length ] + [--max-prefix-length ] + [--address-scope | --no-address-scope] + [--default | --no-default] + [--description ] + [--default-quota ] + + +.. option:: --name + + Set subnet pool name + +.. option:: --pool-prefix + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + +.. option:: --default-prefix-length + + Set subnet pool default prefix length + +.. option:: --min-prefix-length + + Set subnet pool minimum prefix length + +.. option:: --max-prefix-length + + Set subnet pool maximum prefix length + +.. option:: --address-scope + + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes + +.. option:: --no-address-scope + + Remove address scope associated with the subnet pool + +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + +.. option:: --description + + Set subnet pool description + +.. option:: --default-quota + + Set default quota for subnet pool as the number of + IP addresses allowed in a subnet + +.. _subnet_pool_set-subnet-pool: +.. describe:: + + Subnet pool to modify (name or ID) + +subnet pool show +---------------- + +Display subnet pool details + +.. program:: subnet pool show +.. code:: bash + + openstack subnet pool show + + +.. _subnet_pool_show-subnet-pool: +.. describe:: + + Subnet pool to display (name or ID) + +subnet pool unset +----------------- + +Unset subnet pool properties + +.. program:: subnet pool unset +.. code:: bash + + openstack subnet pool unset + [--pool-prefix [...]] + + +.. option:: --pool-prefix + + Remove subnet pool prefixes (in CIDR notation). + (repeat option to unset multiple prefixes). + +.. _subnet_pool_unset-subnet-pool: +.. describe:: + + Subnet pool to modify (name or ID) -- cgit v1.2.1