Update purge doc
purge command guide is missing. Change-Id: I92dcd1ca025aa1c5982fe22fee000d237c110022
This commit is contained in:
parent
33a3681157
commit
ab7e5ca9eb
@ -177,3 +177,29 @@ Get queue stats.
|
|||||||
|
|
||||||
``<queue_name>``
|
``<queue_name>``
|
||||||
Name of the queue.
|
Name of the queue.
|
||||||
|
|
||||||
|
|
||||||
|
.. _openstack_queue_purge:
|
||||||
|
|
||||||
|
openstack queue purge
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: openstack queue purge [-h] [--resource_types <resource_types>]
|
||||||
|
<queue_name>
|
||||||
|
|
||||||
|
Purge a queue. All the metadata of the queue will be kept. Use
|
||||||
|
``--resource_types`` to specify which resource should be pured. If
|
||||||
|
``--resource_types`` is not specified, all the messages and subscriptions in
|
||||||
|
the queue will be purged by default.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``<queue_name>``
|
||||||
|
Name of the queue.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``--resource_types <resource_types>`
|
||||||
|
Resource types want to be purged. Support ``messages`` and ``subscriptions``.
|
||||||
|
@ -95,4 +95,4 @@ Indices and tables
|
|||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
.. _`Release Page`: https://releases.openstack.org
|
.. _`Release Page`: https://docs.openstack.org/releasenotes/python-zaqarclient
|
||||||
|
Loading…
x
Reference in New Issue
Block a user