diff options
| author | Jenkins <jenkins@review.openstack.org> | 2015-01-02 09:17:00 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2015-01-02 09:17:00 +0000 |
| commit | 6c0d4b82e027cc0573be05d19c5ae779e7e7425c (patch) | |
| tree | 7607557c9c3fd9a3f338cdd5f5b4b16dfe9862b4 /doc/source/command-objects | |
| parent | ee912035cad408dca9bc8bad0939feb988e4bfd9 (diff) | |
| parent | b5ce0f145f9342a01370ac34a7a11d40df703249 (diff) | |
| download | python-openstackclient-6c0d4b82e027cc0573be05d19c5ae779e7e7425c.tar.gz | |
Merge "Command docs: region"
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/region.rst | 68 |
1 files changed, 44 insertions, 24 deletions
diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index 788ed6fa..d1aedb31 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -9,24 +9,30 @@ region create Create new region +.. program:: region create .. code:: bash os region create [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] + [--description <description>] + [--url <url>] <region-id> -:option:`--parent-region` <region-id> - Parent region +.. option:: --parent-region <region-id> + + Parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region-id>` +.. _region_create-region-id: +.. describe:: <region-id> + New region ID region delete @@ -34,61 +40,75 @@ region delete Delete region +.. program:: region delete .. code:: bash os region delete - <region> + <region-id> + +.. _region_delete-region-id: +.. describe:: <region-id> -:option:`<region>` - Region to delete + Region ID to delete region list ----------- List regions +.. program:: region list .. code:: bash os region list [--parent-region <region-id>] -:option:`--parent-region` <region-id> - Filter by a specific parent region +.. option:: --parent-region <region-id> + + Filter by parent region ID region set ---------- Set region properties +.. program:: region set .. code:: bash os region set [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] - <region> + [--description <description>] + [--url <url>] + <region-id> -:option:`--parent-region` <region-id> - New parent region +.. option:: --parent-region <region-id> + + New parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region>` +.. _region_set-region-id: +.. describe:: <region-id> + Region ID to modify region show ----------- -Show region +Display region details +.. program:: region show .. code:: bash os region show - <region> + <region-id> -:option:`<region>` - Region ID to modify +.. _region_show-region-id: +.. describe:: <region-id> + + Region ID to display |