summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-01-08 01:29:35 -0500
committerSteve Martinelli <stevemar@ca.ibm.com>2015-01-08 17:28:09 -0500
commitc885c72cba459ca853de10ec1685d70d9c2b7ca2 (patch)
tree8d38d799e6b424b36e2238f8a5aa69f1e3353d36 /doc/source
parent6b196d1a17531b56d0a19b95a81a21c6a2ccc625 (diff)
downloadpython-openstackclient-c885c72cba459ca853de10ec1685d70d9c2b7ca2.tar.gz
Command doc: consumer
Change-Id: Ie687e1d7f80810106a64204828299f9d143b8d7c
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/consumer.rst83
-rw-r--r--doc/source/commands.rst2
2 files changed, 84 insertions, 1 deletions
diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst
new file mode 100644
index 00000000..59ace845
--- /dev/null
+++ b/doc/source/command-objects/consumer.rst
@@ -0,0 +1,83 @@
+========
+consumer
+========
+
+Identity v3
+
+`Requires: OS-OAUTH1 extension`
+
+consumer create
+---------------
+
+Create new consumer
+
+.. program:: consumer create
+.. code:: bash
+
+ os consumer create
+ [--description <description>]
+
+.. option:: --description <description>
+
+ New consumer description
+
+consumer delete
+---------------
+
+Delete a consumer
+
+.. program:: consumer delete
+.. code:: bash
+
+ os consumer delete
+ <consumer>
+
+.. describe:: <consumer>
+
+ Consumer to delete
+
+consumer list
+-------------
+
+List consumers
+
+.. program:: consumer list
+.. code:: bash
+
+ os consumer list
+
+consumer set
+------------
+
+Set consumer properties
+
+.. program:: consumer set
+.. code:: bash
+
+ os consumer set
+ [--description <description>]
+ <consumer>
+
+.. option:: --description <description>
+
+ New consumer description
+
+.. describe:: <consumer>
+
+ Consumer to modify
+
+consumer show
+-------------
+
+Display consumer details
+
+.. program:: consumer show
+.. code:: bash
+
+ os consumer show
+ <consumer>
+
+.. _consumer_show-consumer:
+.. describe:: <consumer>
+
+ Consumer to display
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index bb3db187..9d609843 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -76,7 +76,7 @@ referring to both Compute and Volume quotas.
* ``catalog``: (**Identity**) service catalog
* ``console log``: (**Compute**) server console text dump
* ``console url``: (**Compute**) server remote console URL
-* ``consumer``: Identity - OAuth-based delegatee
+* ``consumer``: (**Identity**) OAuth-based delegatee
* ``container``: (**Object Store**) a grouping of objects
* ``credentials``: (**Identity**) specific to identity providers
* ``domain``: (**Identity**) a grouping of projects