tsm topology

使用 tsm topology 命令准备文件存储节点以便安全删除或使其恢复为读写模式。您还可以启动存储库故障转移、获取节点或端口列表、获取为群集添加其他节点、移除节点、配置外部存储库和外部文件存储所需的引导程序配置文件。

对拓扑进行更改时，还需要应用这些待处理更改。有关详细信息，请参见tsm pending-changes。

• cleanup-coordination-service

• deploy-coordination-service

• external-services

• disable

• enable

• replace-host

• gateway disable

• gateway enable

• gateway update

• storage disable

• storage enable

• storage switch-share

• filestore

• gateway

• list

• repository

• failover-repository

• filestore

• decommission

• recommission

• list-nodes

• list-ports

• nodes

• get-bootstrap-file

• remove-nodes

• set-node-role

• set-ports

• set-process

• toggle-coordination-service

tsm topology cleanup-coordination-service

注意：从版本 2020.1.0 开始，所有协调服务整体命令都需要输入“y/n”提示，确认服务器将重新启动。若要在不输入的情况下运行这些命令，请包括 --ignore-prompt 选项。

部署新整体后，使用 tsm topology cleanup-coordination-service 命令删除非生产 Tableau Server 协调服务整体。此命令将移除非生产协调服务整体中所有节点上的旧协调服务实例，并且在部署新协调服务整体后需要执行该命令。若要了解有关协调服务整体的详细信息，请参见部署协调服务整体。

在版本 2020.1.0 及更高版本中，tsm topology deploy-coordination-service 命令还会移除旧整体。除非部署失败，否则无需单独运行此命令。

概要

tsm topology cleanup-coordination-service [option] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 2700（45 分钟）。

tsm topology deploy-coordination-service

注意：从版本 2020.1.0 开始，所有协调服务整体命令都需要输入“y/n”提示，确认服务器将重新启动。若要在不输入的情况下运行这些命令，请包括 --ignore-prompt 选项。

您可以使用 tsm topology deploy-coordination-service 命令部署 Tableau Server 协调服务。此命令将部署协调服务整体，这是在服务器群集中的指定节点上运行的一组协调服务实例。若要了解有关协调服务整体的详细信息，包括群集中多少个节点应该有一个协调服务实例，请参见部署协调服务整体。

在版本 2020.1.0 及更高版本中，tsm topology deploy-coordination-service 命令还会移除旧整体。无需单独运行 cleanup-coordination-service 命令。

概要

tsm topology deploy-coordination-service --nodes

选项

• -n, --nodes

• 必需。

  要包括在新协调服务整体中的节点的节点 ID，用逗号分隔。您可以指定 1、3 或 5 个协调服务节点，具体取决于群集中的节点总数。有关详细信息，请参见协调服务法定数量。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 2700（45 分钟）。

tsm topology external-services storage disable

将 Tableau Server 配置为以本地方式运行文件存储。使用此命令来禁用外部文件存储，并将文件存储数据移到 Tableau Server。

概要

tsm topology external-services storage disable [options] [global options]

选项

• -fsn

• 必需

  指定要配置文件存储的节点。可以指定多个节点。数据将迁移到列表中的第一个节点，然后复制到其他节点。

  有关详细信息，请参见重新配置文件存储。

tsm topology external-services storage enable

将 Tableau Server 配置为包含外部文件存储。外部文件存储使用 SAN 或 NAS 来存储文件存储数据。

概要

tsm topology external-services storage enable [options] [global options]

选项

• --network-share

• 必需

  指定要用于外部文件存储的网络共享的名称和路径。

  有关详细信息，请参见重新配置文件存储。

tsm topology external-services storage switch-share

使用此命令将外部服务移动到其他网络共享。例如，当您的当前网络连接存储即将使用寿命结束时，您需要将新的网络连接存储与新硬件配合使用。有关详细信息，请参见重新配置文件存储。

概要

tsm topology external-services filestore [option] [global options]

选项

• --network-share

• 必需

  指定要切换到的新网络共享的路径。

tsm topology external-services gateway disable

在 Tableau Server 上禁用独立网关的所有实例。

