Configuring Deploy

If you did not install Deploy with the Apply All Tanium recommended configurations option, you must enable and configure certain features.

(Tanium Core Platform 7.4.5 or later only) You can set the Deploy action group to target the No Computers filter group by enabling restricted targeting before adding Deploy to your Tanium licenseimporting Deploy. This option enables you to control tools deployment through scheduled actions that are created during the import and that target the Tanium Deploy action group. For example, you might want to test tools on a subset of endpoints before deploying the tools to all endpoints. In this case, you can manually deploy the tools to an action group that you configured to target only the subset. To configure an action group, see Tanium Console User Guide: Managing action groups. To enable or disable restricted targeting, see Tanium Console User Guide: Dependencies, default settings, and tools deployment.

When you import Deploy with automatic configuration, the following default settings are configured:

The following default settings are configured for Deploy:

Setting Default value
Action group
  • Restricted targeting disabled (default): All Computers computer group
  • Restricted targeting enabled: No Computers computer group
Service account

The service account is set to the account that you used to import the module.

Configuring a unique service account for each Tanium solution is an extra security measure to consider in consultation with the security team of your organization. See Configure service account.

Deploy deployment templates

The following deployment templates are created:

  • [Standard Deployment] - default
  • [Deployment with Reboot]
  • [Deployment with Pre-Notification]

Deploy maintenance windows

An Always On maintenance window is created, and enforced against the All Computers computer group.

Deploy configurations For action locked machines, only applicability scanning is enabled, so that deployments cannot run on action locked machines.

Configure advanced settings

You can configure the Tanium platform for optimal delivery of larger payloads, which are typically associated with downloading and installing software.

  1. From the Main menu, go to Administration > Configuration > Settings > Advanced Settings.
  2. To increase the client cache size, click Add Setting, provide the following information, and click Save.
    Setting Type: Client
    Platform Setting Name: ClientCacheLimitInMB
    Value Type: Numeric
    Value 2048

Changes to platform settings can take up to five hours to propagate to clients.

Install and configure Configure Tanium End-User Notifications

With the Tanium End-User Notifications solution, you can create a notification message with your deployment to Windows and macOS endpoints to notify the user that the system is about to begin a deployment, has completed a deployment, and if postponements are enabled, to give the user the option to postpone the deployment or restart now.

For more information, see Tanium End-User Notifications User Guide: End-User Notifications overview.

Install and configure Configure Tanium Endpoint Configuration

Manage solution configurations with Tanium Endpoint Configuration

Tanium Endpoint Configuration delivers configuration information and required tools for Tanium Solutions to endpoints. Endpoint Configuration consolidates the configuration actions that traditionally accompany additional Tanium functionality and eliminates the potential for timing errors that occur between when a solution configuration is made and the time that configuration reaches an endpoint. Managing configuration in this way greatly reduces the time to install, configure, and use Tanium functionality, and improves the flexibility to target specific configurations to groups of endpoints.

Endpoint Configuration is installed as a part of Tanium Client Management. For more information, see the Tanium Client Management User Guide: Installing Client Management.

Additionally you can use Endpoint Configuration to manage configuration approval. For example, configuration changes are not deployed to endpoints until a user with approval permission approves the configuration changes in Endpoint Configuration. For more information about the roles and permissions that are required to approve configuration changes for Deploy, see User role requirements.

To use Endpoint Configuration to manage approvals, you must enable configuration approvals.

  1. From the Main menu, go to Administration > Shared Services > Endpoint Configuration to open the Endpoint Configuration Overview page.
  2. Click Settings and click the Global tab.
  3. Select Enable configuration approvals, and click Save.

For more information about Endpoint Configuration, see Tanium Endpoint Configuration User Guide.

If you enabled configuration approvals, the following configuration changes must be approved in Endpoint Configuration before they deploy to endpoints:

  • Creating, stopping, or reissuing deployments
  • Adding or removing maintenance window enforcements
  • Creating, editing, or removing self service profiles
  • User-initiated actions, such as initializing endpoints, distributing the software package catalog, updating Deploy Settings

Configure Deploy

Configure service account

The service account is a user that runs several background processes for Deploy. This user requires the Content Administrator, Deploy Service Account, and End-User Notifications Read Only User roles, or the Tanium Administrator role. If you enabled configuration approvals in Endpoint Configuration, then by default, configuration changes initiated by the module service account (such as tool deployment) require approval. You can bypass approval for module-generated configuration changes by applying the Endpoint Configuration Bypass Approval permission to the Deploy Service Account role and adding the relevant content sets. For more information, see Tanium Endpoint Configuration User Guide: User role requirements and Tanium Endpoint Configuration User Guide: Managing approvals. For more information about Deploy permissions, see User role requirements.

