Skip to content

msl-network start¤

Start the Broker as a message proxy.

Usage¤

msl-network start [--auth-curve [KEYS_DIR]] [--auth-curve-allow-any] [--auth-device [DEVICE ...]] [--auth-plain [JSON_FILE]] [-H HOST] [-p PORT] [-m] [-h] [-q] [-v]

Options¤

--auth-curve [KEYS_DIR]¤

Use authentication based on public and private CURVE keys.

Specifying a value after this flag will use the specified directory to load the key files. 

msl-network start --auth-curve path/to/curve/keys

Specifying this flag without a value will use all keys that are located in the directories ~/.curve and ~/.msl/network/curves (the ~/.msl/network part may also be set by an MSL_NETWORK_HOME environment variable). 

msl-network start --auth-curve

See msl-network curve for more details.

--auth-curve-allow-any¤

Allow CURVE keys from any device. Enabled by default if no public key files are found.

If you have public keys of devices stored in the ~/.curve or ~/.msl/network/curves directories, then only devices that send a valid key during authentication are allowed to connect. You can ignore the stored keys by specifying this flag so that a Broker does not validate the key of a connecting device (the connecting device still validates the key of the Broker).

--auth-device [DEVICE ...]¤

Use authentication based on the IP address (or hostname) of devices that are allowed to connect.

Specifying this flag without additional values will use the devices stored in the default file. See msl-network device for more details. 

msl-network start --auth-device

Specifying this flag with one or more values will use the specified devices and ignore the list of devices stored in the default file. 

msl-network start --auth-device 10.9.102.80 lab-computer

--auth-plain [JSON_FILE]¤

Use authentication based on usernames and passwords.

Specifying a value after this flag will load that JSON file for the username to password mapping for the authentication parameters. 

msl-network start --auth-plain path/to/credentials.json

Specifying this flag without a value will use the parameters in the default file. The default file is in the ~/.msl/network directory, which may also be set by an MSL_NETWORK_HOME environment variable. See msl-network plain for more details. 

msl-network start --auth-plain

-H, --host HOST¤

The network interface to run the Broker on. If unspecified, listen on all network interfaces.

-p, --port PORT¤

The port number to use for the Broker. Default is 1875.

-m, --monitor¤

Whether to allow ZeroMQ event monitoring (as INFO log messages).

-h, --help¤

Show the help message and exit.

-q, --quiet¤

Give less output. Option is additive and can be used up to 3 times.

For example,

  • -q — Silence INFO (and below) logging level
  • -qq — Silence WARNING (and below) logging level
  • -qqq — Silence ERROR (and below) logging level

-v, --verbose¤

Give more output (DEBUG logging level).