概要

tsm topology external-services gateway disable [options] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 2700（45 分钟）。

tsm topology external-services gateway enable

在 Tableau Server 上启用独立网关实例。

概要

tsm topology external-services gateway enable [options] [global options]

选项

• -c, --config <配置文件>

• 必需

  指定包含独立网关所有实例的配置详细信息的 JSON 文件的名称。

tsm topology external-services gateway update

使用此命令可更新 Tableau Server 中独立网关的配置。如果添加或移除独立网关的其他实例，或者升级独立网关，则需要执行此操作。在运行此命令之前收集独立网关计算机上的任何更改并更新配置文件。

概要

tsm topology external-services gateway update [option] [global options]

选项

• -c, --config <配置文件>

• 必需

  指定包含独立网关所有实例的配置详细信息的 JSON 文件的名称。

tsm topology external-services list

使用 tsm topology external-service-list 命令获取用于 Tableau Server 外部存储库的服务。举例来说，如果已将 Tableau Server 配置为使用 Amazon RDS，您将看到以下消息：

这些外部配置的服务由 Tableau Server 使用：

- pgsql

概要

tsm topology external-service list [global options]

选项

此命令没有选项。

tsm topology external-services repository disable -n nodeN

使用 tsm topology external-services repository disable 命令停止使用外部存储库，并重新配置安装以使用本地存储库。这会将数据迁移到本地存储库，并将 Tableau Server 配置为使用本地存储库。

概要

tsm topology external-services repository disable -n nodeN

选项

• -n, --node-name

• 必需。

  指定应将存储库移入其中的节点的节点 ID。

  重要信息：这不会停止或删除 RDS 实例。有关如何删除 RDS 实例的详细信息，请参见 AWS 网站上的删除 DB 实例(链接在新窗口中打开)。

tsm topology external-services repository enable

使用 tsm topology external-services repository enable 命令将 Tableau Server 配置为使用外部存储库。可以在安装新 Tableau Serve 期间使用此命令配置外部存储库。如果在已存在并正在运行 Tableau Server 上运行此命令，它会将数据从本地节点迁移到外部存储库，并将 Tableau Server 配置为在迁移完成后使用外部存储库。

概要

tsm topology external-services repository enable -f <filename>.json -c <ssl certificate file>.pem

选项

--f

• 必需。

  将用于保存配置文件的完整路径和文件名。有关详细信息，请参见重新配置 Tableau Server 存储库。

--c

• 对于版本 2021.2 和 2021.2.1 为必需。对于版本 2021.2.2 及更高版本是可选的。

  对于 SSL 配置，下载证书文件，并指定要用于此选项的文件。

  1. Amazon RDS：请参见使用 SSL 对 DB 实例连接进行加密(链接在新窗口中打开)。

  2. Azure Database：请参见为 Azure Database for PostgreSQL 配置 TLS 连接(链接在新窗口中打开)。

  3. 独立 PosgreSQL 实例：请参见配置 SSL。

--no-ssl

• 可选。此选项仅在版本 2021.2.2 及更高版本中可用。

  这意味着连接到外部存储库时不需要 SSL。如果您不需要使用加密连接，您还必须配置外部存储库以允许未加密连接。使用此选项时，如果外部存储库配置为支持 TLS/SSL 连接，则连接将被加密。否则，Tableau Server 将使用非加密连接。

tsm topology external-services repository replace-host

此命令更新 Tableau Server 配置设置以使用指定的外部存储库。使用 tsm topology external-services repository replace-host 命令重新配置 Tableau Server 以立即使用新的外部存储库，而无需将数据从当前外部存储库移动到该存储库。您可能需要手动迁移数据。只有在您完全评估和了解潜在数据丢失的影响之后，才应执行此操作。

可在以下情形下使用此命令：

• RDS 实例使用的 SSL 证书的计划过期：RDS 实例需要使用新证书进行更新，并且 Tableau Server 需要配置为使用新的证书文件连接到 RDS 实例。

• 灾难恢复：使用它连接到灾难恢复情形中的新 RDS 实例。有关详细信息，请参见在 AWS 关系数据库服务 (RDS) 上创建 PostgreSQL DB 实例。

