blob: 20adeb977e8702e269e4d0cddb41d98fbdb9507d [file] [log] [blame]
<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">3.5.&#160;Using the command line</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Getting-Started-Logging.html">Prev</a>&#160;</td><th align="center" width="60%">Chapter&#160;3.&#160;Getting Started</th><td align="right" width="20%">&#160;<a accesskey="n" href="Java-Broker-Concepts.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Getting-Started-CommandLine"></a>3.5.&#160;Using the command line</h2></div></div></div><p>The Broker understands a number of command line options which may be used to customise the configuration.</p><p>
For additional details about the broker configuration and related command line arguments see
<a class="xref" href="Java-Broker-Initial-Configuration.html" title="Chapter&#160;5.&#160;Initial Configuration">Chapter&#160;5, <em>Initial Configuration</em></a>.
The broker is fully configurable via its Web Management Console, for details of this see
<a class="xref" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2.&#160;Web Management Console">Section&#160;6.2, &#8220;Web Management Console&#8221;</a>.
</p><p>To see usage information for all command line options, use the <code class="option">--help</code> option</p><pre class="programlisting">bin/qpid-server --help</pre><pre class="screen">usage: Qpid [-cic &lt;path&gt;] [-h] [-icp &lt;path&gt;] [-mm] [-mmhttp &lt;port&gt;]
[-mmpass &lt;password&gt;] [-mmqv] [-os]
[-prop &lt;name=value&gt;] [-props &lt;path&gt;] [-sp &lt;path&gt;] [-st &lt;type&gt;] [-v]
-cic,--create-initial-config &lt;path&gt; create a copy of the
initial config file,
either to an
optionally specified
file path, or as
initial-config.json
in the current
directory
-h,--help print this message
-icp,--initial-config-path &lt;path&gt; set the location of
initial JSON config
to use when
creating/overwriting
a broker
configuration store
-mm,--management-mode start broker in
management mode,
disabling the AMQP
ports
-mmhttp,--management-mode-http-port &lt;port&gt; override http
management port in
management mode
-mmpass,--management-mode-password &lt;password&gt; Set the password for
the management mode
user mm_admin
-mmqv,--management-mode-quiesce-virtualhostnodes make virtualhost nodes
stay in the quiesced
state during
management mode.
-prop,--config-property &lt;name=value&gt; set a configuration
property to use when
resolving variables
in the broker
configuration store,
with format
"name=value"
-props,--system-properties-file &lt;path&gt; set the location of
initial properties
file to set
otherwise unset
system properties
-sp,--store-path &lt;path&gt; use given
configuration store
location
-st,--store-type &lt;type&gt; use given broker
configuration store
type
-v,--version print the version
information and exit
</pre></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Getting-Started-Logging.html">Prev</a>&#160;</td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Getting-Started.html">Up</a></td><td align="right" width="40%">&#160;<a accesskey="n" href="Java-Broker-Concepts.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">3.4.&#160;Log file&#160;</td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;Chapter&#160;4.&#160;Concepts</td></tr></table></div></div>