Appendix of Server Commands

Using Command Line Parameters

Command line parameters are specified after rbnb.jar in the terminal.

For example:

java -jar rbnb.jar -F -a localhost:3333

Appendix of Parameters

Parameter Option Format Description
Address -a <host>:<port> Specifies the address of the server.

  • host is either localhost, the DNS name of the local host, or the IP address of the local host
  • port is the TCP server socket port identification.
Security File -A <security file URL> The security file determines whether a connection is allowed based on its DNS name or IP address. The file consists of a list of ALLOWED addresses with optional lists of permissions) and a list of DENIED addresses. Without the file, all addresses are allowed. With the file, only addresses that match an allowed entry and not a more specific denied entry can be made.

The syntax of the file is:

# Comment
ALLOW
<DNS or IP address string>[=<permissions>]
DENY <DNS or IP address string>

Multiple addresses can be specified after each ALLOW or DENY entry, so long as they are separated by whitespace (spaces, tabs, carriage returns, and new lines). An address can be a specific address such as rbnb.creare.com or a wildcard such as216.204.34.*

The optional permissions parameter, which can only be added to ALLOW lines consists of the equals (=) followed by one or more allowed permissions from the following list:

  • R – read permission (sink connections),
  • W – write permission (source connections),
  • X – execute permission (control connections and functions),
  • P – plugin permission (plugin connections), and
  • T – routing permission (routing connections).

Example:

# Allow Creare full access and NASA read/write/routing.
ALLOW *.creare.com *.nasa.gov=RWT
# Deny rbnb.creare.com.
DENY rbnb.creare.com

Connections are allowed from all “nasa.gov” addresses, plus all “creare.com” addresses except “rbnb.creare.com”. All other connections are denied.

An example security file is available through the web. Its default URL is:

Note: If the security file URL is inaccessible, the server may block until a low-level timeout occurs.

Compatibility Mode -C <version> This flag specifies that, where there are differences in behavior between releases, the server should behave a close as possible to the version specified.

The default is the current version.  Supported versions are:

  • V2.1 – requests for a specified time and a duration of 0 are always handled as requests for the data point exactly at that time.  The newer servers normally retrieve the newest data point at or before the specified time.
  • V2.3 – the current version.
Auto Load Archive -F Automatically loads any archives in the server’s home folder.

This operation may cause errors as the system will attempt to load every sub-folder in the server’s home folder as an archive. If some of them are not actually archives, the system will report problems.

Also note that this operation can destroy files or move sub-sub-folders if the system thinks that it recognizes the files (those with .rbn extensions) or sub-sub-folders (those with names like RB# or FS#, where # is an integer value).

Archive Directory -H <archive home dir> Specify the archive home directory.  All archive activity (load, creation, and append) will take place in the specified archive home directory.  When using the “-F” command-line flag, archives will be automatically loaded from this archive home directory.

The argument to the “-H” flag must be an absolute or relative pathwithout any embedded spaces.

Set Log -l <period>,
<cache>,
<archive>,
<access>
Sets up the server log, a source called _Log.

Period specifies the amount of time between status reports, in seconds. Two special values can be set:

  1. OFF – turns off the log (remaining values are ignored), and
  2. NONE (or 0) turns off the periodic status reports, but creates a log as specified by the remaining values.

Cache frames specifies the size of the in-memory cache in terms of frames (messages) logged.

Archive frames specifies the size of the archive file in terms of frames.  If an archive is created, it defaults to a size equal to that of the cache.

Archive access specifies that the log should be archived.  It can be one of:

  • Create – creates a new archive, or
  • Append – adds to an existing archive.

At least one parameter must be specified, but each parameter is optional as shown in the examples.

Default:

-l 3600,1000,0,none

This means status being logged for each connection once an hour to a cache of 1000 frames.

Examples:

  1. -l 60,10000,0,none
  2. -l ,,1000000
  3. -l ,100,,append

The first example is the default setting.

The second example uses the default period and cache size, and creates an archive of 1000000 frames.

The third example changes the cache size to 100 frames and appends to an existing archive.

Lockdown -L Specifies that the server is to locked down.

Only connections from the local machine will be allowed.

Set Metrics -m <period>, <cache>, <archive>, <access> Sets up the server metrics, in a source called _Metrics.

The arguments to this flag are the same as those for the server log (-l), except that they set the metrics period and metrics source size.

Note: a period of OFF, NONE, or 0 turns metrics off.

Default:

-m 1,3600,0,none

This means metrics running once a second to a cache of 3600 frames.

Max # of Activity Threads -M <maximum activity threads> Specifies the maximum number of activity threads to have available.

These are Java threads that are used to handle certain types of actions – the only current activity performed is adding frames of data to ring buffers within a source handler. The value specifies the maximum number of such actions that can be handle simultaneously by the server. Note that the actual number of threads created may be less than this value – the server creates threads only when needed.

A large number of threads runs the risk of exceeding the maximum number of threads allowed or adversely impacting performance due to the time needed to switch between threads. A small number of threads can adversely effect performance by unnecessarily forcing independent actions to be handled sequentially.

The default value is 100 threads.

Name -n <server name> Specifies the name of the server.
Options File -O <options file URL> Specifies the URL of the options file.

The options file allows server options to be saved in a file that can be reused. It also provides the user of the Web RBNB Server startup page access to the options not otherwise available.

This contents of this file are options from this page. Comments can be added by starting a line with a “#”.

An example options file is available through the web. Its default URL is:

http://localhost/Configuration/Options.rbn

This translates to:

<install folder>/jakarta-tomcat-<version>/webapps/ROOT/Configuration/Options.rbn

This file contains comments, including some examples. If this file is used unchanged, no additional options are actually added.

Note: If the options file URL is inaccessible, the server may block until a low-level timeout occurs.

Parent Server -p <parent server address> Specifies the address of the server that is to be this server’s parent.

The server’s lineage determines the full name of the server and determines where in the hierarchy of connected servers this server appears.  For example:

/Server specifies a server named ‘Server’ with no parent.
/Parent/Child specifies a server named ‘Child’ with a parent named ‘Parent’.
Shortcut -s <shortcut name>,
<server address>,
[<cost>]
Specifies a shortcut to another server.

The shortcut name specifies the name of the shortcut relative to the local server.

The server address specifies the address of the server to which the shortcut leads.  The local server can be used to retrieve data from the remote server via the shortcut.

The optional cost specifies how much this shortcut costs to use. The server actually maps the shortcut to the full name of the server and then determines the best path amongst all possible paths based on the various costs.

Max # of Filesets -S <maximum open filesets> Specifies the maximum number of filesets that can be kept open simiultaneously.

A large value runs the risk of running into a operating system per user limit on the number of open files. A small value may adversely effect performance because one source may be blocked waiting for another source to finish writing to an archive.

The default value is 10.

Open Source DataTurbine Initiative © 2016 Frontier Theme