tsm status

You can use the tsm status command to display the status of Tableau Server.

Synopsis

tsm status [global options]

Options

-v, --verbose

Optional.

Display status for every node in the Tableau Server cluster.

tsm status will return one of four potential statuses for a Tableau Server node:

  • RUNNING: The node is running without error statuses for any service.

  • DEGRADED: A primary service - such as the repository - is in an error state.

  • ERROR: One or more services is in an error state.

  • STOPPED: The node is stopped.

When running tsm status with the --verboseoption, TSM will return a status for each individual service. There are four status messages:

  • is running: The service is running.

  • status is unavailable: The status is not returned - such as when processes are starting up.

  • is in an error state: The process is running, but returning errors. This status indicates the process failed to install properly, or has not been configured.

  • is stopped: The process is stopped.

Global options

-h, --help

Optional.

Show the command help.

-p, --password <password>

Required, along with -u or --username if no session is active.

Specify the password for the user specified in -u or --username.

If the password includes spaces or special characters, enclose it in quotes:

--password "my password"

-s, --server <url_to_tsm>

Optional.

Use the specified address for Tableau Services Manager. The URL must start with https, include port 8850, and use the server name not the IP address, for example https://mytableauhost:8850. If no server is specified, https://<localhost | dnsname>:8850 is assumed.

--trust-admin-controller-cert

Optional.

Use this flag to trust the self-signed certificate on the TSM controller. For more information about certificate trust and CLI connections, see Connecting TSM clients.

-u, --username <user>

Required if no session is active, along with -p or --password.

Specify a user account. If you do not include this option, the command is run using credentials you signed in with.

Thanks for your feedback! There was an error submitting your feedback. Try again or send us a message.