gatewaySettings Entity

You must configure the gateway settings for the Tableau Server computer.

Use the configuration file template below to create a json file. After you have filled in the options with the appropriate values, pass the json file and apply settings with the following commands:

tsm settings import -f /path/to/file.json

tsm pending-changes apply

The pending-changes apply command displays a prompt to let you know this will restart Tableau Server if the server is running. The prompt displays even if the server is stopped, but in that case there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behavior. For more information, see tsm pending-changes apply.

Gateway settings

The gateway settings in the template below specify the HTTP settings for Tableau Server. We recommend using SSL/TLS. Tableau Server is hard-coded to use port 443 for SSL/TLS. Therefore, if you enable SSL, you do not need to update the gatewaySettings entity.

Configuration template

Use this template to configure the gateway settings.

All entity options are case sensitive.

For more explanation about configuration files, entities, and keys see Configuration File Example.

{
  "configEntities": {
	 "gatewaySettings": {
	  "_type": "gatewaySettingsType",
	   "port": 80,
	   "sslRedirectEnabled": true,
	   "publicHost": "localhost"
	 }
	}			
 }

Configuration file reference

This table includes all of the options that can be included with the "gatewaySettings" entity set.

_type

Required.

Value: "gatewaySettingsType"

Do not change.

port

Specifies HTTP port. Default is port 80.

sslRedirectEnabled

Options: true or false.

publicHost

Specifies host name for http/s service.

trustedIPs

Specifies trusted IP addresses that communicate with Tableau Server. Trusted IP addresses include upstream proxy servers and servers that are used for trusted authentication with Tableau Server. See Configuring Proxies for Tableau Server and Add Trusted IP Addresses or Host Names to Tableau Server.

If you are running Tableau Server in a cluster then all other nodes of the cluster will automatically be included in the corresponding configuration file that this entity updates. Therefore, if you specify a new value for trustedIPs, then you must include the IP addresses for the other nodes in the value.

trustedHosts

Specifies trusted IP addresses that communicate with Tableau Server. Typically, this value contains a list of upstream proxy servers. The values in trustedHosts are used to determine client request targets.

If you are running Tableau Server in a cluster then all other nodes of the cluster will automatically be included in the corresponding configuration file that this entity updates. Therefore, if you specify a new value for trustedIPs, then you must include the IP addresses for the other nodes in the value.

The hostname may be entered as a name or an IP address. Format is hostname:port, for example, proxy_server1:80. In the case where a given proxy server has multiple name forms (proxy_server1, proxy_server1.example.com, etc), each name must be entered in the hostname:port format. Enter multiple hostname:port pairs in a comma-separated list.

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