python-openstackclient/doc/source/command-objects/consumer.rst
Kevin_Zheng 9663424c74 change os in command example to openstack
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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00

84 lines
1.1 KiB
ReStructuredText

========
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