If you imported Deploy with default settings, the service account is set to the account that you used to perform the import. Configuring a unique service account for each Tanium solution is an extra security measure to consider in consultation with the security team of your organization.

  1. On the Deploy Overview page, click Settings and then click Service Account if needed.
  2. Provide a user name and password, and then click Save.

(Optional) Configure the Deploy action group

Importing the Deploy module automatically creates an action group to target specific endpoints. If you did not use automatic configuration or you enabled restricted targeting when you imported Deploy, the action group targets No Computers.

If you used automatic configuration and restricted targeting was disabled when you imported Deploy, configuring the Deploy action group is optional.

Select the computer groups to include in the Deploy action group.

Clear the selection for No Computers and make Make sure that all operating systems that are supported by Deploy are included in the Deploy action group.

  1. From the Main menu, go to Administration > Actions > Action Groups.
  2. Click Tanium Deploy.
  3. Select the computer groups that you want to include in the action group and click Save.
    If you select multiple computer groups, choose an operator (AND or OR) to combine the groups.

Organize computer groups

One way to deploy packages or bundles is by computer group. Create relevant computer groups to organize your endpoints. Some options include:

  • Endpoint type, such as servers or employee workstations
  • Endpoint location, such as by country or time zone
  • Endpoint priority, such as business-critical machines

Set up Deploy users

You can use the following set of predefined user roles to set up Deploy users.

To review specific permissions for each role, see User role requirements.

For more information about assigning user roles, see Tanium Core Platform User Guide: Manage role assignments for a user.

Deploy Administrator

Assign the Deploy Administrator role to users who manage the configuration and deployment of Deploy functionality to endpoints.
This role can perform the following tasks:

  • Manage all Deploy settings
  • Manage deployments, maintenance windows, and Self Service profiles

Deploy Endpoint Configuration Approver

Assign the Deploy Endpoint Configuration Approver role to a user who approves or rejects Deploy configuration items in Tanium Endpoint Configuration.
This role approves, rejects, or dismisses changes that target endpoints where Deploy is installed.

Deploy Operator

Assign the Deploy Operator role to users who manage the configuration and deployment of Deploy functionality to endpoints.
This role can perform the following tasks:

  • Create, edit, import, or delete software packages and software bundles

  • Manage deployments, maintenance windows, and Self Service profiles

Deploy Package Administrator

Assign the Deploy Package Administrator role to users who manage the configuration of Deploy functionality.
This role can perform the following tasks:

  • Reject or dismiss Deploy configuration changes

  • Create, edit, import, or delete software packages and software bundles

  • View all configurations, graphs, and reporting data in Deploy

Deploy Read Only User

Assign the Deploy Read Only User role to users who need visibility into Deploy data.
This role can view all configurations, graphs, and reporting data in Deploy.

Deploy Service Account

Assign the Deploy Service Account role to the account that configures system settings for Deploy.
This role can perform several background processes for Deploy.

Deploy User

Assign the Deploy User role to users who manage the deployment of Deploy functionality to endpoints.
This role can manage deployments, maintenance windows, and Self Service profiles.

