summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/subnet-pool.rst
diff options
context:
space:
mode:
authorEric Fried <openstack@fried.cc>2019-10-28 17:27:38 -0500
committerEric Fried <openstack@fried.cc>2019-11-01 14:24:30 -0500
commitcd6c285cc6c2274e6b42cc452ba4a61a3487ca23 (patch)
tree334eddf792c9287511a8d419e82c2e6777fd63b2 /doc/source/cli/command-objects/subnet-pool.rst
parent61ad83b57580c76a1c448e03064c4df6bcc01e87 (diff)
downloadpython-openstackclient-cd6c285cc6c2274e6b42cc452ba4a61a3487ca23.tar.gz
neutron: autogenerate docs
$namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
Diffstat (limited to 'doc/source/cli/command-objects/subnet-pool.rst')
-rw-r--r--doc/source/cli/command-objects/subnet-pool.rst303
1 files changed, 2 insertions, 301 deletions
diff --git a/doc/source/cli/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst
index 77259a83..ce9649dc 100644
--- a/doc/source/cli/command-objects/subnet-pool.rst
+++ b/doc/source/cli/command-objects/subnet-pool.rst
@@ -7,304 +7,5 @@ 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 <default-prefix-length>]
- [--min-prefix-length <min-prefix-length>]
- [--max-prefix-length <max-prefix-length>]
- [--description <description>]
- [--project <project> [--project-domain <project-domain>]]
- [--address-scope <address-scope>]
- [--default | --no-default]
- [--share | --no-share]
- [--default-quota <num-ip-addresses>]
- [--tag <tag> | --no-tag]
- --pool-prefix <pool-prefix> [...]
- <name>
-
-.. option:: --default-prefix-length <default-prefix-length>
-
- Set subnet pool default prefix length
-
-.. option:: --min-prefix-length <min-prefix-length>
-
- Set subnet pool minimum prefix length
-
-.. option:: --max-prefix-length <max-prefix-length>
-
- Set subnet pool maximum prefix length
-
-.. option:: --description <description>
-
- Set subnet pool description
-
-.. option:: --project <project>
-
- Owner's project (name or ID)
-
-.. option:: --project-domain <project-domain>
-
- Domain the project belongs to (name or ID). This can be used in case
- collisions between project names exist.
-
-.. option:: --address-scope <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 <num-ip-addresses>
-
- Set default per-project quota for this subnet pool as the number of
- IP addresses that can be allocated from the subnet pool
-
-.. option:: --tag <tag>
-
- Tag to be added to the subnet pool (repeat option to set multiple tags)
-
-.. option:: --no-tag
-
- No tags associated with the subnet pool
-
-.. option:: --pool-prefix <pool-prefix>
-
- Set subnet pool prefixes (in CIDR notation)
- (repeat option to set multiple prefixes)
-
-.. _subnet_pool_create-name:
-.. describe:: <name>
-
- 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> [<subnet-pool> ...]
-
-.. _subnet_pool_delete-subnet-pool:
-.. describe:: <subnet-pool>
-
- 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> [--project-domain <project-domain>]]
- [--name <name>]
- [--address-scope <address-scope>]
- [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
- [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
-
-.. 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 <project>
-
- List subnet pools according to their project (name or ID)
-
-.. option:: --project-domain <project-domain>
-
- Domain the project belongs to (name or ID).
- This can be used in case collisions between project names exist.
-
-.. option:: --name <name>
-
- List only subnet pools of given name in output
-
-.. option:: --address-scope <address-scope>
-
- List only subnet pools of given address scope in output (name or ID)
-
-.. option:: --tags <tag>[,<tag>,...]
-
- List subnet pools which have all given tag(s)
-
-.. option:: --any-tags <tag>[,<tag>,...]
-
- List subnet pools which have any given tag(s)
-
-.. option:: --not-tags <tag>[,<tag>,...]
-
- Exclude subnet pools which have all given tag(s)
-
-.. option:: --not-any-tags <tag>[,<tag>,...]
-
- Exclude subnet pools which have any given tag(s)
-
-subnet pool set
----------------
-
-Set subnet pool properties
-
-.. program:: subnet pool set
-.. code:: bash
-
- openstack subnet pool set
- [--name <name>]
- [--pool-prefix <pool-prefix> [...]]
- [--default-prefix-length <default-prefix-length>]
- [--min-prefix-length <min-prefix-length>]
- [--max-prefix-length <max-prefix-length>]
- [--address-scope <address-scope> | --no-address-scope]
- [--default | --no-default]
- [--description <description>]
- [--default-quota <num-ip-addresses>]
- [--tag <tag>] [--no-tag]
- <subnet-pool>
-
-.. option:: --name <name>
-
- Set subnet pool name
-
-.. option:: --pool-prefix <pool-prefix>
-
- Set subnet pool prefixes (in CIDR notation)
- (repeat option to set multiple prefixes)
-
-.. option:: --default-prefix-length <default-prefix-length>
-
- Set subnet pool default prefix length
-
-.. option:: --min-prefix-length <min-prefix-length>
-
- Set subnet pool minimum prefix length
-
-.. option:: --max-prefix-length <max-prefix-length>
-
- Set subnet pool maximum prefix length
-
-.. option:: --address-scope <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 <description>
-
- Set subnet pool description
-
-.. option:: --default-quota <num-ip-addresses>
-
- Set default per-project quota for this subnet pool as the number of
- IP addresses that can be allocated from the subnet pool
-
-.. option:: --tag <tag>
-
- Tag to be added to the subnet pool (repeat option to set multiple tags)
-
-.. option:: --no-tag
-
- Clear tags associated with the subnet pool. Specify both --tag
- and --no-tag to overwrite current tags
-
-.. _subnet_pool_set-subnet-pool:
-.. describe:: <subnet-pool>
-
- 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>
-
-.. _subnet_pool_show-subnet-pool:
-.. describe:: <subnet-pool>
-
- Subnet pool to display (name or ID)
-
-subnet pool unset
------------------
-
-Unset subnet pool properties
-
-.. program:: subnet pool unset
-.. code:: bash
-
- openstack subnet pool unset
- [--tag <tag> | --all-tag]
- <subnet-pool>
-
-.. option:: --tag <tag>
-
- Tag to be removed from the subnet pool
- (repeat option to remove multiple tags)
-
-.. option:: --all-tag
-
- Clear all tags associated with the subnet pool
-
-.. _subnet_pool_unset-subnet-pool:
-.. describe:: <subnet-pool>
-
- Subnet pool to modify (name or ID)
+.. autoprogram-cliff:: openstack.network.v2
+ :command: subnet pool *