summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/consumer.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/consumer.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/consumer.rst')
-rw-r--r--doc/source/cli/command-objects/consumer.rst83
1 files changed, 83 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst
new file mode 100644
index 00000000..d4ce5dc5
--- /dev/null
+++ b/doc/source/cli/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
+
+ openstack consumer create
+ [--description <description>]
+
+.. option:: --description <description>
+
+ New consumer description
+
+consumer delete
+---------------
+
+Delete consumer(s)
+
+.. program:: consumer delete
+.. code:: bash
+
+ openstack consumer delete
+ <consumer> [<consumer> ...]
+
+.. describe:: <consumer>
+
+ Consumer(s) to delete
+
+consumer list
+-------------
+
+List consumers
+
+.. program:: consumer list
+.. code:: bash
+
+ openstack consumer list
+
+consumer set
+------------
+
+Set consumer properties
+
+.. program:: consumer set
+.. code:: bash
+
+ openstack 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
+
+ openstack consumer show
+ <consumer>
+
+.. _consumer_show-consumer:
+.. describe:: <consumer>
+
+ Consumer to display