Menu Search

3.5. Using the command line

The Broker understands a number of command line options which may be used to customise the configuration.

For additional details about the broker configuration and related command line arguments see Chapter 5, Initial Configuration. The broker is fully configurable via its Web Management Console, for details of this see Section 6.2, “Web Management Console”.

To see usage information for all command line options, use the --help option

bin/qpid-server --help
usage: Qpid [-cic <path>] [-h] [-icp <path>] [-mm] [-mmhttp <port>]
       [-mmpass <password>] [-mmqv] [-os]
       [-prop <name=value>] [-props <path>] [-sp <path>] [-st <type>] [-v]
 -cic,--create-initial-config <path>                  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 <path>                    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 <port>           override http
                                                      management port in
                                                      management mode
 -mmpass,--management-mode-password <password>        Set the password for
                                                      the management mode
                                                      user mm_admin
 -mmqv,--management-mode-quiesce-virtualhosts         make virtualhosts
                                                      stay in the quiesced
                                                      state during
                                                      management mode.
 -os,--overwrite-store                                overwrite the broker
                                                      configuration store
                                                      with the current
                                                      initial
                                                      configuration
 -prop,--config-property <name=value>                 set a configuration
                                                      property to use when
                                                      resolving variables
                                                      in the broker
                                                      configuration store,
                                                      with format
                                                      "name=value"
 -props,--system-properties-file <path>               set the location of
                                                      initial properties
                                                      file to set
                                                      otherwise unset
                                                      system properties
 -sp,--store-path <path>                              use given
                                                      configuration store
                                                      location
 -st,--store-type <type>                              use given broker
                                                      configuration store
                                                      type
 -v,--version                                         print the version
                                                      information and exit