Windows 版 Tableau Server 帮助

可以在初始节点（安装 TSM 的节点）或群集中的任何附加节点上运行 tsm 命令。

若要运行 tsm 命令，您需要打开 Windows 命令提示符。请勿使用 PowerShell 运行 tsm 命令。使用 PowerShell 可能会导致意外行为。

1. 使用作为群集中某个节点上的管理员组成员的帐户打开 Windows 命令提示符。

2. 运行所需命令。如果从不是初始节点的某个节点中运行命令，请包括 -s 选项，按名称（而非 IP 地址）指定初始节点的 URL，并包括 TSM 端口 8850。

   从初始节点中查看 TSM 和 Tableau Server 的版本：

   tsm version

   从附加节点中查看 TSM 和 Tableau Server 的版本：

   tsm version -s https://<inital_node_name>:8850

   例如：

   tsm version -s https://myTableauHost:8850

backgrounder.failure_threshold_for_run_prevention

默认值：5

订阅、数据提取或流程运行作业挂起前连续失败的次数。挂起连续失败的作业有助于为其他作业保留后台程序资源。若要禁止挂起失败的后台任务，请将其设置为 -1。

backgrounder.log.level

版本：版本 2020.3.0 中新增。

默认值：info

后台程序进程日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

backgrounder.restrict_serial_collections_to_site_level

默认值：false

在 Tableau Server 中，您可以计划定期运行数据提取刷新、订阅或流程。这些计划项称为任务。后台程序进程启动这些任务的唯一实例，以在计划时间运行它们。作为结果启动的任务的唯一实例称为作业。

此设置会影响配置为串行运行的计划。默认情况下，当计划配置为串行运行时，使用该计划的所有作业都将串行运行。当此设置设为 true 时，在不同站点上运行的作业可以并行运行。同一站点上计划任务的作业将继续串行运行。

下面的示例说明了这种情况：

Tableau Server 包含一个名为“每日”的计划，用于每天早上 7 点运行作业。“每日”计划配置为串行运行。站点“HR”和站点“Payroll”各有多个使用计划“每日”的计划任务。当此设置设为 true 时，站点“HR”上这些计划任务的作业可以与站点“Payroll”上的作业并行运行，而同一站点上的作业仍然只会串行运行。

backgrounder.timeout.single_subscription_notify

版本：版本 2021.2 中新增。

默认值：1800 秒（30 分钟）

这是完成单个订阅作业的最长允许时间（以秒为单位）。

backgrounder.timeout.sync_ad_group

版本：版本 2021.1.23、2021.2.21、2021.3.20、2021.4.15、2022.1.11、2022.3.3、2023.1 新增。

默认值：14400 秒（4 小时）

这是完成 Active Directory 组同步的最长允许时间（以秒为单位）。这适用于由后台程序服务完成的计划组同步，并防止长时间运行的同步无限期运行。这不会影响使用 Tableau Server UI 或 REST API 完成的组同步。

backgrounder.vInstances_max_overflow_queue_size

版本：在版本 20221.2 中新增。

默认值：1000

可位于辅助队列中的最大作业数。当运行的作业数量达到设置的并发限制时，将创建辅助队列。默认最大值设置为 1000 个作业 - 这意味着如果在达到并发限制时有超过 1000 个作业，则任何超过 1000 个作业的作业都不会排队。使用 backgrounder.vInstance_max_overflow_queue_size tsm 命令更改溢出最大队列大小。

这些值应以整数形式指定。

backup.zstd.thread_count

版本：版本 2021.1.0 中新增。此键可动态配置。有关详细信息，请参见Tableau Server 动态拓扑更改

默认值：2

创建备份时应使用的线程数。

增加此数量可以提高备份性能，但我们建议线程数量不要超过 Tableau Server 计算机上的逻辑处理器数量，最多四个。

basefilepath.backuprestore

默认值：C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

tsm maintenance backup 命令在其中创建备份的位置。这也是使用 tsm maintenance restore 命令或 tsm maintenance send-logs 命令还原时备份文件时必须位于的位置。设置后，您应该运行 tsm maintenance validate-backup-basefilepath 命令（在 2022.1 及更高版本中可用）以验证是否为该位置正确设置了权限。有关详细信息，请参见tsm File Paths。

basefilepath.log_archive

默认值：C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

tsm maintenance ziplogs 命令在其中创建压缩存档的位置。有关详细信息，请参见tsm File Paths。

basefilepath.site_export.exports

默认值：C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteexports\

tsm sites export 命令在其中创建导出文件的位置。有关详细信息，请参见tsm File Paths。

basefilepath.site_import.exports

默认值：C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteimports\

tsm sites import 命令希望导入文件所在的位置。有关详细信息，请参见tsm File Paths。

clustercontroller.log.level

版本：版本 2020.3.0 中新增。

默认值：info

群集控制器的日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

databaseservice.max_database_deletes_per_run

版本：版本 2021.2 中新增。

默认值：null

使用此选项可调整每次后台程序处理时可删除的嵌入式外部资产（数据库和表）的最大数量，通过 features.DeleteOrphanedEmbeddedDatabaseAsset 控制。如果将此选项留空，则可删除的嵌入式外部资产的默认最大数量为 100。

有关详细信息，请参见features.DeleteOrphanedEmbeddedDatabaseAsset。

dataserver.log.level

版本：版本 2020.3.0 中新增。

默认值：info

数据服务器的日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

dataserver_<n>.port

数据服务器实例在其中运行的端口（通过“<n>”指定）。

excel.shadow_copy_all_remote.enabled

版本：2019.1.5、2019.2.1 版本中新增。

默认值：false

控制 Tableau Server 是否创建用作实时数据源的共享 Excel 电子表格spreadsheet（.xlxs 或 .xlxm）的“卷影副本”。如果启用，此选项将防止 Excel 用户查看“共享验证错误”和指明文件“当前已正使用”的消息。对于大型 Excel 文件，此选项可能会对性能产生影响。如果 Excel 用户不需要编辑共享文件，则无需启用此选项。

注意：Tableau Server 会始终尝试创建 .xls 文件的卷影副本。此选项不会更改该行为。

extractservice.command.execution.timeout

版本：版本 2021.4 中新增。

默认值：7200 秒

设置 VConn 数据提取刷新运行时间的超时值。

示例： tsm configuration set -k extractservice.command.execution.timeout -v <timeout_in_seconds> --force-keys

注意：您必须使用 --force-keys 选项来更改此值。

features.ActiveMQ

版本：版本 2021.4 中新增。

默认值：true

控制 Tableau Server 是否使用 Apache ActiveMQ 服务（Tableau Server 消息服务）作为内部消息机制。

features.DeleteOrphanedEmbeddedDatabaseAsset

版本：版本 2021.2 中新增。

默认值：true

控制 Tableau Catalog（或 Tableau 元数据 API）的后台程序进程，该进程删除不再与下游 Tableau 内容关联的嵌入式外部资产（数据库和表）。此进程每天在 22:00:00 UTC（协调世界时）运行，并且每天最多可以删除 100 个外部资产，直到没有与下游 Tableau 内容没有连接的剩余外部资产。您可以将此选项设置为 false 来阻止此进程运行。或者，您还可以使用 databaseservice.max_database_deletes_per_run 调整可以删除的外部嵌入式资产的最大数量。

