diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/region.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
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 <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/region.rst')
| -rw-r--r-- | doc/source/cli/command-objects/region.rst | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst new file mode 100644 index 00000000..d2c63c1b --- /dev/null +++ b/doc/source/cli/command-objects/region.rst @@ -0,0 +1,104 @@ +====== +region +====== + +Identity v3 + +region create +------------- + +Create new region + +.. program:: region create +.. code:: bash + + openstack region create + [--parent-region <region-id>] + [--description <description>] + <region-id> + +.. 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 |