Reference: Appliance Maintenance menu

You can use the Appliance Maintenance menu to perform backup, factory reset, TanOS upgrade, and system reboot or shutdown.

Back up

The backup procedure uses the rsync utility to copy the active partition to a backup partition.

Back up to the alternate partition

TanOS has two partitions: an active partition and an inactive partition that can be used in case of failover or troubleshooting. Perform a partition sync prior to upgrading TanOS or a Tanium server component, so you have an alternate partition in case there are issues encountered during the upgrade process or issues with the Tanium server update and you want to revert to the previous version. The alternate partition can also be useful if the primary partition fails to boot. During the TanOS boot process, you have the option to select the alternate partition if needed.

  1. Log into the TanOS console as a user with the tanadmin role.

    The TanOS console displays the tanadmin menu.

  2. Enter B to go to the Appliance Maintenance menu.
  3. Enter 1 to go to the Backup/Restore menu.
  4. Enter 1 to display the Partition Sync menu.
  5. When prompted to enter maintenance mode, enter Yes.
  6. Follow the prompts to complete the backup.
  7. After the partition sync has completed, exit maintenance mode:
    1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
    2. Enter C to go to the Maintenance Mode menu.
    3. Enter 2 and follow the prompts to toggle off maintenance mode.

Change the active partition

If you encounter issues during the upgrade process or issues with a recent Tanium server update and you want to revert to the previous version, you can switch to the alternate partition.

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter A to display the Appliance Configuration menu.
  3. Enter X and follow the prompts to display the Advanced Configuration menu.
  4. Enter 3 to display the Active Partition menu.
  5. When prompted to enter maintenance mode, enter Yes.
  6. Follow the prompts to switch to the alternate partition.
  7. After the appliance has rebooted, exit maintenance mode:
    1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
    2. Enter C to go to the Maintenance Mode menu.
    3. Enter 2 and follow the prompts to toggle off maintenance mode.

Back up to an external file

There are two options to create external backup files: minimal and full.

minimal

Quick backup of a number of key files that can help you recover more quickly in the case of a failure. Perform a minimal backup after the initial configuration of your Tanium Appliance is complete. Tanium services do not have to be stopped prior to a minimal backup.

On a Tanium Server appliance, the backup includes the following:

  • Tanium public and private key files
  • Web server SSL certificates
  • Tanium Server configuration database
  • Tanium Downloader configuration database
  • Tanium license file

After the initial configuration is completed, these files do not change frequently. A monthly minimal backup is sufficient.

TanOS saves the backup file to the /outgoing directory where you can use SFTP to download it.

full

Complete backup of the /opt/Tanium directory. A complete backup enables you to completely restore the Tanium installation in the event of a hardware failure or corruption of the Tanium installation. This option takes a significant amount of time to complete and requires that the services on the Tanium Appliance are stopped.

For Active-Active deployments, take the following steps to minimize downtime:

  1. Confirm that your database replication between your primary and secondary Tanium database is running successfully.
  2. Stop all Tanium services on your Tanium Server hosting the secondary database (this includes the PostgreSQL service).
  3. Complete backup using the Backup Off-Box (full) menu.
  4. Start the Tanium services.

This process ensures you have a backup of your entire Tanium installation, including the Tanium database, without needing stop both Tanium Servers.

For environments with only a single Tanium Server, there will be an outage while the backup is performed.

For the Tanium Module Server, stop all Tanium Services while the backup is performed. During this time, users can still access Tanium and ask questions, but the module workbenches are unavailable until the Module Server is restarted.

The TanOS Backup Off-Box (full) menu prompts you to save the backup file to the /outgoing directory or specify a the username and IP address for a destination server that can be reached with secure copy protocol (SCP).

Perform a backup

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 1 to go to the Backup/Restore menu.
  4. Use the menu to create an off-box backup:
    • Enter 2 to display the Backup off-box minimum menu.
    • Enter 3 to display the Backup off-box full menu.
  5. When prompted to enter maintenance mode, enter Yes.
  6. Specify a password and file transfer option.
  7. After the backup has completed, exit maintenance mode:
    1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
    2. Enter C to go to the Maintenance Mode menu.
    3. Enter 2 and follow the prompts to toggle off maintenance mode.

Backup the Tanium database

A backup of the Tanium PostgreSQL database is performed nightly at 2 AM. In the event of database failure, you can use the daily backups to restore the database to a known good state.

