Server Command Line Reference

Administrators use tibeftlserver, the TIBCO eFTL server command-line executable program, to start a server process.

Most command-line parameters and options have both a short and a long form. The command-line parser accepts either form.

Help

Parameter Arguments Description
-h

--help

  Display a help message describing the command-line parameters and options.

Realm Server

Parameter Arguments Description
--realmserver

-rs

URL Optional.

URL of the realm server.

The TIBCO eFTL server contacts the realm server at this location to receive its realm definition. Supply the location of the primary realm server or a satellite server.

When absent, the default value is http://localhost:8080.

--secondary-realmserver

-s

URL Optional.

URL of the backup realm server.

If the regular realm server is unavailable, the TIBCO eFTL server contacts the backup realm server at this location to receive its realm definition. Supply the location of the backup realm server.

--name

-n

cluster_name Optional.

Cluster name.

A server process belongs to exactly one cluster.

You may supply the name of the cluster to which this process belongs.

When absent, the default value is Cluster.

Clients

Parameter Arguments Description
--listen

-l

URI Optional.

The TIBCO eFTL server listens for client connections at this URI. Supply a URI in either of two forms: 

  ws://host[:port]
  wss://host[:port]

When this parameter is absent, the server listens on ws://localhost:9191.

If you omit the port, the server listens for non-TLS (ws:) connections on port 9191, or TLS (wss:) connections on port 9291.

Authentication and Authorization Service

Parameter Arguments Description
--auth.url URL Optional.

The eFTL server contacts the authentication service at this URL.

When present, authentication is enabled, so that the eFTL server requires and verifies user name and password credentials from clients.

When absent, authentication is disabled, so that the eFTL server neither requires nor verifies credentials.

--auth.user user_name

Optional.

When the authentication service URL uses the https:// protocol, the eFTL server identifies itself to the authentication service using this user name credential.

--auth.password password

Optional.

When the authentication service URL uses the https:// protocol, the eFTL server identifies itself to the authentication service using this password credential.

--auth.trust path

Optional.

When the authentication service URL uses the https:// protocol, use this parameter to specify the location of the authentication service's public certificate file (in PEM format). The eFTL server uses the certificate to verify the identify of the authentication service.

Security: Realm Server

Parameter Arguments Description
--password-file

-pf

path Required if the realm server requires password authentication from its clients.

The TIBCO eFTL server uses credentials in this password file to authenticate itself to the realm server.

See also, Password File.

--trust-file path Optional. (Required for TLS communication with a secure realm server.)

When present, the eFTL server reads a trust file from path, and uses that trust data in communications with the secure realm server. See “Running a Secure Realm Server” in TIBCO FTL Administration.

--trust-everyone Optional.

The eFTL server trusts any realm server without verifying trust in the server's certificate.

Warning: Do not use this parameter except for convenience in development and testing. It is not secure.

Security: Clients

Parameter Arguments Description
--server-cert path Required if the --listen argument specifies TLS, that is, it uses the wss protocol scheme.

The TIBCO eFTL server reads a public TLS certificate from this file. It uses the certificate to authenticate itself to clients.

The certificate file must be in PEM format.

See also, Clients Trust the Server.

--private-key path Required if the --listen argument specifies TLS, that is, it uses the wss protocol scheme.

The TIBCO eFTL server reads an encrypted TLS private key from this file. It uses the key to authenticate itself to clients, and to encrypt TLS communication with clients.

The key file must be in PEM format.

See also, Clients Trust the Server.

--private-key-password password Required if you specify --private.key.

The TIBCO eFTL server decrypts the private key using this password.

Security: EMS Server

Parameter Arguments Description
--ssl-params path Required for secure connections to an EMS server.

The eFTL server reads parameters from this file, and uses them when connecting to a secure EMS server.

For details, see SSL Parameters for EMS Connections Reference.

Messages

The TIBCO eFTL server can automatically append user and client identification information to the messages that clients publish. See "Client Information Fields" in TIBCO eFTL Development.

Parameter Arguments Description
--publish-client-id Optional.

When present, the server appends the _client_id field to every message that any eFTL client publishes.

See "Client ID Field" in TIBCO eFTL Concepts.

--publish-user Optional.

When present, the server appends the _user field to every message that any eFTL client publishes.

See "User Field" in TIBCO eFTL Concepts.

Logging

Parameter Arguments Description
--trace

-t

level Optional.

When present, the TIBCO eFTL server logs at this level of detail. Supply one of these strings:

  • off
  • severe
  • warn
  • info
  • verbose
  • debug

    The output from debug and verbose can result in very large log files. This level of detail is generally not useful unless TIBCO staff specifically requests it.

    When this option is absent, the default value is info.

--verbose

-v

Optional.

When present, the TIBCO eFTL server produces verbose log output related to clients.

This level of tracing is appropriate only during client program development and testing.

--logfile logfile_prefix Optional.

When present, the TIBCO eFTL server logs to a rolling set of log files instead of the console. The logfile_prefix argument may denote a path. If so, then all of the directories in the path must already exist.

For more information about rotating log files, see “Log Output Targets” in TIBCO FTL Development.

When absent, the TIBCO eFTL server sends log output to the console, and ignores the parameters --max.log.size and --max.logs.

--max-log-size size Optional.

Limits the maximum size (in bytes) of log files. The value must be greater than 100 kilobytes, that is, 102400 bytes. The default value is 2 megabytes, that is, 2×1024×1024.

--max-logs logs Optional.

Limits the maximum number of rolling log files. The default is 50.