有关详细信息，请参见缺少内容疑难解答。

features.IdentityMigrationBackgroundJob

版本：版本 2022.1 中新增。在版本 2021.4.22、2022.1.18、2022.3.10、2023.1.6 和 2023.3 中，默认值更改为 false。

默认值：false

控制执行身份迁移的过程。当设置为 true 时，将 Tableau Server 升级到版本 2022.1（或更高版本）并还原 Tableau Server 版本 2021.4（或更低版本）的备份后，身份迁移会立即在现有部署中运行。设置为 false（默认值）以禁用身份迁移。

例如，若要启动身份迁移，请运行以下命令：

tsm configuration set -k features.IdentityMigrationBackgroundJob -v true

有关详细信息，请参见关于身份迁移。

注意：如果禁用身份迁移，Tableau Server 将无法使用身份服务来存储和管理用户身份信息。使用身份服务是某些功能（例如身份池）的先决条件。

features.IdentityPools

版本：版本 2023.1 中新增。

默认值：false

如果执行新的 Tableau Server 安装，需要启用身份池功能的组件。需要 feature.NewIdentityMode 和 wgserver.authentication.legacy_identity_mode.enabled。设置为 true 以启用身份池。设置为 false（默认值）以禁用身份池。

例如，若要启动身份池，请运行以下命令：

tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply

有关详细信息，请参见身份池故障排查。

features.MessageBusEnabled

版本：版本 2019.4 中新增。

默认值：true

控制 Tableau Server 是否使用新的内部消息机制。

features.NewIdentityMode

版本：版本 2022.1 中新增。

默认值：false。在 2023.1.6 中，默认值已从 true 更改为 false。

身份池功能的先决条件。需要将 wgserver.authentication.legacy_identity_mode.enabled 设置为 false 以启用身份池。设置为 true 以禁用身份池。

tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply

有关详细信息，请参见身份池故障排查。

features.PasswordlessBootstrapInit

默认值：true

控制 Tableau Server 是否允许引导文件中的嵌入式凭据。如果启用（默认值），引导文件中将包括嵌入式凭据，除非您指定不应包括它们。如果决不应在生成的任何引导程序文件中包括凭据，请将此选项设置为 false。有关生成引导程序文件的详细信息，请参见tsm topology nodes get-bootstrap-file。

此选项是从以下 Tableau Server 版本 2019.3 开始添加的。

features.PasswordReset

版本：在版本 2024.2 中已停用。对于版本 2024.2 及更高版本，使用 vizportal.password_reset。

默认值：false

仅适用于使用本地身份验证的服务器。设置为 true 可让用户在登录页面上使用“忘记密码”选项重置密码。

filestore.empty_folders_reaper.enabled

版本：2020.x（2020.1.14、2020.2.11、2020.3.6、2020.4.2）和 2021.1.x 中新增。在 2021.2 中，默认值已更改为 true。

默认值：true

启用“去除”（移除）空 Filestore 文件夹的作业。

filestore_empty_folders_reap.frequency_s

版本：2020.x（2020.1.14、2020.2.11、2020.3.6、2020.4.2）中新增。

默认值：86400（24 小时）

以分钟为单位指定运行移除空 Filestore 文件夹的作业的频率。

features.Hyper_DisallowTDEPublishing

版本：从版本 2023.1.0 开始，默认为 true 。在 Tableau Server 2024.2 中已弃用。

默认值：true

指定用户是否可以上载 .tde 格式文件。从 Tableau Server 10.5 版本开始，此格式已被 .hyper 格式取代，但未阻止上载。从版本 2024.3 开始，.tde 格式文件不再可用。如果执行了多个操作之一，文件将自动转换为 .hyper 格式。有关详细信息，请参见数据提取升级为 .hyper 格式。

filestore.log.level

版本：版本 2020.3.0 中新增。

默认值：info

文件存储的日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

filestore.reapemptyfoldersholdoffms

版本：2020.x（2020.1.14、2020.2.11、2020.3.6、2020.4.2）中新增。此选项在 2021.1 中尚不可用。

默认值：300000 （5 分钟）

以毫秒为单位指定移除空 Filestore 文件夹之前等待的时间。

floweditor.max_datafile_upload_size_in_kb

版本：版本 2020.4 中新增

默认值：1048576

对于 Tableau Prep 流程 Web 制作，可以上载到 Tableau Server 的定界文本文件（例如 CSV 或 TXT）的最大大小。

gateway.external_url

版本：版本 2023.1 中新增

默认值：Null

在 Tableau Server 设置期间或使用身份池在 TSM 中配置 OpenID Connect (OIDC) 身份验证时需要。指定身份提供程序 (IdP) 使用的 Tableau Server URL，以将进行身份验证的用户重定向到 Tableau。网关外部 URL 与您用 IdP 指定为重定向 URL 的 URL 相同，用于匹配目的。

例如，若要将与 OIDC 身份验证配置关联的 IdP 重定向到您的 Tableau Server，即 http://myco，请运行以下命令：

tsm configuration set -k gateway.external_url -v http://myco

gateway.http.hsts

默认值：false

HTTP 严格传输安全性 (HSTS) 头强制浏览器在启用它的域上使用 HTTPS。

gateway.httpd.loglevel

版本：2021.3.0 中新增。

默认值：notice

指定网关（Apache HTTPD 服务器）的日志记录级别。默认情况下这设置为 notice。其他选项包括 debug、info、 warning、error。如果更改日志记录级别，请注意对磁盘空间使用和性能的潜在影响。作为最佳实践，在收集到所需信息后，将日志记录级别恢复为默认值。有关 Apache 日志记录的详细信息，请参见 Apache HTTP 文档(链接在新窗口中打开)。

gateway.httpd.shmcb.size

版本：2021.4 中新增

默认值：2048000

使用 shmcb存储类型时，指定循环缓冲区的内存量（以字节为单位）。使用 dbm 存储类型时，此配置键不适用。

gateway.httpd.socache

版本：2021.4 中新增

默认值：shmcb

指定全局/进程间 SSL 会话缓存的存储类型。默认情况下，此项设置为 shmcb，带有另一个可配置的选项 dbm。有关shmcb 和 dbm 存储类型的详细信息，请参见 Apache 网站上的 SSLSessionCache 指令(链接在新窗口中打开)。

gateway.log.level

版本：版本 2020.3.0 中新增。

默认值：info

网关的日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

hyper.log_queries

默认值：true

设置为 true 时，将记录查询信息。

默认情况下会记录查询信息。但如果您发现日志文件对于可用磁盘空间量而言太大，您可以将其设置为 false 来禁用查询信息日志记录。Tableau 建议将此配置保持设置为 true。

hyper.session_memory_limit

默认值：0（表示无限制）

控制单个查询可以具有的最大内存消耗。指定字节数。将字母“k”附加到值以指明千字节，附加“m”以指明兆字节，附加“g”以指明千兆字节，附加“t”以指明太字节。

例如，若要将内存限制设置为 900 MB，请运行以下命令：

tsm configuration set -k hyper.session_memory_limit -v 900m。

或者，若将会话内存限制指定为可用系统总内存的百分比，请运行以下命令：

tsm configuration set -k hyper.session_memory_limit -v 90%。

