Running Orion from command line

You can run the broker just typing the following command:

contextBroker

The broker will run in background by default, so you will need to stop it using signals.

You can use command line arguments, e.g. to specify the port in which Orion Context Broker listens, using the -port option:

contextBroker -port 5057

To know all the possible options, have a look at the command line options section.

Command line options

Command line options can be used directly (in the case of running from the command line) or indirectly through the different fields in /etc/sysconfig/contextBroker (in the case of running as a system service ) To obtain a list of available options, use:

contextBroker -u

To get more information (including default values), use:

contextBroker -U

The list of available options is the following:

• -u and -U. Shows usage in brief or long format, respectively.
• --help. Show help (very similar to previous).
• --version. Shows version number
• -port . Specifies the port that the broker listens to. Default port is 1026.
• -ipv4. Runs broker in IPv4 only mode (by default, the broker runs in both IPv4 and IPv6). Cannot be used at the same time that -ipv6.
• -ipv6. Runs broker in IPv6 only mode (by default, the broker runs in both IPv4 and IPv6). Cannot be used at the same time that -ipv4.
• -rush . Use rush in host and port. Default behavior is to not use Rush. See section on using Rush relayer.
• -multiservice. Enables multiservice/multitenant mode (see multi service tenant section).
• -db . The MongoDB database to use or (if -multiservice is in use) the prefix to per-service/tenant databases (see section on service/tenant database separation. This field is restricted to 10 characters max length.
• -dbhost . The MongoDB host and port to use, e.g. -dbhost localhost:12345.
• -rplSet . If used Orion CB will connnect to a MongoDB replica set (instead of an stand-alone MongoDB instance). The name of the replica set to use is the value of the parameter. In this case, the -dbhost parameter can be a list of host (separated by ",") which are used as seed for the replica set.
• -dbTimeout . Only used in the case of using replica set (-rplSet), ignored otherwise. It specifies the timeout in miliseconds for connections to the replica set.
• -dbuser . The MongoDB user to use. If your MongoDB doesn't use authorization this option must be avoided. See database authorization section.
• -dbpwd . The MongoDB password to use. If your MongoDB doesn't use authorization this option must be avoided. See database authorization section.
• -dbPoolSize . Database connection pool. Default size of the pool is 10 connections.
• -writeConcern <0|1>. Write concern for MongoDB write operations: acknowledge (1) or unacknowledge (0). Default is 1.
• -https. Work in secure HTTP mode (See also -cert and -key).
• -cert. Certificate file for https. Use an absolute file path. Have a look to this script for an example of how generating this file.
• -key. Private server key file for https. Use an absolute file path. Have a look to this script for an example of how generating this file.
• -logDir <dir>. Specifies the directory to use for the contextBroker log file.
• -logAppend. If used, the log lines are appended to the contextBroker log file, instead of re-creating it when the broker starts.
• --silent. Suppress all log output except errors.
• -t . Specifies the initial trace levels for logging. You can use a single value (e.g. "-t 70"), a range (e.g. "-t 20-80"), a comma-separated list (e.g. "-t 70,90") or a combination of them (e.g. "-t 60,80-90"). If you want to use all trace levels for logging, use "-t 0-255". Note that trace levels can be changed dynamically using the management REST interface. The detail of the available tracelevels and its numbers can be found here (as a C struct).
• -fg. Runs broker in foreground (useful for debugging)
• -localIp . Specifies in which IP interface the broker listens to. By default it listens to all the interfaces.
• -pidpath . Specifies the file to store the PID of the broker process.
• -httpTimeout . Specifies the timeout in milliseconds for forwards and notifications.
• -corsOrigin . Configures CORS allowed for GET requests, specifing the allowed origin (use __ALL for *).
• -reqMutextPolicy . Specifies the internal mutext policy. Possible values are: "all" (which ensures that in a given CB node as much as 1 request is being processed by the internal logic module at the same time), "read" (which ensures that in a given CB node as much as 1 read request is being processed by the internal logic module at the same time, write request can execute concurrently), "write" (which ensures that in a given CB node as much as 1 write request is being processed by the internal logic module at the same time, write request can execute concurrently) and "none" (which allows all the requests being executed concurrently). Default value is "all". For Active-Active Orion configuration "none" is recommended.
• -mutexTimeStat. Include semaphore waiting time in the "/statistics" information. It may have performance impact.