Other versions

Reference: Tanium server CLI

Tanium core platform release 7.1.314.2924 and later support the configuration of component server settings with the a command-line interface (CLI). The Windows Registry is still the canonical source of configuration. The CLI controls read and write to the settings Windows Registry. We recommend you use the CLI if you get or set the configuration programmatically.

The following examples show how to use the CLI.

If necessary, elevate privileges to open the command prompt as administrator.

Tanium Server

TaniumReceive.exe is the executable program. It is in the Tanium Server installation directory.

Display help

cmd-prompt>TaniumReceiver --help
Usage: TaniumReceiver [options] <command> [<args>]

General Options:
  -h [ --help ]         Print this help message
  -v [ --version ]      Print the version
  --verbose             Verbose output

Service Options:
  -i                    Install the service
  -u                    Uninstall the service
  -s                    Start the service
  -e                    Stop the service

Internal Tanium Options - DO NOT USE:
  -d                    Run without daemonizing

Commands:
  config                Manage configuration
  trust-module-certs    Add trusted Module Server certificates

For help on a specific command run `TaniumReceiver COMMAND -h`

Display config help

cmd-prompt>TaniumReceiver config --help
Usage: TaniumReceiver config <action> [<key>] [<value>]

Actions:
  config list                         List all keys and non-protected values
  config list-protected               List all keys and values
  config get <key>                    Print non-protected config value
  config get-protected <key>          Print config value
  config set <key> <value>            Set config value and try to guess type
  config set-string <key> <value>     Set string value
  config set-protected <key> <value>  Set protected string value
  config set-number <key> <value>     Set numeric value (in decimal or hex notation)
  config remove <key>                 Remove config value

Example: List configuration settings

cmd-prompt>TaniumReceiver config list
Keys:
  - AddressMask: 16777215
  - ConsoleSettingsJSON: C:\Program Files\Tanium\Tanium Server\http\config\console.json
  - DBUserDomain: tam.local
  - DBUserName: taniumsvc
  - LogPath: C:\Program Files\Tanium\Tanium Server\Logs
  - LogVerbosityLevel: 1
  - Logs:
    - Logs.MiniDumpMessages:
      - Logs.MiniDumpMessages.FilterRegex: .*Begin MiniDumper.*
      - Logs.MiniDumpMessages.LogVerbosityLevel: 1
  - ModuleServer: tms1.tam.local,TMS1.tam.local:17477
  - ModuleServerPort: 17477
  - PGDLLPath: C:\Program Files\Tanium\Tanium Server\postgres\bin
  - PGRoot: C:\Program Files\Tanium\Tanium Server\postgres
  - Path: C:\Program Files\Tanium\Tanium Server
  - ProxyPassword: 
  - ProxyPort: 
  - ProxyServer: 
  - ProxyType: NONE
  - ProxyUserid: 
  - SQLConnectionString: postgres:[email protected]=postgres port=5432
  - ServerName: 0.0.0.0
  - ServerPort: 17472
  - ServerSOAPPort: 443
  - TrustedCertPath: C:\Program Files\Tanium\Tanium Server\Certs\installedcacert.crt
  - TrustedHostList: ts1.tam.local
  - TrustedModuleServerCertsPath: C:\Program Files\Tanium\Tanium Server\trusted-module-servers.crt
  - Version: 7.2.314.2831

Example: Set configuration values

cmd-prompt>TaniumReceiver config set BypassProxyHostList ts1.example.com,ts2.example.com,localhost,127.0.0.1,10.10.10.11,10.10.10
.15
cmd-prompt>TaniumReceiver config get BypassProxyHostList
ts1.example.com,ts2.example.com,localhost,127.0.0.1,10.10.10.11,10.10.10.15

TDownloader

TDownloader.exe is the executable program. It is in the Tanium Server and Tanium Module Server installation directories.

Display help

cmd-prompt>TDownloader --help
Usage: TDownloader <command> [<args>] [ --help ]

Commands:
    config    Manage downloader configuration
    download  Download a file

Options:
  -h [ --help ]         Display help.
  --verbose             Verbose output

Display config help

cmd-prompt>TDownloader config --help
Usage: TDownloader config <action> [<key>] [<value>]

Actions:
  config list                         List all keys and non-protected values
  config list-protected               List all keys and values
  config get <key>                    Print non-protected config value
  config get-protected <key>          Print config value
  config set <key> <value>            Set config value and try to guess type
  config set-string <key> <value>     Set string value
  config set-protected <key> <value>  Set protected string value
  config set-number <key> <value>     Set numeric value (in decimal or hex notation)
  config remove <key>                 Remove config value

Example: List configuration settings

cmd-prompt>TDownloader config list
Keys:
  - BypassProxyHostList: ts1.example.com,ts2.example.com,localhost,127.0.0.1,10.10.10.11,10.10.10.15
  - LogVerbosityLevel: 41
  - ProxyPassword:
  - ProxyPort:
  - ProxyServer:
  - ProxyType: NONE
  - ProxyUserid:
  - TrustedCertPath: C:\Program Files\Tanium\Tanium Server\Certs\installedcacert.crt
  - TrustedHostList: ts1.tam.local

Example: Set configuration values

