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
If the pending changes require a server restart, the pending-changes apply
command will display a prompt to let you know a restart will occur. This 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. If the changes do not require a restart, the changes are applied without a prompt. For more information, see tsm pending-changes apply.
Because the configuration file is using configKey class, the values that you pass are not validated by TSM as they are when you use configEntities class. You can verify and set individual options by using the tsm configuration commands.
Crash reporter settings
The crash reporter settings in the template below specify a range of options for configuring Tableau Server to send crash reports to Tableau.
Configuration template
Use this template to configure the gateway settings.
For more explanation about configuration files, entities, and keys see Configuration File Example.
{
"configKeys": {
"servercrashupload.enabled": "true",
"servercrashupload.scheduled_time": "1:00:00 UTC",
"servercrashupload.proxy_server_host": "",
"servercrashupload.proxy_server_port": "",
"servercrashupload.proxy_server_username": "",
"servercrashupload.proxy_server_password": "",
"servercrashupload.preserve_upload_packages": "false",
"servercrashupload.delete_completed_dumps": "false"
}
}
Configuration file reference
This table includes keys that you can set to configure crash reporting.
- servercrashupload.enabled
Default: false
.
Set to true
to enable crash reporting.
- servercrashupload.scheduled_time
Default: 1:00:00 UTC
Specifies the scheduled time that crash uploads will begin. Enter time of day in 24 hour format.
- servercrashupload.proxy_server_host
If your organization uses a proxy server to communicate with the internet, specify the host name.
- servercrashupload.proxy_server_port
If your organization uses a proxy server to communicate with the internet, specify the port number.
- servercrashupload.proxy_server_username
If your proxy server requires authentication, specify the user name with this key.
- servercrashupload.proxy_server_password
If your proxy server requires authentication, specify the password with this key.
- servercrashupload.preserve_upload_packages
Default: false
.
To save all packages that are created for a crash reporting, set this key to true
.
By default, packages are saved to C:\ProgramData\Tableau\Tableau Server\data\tabsvc\clustercontroller\tabcrashreporter
.
- servercrashupload.delete_completed_dumps
Default: false
.
To delete all dumps after they are sent, set this key to true
.