Summary

Command-line parameters available to the Tachyon Agent executable.

There are a number of command line options for the Tachyon Agent executable. Some invoke the Agent itself, whereas others are used to control execution of the Agent. Normally a user does not have to be aware of the options, but they can be useful for testing and debugging. These options work on all supported platforms except Android.

All invocations of the Tachyon Agent executable require at least one option, and if none is given then a convenient usage message is output showing the options and syntax.

All options can start with a '-' or a '/', but we only show the '-' form in the following. Options are mutually exclusive unless noted otherwise.

When running these commands from a console, run as administrator (Windows) or prefix the commands with sudo (non-Windows).


On this page:

Agent command-line parameters

-reconfigure name1=value1 ...

This is a convenient way to change configuration settings. One or more name-value pairs should be specified, and the configuration file will be updated. A value can be empty, although that is only valid for a few configuration settings. Case of the name-part is not signficant, but the case of the value is preserved when it is written to the configuration file. If a key with the name does not already exist in the configuration file, it will be appended and a warning output (in case the name has been misspelled). Unlike most options, this can be used in combination with -start and -restart (and -stop although that is not very useful).

Note

The Agent will not pick up the new configuration value(s) until it is restarted.

Examples

Set the Switch and BackgroundChannelUrl values, then restart the Agent (after a random stagger interval) to pick up the new values.

On Windows:

"C:\Program Files\1E\Tachyon\Agent\Tachyon.Agent.exe" -reconfigure Switch=ACME-W2008R2.ACME.LOCAL:4000 BackgroundChannelUrl=https://tachyon.ACME.LOCAL:443/Background/ -restart

On Linux and Solaris:

/usr/sbin/Tachyon.Agent -reconfigure Switch=ACME-W2008R2.ACME.LOCAL:4000 BackgroundChannelUrl=https://tachyon.ACME.LOCAL:443/Background/ -restart

On Mac:

cd /Library/Application Support/1E/Tachyon/Agent # Do not prefix cd with sudo
./Tachyon.Agent -reconfigure Switch=ACME-W2008R2.ACME.LOCAL:4000 BackgroundChannelUrl=https://tachyon.ACME.LOCAL:443/Background/ -restart

-restart [-immediate]

Shut down if necessary then (re)start the Agent service or daemon. if -immediate is given, this will happen immediately, otherwise it will happen after a random number of seconds in a range between the ConnectionRetryTimeInSecondsMin and ConnectionRetryTimeInSecondsMax configuration values in order not to flood the Switch with messages.

-runservice

This is the normal invocation of the Agent to run it as a service or daemon. Do not use this mode from the command line.

-start [-immediate]

Start the Agent service or daemon if it is not already running. if -immediate is given, the Agent will start immediately, otherwise it will happen after a random number of seconds in a range between the ConnectionRetryTimeInSecondsMin and ConnectionRetryTimeInSecondsMax configuration values in order not to flood the Switch with online messages.

-stop [-immediate]

Stop the running Agent service or daemon. if -immediate is given, the Agent will shut down immediately (or as soon as possible to preserve instruction integrity), otherwise it will happen after a random number of seconds in a range between the ConnectionRetryTimeInSecondsMin and ConnectionRetryTimeInSecondsMax configuration values in order not to flood the Switch with offline messages..