当查询使用过多的内存并使其他查询长时间失败时，降低此值可能会有所帮助。通过降低限制，单个大型查询将失败（或采用假脱机，如果假脱机未关闭），并且对其他查询没有负面影响。

hyper.srm_cpu_limit_percentage

默认值（以百分比为单位）：75

指定 Hyper 允许的最大每小时平均 CPU 使用率。如果超出，数据引擎将自行重启以尽量减少对计算机上其他进程的影响。

默认情况下，如果 CPU 在一小时内的平均使用率超过 75%，数据引擎将自行重启。除非与 Tableau 支持合作，或者如果您在专用服务器节点上运行数据引擎，否则不应更改此值。如果数据引擎在专用节点上运行，您可以安全地将此值增加到 95% 以充分利用可用的计算机硬件。有关在专用节点上运行数据引擎的详细信息，请参见针对数据提取查询密集型环境进行优化。

将此值增加到 95%：

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 95 --force-keys

tsm pending-changes apply

将其重置为默认值 75%：

tsm configuration set -k hyper.srm_cpu_limit_percentage -v 75 --force-keys

tsm pending-changes apply

hyper_standalone.consistent_hashing.enabled

默认值：true

提高了查询的数据提取已被缓存的可能性。如果缓存了数据提取的节点不支持额外的负载，则会将您路由到新节点，并且数据提取将加载到新节点上的缓存中。这可以改善系统利用率，因为只有在负载证明需要时，才会将数据提取加载到内存中。

indexandsearchserver.vmopts

版本：版本 2022.1 中新增。

默认值：“-Xmx<default_value> -Xms<default_value>”

默认值基于系统内存量，为系统总 RAM 的 3.125%。

控制索引和搜索服务器堆大小。由于默认值会自动缩放，因此仅在绝对必要时才使用此选项覆盖默认值。将字母“k”附加到值以指明千字节，附加“m”以指明兆字节，附加“g”以指明千兆字节。一般情况下，将初始堆大小 (-Xms) 设置为等于最大堆大小 (-Xmx)，以最大限度地减少垃圾回收。

jmx.security.enabled

版本：版本 :2022.1 中新增。

默认值：false

JMX 默认情况下已禁用，因此也禁用了安全 JMX。如果您要启用 JMX，我们强烈建议您启用安全 JMX。

此项设置为 true，并在您运行 tsm maintenance jmx enable命令，且在系统提示为 JMX 启用安全功能时回答 y 时，使用 SSL 和基本用户名/密码身份验证启用安全 JMX：

tsm maintenance jmx enable
We do not recommend you enable JMX unsecured on a production environment. Would you like to enable security features for JMX?
(y/n): y

jmx.ssl.enabled

版本：版本 :2022.1 中新增。

默认值：true

为 JMX 强制使用 SSL。此选项默认为 true，但除非 jmx.security.enabled 也设置为 true，否则不起作用。若要启用 JMX 安全性，请运行 tsm maintenance jmx enable 命令。当系统提示启用 SSL 时，回答 y，或回答 n 禁用 SSL：

tsm maintenance jmx enable
...
Would you like to enable SSL?
(y/n): n

jmx.ssl.require_client_auth

版本：版本 :2022.1 中新增。

默认值：false

当您运行 tsm maintenance jmx enable 命令，且在系统提示需要客户端身份验证 (mTLS) 时回答 y 时，此项设置为 true：

tsm maintenance jmx enable
...
Would you like to require client authentication (mTLS)?
(y/n): y

为了完成配置，您必须拥有客户端证书并将其放置在客户端计算机上的正确位置：

jmx.ssl.user.name

版本：版本 :2022.1 中新增。

默认值：tsmjmxuser

在安装或升级 Tableau Server 时设置此项。

jmx.ssl.user.password

版本：版本 :2022.1 中新增。

默认值：<generated>

在安装或升级 Tableau Server 时设置此项。

jmx.user.access

版本：版本 :2022.1 中新增。

默认值：readonly

当您运行 tsm maintenance jmx enable 命令，且在系统提示添加 readwrite 访问权限时回答 y，您可以将此项更改为 readwrite：

tsm maintenance jmx enable
...
JMX access is readonly by default. Would you like to add readwrite access?
(y/n): y

licensing.login_based_license_management.default_requested_duration_seconds

默认值：0

设置为在提示用户再次激活之前，用户基于登录名的许可证可在不连接到 Tableau Server 的情况下处于脱机状态持续时间（以秒为单位）。在 Tableau Desktop 在使用中并可连接到 Tableau Server 时，此持续时间始终会刷新。

licensing.login_based_license_management.enabled

默认值：true

设置为 true 以启用 基于登录名的许可证管理。设置为 false 以禁用 基于登录名的许可证管理。

注意：为了使用 基于登录名的许可证管理，您必须激活为 基于登录名的许可证管理 启用的产品密钥。您可以使用 tsm licenses list 查看哪些产品密钥已启用 基于登录名的许可证管理。

licensing.login_based_license_management.max_requested_duration_seconds

默认值：7776000

设置为在提示用户再次激活 Tableau 之前，用户基于登录名的许可证可在不连接到 Tableau Server 的情况下处于脱机状态最长持续时间（以秒为单位）。最大值为 7776000 秒（90 天）。在 Tableau Desktop 在使用中并可连接到 Tableau Server 时，此持续时间始终会刷新。

metadata.ingestor.blocklist

默认值：null

配置后，Tableau Catalog 会阻止摄取指定的内容。若要指定要阻止的内容，必须从服务器“非交互式”日志文件中标识阻止列表值，该值是要阻止的内容的站点 ID、内容类型和内容 ID 的组合。阻止列表值必须用逗号分隔。

重要信息：您仅在 Tableau 支持人员指示时才应使用此选项。

例如，可以使用 tsm configuration set --force-keys -k metadata.ingestor.blocklist，通过以下命令来阻止摄取数据源、工作簿和流程的组合：

tsm configuration set --force-keys -k metadata.ingestor.blocklist -v "sites/1/datasources/289, sites/2/datasources/111, sites/1/workbooks/32, sites/3/workbooks/15, sites/1/flows/13, sites/1/flows/18”

若要验证阻止的内容，请查看服务器“非交互式”日志文件来查找以下事件：

• Skipping ingestion for
• Successfully updated blocklist to

例如：

Skipping ingestion for contentType [Workbook], contentId [sites/1/datasources/289], siteDisabled [false], swallowEvent [false], contentBlocked [true]

Skipping ingestion for contentType [Workbook], contentId [sites/3/workbooks/15], siteDisabled [false], swallowEvent [false], contentBlocked [true]

和

Successfully updated blocklist to: [sites/1/datasources/289, sites/1/workbooks/32, sites/2/datasources/111]

metadata.ingestor.pipeline.throttleEventsEnable

默认值：false

控制新内容和更新内容（也称为事件）的索引是否在服务器上的所有站点中进行监管。默认情况下，事件限制已关闭。若要开启事件限制，请使用以下命令将此设置更改为 true： 

tsm configuration set -k metadata.ingestor.pipeline.throttleEventsEnable -v true --force-keys

有关事件限制的详细信息，请参见启用 Tableau Catalog。

metadata.ingestor.pipeline.throttleLimit

默认值：20

启用事件限制时，这是可以在指定时间段内编制索引的新内容和更新内容项的最大数量。达到特定项的指定限制后，将推迟对编制索引。

