Interacting with Jetstream

There are a few ways of working with Jetstream server: for automation, there are command line and Python API intefaces; for end users and convenient way of transferring files, there are graphical and command line clients.

Command Line Interface

Synopsis

jetstream [options] subcommand [subcommand-options]

Description

jetstream is the main way to interact with the Jetstream server. There are three sub commands:

• server to start the Jetstream server
• relay_server to start a relay server
• api to interact with API

Options

--version

Print version information

jetstream server

Options

--api-host arg

TCP client API host address. If specified, bind API to listen on this address (overrides --api-allow-remote-control).

--api-port arg (=8886)

TCP client API control port.

--api-allow-remote-control

Allow API connections from remote machines (can be overriden by api-host).

--api-min-ssl-version arg (=TLS1.2)

Minimum allowed SSL protocol (TLS1.2,TLS1.1,TLS1.0).

--api-ssl-cert arg

Path to a file containing the SSL certificate to use for API connections. --api-ssl-cert-key must also be specified.

--api-ssl-cert-key arg

Path to a file containing the SSL private key to use for API connections. --api-ssl-cert must also be specified.

--api-connect arg

Actively create an API connection to the specified client.

--api-disable-shared-tokens

Disable the creation and use of tokens for anonymous downloads.

See also

Shared Links

--max-file-cache-size arg (=4294967296)

Maximum size, in bytes, of file cache.

See also

S3

--max-file-cache-download-size arg (=52428800)

Maximum size, in bytes, of file cache to use per download transfer.

See also

S3

--max-file-cache-upload-size arg (=104857600)

Maximum size, in bytes, of file cache to use per upload transfer.

See also

S3

--max-cloud-connections arg (=16)

Maximum number of simultaneous connections to cloud storage.

--sandbox-dir arg

Sandbox jetstream into path. %u token can be used for user name.

See also

Sandboxing

--trigger-dir arg

Folder containing trigger scripts.

--persistent-state-dir arg

Folder to store persistent server state.

Note

Persistent state directory can’t be shared between servers. Each running server will need its own independent persistent state directory.

--persistent-destinations arg

Load and save destinations (if --persistent-state-dir is present).

--persistent-transfers arg

Load and save transfers (if --persistent-state-dir is present). --persistent-destinations is required.

--recv-host arg

UDP receiver host address. If specified, bind server to listen on this address.

--recv-port arg (=8886)

UDP receiver port.

--recv-auth-required arg (=1)

Auth is required to receive transfers (always true when the server is running as root).

--recv-relay-host arg

TCP relay host address. If specified, route Receiver traffic through this relay address.

--recv-relay-port arg (=8887)

TCP relay host control port.

--recv-nat-traversal arg (=0)

Uses UPnP and NAT-PMP to open UDP receiver port on the Internet Gateway Device.

--name arg

Specify a name for this server.

This can then be retrieved using the getServerInfo() API call.

--external-address arg

Specify FQDN or IP address and port that will be used to create shared links (host:API-port)

See also

Shared Links

--license-location arg (=.)

Specify license location which can be file path, dir path, or server address (port@host).

See also

License Configuration

--license-password arg

Specify license password if required. This is same as setting RLM_LICENSE_PASSWORD environment variable.

See also

License Configuration

--superuser arg

Specify a user name that will be recognized as a superuser (multi-use).

See also

Superusers

--supergroup arg

Specify a group name whose members will be recognized as superusers (multi-use).

See also

Superusers

--incoming-rate-limit arg

Cap on the incoming bandwidth in kilobits per second.

--outgoing-rate-limit arg

Cap on the outgoing bandwidth in kilobits per second.

--borrow-incoming-rate

Increase the outgoing rate limit by unused incoming rate.

--borrow-outgoing-rate

Increase the incoming rate limit by unused outgoing rate.

--disable-port-multiplex

Never reuse the same local port for multiple connections.

--log arg

Output all log data into the given file instead of standard out.

See also

Logging

--log-file-creates

Add a log entry for every received file.

--log-level arg (=3)

Change the verbosity of the log file.

Available log levels are:

• 0: Fatal errors only
• 1: Errors
• 2: Warnings
• 3: Informational messages
• 4: Security audit events
• 5: Debug errors
• 6: Debug information

--disable-telemetry

Disable collection of telemetry data.

--response-file arg

Response file that contains additional command-line arguments (alternately use ‘@file’).

jetstream relay_server

See also

Relay Configuration

Options

--control-port arg (=8887)

TCP packet forwarding control port.

--log arg

Output all log data into the given file instead of standard out.

--response-file arg

Response file that contains additional command-line arguments (alternately use ‘@file’).

jetstream api

See also

Cumul8:Jetstream API Documentation

Options

--host arg (=localhost)

Address of Jetstream server to control

--api-control-port arg (=8886)

Default API port

--user arg

User name for API authentication (cannot be used at the same time as token)

--authToken arg

Token for API authentication (cannot be used at the same time as user)

--authTokenSession arg

Token session for sharing transfers between instances of token authentication

--superuser

Run the API command as a superuser

--no-auth

Skip API authentication. If used, the --user, --authToken, --authTokenSession and --superuser options are ignored

Environment

RLM_LICENSE_PASSWORD

Used to specify a license password through the environment, instead of the command line parameter

API

Jetstream Server comes with full API access. To learn more about using the API, please refer to Cumul8:Jetstream API Documentation.

Graphical Client

A graphical Jetstream Client is available for download.

Command Line Client

The Jetstream API Python package comes with a command line client jscp. It can be used to transfers files between two Jetstream Servers with syntax similar to the OpenSSH scp tool.