概要

tsm topology external-services repository replace-host -f <filename>.json -c <ssl certificate file>.pem

选项

-f

• 必需。

  将用于保存配置文件的完整路径和文件名。有关详细信息，请参见重新配置 Tableau Server 存储库。

-c

• 可选。

  证书文件是要导入以允许连接到实例的证书。对于 RDS，这是用于对实例证书进行签名的 CA 证书。这通常是最新的根证书 rds-ca-XXXX-root.pem 文件。 如果证书在 RDS 实例上已更改，则使用此参数更新 Tableu Server。

  有关详细信息，请参见使用 SSL/TLS 对 DB 实例连接加密。

  有关如何获取 .pem 文件的详细信息，请参见使用 SSL 对 DB 实例连接加密(链接在新窗口中打开)。

--ignore-prompt

• 可选。

  运行此命令时没有提示。

tsm topology failover-repository

您可以使用 tsm topology failover-repository 手动启动从当前主动存储库到第二个被动存储库的存储库故障转移。

tsm topology failover-repository 命令是永久性的。故障转移存储库将一直是主动存储库，直至您再次发出命令为止。或者，如果针对其配置了 Tableau Server，则会一直保持到发生自动故障转移为止。如果配置了首选主动存储库，请使用 --preferred 选项切换回该存储库。有关配置首选主动存储库的详细信息，请参见Tableau Server 存储库。如果针对高可用性配置了 Tableau Server，则会自动进行存储库故障转移。使用 failover-repository 命令对存储库进行手动故障转移。

概要

tsm topology failover-repository --preferred | --target

选项

• -r, --preferred

• 如果未使用 -t 或 --target，则为必需。

  使用配置的首选节点作为存储库故障转移的目标。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 1800（30 分钟）。

• -t, --target

• 如果未使用 -r 或 --preferred，则为必需。

  将在其中发生故障转移的目标节点的节点 ID。使用 tsm topology list-nodes 命令查找节点 ID。

tsm topology filestore decommission

您必须使用 tsm topology filestore decommission 命令来准备一个或多个文件存储节点以便安全删除。此命令会将指定节点置于只读模式，并确保指定节点上没有唯一内容。

如果停止使用单个文件存储节点中的结果，则必须使用 --override 选项，否则停止使用将失败。

概要

tsm topology filestore decommission --nodes

选项

• -n, --nodes

• 必需。

  由节点 ID 指定并用逗号分隔的一个或多个待停用节点的列表。

• --delete-filestore

• 可选。

  强制移除文件存储，即使尚未将其停止使用。只有在文件存储所在的节点处于错误状态并且无法完成停止使用操作时，才应使用此选项。将永久性删除该节点上的任何唯一文件。

• -o, --override

• 可选。

  如果删除目标文件存储节点会将剩余文件存储节点的数量减少到一个，则覆盖通常会发生的警告或故障。此选项不能与 --delete-filestore 选项一起使用。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 1800（30 分钟）。

tsm topology filestore recommission

使用 tsm topology filestore recommission 命令将任何已停用的节点恢复为读写模式。

概要

tsm topology filestore recommission --nodes

选项

• -n, --nodes

• 必需。

  由节点 ID 指定并用逗号分隔的一个或多个待重新使用节点的列表。

tsm topology list-nodes

显示群集中的节点和（可选）每个节点上的服务。

概要

tsm topology list-nodes [options] [global options]

选项

• -v, --verbose

• 可选。

  显示每个节点 ID、节点角色（有关详细信息，请参见下面的 set-node-role）、节点地址以及每个节点上的进程。

tsm topology list-ports

显示群集中的端口。

概要

tsm topology list-ports [options] [global options]

选项

• --node-name

• 可选。

  指定要列出其端口的节点。

• --service-name

• 可选。

  指定要列出其端口的服务。

tsm topology nodes get-bootstrap-file

您可以使用 tsm topology nodes get-bootstrap-file 命令获取将新节点添加到群集所需的引导程序文件。