默认情况下，限制设置为 20 ，不能设置为低于 2。可以使用以下命令更改限制： 

tsm configuration set -k metadata.ingestor.pipeline.throttleLimit -v 25 --force-keys

在服务器“非交互式”日志文件中，可以将受限制事件标识为 ingestor event flagged for removal by throttle filter。

metadata.ingestor.pipeline.throttlePeriodLength

默认值：20

启用事件限制时，这是可以对指定最大数量的新内容项和更新内容项编制索引的时间段（以分钟为单位）。达到指定时间后，将推迟对任何其他新内容和更新内容编制索引。

默认情况下，时间设置为 30 分钟。您可以使用以下命令更改时间：

tsm configuration set -k metadata.ingestor.pipeline.throttlePeriodLength -v PT45M --force-keys

metadata.query.limits.time

默认值：20

这是 Catalog 或元数据 API 查询在发生超时和取消查询之前运行的最长允许时间（以秒为单位）。Tableau 建议使用以下命令逐步将超时限制增加到不超过 60 秒：

tsm configuration set -k metadata.query.limits.time –v PT30S --force-keys

重要信息：仅当看到此处描述的错误超时限制和超过节点限制消息时，才应更改此选项。增加超时限制可以延长使用更多 CPU 的时间，这可能会影响整个 Tableau Server 的任务性能。增加超时限制还可能导致更高的内存使用率，从而可能导致在查询并行运行时交互式微服务容器出现问题。

metadata.query.limits.count

默认值：20000

这是 Catalog 在超出节点限制和取消查询之前可以返回的对象数（可以松散地映射到查询结果数）。Tableau 建议使用以下命令逐步将超时限制增加到不超过 100000：

tsm configuration set -k metadata.query.limits.count –v 3000 --force-keys

重要信息：仅当看到此处描述的错误超时限制和超过节点限制消息时，才应更改此选项。增加节点限制可能导致更高的内存使用率，从而可能导致在查询并行运行时交互式微服务容器出现问题。

metadata.query.throttling.enabled

版本：版本 2023.3 中新增

默认值：true

控制是否启用元数据 API(链接在新窗口中打开) 查询限制。元数据 API 查询限制是一项旨在防止服务器的 API 响应对整体性能产生负面影响的功能。当设置为 true（默认值）时，如果对元数据 API 的请求超过定义的阈值，将返回 RATE_EXCEEDED 错误。

如果元数据 API 用户经常看到 RATE_EXCEEDED 错误，管理员可以尝试使用 metadata.query.throttling.tokenRefilledPerSecond 和 metadata.query.throttling.queryCostCapacity 设置调整限制。或者，管理员可以通过将 metadata.query.throttling.enabled 值设置为 false 来完全禁用限制。然而，这样做会妨碍该功能的性能保护优势。

metadata.query.throttling.queryCostCapacity

版本：版本 2023.3 中新增

默认值：20000000

代表元数据 API(链接在新窗口中打开) 回答查询的能力的一个数字。对元数据 API 的每个请求都有一个计算成本，在执行时会从此数字中减去该成本。（使用令牌存储桶模型，这是存储桶中可以容纳的最大令牌数量。）

如果元数据 API 用户经常看到 RATE_EXCEEDED 错误，管理员可以调整限制设置。他们应该调整 metadata.query.throttling.tokenRefilledPerSecond，并在尝试调整 metadata.query.throttling.queryCostCapacity 之前测试结果。或者，管理员可以通过将 metadata.query.throttling.enabled 设置为 false 来完全禁用限制。然而，这样做会妨碍该功能的性能保护优势。

metadata.query.throttling.tokenRefilledPerSecond

版本：版本 2023.3 中新增

默认值：5555

表示每秒重新生成的元数据 API(链接在新窗口中打开) 查询容量的数字。（使用令牌存储桶模型，这是每秒放入存储桶中的令牌数量。）

如果元数据 API 用户经常看到 RATE_EXCEEDED 错误，管理员可以调整限制设置。他们应该调整 metadata.query.throttling.tokenRefilledPerSecond，并在尝试调整 metadata.query.throttling.queryCostCapacity 之前测试结果。或者，管理员可以通过将 metadata.query.throttling.enabled 设置为 false 来完全禁用限制。然而，这样做会妨碍该功能的性能保护优势。

native_api.allowed_paths

默认值：""

注意：在 2023 年 10 月之前的 Tableau Server 版本（包括维护版本）中，此设置默认配置为允许访问所有路径。

使用此设置可以指定访问存储在 Tableau 或远程共享上的文件的允许列表。此情况允许授权的 Tableau Server 用户生成工作簿，这些工作簿使用服务器上的文件作为基于文件的数据源（如电子表格）。

此设置允许您仅限制对您指定的那些目录的访问。因此，运行身份服务帐户访问权限仅限于托管数据文件的目录路径。

重要信息：请确保您在此设置中指定的文件路径存在，并且可由系统帐户访问。

native_api.ExplainDataEnabled

默认值：true

此选项控制是为服务器启用还是禁用“数据解释”功能。有关“数据解释”功能的详细信息，请参见 Tableau 帮助中的“数据解释”功能入门(链接在新窗口中打开)。

此选项是从 Tableau Server 版本 2019.3 开始添加的。

nlp.concepts_shards_count

默认值：1

注意：对于大多数 Tableau Server 安装，默认分片计数值已经足够。

在以下各项中，控制“数据问答”(Ask Data) 功能，字段名称、字段同义词的概念索引的数据分片，以及分片中存储的分析词：

• 适用于 2022.1 及更高版本的索引和搜索服务器。
• 适用于 2019.1 - 2021 的弹性服务器。4

分片计数对搜索索引进行分区，以减少总索引大小，这可能会提高“数据问答”（Ask Data）功能的语义解析器的性能。调整分片计数是您可以随通过 elasticserver.vmopts 或 indexandsearchserver.vmopts 增加堆大小而采取的另一种性能增强措施，具体取决于您运行的 Tableau Server 的版本。

Tableau 建议每 50 GB 将分片计数增加 1。若要减少调整分片计数的次数，请通过向当前索引添加 50% 来计算总索引大小。举例来说，如果总索引大小小于 50 GB，则 1 个分片就足够了。实际性能将因服务器、索引大小增长速率以及其他因素而异。

• 0 到 50 GB：1
• 50 GB 到 100 GB：2
• 100 GB 到 150 GB：3

可以使用以下命令将概念索引分片大小从默认值增加到 2：

tsm configuration set -k nlp.concepts_shards_count -v 2

nlp.values_shards_count

默认值：1

在以下各项中，控制“数据问答”(Ask Data) 功能，字段名称、字段同义词的概念索引的数据分片，以及分片中存储的分析词：

• 适用于 2022.1 及更高版本的索引和搜索服务器。
• 适用于 2019.1 - 2021 的弹性服务器。4

分片计数对搜索索引进行分区，以减少总索引大小，这可能会提高“数据问答”（Ask Data）功能的语义解析器的性能。调整分片计数是您可以随通过 elasticserver.vmopts 或 indexandsearchserver.vmopts 增加堆大小而采取的另一种性能增强措施，具体取决于您运行的 Tableau Server 的版本。

