summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-multi.1.xml
blob: 5f5c6c2febf25bddc46e9aa805c5d2d36e4d013a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd">
<refentry lang="en">
    <refentryinfo>
        <productname>RabbitMQ Server</productname>
        <authorgroup>
            <corpauthor>The RabbitMQ Team &lt;<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>&gt;</corpauthor>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>rabbitmq-multi</refentrytitle>
        <manvolnum>1</manvolnum>
        <refmiscinfo class="manual">RabbitMQ Server</refmiscinfo>
    </refmeta>

    <refnamediv>
        <refname>rabbitmq-multi</refname>
        <refpurpose>start/stop local cluster RabbitMQ nodes</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
        <cmdsynopsis>
          <command>rabbitmq-multi</command>
          <arg choice="req"><replaceable>command</replaceable></arg>
          <arg choice="opt" rep="repeat"><replaceable>command options</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>
        <para>
           RabbitMQ is an implementation of AMQP, the emerging standard for high
performance enterprise messaging. The RabbitMQ server is a robust and
scalable implementation of an AMQP broker.
        </para>
        <para>
rabbitmq-multi scripts allows for easy set-up of a cluster on a single
machine.
        </para>
    </refsect1>

    <refsect1>
      <title>Commands</title>
      <variablelist>
        <varlistentry>
          <term><cmdsynopsis><command>start_all</command> <arg choice="req"><replaceable>count</replaceable></arg></cmdsynopsis></term>
          <listitem>
            <para>
Start count nodes with unique names, listening on all IP addresses and
on sequential ports starting from 5672.
            </para>
            <para role="example-prefix">For example:</para>
            <screen role="example">rabbitmq-multi start_all 3</screen>
            <para role="example">
              Starts 3 local RabbitMQ nodes with unique, sequential port numbers.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term><cmdsynopsis><command>status</command></cmdsynopsis></term>
          <listitem>
            <para>
Print the status of all running RabbitMQ nodes.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term><cmdsynopsis><command>stop_all</command></cmdsynopsis></term>
          <listitem>
            <para>
Stop all local RabbitMQ nodes,
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term><cmdsynopsis><command>rotate_logs</command></cmdsynopsis></term>
          <listitem>
            <para>
Rotate log files for all local and running RabbitMQ nodes.
            </para>
          </listitem>
        </varlistentry>

      </variablelist>
    </refsect1>


    <refsect1>
        <title>See also</title>
        <para>
            <citerefentry><refentrytitle>rabbitmq-env.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
            <citerefentry><refentrytitle>rabbitmq-server</refentrytitle><manvolnum>1</manvolnum></citerefentry>
            <citerefentry><refentrytitle>rabbitmqctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        </para>
    </refsect1>
</refentry>