openstack/python-openstackclient
Code Issues Proposed changes
a87bd58fb4
python-openstackclient/doc/source/cli/command-objects/region.rst

105 lines
1.5 KiB
ReStructuredText
Raw Normal View History

Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
======
region
======
Identity v3
region create
-------------
Create new region
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. program:: region create
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack region create
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
[--parent-region <region-id>]
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
[--description <description>]
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
<region-id>
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. option:: --parent-region <region-id>
Parent region ID
.. option:: --description <description>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
New region description
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. _region_create-region-id:
.. describe:: <region-id>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
New region ID
region delete
-------------
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
Delete region(s)
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. program:: region delete
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack region delete
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
<region-id> [<region-id> ...]
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. _region_delete-region-id:
.. describe:: <region-id>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906
2016-07-12 12:44:55 +08:00
Region ID(s) to delete
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
region list
-----------
List regions
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. program:: region list
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack region list
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
[--parent-region <region-id>]
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. option:: --parent-region <region-id>
Filter by parent region ID
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
region set
----------
Set region properties
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. program:: region set
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack region set
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
[--parent-region <region-id>]
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
[--description <description>]
<region-id>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. option:: --parent-region <region-id>
New parent region ID
.. option:: --description <description>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
New region description
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. _region_set-region-id:
.. describe:: <region-id>
Fine tune some of the helps commands try and add some consistency with the show and delete commands. replace 'show x' with 'display x' change 'delete a y' with just 'delete y' Change-Id: I47dfa8ee23ac5c41b355796415eb515155832f65
2015-01-09 19:13:03 -05:00
Region to modify
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
region show
-----------
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
Display region details
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. program:: region show
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack region show
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
<region-id>
Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
2014-11-17 22:59:57 -06:00
Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
2014-12-31 10:05:37 -06:00
.. _region_show-region-id:
.. describe:: <region-id>
Fine tune some of the helps commands try and add some consistency with the show and delete commands. replace 'show x' with 'display x' change 'delete a y' with just 'delete y' Change-Id: I47dfa8ee23ac5c41b355796415eb515155832f65
2015-01-09 19:13:03 -05:00
Region to display
Copy Permalink