Tableau 建议每 50 GB 将分片计数增加 1。若要减少调整分片计数的次数，请通过向当前索引添加 50% 来计算总索引大小。举例来说，如果总索引大小小于 50 GB，则 1 个分片就足够了。实际性能将因服务器、索引大小增长速率以及其他因素而异。

• 0 到 50 GB：1
• 50 GB 到 100 GB：2
• 100 GB 到 150 GB：3

可以使用以下命令将值索引分片计数从默认值增加到 2：

tsm configuration set -k nlp.values_shards_count -v 2

nlp.defaultNewSiteAskDataMode

默认值：disabled_by_default

使用此选项在创建站点时设置“数据问答模式”的初始值。有关详细信息，请参见为站点禁用或启用“数据问答”(Ask Data) 功能。

有效的选项为 disabled_by_default 和 disabled_always。

此选项是从以下 Tableau Server 版本开始添加的：2019.4.5、2020.1.3。

noninteractive.vmopts

pgsql.port

默认值：8060

PostgreSQL 所侦听的端口。

pgsql.preferred_host

指定安装了首选存储库的节点的计算机名称。如果随 tsm topology failover-repository 命令一起指定了 --preferred 或 -r 选项，则使用此值。

示例：

pgsql.ssl.ciphersuite

默认值：HIGH:MEDIUM:!aNULL:!MD5:!RC4

为存储库指定 SSL 允许的密码算法。1

有关可接受的值和格式要求，请参见 Postgres 网站上的 ssl_ciphers(链接在新窗口中打开)。

pgsql.ssl.max_protocol_version

默认值：TLSv1.3

设置通过 SSL 连接到存储库时要使用的最大 SSL/TLS 协议版本。

有效值：TLSv1、TLSv1.1、TLSv1.2、TLSv1.3

pgsql.ssl.min_protocol_version

默认值：TLSv1.2

设置通过 SSL 连接到存储库时要使用的最小 SSL/TLS 协议版本。

有效值：TLSv1、TLSv1.1、TLSv1.2、TLSv1.3

pgsql.verify_restore.port

默认值：8061

用于验证 PostgreSQL 数据库完整性的端口。有关详细信息，请参见tsm maintenance backup。

ports.blocklist

版本：版本 2021.1 中新增

默认值：在用于自动端口分配的范围内没有阻止端口。

用于指定端口分配范围内的端口，在动态分配端口时不应由 Tableau 使用。当您知道另一个应用程序正在使用范围内的端口时，这非常有用。使用逗号分隔多个端口，例如：

tsm configuration set -k ports.blocklist -v 8000,8089, 8090

有关使用 ports.blocklist 键的详细信息，请参见阻止范围内的特定端口

recommendations.enabled

默认值：true

控制建议功能，该功能为数据源和表（针对 Tableau Desktop）的建议以及视图的建议（针对 Tableau Server）提供支持。建议基于内容的受欢迎程度，以及确定为与当前用户相似的其他用户使用的内容。

searchserver.connection_timeout_milliseconds

版本：版本 2019.1 中新增。在版本 2022.3 中已弃用。在版本 2023.3 中已停用。

默认值（以毫秒为单位）：100000

指定“搜索和浏览”客户端等待建立与“搜索和浏览”服务器的连接的时间（以毫秒为单位）。

在特别繁忙的 Tableau Server 计算机上，或者如果您看到日志错误“Failed zookeeper health check.Refusing to start SOLR.” （zookeeper 运行状况检查失败。拒绝启动 SOLR。），请增大此值。

有关详细信息，请参见客户端会话超时。

searchserver.index.bulk_query_user_groups

版本：在版本 2022.3 中已停用。

默认值：true

指定在使用 CSV 文件导入或删除用户时是否批量查询站点用户。如果设置为 true（默认值），则会以批量方式完成索引操作。

searchserver.javamemopts

版本：版本 2019.1 中新增。在 2023.3 中已停用

默认值：-Xmx512m -Xms512m -XX:+ExitOnOutOfMemoryError -XX:-UsePerfData

确定 SOLR 的 JVM 选项。

在所有可配置选项中，由 -Xmx 参数配置的最大堆内存是调整搜索服务器时最重要的。在大多数情况下，应根据 Tableau Server 计算机上的可用物理内存尽可能高设置此值，最高为 24 GB。若要仅更改最大堆内存，请指定整个默认字符串，但仅更改 -Xmx 的值。

-Xmx 的有效值取决于 Tableau Server 计算机上的可用内存，但不能大于 24 GB。有关详细信息，请参见“搜索和浏览”最大堆内存。

searchserver.startup.zookeeper_healthcheck_timeout_ms

版本：版本 2020.1 中新增。在版本 2023.3 中已停用。

默认值（以毫秒为单位）：300000

指定 Tableau Server 在启动时应等待成功的 Zookeeper 运行状况检查的时间（以毫秒为单位）。

在特别繁忙的 Tableau Server 计算机上，或者如果您看到日志错误“Failed zookeeper health check.Refusing to start SOLR.” （zookeeper 运行状况检查失败。拒绝启动 SOLR。），请增大此值。

有关详细信息，请参见Zookeeper 连接运行状况检查在启动时超时。

searchserver.zookeeper_session_timeout_milliseconds

版本：在版本 2022.3 中已停用。

默认值（以毫秒为单位）：100000

指定“搜索和浏览”客户端等待建立与协调服务 (Zookeeper) 的连接的时间（以毫秒为单位）。

有关详细信息，请参见客户端会话超时。

ServerExportCSVMaxRowsByCols

版本：版本 2020.3 中新增。

默认值：0（无限制）

指定可以从“视图数据”下载到 CSV 文件中的最大数据单元格数。默认情况下，没有限制。指定单元格数。例如，设置 300 万的限制： 

tsm configuration set -k ServerExportCSVMaxRowsByCols -v 3000000 

tsm pending-changes apply

ssl.ciphersuite

默认值：HIGH:MEDIUM:!EXP:!aNULL:!MD5:!RC4:!3DES:!CAMELLIA:!IDEA:!SEED

为网关指定 SSL 允许的密码算法。

有关可接受的值和格式要求，请参见 Apache 网站上的 SSLCipherSuite(链接在新窗口中打开)。

ssl.client_certificate_login.blocklisted_signature_algorithms

默认值：

• 版本 2020.4.0： 

  sha1withrsaencryption,
sha1withrsa

• 版本 2020.4.1 及更高版本：

  sha1withrsaencryption,
sha1withrsa,
sha1withrsaandmgf1,
sha1withdsa,
sha1withecdsa

默认值会阻止使用 SHA-1 签名算法的证书。指定为 SSL 阻止的客户端签名算法。若要禁止阻止所有签名算法，请使用一组空引号运行此键。

有关此键的详细信息，请参见知识库文章如果证书使用 SHA-1 签名，则升级后相互 SSL 失败(链接在新窗口中打开)。

ssl.client_certificate_login.min_allowed.elliptic_curve_size

默认值：256

指定通过相互 SSL 向 Tableau Server 进行身份验证的 ECDSA 客户端证书所需的最小椭圆曲线大小。如果客户端提供的 ECDSA 客户端证书不满足此最小曲线大小，则身份验证请求将失败。

此选项是 Tableau Server 版本 2021.1 中引入的。

ssl.client_certificate_login.min_allowed.rsa_key_size

默认值：2048

