summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-01-09 08:38:39 +0000
committerGerrit Code Review <review@openstack.org>2015-01-09 08:38:39 +0000
commitbf964810b7c019f22d80084bb2318f4eaac6911f (patch)
treef794b3eb17e8569e7ff80aa5ac92fae829ae1054 /doc/source/command-objects
parent0d7a50d3848484d6562dbd6af87de7836365821a (diff)
parentc885c72cba459ca853de10ec1685d70d9c2b7ca2 (diff)
downloadpython-openstackclient-bf964810b7c019f22d80084bb2318f4eaac6911f.tar.gz
Merge "Command doc: consumer"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/consumer.rst83
1 files changed, 83 insertions, 0 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