Configuring file destinations

File destinations are not supported with Tanium as a Service.

You can configure flat text or JSON files as your connection destination. By default, files are written to the \Program Files\Tanium\Tanium Module Server\services\connect-files\output directory on Windows. On a Tanium™ Appliance, files are written to /opt/mounts/connect by default, or you can specify a file share mount for Connect. For more information, see Tanium Appliance Deployment Guide: Configure solution module file share mounts.

Specify general connection information

  1. On the Connect Overview page, scroll to the Connections section and click Create Connection.
  2. Enter a name and description for the connection.
  3. (Optional) In the General Information section, expand Advanced to configure the following settings:

    Log Level

    By default, the logging is set to Information. Set the log level to Trace or Debug if you are debugging the connection. To reduce the amount of logging, you can set the log level to Warning, Error, or Fatal.

    Minimum Pass Percentage

    Minimum percentage of the expected rows that must be processed for the connection to succeed.

Configure the connection source

The connection source determines what data you are sending to the destination. This data is usually information from Tanium, such as a saved question, question log, system status, or event. The settings vary depending on which source you choose.

Configure the file destination

Specify details about the file that you want Connect to create, including the file name and how you want to save the file.

  1. Name the destination.

    You can either indicate a unique name to save the configuration information as a new destination, or you can select an existing file destination from the list.
  2. Indicate the file name or use a variable, as listed in Reference: Variables. On Windows, files are written to the \Program Files\Tanium\Tanium Module Server\services\connect-files\output directory.
    • The file name can include a subdirectory to create in the \Program Files\Tanium\Tanium Module Server\services\connect-files\output directory, or just the file name. For example, if you specify high_cpu_results\cpu_results.txt, the file is written to: \Program Files\Tanium\Tanium Module Server\services\connect-files\output\high_cpu_results\cpu_results.txt.
    • If you want to point to the file directory on the Module Server from another location, create a symbolic link with the mklink command. For example, if you wanted a symbolic link from the c:\logs\mylogs directory to the Connect logs directory, you might run: 

      mklink /d "c:\logs\mylogs" "c:\Program Files\Tanium\Tanium Module Server\services\connect-files\output\logs\mylogs"

    • You can choose to compress the resulting file as a gzip or zip file. The file extension is automatically added to the end of the file name.

    On Tanium Appliance, files are written to /opt/mounts/connect or you can specify a file share mount for Connect. For more information, see Tanium Appliance Deployment Guide: Configure solution module file share mounts.

  3. (Optional) In the Advanced section, add a time stamp to the file name.
    You can choose from the formats that are available, or enter your own time stamp format in ISO 8601 format.
  4. (Optional) Compress or replace files.
    Choose whether you want to replace the contents of the file when the connection runs, or if you want to append to the file contents. If you choose to replace the file contents, you can also compress the resulting file in zip or gzip format.

Configure filters

(Optional) In the Configure Output > Filters section, you can specify filters to modify the data that you are getting from your connection source before it is sent to the destination.

For more information about the types of filters you can configure, see Reference: Filtering options.

Format data for file

You can choose to save your file in any of the available formats, as listed in Reference: Format types. Each format has slightly different configuration options, but all allow you to choose which column data to save.

In the Configure Output > Columns section, you can change the Destination Label of each column and Value Type to force the column to be a String, Numeric, or Date/Time value.

If you choose Numeric for the value, you can specify a default value that is used if the data cannot be coerced into a numeric value. You can specify any negative or positive number.

If you choose Date/Time for the value, specify the Date/Time format that you want to use for the column. For more information about using a variable, see Time stamp variables.

Schedule the connection

Connections can run at a highly configurable time interval, such as multiple times per hour, day, week, or month.

If you do not enable the schedule, the connection only runs when you manually run it.

Use the Schedule section to update the schedule: 

  • Select Enable schedule.
  • In the Schedule Type, select Basic to build a schedule with the provided controls.
  • To view or edit the Cron expression directly, select Advanced - Define as a Cron Expression, and use the Advanced field to edit the Cron expression.

Save and verify connection

  1. After you enter the details for the connection, click Save. If needed, resolve any errors or missing information. When the connection gets created, the connection displays in the Connections section of the Connect Overview page.
  2. To view details about when the connection is running, click the name of the connection. On the resulting connection details page, click the Logs tab.
  3. To view an individual run log, expand the row table.