指定通过相互 SSL 向 Tableau Server 进行身份验证的 RSA 客户端证书的最小密钥大小。如果客户端提供的 RSA 客户端证书不满足此最小密钥大小，则身份验证请求将失败。

此选项是 Tableau Server 版本 2021.1 中引入的。

ssl.protocols

默认值：all +TLSv1.2 -SSLv2 -SSLv3 -TLSv1.3

为网关指定 Tableau Server 支持用于 TLS 连接的 SSL 协议。可接受的值来自 Apache SSLProtocol Directive(链接在新窗口中打开)。我们建议遵循安全强化检查表中所述的 SSL 协议配置。

storage.monitoring.email_enabled

默认值：false

控制是否为服务器磁盘空间监视启用电子邮件通知。默认情况下，电子邮件通知处于启用状态。若要为磁盘空间监视启用通知，请将此选项设置为 true。

必须配置 SMTP 才能发送通知。有关详细信息，请参见配置 SMTP 设置。

storage.monitoring.warning_percent

默认值：20

剩余磁盘空间的警告阈值，以占总磁盘空间的百分比形式表示。如果磁盘空间低于此阈值，则发送警告通知。

storage.monitoring.critical_percent

默认值：10

剩余磁盘空间的严重阈值，以占总磁盘空间的百分比形式表示。如果磁盘空间低于此阈值，则会发送一个严重通知。

storage.monitoring.email_interval_min

默认值：60

在启用磁盘空间监视且超出阈值时发送电子邮件通知的频率（以分钟为单位）。

storage.monitoring.record_history_enabled

默认值：true

确定是否保存可用磁盘空间历史记录，并可在管理视图中查看。若要为监视禁用历史记录存储，请将 storage.monitoring.record_history_enabled 设置为 false。

svcmonitor.notification.smtp.enabled

默认值：false

控制是否为服务器进程事件启用电子邮件通知。默认情况下，会在进程关闭、进行故障切换或重新启动发送通知。若要启用服务器进程通知，请将此选项设置为 true。

必须配置 SMTP 才能发送通知。有关详细信息，请参见配置 SMTP 设置。

svcmonitor.notification.smtp.mime_use_multipart_mixed

版本：版本 2020.1.8、2020.2.5、2020.3.1 中机关干部

Default value: false

控制是以 multipart/related （默认值）还是 multipart/mixe1d 形式发送订阅 HTML MIME 附件。

在极少数情况下，电子邮件客户端可能无法正确解析 Tableau Server 发送的电子邮件。很多时候，可以通过将此属性设置为 true 来解决此问题。已知的客户端包括 iOS Mail 和 Microsoft Outlook（与 Exchange S/MIME 加密配对时）。

tabadmincontroller.auth.expiration.minutes

默认值：120

控制会话 Cookie 的有效时间。默认情况下，此选项设置为 120 分钟。此值还确定节点引导程序文件中嵌入式凭据的有效时间。有关详细信息，请参见tsm topology nodes get-bootstrap-file。

tdsservice.log.level

版本：版本 2020.3.0 中新增

默认值：info

数据源属性服务的日志记录级别。此设置是动态配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

tomcat.useSystemProxies

默认值：false

指定 tomcat 组件 (OpenID) 是否需要访问本地 Windows 操作系统上的转发代理配置。请参见针对 OpenID Connect 配置 Tableau Server。

tomcatcontainer.log.level

默认值：info

交互式微服务容器和非交互式微服务容器中的微服务的日志记录级别。此设置从版本 2020.4 开始是动态可配置的，因此，如果您只是更改此设置，则不必重新启动 Tableau Server。有关详细信息，请参见更改日志记录级别。

tsm.log.level

默认值：info

TSM 服务的日志记录级别。这些日志包括在 TSM 服务出现问题时可能非常有用的信息：管理代理、管理控制器、客户端文件服务、群集控制器、服务管理器和许可证服务。此配置键不会更改协调服务或维护进程的日志记录级别。有关详细信息，请参见更改日志记录级别和Tableau Server 进程。

tsm.controlapp.log.level

默认值：info

control_<app> 服务的日志记录级别。这些日志包含在启动或重新配置 TSM 或 Tableau Server 进程时遇到问题的情况下可能非常有用的信息。有关详细信息，请参见更改日志记录级别。

usernotifications.reap_after_days

默认值：30

用户通知将在多少天后从服务器中删除。

vizportal.adsync.update_system_user

默认值：false

指定在 Tableau Server 中同步 Active Directory 组时用户的电子邮件地址和显示名称是否更改（即使在 Active Directory 中更改）。为了确保用户电子邮件地址和显示名称在同步过程中更新，请将 vizportal.adsync.update_system_user 设置为 true，然后重新启动服务器。

vizportal.alwaysUseEmbeddedShareLinks

版本：版本 2021.3.0 中新增

默认值：false

指定“复制链接”选项是否应包含“embed=y”参数。从版本 2019.4 开始，默认情况下不包含此参数。将此配置键设置为 true 会更改行为，以便包含“embed=y”参数。有关使用“复制链接”选项共享链接以嵌入网页的详细信息，请参见 Tableau Desktop 和 Web 制作帮助中的将视图嵌入网页(链接在新窗口中打开)。

vizportal.art_skip_list

版本：版本 2024.2 中新增。

默认值：null

使用此配置键指定 Tableau Server 功能的某些方面，这些功能不使用活动和资源跟踪 (ART)，并且在启用 ART 时会生成大量不必要的数据。

此键与vizportal.log_art_java 和 vizportal.enable_art 一起使用，用于排查应用程序服务器 (VizPortal) 的问题。当设置为 [此处需要有关其设置的信息。]若要了解如何使用此配置设置，请参见排查应用程序服务器的问题。

vizportal.csv_user_mgmt.index_site_users

版本：在版本 2022.3 中已弃用。在版本 2023.3 中已停用（完全移除）。

默认值：true

指定在使用 CSV 文件导入或删除用户时是否逐个用户地完成站点用户索引。如果设置为 true（默认值），则会在添加或删除每个用户时完成索引。若要将站点用户的索引延迟到处理完整个 CSV 文件之后，请将此项设置为 false。

vizportal.csv_user_mgmt.bulk_index_users

版本：在版本 2022.3 中已弃用。在版本 2023.3 中已停用（完全移除）。

默认值：false

指定在使用 CSV 文件导入或删除用户时是否批量建立站点用户的索引。当设置为 false（默认值）时，索引操作是单独完成的。若要在处理完 CSV 文件后批量创建索引，请将此项设置为 true。

vizportal.enable_art

版本：版本 2024.2 中新增。

默认值：false

此配置键与 vizportal.log_art_java 和 vizportal.art_skip_list 一起使用，用于排查应用程序服务器 (VizPortal) 的问题。设置为 true 时，将启用应用程序服务器中的活动和资源跟踪。若要了解如何使用此配置设置，请参见排查应用程序服务器的问题。

vizportal.log_art_java

版本：版本 2024.2 中新增。

默认值：false

此配置键与 vizportal.enable_art 和 vizportal.art_skip_list 一起使用，用于排查应用程序服务器 (VizPortal) 的问题。设置为 true 时，将启用应用程序服务器中的活动和资源跟踪。若要了解如何使用此配置设置，请参见排查应用程序服务器的问题。

vizportal.oauth.connected_apps.max_expiration_period_in_minutes