cmd-prompt>TDownloader config set ProxyServer 10.10.10.10
cmd-prompt>TDownloader config get ProxyServer
10.10.10.10

Tanium Module Server

TaniumModuleServer.exe is the executable program. It is in the Tanium Module Server installation directory.

Display help

cmd-prompt>TaniumModuleServer --help
Usage: TaniumModuleServer [options] <command> [<args>]

General Options:
  -h [ --help ]         Print this help message
  -v [ --version ]      Print the version
  --verbose             Verbose output

Service Options:
  -i                    Install the service
  -u                    Uninstall the service
  -s                    Start the service
  -e                    Stop the service

Internal Tanium Options - DO NOT USE:
  -d                    Run without daemonizing

Commands:
  config                Manage configuration
  register              Register with server
  trust-server-certs    Add trusted server certificates

For help on a specific command run `TaniumModuleServer COMMAND -h`

Display config help

cmd-prompt>TaniumModuleServer config --help
Usage: TaniumModuleServer config <action> [<key>] [<value>]

Actions:
  config list                         List all keys and non-protected values
  config list-protected               List all keys and values
  config get <key>                    Print non-protected config value
  config get-protected <key>          Print config value
  config set <key> <value>            Set config value and try to guess type
  config set-string <key> <value>     Set string value
  config set-protected <key> <value>  Set protected string value
  config set-number <key> <value>     Set numeric value (in decimal or hex notation)
  config remove <key>                 Remove config value

Example: List configuration settings

cmd-prompt>TaniumModuleServer config list 
Keys:
  - LogVerbosityLevel: 1
  - Path: C:\Program Files\Tanium\Tanium Module Server
  - ServerName: 0.0.0.0
  - ServerPort: 17477
  - Version: 7.2.314.2831

Example: Set configuration values

cmd-prompt>TaniumModuleServer config set LogVerbosityLevel 41
cmd-prompt>TaniumModuleServer config get LogVerbosityLevel
41

Example: Register with Tanium Server

On the Module Server host computer, use the CLI to register with a Tanium Server. Specify a Tanium Console admin username and password.

cmd-prompt>TaniumModuleServer register ts2.tam.local
Enter administrator username: TaniumAdmin

Enter password for user 'TaniumAdmin':
Successfully completed registration.

cmd-prompt>

If the Tanium Console has been configured to use a non-standard port, you must specify the port number, as shown in the following example.

cmd-prompt>TaniumModuleServer register ts2.tam.local:8443
Enter administrator username: TaniumAdmin

Enter password for user 'TaniumAdmin':
Successfully completed registration.

cmd-prompt>

If the Tanium Console is not listening on 443 and you do not specify the port in the registration command, the registration results in failure with the message:

Failed to register module server. Failed to authenticate for registration. SSLClientConnection has failed to complete request.

Registration involves copying files between the Module Server and the Tanium Server. Run the registration command from the Module Server. Both servers must be reachable when you issue the registration command or the command fails.

Tanium Zone Server

TaniumZoneServer.exe is the executable program. It is in the Tanium Zone Server installation directory.

Display help

cmd-prompt>TaniumZoneServer --help
Usage: TaniumZoneServer [options] <command> [<args>]

General Options:
  -h [ --help ]         Print this help message
  -v [ --version ]      Print the version
  --verbose             Verbose output

Service Options:
  -i                    Install the service
  -u                    Uninstall the service
  -s                    Start the service
  -e                    Stop the service

Internal Tanium Options - DO NOT USE:
  -d                    Run without daemonizing

Commands:
  config                Manage configuration

For help on a specific command run `TaniumZoneServer COMMAND -h`

Display config help

cmd-prompt>TaniumZoneServer config --help
Usage: TaniumZoneServer config <action> [<key>] [<value>]

Actions:
  config list                         List all keys and non-protected values
  config list-protected               List all keys and values
  config get <key>                    Print non-protected config value
  config get-protected <key>          Print config value
  config set <key> <value>            Set config value and try to guess type
  config set-string <key> <value>     Set string value
  config set-protected <key> <value>  Set protected string value
  config set-number <key> <value>     Set numeric value (in decimal or hex notation)
  config remove <key>                 Remove config value

Example: List configuration settings

cmd-prompt>TaniumZoneServer config list
Keys:
  - LogPath: C:\Program Files (x86)\Tanium\Tanium ZoneServer\Logs
  - LogVerbosityLevel: 1
  - Logs:
    - Logs.MiniDumpMessages:
      - Logs.MiniDumpMessages.FilterRegex: .*Begin MiniDumper.*
      - Logs.MiniDumpMessages.LogVerbosityLevel: 1
  - Path: C:\Program Files (x86)\Tanium\Tanium ZoneServer
  - ServerName: ts1.tam.local
  - ServerPort: 17472
  - ServiceUserDomain: tam.local
  - ServiceUserName: taniumsvc
  - Version: 7.2.314.2831
  - ZoneHubFlag: 1

Example: Set configuration values

cmd-prompt>TaniumZoneServer config set LogVerbosityLevel 41
cmd-prompt>TaniumZoneServer config get LogVerbosityLevel
41

Last updated: 7/17/2018 3:11 PM | Feedback