tsm register
You can use the tsm register command to register Tableau Server. This command lets you either display the registration file template (using the --template option) or provide the path to a completed registration file (using the --file option). You must use one of these two options when calling the tsm register command.
Synopsis
tsm register --template | --file <registration-filename> [global options]
Options
-
--file <registration-filename>
-
Required.
Path to the file that contains the registration data.
-
--template
-
Required.
Displays the registration file template.
Registration fields
The registration file contains these fields.
-
first_name -
The first name of the person registering Tableau Server.
-
last_name -
The last name of the person registering Tableau Server.
-
phone -
The phone number of the contact person for this registration.
-
email -
The email address of the contact person for this registration.
-
company -
The name of the organization registering Tableau Server.
-
industry -
The industry of the organization.
-
company_employees -
The number of employees in the organization.
-
department -
The department of the person registering Tableau Server within the organization.
-
title -
The job title of the person registering Tableau Server.
-
city -
The city where the organization or the registering individual is located.
-
state -
The state or province where the organization or the registering individual is located.
-
zip -
The postal or ZIP code where the organization or the registering individual is located.
-
country -
The country where the organization or the registering individual is located.
-
opt_in -
Indicates your preference for receiving marketing communications from Tableau. The default value is
falsefor many countries. Country-specific laws can impact the default for this field. For more information, see Privacy Information(Link opens in a new window) on the Salesforce website. -
eula -
Confirms you accept the End User License Agreement (EULA). The default value is
accept. You must accept the EULA to use Tableau Server. If you don't accept, you can't run Tableau Server.
Global options
-
-h, --help
-
Optional.
Show the command help.
-
-p, --password <password>
-
Required, along with
-uor--usernameif no session is active.Specify the password for the user specified in
-uor--username.If the password includes spaces or special characters, enclose it in quotes:
--password 'my password' -
-s, --server https://<hostname>:8850
-
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 examplehttps://<tsm_hostname>:8850. If no server is specified,https://<localhost | dnsname>:8850is 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
-por--password.Specify a user account. If you do not include this option, the command is run using credentials you signed in with.