版本：版本 2021.4 中新增。

默认值：10

JSON Web 令牌 (JWT) 有效的最长时间段（以分钟为单位）。在验证 JWT 时，Tableau Server 会检查 JWT 中指定的时间段是否不超过此默认值。当使用 Tableau REST API(链接在新窗口中打开) 在 Tableau Server 上配置了 Tableau 已连接应用时，将使用此设置。

例如，若要将最长周期更改为 5 分钟，请运行以下命令：

tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5

vizportal.oauth.external_authorization.enabled

版本：版本 2021.4 中新增。

默认值：false

在 Tableau Server 2024.2 及更高版本中，已为 Tableau Server 启用“启用已连接应用”选项。在 Tableau Server 2023.2 及更低版本中，指定是否为 Tableau Server 启用“为嵌入内容启用 OAuth 访问权限”选项。

使用此选项向 Tableau Server 注册外部授权服务器 (EAS)，以便您可以启用应用程序集成。有关详细信息，请参见使用 OAuth 2.0 信任配置已连接应用。

若要启用此选项，请运行以下命令：

tsm configuration set -k vizportal.oauth.external_authorization.enabled -v true

vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms

版本：版本 2021.4 中新增。

默认值：ES256K

注册外部授权服务器 (EAS) 或配置已连接应用后，您可以使用此命令指定 JSON Web 令牌 (JWT) 标头中使用的签名算法。有关详细信息，请参见使用 OAuth 2.0 信任配置已连接应用或使用 Tableau 已连接应用进行应用程序集成。

例如，如果需要，您可以运行以下命令来移除算法：

tsm configuration set - k vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms -v

重要信息：上面的示例命令允许使用不安全的签名算法，并且只能用于解决错误。

vizportal.oauth.external_authorization_server.issuer

版本：版本 2021.4 中新增。

默认值：null

必需。使用此命令指定颁发者 URL。需要颁发者 URL 才能向 Tableau Server 注册外部授权服务器 (EAS)。有关详细信息，请参见使用 OAuth 2.0 信任配置已连接应用。

举例来说，如果您的 EAS 是 Okta，您可能会运行类似于以下内容的命令：

tsm configuration set -k vizportal.oauth.external_authorization_server.issuer -v "https://dev-12345678.okta.com/oauth2/abcdefg9abc8eFghi76j5"

vizportal.oauth.external_authorization_server.jwks

版本：版本 2021.4 中新增。

默认值：null

注册外部授权服务器 (EAS) 后，您可以使用此命令指定 JSON Web 密钥集 (JWKS) URL。如果身份提供程序 (IdP) 不公开外部授权服务器元数据端点，则需要 JWKS URL。

举例来说，如果您的 IdP 是 Amazon Cognito，您可能会运行类似于以下内容的命令：

tsm configuration set -k vizportal.oauth.external_authorization_server.jwks -v "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_Ab129faBb/.well-known/jwks.json"

vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes

版本：版本 2021.4 中新增。

默认值：10

JSON Web 令牌 (JWT) 有效的最长时间段（以分钟为单位）。在验证 JWT 时，Tableau Server 会检查 JWT 中指定的时间段是否不超过此默认值。当 EAS 已注册到 Tableau Server 时，将使用此设置。有关详细信息，请参见使用 OAuth 2.0 信任配置已连接应用。

例如，若要将最长周期更改为 5 分钟，请运行以下命令：

tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5

vizportal.openid.full_server_request_logging_enabled

默认值：false

指定是否对 OpenID 活动进行完整日志记录。

在对 OpenID Connect 问题进行故障排除时将此设置为 true ，以收集更详细的日志并让您更好地进行故障排除。

与所有日志记录相关配置一样，我们建议您在完成故障排除和收集日志后，将此键重置为默认值 (false)。这限制了记录的信息量，并将日志文件的大小保持在最低限度。

vizportal.password_reset

版本：在版本 2024.2 中替换 features.PasswordReset。

默认值：false

仅适用于使用本地身份验证的服务器。设置为 true 可让用户在登录页面上使用“忘记密码”选项重置密码。

vizportal.rest_api.cors.enabled

默认值：false

控制 Tableau Server 是否允许进行跨源资源共享 (CORS)。设置为 true 时，服务器允许 Web 浏览器访问 Tableau REST API 端点。您可以使用此选项和 REST API 创建自定义门户。默认情况下，此功能未启用。若要指定具有访问权限的源（站点），请使用 vizportal.rest_api.cors.allow_origin 选项。只允许使用此选项指定的源向 Tableau Server REST API 发出请求。有关详细信息，请参见在 Tableau Server 上启用 CORS。

vizportal.site_user_group_count_enabled

版本：2022.3.5 及更高版本、2023.1.0 及更高版本中新增。

默认值：false

控制“站点用户”页面是否包含显示每个用户的组计数的列。

vizqlserver.force_maps_to_offline

版本：版本 2020.4.0 中新增。

默认值：false

确定 Tableau Server 是否以脱机模式运行地图。这在断开连接的环境中很有用，在这种环境中对 Internet 和地图服务器的访问受到限制。若要为地图启用脱机模式，请将此值设置为 true。有关在无法访问 Internet 的环境中安装和配置 Tableau Server 的详细信息，请参见在断开连接（无网络连接）的环境中安装 Tableau Server。

wgserver.authentication.legacy_identity_mode.enabled

版本：版本 2022.1 中新增

默认值：对于 Tableau Server 2022.1 及更高版本为 false。对于升级到 2022.1 或更高版本的 2022.1 之前的 Tableau Server 部署，默认值为 true。

设置为 false 以使用身份池。

有关详细信息，请参见身份池故障排查。

wgserver.authentication.identity_pools.default_pool_description

版本：版本 2023.1 中新增

默认值：Null

或者，您可以将初始池（已配置 TSM）的描述添加到 Tableau Server 登陆页面，并且对所有用户可见。创建一个或多个身份池时，此描述将添加到主要登录选项下方，可用于帮助引导属于初始池（已配置 TSM）的用户使用正确的登录选项。

例如，若要添加“正式员工在这里登录”描述，可以使用以下命令：

tsm configuration set -k wgserver.authentication.identity_pools.default_pool_description -v “Regular employees sign in here"

注意：初始池（已配置 TSM）描述与 登录自定义项注释不同。“登录自定义”注释显示在所有登录选项下方的 Tableau Server 登陆页面上，以及您的初始池（已配置 TSM）用户输入其用户名和密码的页面上。

wgserver.domain.accept_list

版本：此键是版本 2020.4.0 中新增的，并替换 wgserver.domain.whitelist。

默认值：null

允许从 Tableau Server 连接到辅助 Active Directory 域。辅助域是 Tableau Server 连接到以进行用户同步的域，但也是未安装 Tableau Server 的域。Tableau Server 将尝试连接到辅助域以进行用户和组同步。在某些情况下，Tableau Server 可能无法连接到辅助域，这将导致错误“域不在接受列表中（错误代码 = 101015）”。

需要设置 wgserver.domain.accept_list 选项才能修复安全漏洞[重要] ADV-2020-003：Tableau Server 强制身份验证(链接在新窗口中打开)。自 2020 年 2 月起，此漏洞的修复程序包含在 Tableau Server 的所有最新版本和维护版本中。