重要信息：引导程序文件包含用于对配置密码加密的主密钥存储文件的副本。该文件还可包含有效的嵌入式凭据一段预定义的时间（请参见tabadmincontroller.auth.expiration.minutes）并充当会话 Cookie。我们强烈建议您采取其他措施来保护引导程序文件。

以下命令集提供了加密引导程序文件输出的示例方法。此方法类似于保护用于导入和导出操作的密文中更详细描述的加密过程。

但是请注意，此处的方法必须作为单独的参数传递，并具有 && \尾随运算符，如下所示：

mkfifo -m 600 /tmp/secure1 && \

tsm topology nodes get-bootstrap-file --file /tmp/secure1 && \

gpg --symmetric --batch --yes --passphrase-file ~/.secrets/pgppassphrase.txt --cipher-algo AES256 --output encrypted.enc < /tmp/secure1 && \

rm /tmp/secure1

概要

tsm topology nodes get-bootstrap-file --file <path\file>.json [global options]

选项

• -f,--file

• 必需。

  将用于保存配置文件的完整路径和文件名。如果存在重复文件，则将覆盖文件。

• -nec,--no-embedded-credential

• 可选。

  版本 2019.3 中新增。

  默认情况下，引导程序文件中包括嵌入式凭据。如果引导程序文件中不应包括凭据，请使用此选项。嵌入式凭据是临时的，并会根据 tabadmincontroller.auth.expiration.minutes配置键的值（默认值为 120 分钟）过期。

  注意：可以使用配置选项在服务器级别禁用包括嵌入式凭据的功能。有关详细信息，请参见features.PasswordlessBootstrapInit。

tsm topology remove-nodes

从群集中删除节点。

若要完成节点移除，您还必须运行 tsm pending-changes apply 命令。某些情况下，需要在删除节点之前移动或重新部署进程。请参见移除节点。

如果移除节点并想要将其重新添加到群集，您需要首先运行 obliterate 脚本将 Tableau 从群集中擦除，然后使用用于添加新节点的正常过程重新安装节点。有关详细信息，请参见从计算机中移除 Tableau Server以及安装和配置附加节点。

注意：要从群集中删除节点，必须在过去的某个时刻已为该节点配置了进程。如果要删除尚未配置任何进程的节点，则必须在其上添加一个进程，运行 tsm pending-changes apply，然后删除该节点。

概要

tsm topology remove-nodes --nodes <nodeID,nodeID,...> [global options]

选项

• -n, --nodes

• 必需。

  指定要移除的节点。如果要指定多个节点，请使用逗号分隔节点 ID。

tsm topology set-node-role

设置“后台程序”和“数据提取查询”节点角色。这确定将在节点上执行的任务的类型。如果有多节点群集并且需要加载项许可证，则以下节点角色非常有用。有关详细信息，请参见通过节点角色管理工作负载。

注意：对节点角色进行配置需要重新启动服务器，并且将需要停机一段时间。有关详细信息，请参见tsm pending-changes。

概要

tsm topology set-node-role [options] [global options]

选项

• -n, --nodes

• 必需。

  要为其设置节点角色的一个或多个节点的列表，由节点 ID 指定并用逗号分隔，各节点之间没有空格。

• -r --role

• 必需

  设置指定节点的角色。此选项的有效值为：

  • all-jobs：后台程序将运行所有类型的作业。

  • flows：后台程序将仅运行流程运行作业。

  • no-flows：后台程序将不运行流程运行作业。

  • extract-refreshes：后台程序将仅运行数据提取刷新作业。这包括对所有数据提取（包括流程输出创建的数据提取）进行的增量刷新、完全刷新、加密和解密。

  • subscriptions：后台程序将仅运行订阅作业。

  • extract-refreshes-and-subscriptions：后台程序对所有数据提取（包括流程输出创建的数据提取）运行数据提取刷新、加密和解密，以及运行订阅作业。

  • no-extract-refreshes：后台程序将运行除数据提取刷新、数据提取加密和解密（包括通过流程输出创建的数据提取）之外的所有作业。

  • no-subscriptions：后台程序将运行除订阅之外的所有作业。

  • no-extract-refreshes-and-subscriptions：后台程序将运行除对数据提取（包括通过流程输出创建的数据提取）进行数据提取刷新、加密和解密以及订阅作业之外的所有作业。

  • Extract-queries：选定节点将以 all-jobs 方式运行，并将优先处理数据提取查询。

  • extract-queries-interactive：所选节点将以 all-jobs 方式运行，并将优先处理交互式数据提取查询，例如当用户查看其屏幕并等待加载基于数据提取的仪表板时运行的节点。这是一项高级设置，只有在群集具有繁重的订阅和通知作业工作负载，导致用户在与计划负载几乎同时运行的可视化项加载时上遇到性能下降时，才应使用该设置。

