diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2017-08-17 12:17:39 -0400 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-10-06 00:57:04 +0000 |
| commit | 0d94a76d956c0322e9c4607fb5ce824f7653f038 (patch) | |
| tree | 5044ef180d214ce9a161739c5a6d748970e94766 /doc/source/cli/command-objects/region.rst | |
| parent | a87bd58fb4de5dc5f99193b88d2a3f8bd1338c52 (diff) | |
| download | python-openstackclient-0d94a76d956c0322e9c4607fb5ce824f7653f038.tar.gz | |
auto-generate docs for v3 identity resources
skipped shared v2/v3 identity resources.
Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
Diffstat (limited to 'doc/source/cli/command-objects/region.rst')
| -rw-r--r-- | doc/source/cli/command-objects/region.rst | 108 |
1 files changed, 13 insertions, 95 deletions
diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst index d2c63c1b..58cc341f 100644 --- a/doc/source/cli/command-objects/region.rst +++ b/doc/source/cli/command-objects/region.rst @@ -2,103 +2,21 @@ region ====== -Identity v3 +A **region** is a general division of an OpenStack deployment. You can associate +zero or more sub-regions with a region to create a tree-like structured +hierarchy. Applies to Identity v3. -region create -------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: region create -Create new region +.. autoprogram-cliff:: openstack.identity.v3 + :command: region delete -.. program:: region create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: region list - openstack region create - [--parent-region <region-id>] - [--description <description>] - <region-id> +.. autoprogram-cliff:: openstack.identity.v3 + :command: region set -.. option:: --parent-region <region-id> - - Parent region ID - -.. option:: --description <description> - - New region description - -.. _region_create-region-id: -.. describe:: <region-id> - - New region ID - -region delete -------------- - -Delete region(s) - -.. program:: region delete -.. code:: bash - - openstack region delete - <region-id> [<region-id> ...] - -.. _region_delete-region-id: -.. describe:: <region-id> - - Region ID(s) to delete - -region list ------------ - -List regions - -.. program:: region list -.. code:: bash - - openstack region list - [--parent-region <region-id>] - -.. option:: --parent-region <region-id> - - Filter by parent region ID - -region set ----------- - -Set region properties - -.. program:: region set -.. code:: bash - - openstack region set - [--parent-region <region-id>] - [--description <description>] - <region-id> - -.. option:: --parent-region <region-id> - - New parent region ID - -.. option:: --description <description> - - New region description - -.. _region_set-region-id: -.. describe:: <region-id> - - Region to modify - -region show ------------ - -Display region details - -.. program:: region show -.. code:: bash - - openstack region show - <region-id> - -.. _region_show-region-id: -.. describe:: <region-id> - - Region to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: region show |