Configure module settings

  1. On the Deploy Overview page, click Settings and then click Configuration Settings if needed.
  2. In the Endpoint Process Settings section, configure the following options:

    Scan Interval

    Specify how frequently in hours that endpoints complete a full catalog scan. The default value is 24 hours but can be set lower to improve responsiveness to changes on endpoints, such as software that is installed, updated, or removed by programs other than Deploy.

    File Download Retry Limit

    Specify how many times Deploy will attempt to download a file that has failed to download. Setting this option to a higher number can help work around temporary issues, such as bad network connectivity.

    File Download Retry Delay

    Specify the amount of time in seconds, minutes, or hours before the endpoint tries to download a file that has failed to download. Setting this option to a relatively low number, such as 1-5 minutes, can help work around temporary issues without causing an excessive number of download requests.

    File Download Timeout

    Specify the amount of time in hours or days before a download attempt will time out. Setting this option to at least 24 hours helps ensure that large downloads on bandwidth-constrained endpoints have time to complete.

    When Action Lock Enabled

    This option specifies how Deploy behaves on action-locked endpoints. For best results, select either Applicability Scanning Only or Ignore Action Lock to ensure the accuracy of workbench data.

    The Deploy action lock setting does not override the Endpoint Configuration action lock setting. If you do not select Manifest package ignore action lock in Endpoint Configuration settings, then action-locked endpoints will not receive changes to Deploy configurations. For more information, see Tanium Endpoint Configuration User Guide: Reference: Settings.

    Enable Debug Logging

    Select this option to set the Deploy logs on all endpoints to be at the most verbose level. You should use this setting only with guidance from Tanium Support. To configure log verbosity, log size, and number of logs to keep for individual endpoints, use the Deploy - Set Logging Options Tanium packages.

  3. In the Deployment Retry Settings section, configure the following options:

    Retry Limit

    Specify how many times Deploy will retry a failed deployment on an endpoint. When Deploy reaches this limit, it will not retry the failed deployment until the Reset Frequency time has been reached.

    Reset Frequency (in hours)

    Specify the amount of time in hours before Deploy will attempt to retry failed downloads after the Retry Limit has been reached. Setting this option to a value less than 24 hours lets failed deployments run multiple times in the same day and can help work around temporary issues.

  4. In the General Settings section, configure the following options:

    Client API Nonce Roundoff (in minutes)

    This setting enables a timestamp-based nonce for all Tanium Client API calls to avoid reusing previously cached URLs. You should use this setting only with guidance from Tanium Support.

    Software Package Gallery

    For air-gapped environments, select Enable Alternate Software Package Gallery Location and then specify a location in the Alternate Software Package Gallery Location field. For more information, see Configure an alternate location for the Predefined Package Gallery.

    Auto-Distribute Catalog

    If you want the software package catalog to be automatically distributed, you must select Enable Auto-Distribute Catalog. New installations of Deploy automatically distribute the software package catalog to endpoints when changes are detected. If you do not enable this option, you are prompted to distribute the software package catalog each time an update is detected, and must click Distribute Catalog.

  5. Click Save.

Configure an alternate location for the Predefined Package Gallery

The Predefined Package Gallery in Tanium Deploy provides a collection of common software packages that are hosted at content.tanium.com. These packages are preconfigured and ready to deploy to endpoints. By default, the Tanium Server in an air-gapped environment cannot directly access Deploy Gallery package definitions. To address this scenario, you can configure an alternative Gallery location so that a Tanium Server in an air-gapped environment can still download the Gallery.

To ensure the Tanium Server can download the Gallery, use a computer that is connected to the internet to download the software package definitions and then place the definitions in a location defined on your local network that is accessible to your Tanium Server.

For more information about using the Deploy Gallery, see Import a software package from the Predefined Package Gallery.

Stage the Predefined Package Gallery in a location accessible to the Tanium Server

Download the Package Gallery ZIP file and place it where it can be accessed by the Tanium Server.

The Package Gallery ZIP file contains JSON content for each software package in the Gallery. In environments that are not air-gapped, this JSON content is downloaded automatically from content.tanium.com. Because air-gapped environments do not have access to the internet, the ZIP file must be staged in a location that the Tanium Server can access.

Configure the alternate Gallery location

  1. On the Deploy Overview page, click Settings and then click Configuration Settings.
  2. In the General Settings section, select Enable Alternate Software Package Gallery Location and then specify a location in the Alternate Software Package Gallery Location field.

    For example, a UNC location might look like this: \\myserver.example.local\files\deploy-software-package-gallery.zip.

  3. Click Save and then confirm your changes.
  4. On the Deploy Overview page, in the Configuration section, click Initialize Endpoints and then confirm your action.

  5. In the Initialize Endpoints section, click View Job Status and confirm that Sync Software Gallery appears with a green check mark.

  6. Close the window and let the Package Gallery synchronize to Deploy. This process typically takes 5-10 minutes.

Add files to a software package

When you import a software package from the Gallery, the Tanium Server attempts to download the files associated with that software package. However, air-gapped Tanium Servers cannot download the files, which causes a Sync Software Package warning to appear. For information about fixing the error so that the imported software package can be used by the air-gapped Tanium Server, see Deploy cannot access the origin of a software package file.

Create a custom operating system

To make a specific operating system version available for use in the Restrict Operating System menu for software packages, you can create a new operating system in the Deploy settings.

  1. On the Deploy Overview page, click Settings and then click Operating Systems.
  2. Click Add Operating System.
  3. Select the OS platform, and then specify a name and version.
  4. Configure the following settings as needed:
    • (Windows) In the Type drop-down menu, specify whether the OS is for servers or workstations.

    • (Linux) In the Distribution drop-down menu, specify the type of Linux distribution for the OS.

  5. Click OK.

Initialize Deploy endpoints

Deploy installs a set of tools on each endpoint that you have targeted. Initializing the endpoints starts the Deploy service and starts the Deploy process on every endpoint where it is not running.

  1. On the Deploy Overview page, click Help , and then click Support if needed.
  2. Click Initialize Endpoints and confirm your action.

After deploying the tools for the first time, endpoints can take up to four hours to display status.