The backup is automatically saved to the /outgoing directory. You can schedule daily retrieval of the database backup using sftp as the tancopy user.

To perform a manual backup:

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 1 to go to the Backup/Restore menu.
  4. Enter 4 and then follow the prompts to create a database backup. The backup is saved to the /outgoing folder.
  5. Use SFTP to copy the backup file from the /outgoing directory on the appliance to your management computer.

Manage Tanium database backups

To select a specific backup from the last 7 days, or a manual backup you have performed, you can navigate to menu B-1-5.

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 1 to go to the Backup/Restore menu.
  4. Enter 5 to display the List Tanium Database Backups menu.
  5. Follow the prompts to export, rename, or delete the backup.

Configure alerts

TanOS can send alerts to a syslog server or to an email recipient. It is recommended that you configure an SMTP email recipient. If the syslog server fails, the SMTP recipient will receive a failure notification every 15 minutes until the failure is resolved or the syslog forwarding is disabled.

Configure alerts

Use the Alerts Configuration menu to set severity threshold to info, warn, or error. If you set it to warn, it also includes error. If you set it to info, it also includes warn and error.

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 2 to go to the Alerting menu.
  4. Enter 3 to display the Alerts Configuration menu.
  5. Use the menu to set a severity level and enable/disable alerting.

Configure syslog destination

The Alerting syslog configuration is separate from the syslog configuration in the Appliance Configuration menu. This configuration sends alerts for the alert threshold severity. The syslog configuration in the Appliance Configuration menu sends all logs.

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 2 to go to the Alerting menu.
  4. Enter 1 to display the Syslog Destination menu.
  5. Enter 2 and follow the prompts to configure a syslog destination.
  6. Enter 1 to enable syslog alerts.
  7. Enter 3 to send a test alert to the syslog server.

The test alert appears in the syslog server logs.

Configure SMTP destination

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter 2 to go to the Alerting menu.
  4. Enter 2 to display the SMTP Destination menu.
  5. Enter 2 and then follow the prompts to configure an SMTP destination.
  6. Enter 1 to enable SMTP alerts.
  7. Enter 3 to send a test alert to the mail recipient.

Upgrade TanOS

See Upgrade TanOS.

Upgrade the TanOS shell

See Upgrade the TanOS shell.

Request a shell access key

If necessary for troubleshooting, you can request OS shell access to examine OS processes and files written to the file system. See Examine OS processes and files.

Clean up generated files

You can clean directories to clear up disk space or clear logs to make it easier to work with new entries in the log viewer.

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter A to go to the Clean Directories menu.
  4. Use the menu to delete files that have been generated in the SFTP /incoming and /outgoing directories, core dump files, application logs, and so on.

Reboot or shut down

Tasks you complete with TanOS menus typically do not require you to reboot the system. Reboot might be required during troubleshooting workflows.

Shutdown turns off the system and powers down the appliance.

You must have physical access to the appliance to power it on. Do not perform a system shutdown unless you are prepared to power the appliance back on.

Reboot

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter B to go to the Reboot/Shutdown menu.
  4. Enter 1 to display the Reboot menu.
  5. When prompted to enter maintenance mode, enter Yes.
  6. Follow the prompts to reboot the appliance.
  7. After the appliance has rebooted, exit maintenance mode:
    1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
    2. Enter C to go to the Maintenance Mode menu.
    3. Enter 2 and follow the prompts to toggle off maintenance mode.

Shut down

  1. Log into the TanOS console as a user with the tanadmin role.
  2. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  3. Enter B to go to the Reboot/Shutdown menu.
  4. Enter 2 to display the Shutdown menu.
  5. When prompted to enter maintenance mode, enter Yes.
  6. Follow the prompts to shut down the appliance.
  7. When the appliance has been restarted, exit maintenance mode:
    1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
    2. Enter C to go to the Maintenance Mode menu.
    3. Enter 2 and follow the prompts to toggle off maintenance mode.

Exit maintenance mode

Some maintenance procedures you perform with TanOS menus prompt you to enter maintenance mode to ensure Tanium services are not affected by the maintenance operation. When the operation has been completed, exit maintenance mode to resume normal operations.

  1. From the tanadmin menu, enter B to go to the Appliance Maintenance menu.
  2. Enter C to go to the Maintenance Mode menu.
  3. Enter 2 and follow the prompts to toggle off maintenance mode.

Last updated: 12/5/2019 3:52 PM | Feedback