What is TSM in Tableau?

If you're responsible for managing Tableau Server, you’ve likely come across the term "TSM." The Tableau Services Manager (TSM) is the foundational tool for administering your server from the command line, handling everything from initial setup to day-to-day maintenance. This guide will walk you through what TSM is, why it's essential, and the core commands you need to get started.

Graphed

Still Building Reports Manually?

Watch how growth teams are getting answers in seconds — not days.

Watch the Demo

Beyond the Dashboard: Understanding Tableau Services Manager (TSM)

Tableau Services Manager (TSM) is the definitive management toolset for Tableau Server. Introduced in version 2018.2, it replaced the older tabadmin utility and the Tableau Server Configuration utility, bringing server administration into a more modern, unified framework. Think of it as the control panel for your entire Tableau Server environment.

While your users interact with the front-end - the dashboards, visualizations, and data sources - TSM operates behind the scenes. It's the "engine room" where administrators perform critical tasks like:

• Installing and initializing Tableau Server for the first time.
• Configuring server settings, such as authentication (SAML, OpenID), process configurations, and SSL.
• Managing the server's topology in a multi-node cluster.
• Stopping, starting, and restarting server processes.
• Creating backups and restoring the server from a backup file.
• Managing log files for troubleshooting and support.

In short, if a task involves the core health, configuration, or structural management of your Tableau Server instance, you'll be using TSM to do it.

Why You Can't Ignore TSM

For anyone in a Tableau Server Administrator role, TSM isn't just a helpful utility - it's mandatory. You simply can't run a modern Tableau Server without it. Here's why getting comfortable with TSM is so important.

1. Unified Control Interface

Before TSM, server administration was split between a command-line tool (tabadmin) and a separate graphical utility for configuration. TSM brings all these functions under one umbrella, offering both a comprehensive Command-Line Interface (CLI) and a helpful Web UI. This consolidation makes it much easier to manage all aspects of your server from a single point of control.

Graphed

Still Building Reports Manually?

Watch how growth teams are getting answers in seconds — not days.

Watch the Demo

2. Essential for Installation and Ongoing Configuration

The entire lifecycle of your server settings is managed through TSM. During the initial setup, you use TSM to initialize the server and apply the required configurations. As your needs evolve, you will use TSM to change external SSL settings, tweak cache settings for performance, or configure a new identity provider. It's the authoritative source for your server’s configuration.

3. Automation and Scripting Capabilities

This is where TSM’s command-line interface truly shines. Because you can execute all management tasks from the CLI, you can script repetitive administrative duties. Want to run a server backup every night at 2 a.m.? Write a simple script that calls the TSM backup command and schedule it with Windows Task Scheduler or a cron job. This ability to automate saves countless hours and reduces the risk of human error in routine maintenance.

4. Critical for Disaster Recovery

Your data and content on Tableau Server are incredibly valuable. TSM is your primary tool for creating complete backups of your Tableau Server ecosystem, which includes the data and configuration settings. In the event of a server failure or data corruption, the tsm maintenance restore command is your lifeline to getting your environment back up and running with minimal downtime.

Your TSM Toolkit: The CLI and the Web UI

TSM gives you two ways to manage your server: the command-line interface (CLI) and a browser-based web UI. While they manage the same settings, they serve slightly different purposes.

The TSM Command-Line Interface (CLI)

The CLI is the most powerful and comprehensive way to interact with TSM. You access it through a command prompt (on Windows) or a terminal session (on Linux) directly on the machine running Tableau Server. It's where you'll do most of your heavy lifting, configuration changes, and, most importantly, all your scripting. While it has a learning curve, its flexibility and power make it the preferred tool for experienced administrators.

Graphed

Still Building Reports Manually?

Watch how growth teams are getting answers in seconds — not days.

Watch the Demo

The TSM Web UI

The TSM Web UI provides a graphical interface for many common administrative tasks. You can access it through your browser by navigating to https://<your-server-name>:8850. The Web UI is great for:

• Visually checking the status of all your server processes at a glance.
• Changing configuration settings using forms and dialog boxes instead of commands.
• Scheduling maintenance tasks like backups.
• Applying pending changes without having to use the CLI.
• Easy access to notifications and job statuses.