tsm topology set-ports

设置服务实例的端口。

概要

tsm topology set-ports --node-name <nodeID> --port-name <port_name> --port-value <port_value> [options] [global options]

选项

• -i, --instance

• 可选。

  指定服务的实例 ID。如果未指定，默认为 0（零）。

• -n, --node-name

• 必需。

  指定节点的节点 ID。

• -pn, --port-name

• 必需。

  要设置的端口的名称，格式为：service_name:port_type。如果没有指定端口类型，则假定为主端口。有关端口名称语法，请参见动态映射端口。

• -pv, --port-value

• 必需。

  要设置的端口。

• -r, --restart

• 可选。

  需要时，隐藏重新启动提示并重新启动 Tableau Server。

tsm topology set-process

设置节点上的进程实例数。如果节点已经具有指定的进程，则将该数目更新为与指定的计数匹配。

• 一次只能设置一个进程。如果指定多个进程，则会在无提示的情况下忽略第一个进程后面的任何进程。

• 您必须一次设置一个节点的进程。如果指定多个节点，该命令将显示“invalid node name”（无效节点名称）错误。

更新节点上的进程数后，还需要应用待处理更改。在大多数情况下，这还需要重新启动服务器（系统会提示您），但在特殊情况下，您可以进行动态拓扑更改，而无需重新启动服务器。有关详细信息，请参见Tableau Server 动态拓扑更改。

注意：有关进程名称的完整列表，请参见Tableau Server 进程。

概要

tsm topology set-process --count <process_count> --node <nodeID> --process <process_name> [global options]

选项

• -c, --count

• 必需。

  要设置的进程数（实例数）。

• -n, --node

• 必需。

  指定要对其设置进程的节点的节点 ID。

• -pr, --process

• 必需。

  要设置的进程的名称。

tsm topology toggle-coordination-service

注意：从版本 2020.1.0 开始，所有协调服务整体命令都需要输入“y/n”提示，确认服务器将重新启动。若要在不输入的情况下运行这些命令，请包括 --ignore-prompt 选项。

您可以使用 tsm topology toggle-coordination-service 命令在协调服务整体之间切换。若要了解有关协调服务整体的详细信息，请参见部署协调服务整体。

在版本 2020.1.0 及更高版本中，tsm topology deploy-coordination-service 命令还会切换到新整体。无需单独运行此命令。

概要

tsm topology toggle-coordination-service [option] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。默认值为 1800（30 分钟）。

全局选项

• -h, --help

• 可选。

  显示命令帮助。

• -p, --password

• 在会话不是活动状态的情况下为必需，-u 或 --username 也为必需。

  为在 -u 或 --username 中指定的用户指定密码。

  如果密码包括空格或特殊字符，请将其括在引号中：

  --password 'my password'

• -s, --server https://

• 可选。

  对 Tableau 服务管理器使用指定的地址。URL 必须以 https 开头，包括端口 8850，并使用服务器名称（而不是 IP 地址）。例如，https://。如果没有指定服务器，则假定为 https://。

• --trust-admin-controller-cert

• 可选。

  使用此标志来信任 TSM 控制器上的自签名证书。有关证书信任和 CLI 连接的详细信息，请参见 连接 TSM 客户端。

• -u, --username

• 在会话不是活动状态的情况下为必需，-p 或 --password 也为必需。

  指定用户帐户。如果未包括此选项，则使用您登录所使用的凭据运行该命令。