从 Tabadmin 迁移到 TSM CLI

  • 版本 :2022.1 及更高版本

在 Linux 版 Tableau Server 和 Windows 版 Tableau Server 版本 2018.2 中,Tableau 服务管理器 (TSM) 命令行接口 (CLI) 替代了 tabadmin CLI。本页将 tabadmin 命令映射到 TSM 命令来帮助您迁移到 TSM CLI。

在 Linux 版 Tableau Server 和 Windows 版 Tableau Server 版本 2018.2 中,Tableau 服务管理器 (TSM) 命令行接口 (CLI) 替代了 tabadmin CLI。本页将 tabadmin 命令映射到 TSM 命令来帮助您迁移到 TSM CLI。

若要详细了解 TSM CLI,请参见tsm 命令行参考

具有对应 TSM CLI 命令的 Tabadmin 命令

下表显示了哪些 tabadmin 命令与 TSM CLI 中的可用命令相对应。

命令说明Tabadmin 命令类似的 TSM CLI 命令
激活许可证tabadmin activate --activatetsm licenses activate
停用许可证tabadmin activate --returntsm licenses deactivate
激活试用许可证tabadmin activate --trialtsm licenses activate --trial
创建 Tableau Server 管理的数据的备份tabadmin backuptsm maintenance backup

使用 TSM 创建的备份不包括任何服务器配置数据。没有用于包括服务器配置数据的选项。

清除服务器缓存tabadmin clearcachetsm maintenance cleanup -r
清理临时文件和旧日志文件tabadmin cleanuptsm maintenance cleanup
注意:此命令是版本 10.5.1 中的新增命令
使用您进行的任何更改来更新服务器配置tabadmin configuretsm pending-changes apply
自定义服务器名称和徽标tabadmin customizetsm customize
启用对存储库的访问tabadmin dbpasstsm data-access repository-access enable
禁用对存储库的访问tabadmin dbpass --disabletsm data-access repository-access disable
将文件存储实例设置为只读模式tabadmin decommissiontsm topology filestore decommission
从 Tableau Server 中删除一个或多个 Web 数据连接器 (WDC)tabadmin delete_webdataconnectortsm data-access web-data-connectors delete

若要了解详细信息,请参见Tableau Server 中的 Web 数据连接器

将 Web 数据连接器 (WDC) 添加到 Tableau Servertabadmin import_webdataconnector

tabadmin whitelist_webdataconnector

tsm data-access web-data-connectors add

注意:TSM 不支持导入 WDC,但它允许您将 WDC 添加到允许列表。若要了解详细信息,请参见Tableau Server 中的 Web 数据连接器

列出 Tableau Server 使用的 Web 数据连接器 (WDC)tabadmin list_webdataconnectorstsm data-access web-data-connectors list

若要了解详细信息,请参见Tableau Server 中的 Web 数据连接器

从 Tableau Server 导出站点tabadmin exportsitetsm sites export
启动存储库故障转移tabadmin failoverrepositorytsm topology failover-repository
获取配置选项tabadmin gettsm configuration get
获取 OpenID 重定向 URLtabadmin get_openid_redirect_urltsm authentication openid get-redirect-url
将站点 .csv 文件导入 Tableau Servertabadmin importsitetsm sites import
使用 .csv 文件将站点导入 Tableau Servertabadmin importsite_verifiedtsm sites import-verified
显示 Tableau Server 的许可证信息tabadmin licensestsm licenses list

注意:有关此命令的输出的详细信息,请参见查看服务器许可证

将文件存储从只读模式转换为主动读/写状态tabadmin recommissiontsm topology filestore recommission
重新生成内部安全令牌tabadmin regenerate_internal_tokenstsm security regenerate-internal-tokens
注册 Tableau Servertabadmin registertsm register
为 Tableau Server 重建搜索索引tabadmin reindextsm maintenance reindex-search
重置 Tableau Server 管理员帐户tabadmin resettsm reset

注意:版本 2018.1 中新增。

停止和启动所有 Tableau Server 进程tabadmin restarttsm restart
从 Tableau Server 备份文件进行还原tabadmin restoretsm maintenance restore

restore 命令不还原任何服务器配置数据。无论您是使用通过 TSM 还是 tabadmin 创建的备份,都是如此。

设置配置选项tabadmin settsm configuration set
激活或挂起站点tabadmin sitestatetsm sites unlock
启动所有 Tableau Server 进程tabadmin starttsm start
获取 Tableau Server 和服务器进程的状态tabadmin statustsm status
停止所有 Tableau Server 进程tabadmin stoptsm stop
使用 Tableau Server 日志文件创建存档 (.zip) 文件tabadmin ziplogstsm maintenance ziplogs

ziplogs 命令的默认行为已更改:使用 tsm 时,该命令默认情况下会收集最多两天的日志文件。tabadmin ziplogs 命令收集最多七天的日志文件。有关详细信息,请参见tsm maintenance ziplogs

没有对应 TSM CLI 命令的 Tabadmin 命令

下表列出了没有类似 TSM CLI 命令的 tabadmin 命令。

命令说明Tabadmin 命令说明
在系统管理员组中添加或移除用户tabadmin administrator您可以使用 Tableau Server REST API 的向组中添加用户从组中移除用户方法在系统管理员组中添加或移除用户。
创建一个新密钥以对存储库中存储的敏感信息进行加密tabadmin assetkeys使用 tsm security regenerate-internal-tokens 命令来创建或重新生成密文和主密钥。
指定 Tableau Server 是否在系统启动时启动tabadmin autostartTableau Server 将恢复为系统重新启动之前的状态。如果 Tableau Server 正在运行,它将重新启动。如果 Tableau Server 已停止,则它在系统启动后将处于停止状态。
标识用于备份的另一个服务器节点tabadmin failoverprimaryTSM 没有主节点,因此不需要此命令的等效 TSM 命令。
在 Tableau Server 上管理委派数据访问的凭据tabadmin manage_global_credentials我们建议您使用针对 Apache Impala 的 Kerberos 委派进行全局凭据管理。若要了解详细信息,请参见Kerberos和 Tableau 社区中的为 Hive/Impala 启用 Kerberos 委派(链接在新窗口中打开)
重置 Tableau Server 帐户的密码tabadmin passwd如果服务器使用本地身份验证,您可以使用 Tableau Server REST API 的更新用户方法来重置用户帐户的密码。
重置 Tableau Server 用户 ID 和 Open ID Connect 身份提供程序之间的绑定tabadmin reset_openid_sub
确定您的环境是否满足运行 Tableau Server 的最低要求tabadmin validate
验证 Tableau Server 存储库的备份是否将成功还原tabadmin verify_database除非您使用 --skip-verification 参数,否则 tsm maintenance backup 命令会自动验证备份是否将正确还原。
为 Tableau Server 重新启动后的快速加载时间准备 VizQL 进程tabadmin warmuptabadmin warmup 命令不再为必需,因为 Tableau Server 现在经过优化,可在服务器重新启动后自动提供快速加载时间。