Configuring SMTP email destinations

Before your connections can successfully send data to a destination, your Tanium Cloud instance, CMP network egress allow list, and network allow list must be configured. Note the following:

  • Sign in to the CMP and configure a network egress allow list rule for each destination fully qualified domain name (FQDN) and associated port. For more information on configuring the network egress allow list, see Tanium Cloud Deployment Guide: Configuring network egress allow list rules in the CMP.
  • You must associate a port used for non-HTTPS destinations with only one FQDN. If multiple FQDNs are associated with the same port, traffic does not route correctly.
  • TCP traffic that does not use Server Name Indication (SNI) is limited to one destination per port. For example, SQL traffic and SMTP traffic do not use SNI.
  • TCP traffic is not supported for the following ports: 22, 25, 111, 3128, 3129, 3130, 4000, 5000, 6000, 9100, 9301, 9302, 9901, and 9902.
  • UDP traffic is not supported.
  • Your Tanium Cloud instance has a proxy cluster with 2 public IP addresses. If a destination is in your network, add inbound traffic from these IP addresses to your network allow list.

For more information, including restrictions on FQDNs and ports, see Tanium Cloud Deployment Guide: Network egress. For assistance, contact Tanium Support.

You can send information from a connection source to a set of email addresses using SMTP servers. You can either include the results in the email body, or create an attachment.

Prerequisites

  • Email addresses for sending and receiving email results.
  • Information about your mail server, including host, port, user name, password, and authentication information.

Standard TCP ports for secure email using SMTP include 465 and 587. Tanium does not support sending data over TCP port 25 outbound.

Standard TCP ports for secure email using SMTP include 465 and 587. Do not send unencrypted data over TCP port 25 outbound.

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, Log Level is set to Information. To reduce the amount of logging, you can set Log Level to Warning, Error, or Fatal.


    Override Log Level

    If you are debugging the connection, select Override Log Level to set a Temporary Log Level (such as Trace or Debug) on this connection for a selected Number of Runs (up to 24). A scheduled or manual connection run, once started, counts towards the number of runs, regardless of the connection status. After the number of runs elapse, the logging for this connection returns to the Log Level you selected to prevent finer-grained logging from consuming additional resources for an indefinite number of runs.

    Minimum Pass Percentage

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

    Memory Ceiling (GB)

    Maximum memory for the node process to run the connection. This defaults to 1 GB per connection, and cannot exceed the global maximum sum of memory for all running connections (by default, 8 GB). Increase this setting if a connection frequently exhibits out of memory errors while running.

    If the sum of simultaneously scheduled connection Memory Ceiling values exceed the global Memory Ceiling, connections run until the global Memory Ceiling is reached, then any remaining connections enter a waiting queue if you select the Queue Connections configuration setting, or fail if you clear the Queue Connections configuration setting.

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, client status, or event. The settings vary depending on which source you choose.




If a Tanium solution or source displays Critical , the installed solution does not meet the minimum required version for proper compatibility and functionality. Upgrade the solution to the minimum required version or later.

After you create a connection, you cannot update the connection source type, only the source configuration. If you want to change the source type, create a new connection.

Configure the Email (SMTP) results destination

After you create a connection, you cannot update the connection destination type, only the destination configuration. If you want to change the destination, create a new connection.

  1. In the Email section for the Email (SMTP) destination, provide a name for the destination.
    • Specify a unique name to save the configuration information as a new destination. Select New, and then enter a Destination Name.

    • Copy an existing destination. Select New, and then click Copy Settings. Select a destination from the drop-down list, click Apply, and update the Destination Name.

    • Select an existing destination. Select Existing, and then select a destination from the Destination Name drop-down list.

      Configure a unique destination per connection. If you edit the settings for a shared destination for one connection, any other connections that use the shared destination are affected, and connection runs might fail.

  2. In the Email section, provide information about the email Subject, From Address, and To Address sections. Some fields also support variable substitution, as listed in Reference: Variables.
  3. Specify information about the mail server in the Mail Configuration section:
    • Provide the host name, port, user name, and password.
    • Select Secure if the connection with the SMTP server is authenticated and uses TLS encryption.

      Tanium Cloud does not support using self-signed certificates for authentication with an SMTP server. You must provide a CA-signed certificate.

      If you do not select Secure, authentication information is encrypted at rest, but passed unencrypted to the destination.

    • Specify a Timeout value for sending the message. The default is 0, which means that there is no timeout. A recommended timeout value is 10 seconds.

    If you submit an external access request for traffic, your configured destination FQDN or IP address, port, and protocol must match the FQDN or IP address, port, and protocol submitted in the external access request.

  4. (Optional) Specify advanced settings. Some fields also support variable substitution, as listed in Reference: Variables.
    • You can configure CC and BCC addresses for the email and specify the settings for the email attachment.
    • Attachment is selected by default. Specify a file name and file extension in the Attachment File Name. The file extension does not need to match the format option you select in the Format section. Note the option that you select in the Format section does not add or change the file extension.

    • You can compress the attachment into a zip or gzip file. If you select a compression method, the file extension for the compression method is automatically added to the end of the file name.
    • Under Connection Runs Without Results, select Send Email to send an email if the connection run generates no results. Enter a message in the Email Body field to include in the email body.





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 email

You can choose from any of the available formats for your email. The data is sent in the body of the email by default.

If you want to attach a file to the email instead of having the data in the body of the email, edit the Advanced settings for the Email destination and select Attachment. Specify a file name and whether the file should be compressed.

The data format for email destinations is HTML by default. You can choose the columns that are displayed in the resulting email.

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 format that you want to use for the column. For more information about using a variable, see Time stamp variables.

For more information about column customizations, see Reference: Column customizations.

Schedule the connection

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

Connections scheduled to run during a Tanium Cloud maintenance window might be interrupted or fail. Schedule your connections to run outside of the Tanium Cloud maintenance window. For information on configuring a custom maintenance window start time, see Tanium Cloud Deployment Guide: Configure custom maintenance window.

Connections scheduled to run during an upgrade of Connect, or any Tanium solution configured as a connection source, might be interrupted or fail. Schedule your connections to run at a different time than your Tanium upgrades.

If you do not enable the schedule, the connection only runs when you manually run it, unless you configure an Event source. Connections with Event sources only run when a configured event is detected, and cannot be scheduled or manually run.

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.




If a user that owns a scheduled connection is deleted, future scheduled instances of that connection do not run. For more information, see Issue: Scheduled connection owned by a deleted user no longer runs.

For more information about cron syntax, see Reference: Cron syntax.

Save and verify connection

  1. After you enter the details for the connection, click Save.

    To save the connection and immediately run the connection, click Run and Save.

    If needed, resolve any errors or missing information. After the connection creates successfully, the connection details display.

  2. To view details when the connection runs, click the Logs tab.
  3. To view an individual run log, expand the row table. For more information on resolving errors, see Troubleshooting.