Command Line Parameters

Print this help information.

Print a template YAML configuration file to the console containing all available options and their default values as comments. Additional options in the current command line invocation are added as actual configuration options in the printed output.

Print version information and exit.

specify the path to the configuration file

Run the Node process as a service (Windows only).

Enables verbose logging.

override option to 'false'

Specifies OS environment variable overrides. Individual overrides must be specified as key=value pairs, separated by spaces.

Reset the Node. Accepted values: ALL, SAF, RESTORE

The hostname or IP address set on the HostnameOrIP property of a newly created Node object during initialization. "0.0.0.0" listens on all local interfaces. An empty string defaults to computer name.

The port set on the NodeListenerPort property of a newly created Node object during initialization. A zero value disables inter-Node communication.

Loads the JSON file at the specified path when the Node process is initialized for the first time.

Executes the Lua script file at the specified path during process startup.

Executes the Lua chunk provided as the option value during process startup.

Terminate after startup operations (installation or command line script execution) instead of continuing to run the Node process.

override option to 'false'

Delay Node start-up for the specified amount of seconds.

The Node’s data folder for storing persistent data.

Use the mimalloc memory allocator.

Disable specific system functionality or checks. Accepted values: PASSWORD_POLICIES, LUA

Disable all access permission checks if set to 'false'.

Install and register the Node as a Windows service.

Remove the Node from list of registered services.

Query the Node service status.

Specifies the Node service instance name.

Execute service operations silently (to be used with '--winsvc-install' or '--winsvc-remove' options only).

override option to 'false'

Adjust Windows Firewall settings during service installation automatically (with '--winsvc-install' option only).

override option to 'false'

Specifies the custom action delay (in seconds) after a service failure (default = 30).

Specifies if the service failure action configuration should be performed.

override option to 'false'

Controls LMDB sync flags: 0 = full sync (default), 1 = MDB_NOMETASYNC (skip meta page flush), 2 = MDB_NOSYNC (skip all sync).

Compact the LMDB database file on startup. This reclaims space from deleted records by rewriting the file without free pages. Implies '--exit'.

override option to 'false'

Maximum number of simultaneous read-only transactions (LMDB reader slots). Corresponds to mdb_env_set_maxreaders(). Can only be increased from the previous value and not decreased. Default is 1024.

The GUID of the Node being restored. The recovery connection objects should be created using startup scripts. Requires '--reset=RESTORE' to be specified.

The GUID of the passive UplinkConnection object owned by the Node being restored. The recovery connection objects should be created using startup scripts. Requires '--reset=RESTORE' to be specified.

Performs a network test to a remote machine.

Enables the TLS protocol in a network test.

Custom pre-shared key when connecting to another Node process.

The message size to send for upload tests. In case of zero, the upload test will not be performed.

The remote host address used in a network test.

The remote port used in a network test.