diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2014-11-17 22:59:57 -0600 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2014-12-04 15:45:06 -0600 |
| commit | 6a61dbc86fd2b45ea3126ed20f9f863109b794fb (patch) | |
| tree | ea105a525ce4fa9697ac6cad1671bb4bea411718 /doc/source/command-objects | |
| parent | cc54f989ec53efdf61563d3682ea787c49c21410 (diff) | |
| download | python-openstackclient-6a61dbc86fd2b45ea3126ed20f9f863109b794fb.tar.gz | |
Command object docs: catalog, credentials, endpoint, region, token
catalog
credentials
endpoint
region
token
Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/catalog.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/credentials.rst | 25 | ||||
| -rw-r--r-- | doc/source/command-objects/endpoint.rst | 45 | ||||
| -rw-r--r-- | doc/source/command-objects/region.rst | 94 | ||||
| -rw-r--r-- | doc/source/command-objects/token.rst | 19 |
5 files changed, 203 insertions, 0 deletions
diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst new file mode 100644 index 00000000..99746dd7 --- /dev/null +++ b/doc/source/command-objects/catalog.rst @@ -0,0 +1,20 @@ +======= +catalog +======= + +Identity v2 + +catalog list +------------ + +.. code:: bash + + os catalog list + +catalog show +------------ + +.. code:: bash + + os catalog show + <service> diff --git a/doc/source/command-objects/credentials.rst b/doc/source/command-objects/credentials.rst new file mode 100644 index 00000000..ea8fc08f --- /dev/null +++ b/doc/source/command-objects/credentials.rst @@ -0,0 +1,25 @@ +=========== +credentials +=========== + +credentials create +------------------ + +.. ''[consider rolling the ec2 creds into this too]'' + +.. code:: bash + + os credentials create + --x509 + [<private-key-file>] + [<certificate-file>] + +credentials show +---------------- + +.. code:: bash + + os credentials show + [--token] + [--user] + [--x509 [--root]] diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst new file mode 100644 index 00000000..128ddfa0 --- /dev/null +++ b/doc/source/command-objects/endpoint.rst @@ -0,0 +1,45 @@ +======== +endpoint +======== + +Identity v2, v3 + +endpoint create +--------------- + +.. program:: endpoint create +.. code:: bash + + os endpoint create + --publicurl <public-url> + [--adminurl <admin-url>] + [--internalurl <internal-url>] + [--region <endpoint-region>] + <service> + +endpoint delete +--------------- + +.. program:: endpoint delete +.. code:: bash + + os endpoint delete + <endpoint-id> + +endpoint list +------------- + +.. program:: endpoint list +.. code:: bash + + os endpoint list + [--long] + +endpoint show +------------- + +.. program:: endpoint show +.. code:: bash + + os endpoint show + <endpoint_or_service-type> diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst new file mode 100644 index 00000000..788ed6fa --- /dev/null +++ b/doc/source/command-objects/region.rst @@ -0,0 +1,94 @@ +====== +region +====== + +Identity v3 + +region create +------------- + +Create new region + +.. code:: bash + + os region create + [--parent-region <region-id>] + [--description <region-description>] + [--url <region-url>] + <region-id> + +:option:`--parent-region` <region-id> + Parent region + +:option:`--description` <region-description> + New region description + +:option:`--url` <region-url> + New region URL + +:option:`<region-id>` + New region ID + +region delete +------------- + +Delete region + +.. code:: bash + + os region delete + <region> + +:option:`<region>` + Region to delete + +region list +----------- + +List regions + +.. code:: bash + + os region list + [--parent-region <region-id>] + +:option:`--parent-region` <region-id> + Filter by a specific parent region + +region set +---------- + +Set region properties + +.. code:: bash + + os region set + [--parent-region <region-id>] + [--description <region-description>] + [--url <region-url>] + <region> + +:option:`--parent-region` <region-id> + New parent region + +:option:`--description` <region-description> + New region description + +:option:`--url` <region-url> + New region URL + +:option:`<region>` + Region ID to modify + +region show +----------- + +Show region + +.. code:: bash + + os region show + <region> + +:option:`<region>` + Region ID to modify diff --git a/doc/source/command-objects/token.rst b/doc/source/command-objects/token.rst new file mode 100644 index 00000000..aec87d28 --- /dev/null +++ b/doc/source/command-objects/token.rst @@ -0,0 +1,19 @@ +===== +token +===== + +Identity v2, v3 + +token issue +----------- + +.. code:: bash + + os token issue + +token revoke +------------ + +.. code:: bash + + os token revoke |