若要设置此选项，请输入引在双引号中的辅助域。多个域必须用逗号和空格分隔。例如，tsm configuration set -k wgserver.domain.accept_list -v "example.org, domain.com"。

不支持通配符功能。举例来说，如果 Tableau 连接到 sub1.example.org 和 sub2.example.org，则必须添加这两个域。

更新 wgserver.domain.accept_list 选项将覆盖现有值。因此，如果要将新域添加到存储在值中的一组现有域，请在设置选项时将所有现有域与新域包含在一起。您可以通过运行 tsm configuration get –k wgserver.domain.accept_list 来检索现有域的完整列表。

wgserver.domain.allow_insecure_connection

默认值：False

此设置仅适用于 Windows。该选项指定 Tableau Server 是否将通过未加密的通道连接到 Active Directory。默认值 False 会强制使用加密通道。如果未加密 LDAP 通道，则 Tableau Server 将不会连接到 Active Directory。

您的 Active Directory 基础结构应管理证书并与加入域的计算机建立信任关系。因此，Tableau Server 和 Active Directory 资源之间的通道通信应进行加密。我们不建议允许与 Active Directory 进行未加密的通信，因为此配置容易受到中间人攻击。

如果要升级到 Tableau Server 2021.2 或更高版本，并且您的 LDAP 通道未加密，则升级将失败。升级之前，可以运行此命令以允许较旧版本的 Tableau Server 上的不安全连接。如果您在 2021.2 之前的版本上运行此命令，则必须随命令一起包括 --force-keys 选项。

wgserver.domain.fqdn

默认值：%USERDOMAIN% 的值

要使用的 Active Directory 服务器的完全限定域名。

wgserver.domain.password

默认值：null

指定用于 LDAP 连接的用户帐户的密码。请参见外部身份识存储配置参考。

wgserver.domain.username

默认值：null

指定用于 LDAP 连接的用户帐户的名称。请参见外部身份识存储配置参考。

wgserver.domain.whitelist

重要信息：此键自版本 2020.4.0 起已弃用。请改用 wgserver.domain.accept_list 。

默认值：null

允许从 Tableau Server 连接到辅助 Active Directory 域。辅助域是 Tableau Server 连接到以进行用户同步的域，但也是未安装 Tableau Server 的域。Tableau Server 将尝试连接到辅助域以进行用户和组同步。在某些情况下，Tableau Server 可能无法连接到辅助域，这将导致错误“域不在允许列表中（错误代码 = 101015）”。

wgserver.ignore_domain_in_username_for_matching

版本：版本 2021.4.21、2022.1.17、2022.3.9、2023.1.5 中新增

默认值：false

启用 SAML 后，您可以将 Tableau Server 配置为在将身份提供程序 (IdP) 用户名与 Tableau Server 上的用户帐户匹配时忽略 SAML 用户名属性的域部分。当您已在 Tableau Server 中定义了与用户名属性的前缀部分匹配但与用户名属性的域部分不匹配的用户时，您可能会忽略用户名属性的域部分。有关详细信息，请参见“SAML 要求”主题中的匹配 SAML 用户名属性时忽略域部分。

例如，若要忽略 SAML 用户名属性中的域名，请运行以下命令：

tsm configuration set -k wgserver.ignore_domain_in_username_for_matching -v true

重要信息：

• 在未采取预防措施的情况下，我们不建议忽略域名。具体来说，请验证用户名在您在 IdP 中创建的已配置域中是否唯一。
• 此命令仅适用于以下位置的 Tableau Server 部署：legacy-identity-mode 或尚未通过身份迁移(链接在新窗口中打开)更新以使用身份服务的部署。

wgserver.saml.blocklisted_digest_algorithms

版本：版本 2021.1 中新增。

默认值：SHA1

指定任何相关 SAML 证书签名或 SAML 断言摘要方法或签名方法所不允许的哈希算法。设置之后，用阻止列表算法签名的证书或断言将被拒绝失败。

在 Tableau 和 IdP 端都可以在多个位置使用 SHA-1。例如：

• 与 TSM 一起上载的证书，Tableau Server 使用这些证书对发送到 IdP 的请求进行签名。
• IdP 元数据中的证书，用于验证使用证书中的公钥从 IdP 接收到的 AuthnResponse（签名）。
• 使用 SHA-1 对传入的断言进行签名和哈希处理（DigestMethod 设置为 SHA-1，SignatureMethod 设置为 SHA-1）。

在 Tableau Server 2021.2 中，默认值已更改为 SHA1。有关在配置了 SAML 的情况下升级到 2021.2 的详细信息，请参见知识库文章升级到 Tableau Server 2021.2 后，使用 SAML 身份验证的 Tableau Server 无法启动或拒绝登录。

wgserver.saml.forceauthn

版本：版本 2019.3 中新增。

默认值：false

当设置为 true 时，如果 Tableau 用户会话过期，Tableau Server 将使用 IdP 重新对用户进行身份验证。此选项还可用于要求 IdP 提示用户重新进行身份验证，即使用户具有活动的 IdP 会话。

wgserver.saml.min_allowed.elliptic_curve_size

默认值：256

版本：版本 2021.1 中新增，但不包含默认值。在 2021.2 中，默认值设置为 256。

此选项指定用于 SAML 身份验证的证书的最小允许 ECDSA 曲线大小。如果上载 ECDSA 曲线大小小于 256 的证书，则在应用更改时，TSM 将记录错误。

如果要升级到 Tableau Server 2021.2 或更高版本，并且 SAML 证书使用的 ECDSA 曲线大小小于 256，则升级后 Tableau Server 将不会启动。我们建议在升级之前上载具有 256（或更大）ECDSA 曲线大小的新证书。或者，您可以运行此命令以在升级之前在 Tableau Server 的旧版本（2021.1 之前）上设置较小的 ECDSA 曲线大小。如果您在 2021.1 之前的版本上运行此命令，则必须随命令一起包括 --force-keys 选项。有关在配置了 SAML 的情况下升级到 2021.2 的详细信息，请参见知识库文章升级到 Tableau Server 2021.2 后，使用 SAML 身份验证的 Tableau Server 无法启动或拒绝登录。

wgserver.saml.min_allowed.rsa_key_size

默认值：2048

版本：版本 2021.1 中新增，但不包含默认值。在 2021.2 中，默认值设置为 2048。

此选项指定用于 SAML 身份验证的证书的最小允许 RSA 密钥长度。如果上载 RSA 密钥长度小于 2048 的证书，则在应用更改时，TSM 将记录错误。

若要使用1024 RSA密钥长度运行SAML身份验证（不推荐），请将此值设置为 1024。

如果要升级到 Tableau Server 2021.2 或更高版本，并且 SAML 证书使用的密钥长度小于 2048，则升级后 Tableau Server 将不会启动。我们建议您在升级之前上载密钥长度为 2048（或更大）的新证书。或者，您可以运行此命令以在升级之前在 Tableau Server 的旧版本（2021.1 之前）上设置较低的密钥强度。如果您在 2021.1 之前的版本上运行此命令，则必须随命令一起包括 --force-keys 选项。有关在配置了 SAML 的情况下升级到 2021.2 的详细信息，请参见知识库文章升级到 Tableau Server 2021.2 后，使用 SAML 身份验证的 Tableau Server 无法启动或拒绝登录。