tsm 命令行参考

此部分中的主题包括 Tableau 服务管理器 (TSM) 命令行界面 (CLI) 的参考内容,为 Tableau Server 提供支持。

TSM 用于管理 Tableau Server 的安装和配置。若要了解有关 TSM 的详细信息,请参见Tableau 服务管理器概述

您可以使用 TSM API 自动执行 TSM CLI 支持的安装和配置任务。若要了解有关预发行版本 (Alpha) TSM API 的详细信息,请参见 Tableau 服务管理器 API

使用 tsm CLI

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

若要运行 tsm 命令,您需要打开命令提示符。

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

  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

tsm CLI 身份验证

从 Tableau Server 的 2019.2 版本开始,如果满足以下条件,运行 tsm 命令将不要求您输入密码:

  • 运行命令的帐户是 TSM 授权组(默认情况为 tsmadmin 组)的成员。Tableau 非特权用户(默认情况下为 tableau 用户)和 root 帐户也可以运行 TSM 命令。
  • 您在运行 Tableau Server 管理控制器服务的 Tableau Server 本地运行命令。默认情况下,将在分布式部署中的初始节点上安装和配置 Tableau Server 管理控制器服务。

以本地方式登录到 tsm CLI

如果使用作为 TSM 授权组成员的帐户在本地计算机上运行 tsm 命令,则无需指定密码。在这种情况下,只需运行命令,例如:

tsm version

以远程方式登录到 tsm CLI

如果从未运行 Tableau Server 管理控制器服务的群集节点中运行 TSM 命令,则您必须向远程计算机上的 Tableau Server 管理控制器服务验证会话的身份,然后才能运行命令。例如,运行以下命令:

tsm login -s <server_name> -u <account_name>

其中,<server_name> 是运行 Tableau Server 管理控制器服务的节点的名称,<account_name> 是作为 TSM 授权组成员的帐户。

运行此命令后,系统将提示您输入密码。在对帐户进行身份验证后,您可以运行 TSM 命令。

查看并向 TSM 授权组中添加帐户

TSM 授权组是在服务器安装过程中创建的。默认情况下,为名为 tsmadmin 的 TSM 授权组。如果在安装过程中创建了备用 TSM 授权组,则在以下代码示例中替换 tsmadmin 的组名称。

若要查看 tsmadmin 组中的用户帐户,请运行以下命令:

grep tsmadmin /etc/group

若要向 tsmadmin 组中添加用户帐户,请执行以下操作:

sudo usermod -G tsmadmin -a <username>

tsm CLI 脚本处理和自动化

若要在没有密码的情况下在脚本文件中自动运行 Tableau Server,请使用适当 TSM 授权组中的帐户在初始节点上运行脚本。有关更多详细信息,请参见上面的“身份验证”部分。

在 shell 中查看帮助内容

若要从命令行中查看最少的帮助内容,请使用 tsm help 类别。

概要

tsm help [category] [command]

命令

tsm help

所有 tsm 命令的帮助

tsm help <category>

显示特定命令类别的帮助。例如,tsm help authentication

tsm help <category> <command>

显示特定命令的帮助。例如,tsm help authentication open-id

tsm help command

所有顶级命令或类别的列表。

类别

此部分中的其他文章

感谢您的反馈! 提交反馈时出错。请重试,或向我们发送消息