For administrators who prefer a graphical approach or for quick status checks, the Web UI is incredibly useful. However, the CLI remains the go-to for automation and gaining access to every available command and option.

The Most Common TSM Commands You'll Actually Use

Getting started with the TSM CLI can feel a bit daunting, but in reality, you'll rely on a small set of core commands for the majority of your day-to-day tasks. Let's break down the essential commands every administrator should know.

Server Status and Control

These commands are for turning your server on or off and checking its health.

• tsm status -v: This is your heartbeat command. It tells you the status of every process running on Tableau Server. The -v (verbose) flag provides a detailed node-by-node report, which is essential for multi-node environments.
• tsm start: Starts the Tableau Server application and all its associated services.
• tsm stop: Shuts down Tableau Server gracefully. It's best practice to use this command before performing maintenance or rebooting the host machine.
• tsm restart: A useful combination of stop and start. It stops all services and then starts them back up in the correct sequence.

Configuration Management

These commands allow you to check and update your server's settings.

• tsm configuration get -k <key>: Use this to view the current value of a specific configuration key. For example, to check the gateway port, you'd run:
• tsm configuration set -k <key> -v <value>: This command changes the value of a configuration key. For example, to change the session timeout to 90 minutes, you would run:

Applying Your Changes

This is arguably the most important (and sometimes forgotten) step in managing TSM.

• tsm pending-changes apply: When you use a tsm configuration set command, the change doesn't happen immediately. It's staged as a "pending change." This command applies all pending changes. TSM will inform you if a restart is required and handle it as part of the application process. No configuration change takes effect until you run this.

Backup and Restore

These commands are critical for your disaster recovery plan.

• tsm maintenance backup -f <filename> -d: This creates a full backup of your Tableau Server. The -f flag lets you specify a filename, and the -d flag appends the current date to that filename, which is great for organizing backups. A typical backup command looks like this:
• tsm maintenance restore -f <filename>: This command restores a server from a backup file. Be extremely careful with this command as it will overwrite all existing data on your Tableau Server.

Log Management

When something goes wrong, this is the command you need.

• tsm maintenance ziplogs -a: This command collects all the log files from all nodes in your Tableau Server environment and packages them into a single zip file. This is indispensable for troubleshooting and is exactly what Tableau Support will ask for when you open a support ticket.

Graphed

Still Building Reports Manually?

Watch how growth teams are getting answers in seconds — not days.

Watch the Demo

Putting It All Together: A Simple TSM Workflow

Let's walk through a common administrative task to see how these commands work together in practice. Our goal is to update the idle session timeout to prevent users from being logged off too quickly.

Step 1: Check the Current Setting

First, we want to know what the current timeout is. We'll use the get command:

tsm configuration get -k wgserver.session.idle_limit

TSM might return a value like 30, meaning a 30-minute timeout.

Step 2: Set the New Value

We decide to increase the timeout to 2 hours (120 minutes). We use the set command:

tsm configuration set -k wgserver.session.idle_limit -v 120

TSM will confirm that the value has been updated and a pending change has been created.

Step 3: Review and Apply Pending Changes

As a final check, you can see what changes are pending using tsm pending-changes list. Once confirmed, you apply the change:

tsm pending-changes apply

TSM will process the request. It will detect that this particular change requires a server restart. It will automatically stop all the Tableau Server services, apply the configuration change, and then start the services back up for you.

Step 4: Verify Server Status

Once the apply command has completed, the final step is to ensure everything came back online correctly. A quick run of the status command will confirm this:

tsm status -v

If all services show as "Running," your task is complete! Your server is now configured with the new session timeout.

Final Thoughts

Tableau Services Manager is the non-negotiable cornerstone of administering your Tableau Server. By providing comprehensive command-line and web-based tools, TSM gives you full control over your server's configuration, health, and maintenance. Becoming proficient with its core commands is the key to managing a stable, reliable, and secure analytics platform.

While TSM efficiently manages your server environment, getting fast, easy insights from your actual data is a whole different challenge. We built Graphed to simplify that process. We believe analytics shouldn't require complex tools. Just connect your marketing and sales data sources - like Google Analytics, Shopify, or Salesforce - and use plain English to build dashboards, pull reports, and get your questions answered in seconds, not hours.