Agent Command Line Reference

Administrators start the agent in a Docker container. The tibagent command line accepts the following parameters.

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
--help

-h

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

Realm Server

Parameter Arguments Description
--realmserver

-rs

URL Required.

URL of the realm server.

The agent contacts the realm server at this location. Supply the location of the primary realm server or a satellite server (see Connect Port).

--secondary-realmserver

-s

URL Optional.

URL of the backup realm server.

If the regular realm server is unavailable, the agent contacts the backup realm server at this location. Supply the location of the backup realm server (see Connect Port).

Authentication

Parameter Arguments Description
--password-file

-pf

path Optional. (Required for authentication.)

When present, the agent reads a user name and password from the file at path, and authenticates itself to the realm server using those credentials. For details, see Password File.

Make this file available inside the container, for example, using Docker's -v parameter.

TLS Security

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

When present, the agent reads a trust file from path, and uses that trust data in communications with the secure realm server. See Running a Secure Realm Server.

Make this file available inside the container, for example, using Docker's -v parameter.

--tls.trust.everyone Optional.

The agent 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.

Tracing and Logging

Parameter Arguments Description
--trace

-t

level Optional.

When present, the agent outputs trace messages to stderr.

You may specify any of the standard log level strings (see “Tuning the Log Level” in TIBCO FTL Development).

When absent, the default trace level is info.

--logfile logfile_prefix Optional.

When present, the agent logs to a rolling set of log files instead of the console. The logfile_prefix argument may denote a path. 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 agent sends log output to the console, ignoring 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 (102400). The default value is 2 megabytes (2*1024*1024).

--max-logs logs Optional.

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