diff options
| author | Alexey Lebedeff <alebedev@mirantis.com> | 2016-08-08 19:31:27 +0300 |
|---|---|---|
| committer | Alexey Lebedeff <alebedev@mirantis.com> | 2016-08-12 20:38:29 +0300 |
| commit | 2482c9fe4b540d9ef9a66cd6ca3534015eeb88bc (patch) | |
| tree | bbc4eb90c86fc18f578c95891314af1ea91af02b /docs/rabbitmqctl.1.xml | |
| parent | 065f31d3d878f887bb811db0c5a49029a3f057ef (diff) | |
| download | rabbitmq-server-git-2482c9fe4b540d9ef9a66cd6ca3534015eeb88bc.tar.gz | |
Add support for listing only local queues
Partially implements https://github.com/rabbitmq/rabbitmq-server/issues/851
- Made old `--online`/`--offline` options mutually exclusive between
themselves and the new `--local` option
- Added documentation both for the old and the new option
- Fixed some ugly indentation in generated usage (only `set_policy`
wrapped line remains unfixed)
- Added integration test suite for `rabbitmqctl list_queues`
Diffstat (limited to 'docs/rabbitmqctl.1.xml')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 42 |
1 files changed, 38 insertions, 4 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index ec864af6cf..7dd926eba8 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -749,9 +749,7 @@ <varlistentry> <term> - <cmdsynopsis> - <command>authenticate_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg> - </cmdsynopsis> + <cmdsynopsis><command>authenticate_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg></cmdsynopsis> </term> <listitem> <variablelist> @@ -1237,7 +1235,9 @@ <variablelist> <varlistentry role="usage-has-option-list"> - <term><cmdsynopsis><command>list_queues</command> <arg choice="opt">-p <replaceable>vhost</replaceable></arg> <arg choice="opt" role="usage-option-list"><replaceable>queueinfoitem</replaceable> ...</arg></cmdsynopsis></term> + <term> + <cmdsynopsis><command>list_queues</command> <arg choice="opt">-p <replaceable>vhost</replaceable></arg> <group choice="opt"><arg>--offline</arg><arg>--online</arg><arg>--local</arg></group> <arg choice="opt" role="usage-option-list"><replaceable>queueinfoitem</replaceable> ...</arg></cmdsynopsis> + </term> <listitem> <para> Returns queue details. Queue details of the <command>/</command> virtual host @@ -1245,6 +1245,40 @@ override this default. </para> <para> + Displayed queues can be filtered by their status or + location using one of the following mutually exclusive + options: + <variablelist> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--offline</arg></cmdsynopsis></term> + <listitem> + <para> + List only those durable queues that are not + currently running - i.e. they are located on + inaccessible nodes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--online</arg></cmdsynopsis></term> + <listitem> + <para> + List queues that are currently live. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--local</arg></cmdsynopsis></term> + <listitem> + <para> + List only those queues whose master process is + located on the current node. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> The <command>queueinfoitem</command> parameter is used to indicate which queue information items to include in the results. The column order in the results will match the order of the parameters. |