Windows 版 Tableau Server 帮助

tsm security authorize-credential-migration

授权 Tableau 用户使用 Content Migration Tool 将嵌入式凭据从 Tableau Server 安装迁移到 Tableau Cloud 站点。Tableau Server 和 Tableau Cloud 都必须具有 Advanced Management 许可证才能迁移内容。有关详细信息，请参见迁移包含嵌入式凭据的工作簿和数据源。

您可以使用 tsm security cancel-credential-migrations 命令取消授权。

概要

tsm security authorize-credential-migration --source-site-url-namespace <Tableau Server site ID> --destination-site-url-namespace <Tableau Cloud site ID> --destination-server-url <Tableau Cloud site url> --authorized-migration-runner <username> --destination-public-encryption-key <public key>

选项

tsm security cancel-credential-migrations

取消使用 Content Migration Tool 迁移嵌入式凭据的授权。有关详细信息，请参见“迁移带有嵌入式凭据的工作簿和数据源”。

概要

tsm security cancel-credential-migrations --source-site-url-namespace <Tableau Server site ID>

选项

--source-site-url-namespace

必需。Tableau Server 站点的站点 ID。在 URL 中使用站点 ID 以唯一地标识站点。

例如，名为 West Coast Sales 的站点的 ID 可能为 west-coast-sales。

tsm security custom-indexandsearch-ssl add

为 Tableau Server 2023.1 及更高版本的索引和搜索服务器添加自定义证书。SSL 实施基于 Opensearch.org TLS 实施。请参见配置 TLS 证书(链接在新窗口中打开)了解详细信息。

--admin <file.crt>

必需。

管理员证书文件。指定有效的 PEM 编码 x509 证书的路径，其扩展名为 .crt。

--admin-key <file.key>

必需。

指定有效的 RSA 或 DSA 私钥文件 (PKXA #8)，按照约定具有 .key 扩展名。

-- ca <file.crt>

必需。

受信任的 CA 文件。指定有效的 PEM 编码 x509 证书的路径，其扩展名为 .crt。

--node <file.crt>

必需。

节点证书文件。指定有效的 PEM 编码 x509 证书的路径，其扩展名为 .crt。此命令会将此证书分发到群集中的每个节点。使用通配符证书允许在单个证书中包含完整的节点专有名称 (DN) 数组。

-- node-key <file.key>

必需。

指定有效的 RSA 或 DSA 私钥文件 (PKXA #8)，按照约定具有 .key 扩展名。

概要

tsm security custom-indexandsearch-ssl add --node <file.crt> --admin <file.crt> --node-key <file.key> --admin-key <file.key> --ca <file.crt> [parameters] [global options]

tsm security custom-indexandsearch-ssl list

列出索引和搜索服务器 SSL 自定义证书配置的详细信息。

概要

tsm security custom-indexandsearch-ssl list[global options]

tsm security custom-tsm-ssl disable

禁用用于连接到 TSM 控制器的自定义 SSL 证书。恢复为自动管理的自签名证书。

概要

tsm security custom-tsm-ssl disable [global options]

tsm security custom-tsm-ssl enable

为 Tableau Server 2023.1 及更高版本的 TSM 控制器连接启用自定义 SSL 证书。如果您已启用 SSL 并且需要更新过期的证书，请使用此命令。

-cf,--cert-file <file.crt>

必需。

指定有效的 PEM 编码 x509 证书的路径，其扩展名为 .crt。证书上的使用者名称必须与运行管理控制器的 Tableau 计算机的主机名或 IP 地址相匹配。默认情况下，管理控制器在 Tableau Server 部署的初始节点上运行。

-kf,--key-file <file.key>

必需。

指定有效的 RSA 或 DSA 私钥文件 (PKXA #8)，按照约定具有 .key 扩展名。此密钥不能受密码保护。

--chain-file <file.crt>

可选。

指定证书链文件 (.crt) 的路径

链文件连接构成服务器证书的证书链的所有证书。

文件中的所有证书必须为 x509 PEM 编码，文件扩展名必须为 .crt（而不是 .pem）。

--skip-validation

可选

传递此选项以跳过证书颁发机构根验证。

概要

tsm security custom-tsm-ssl enable --key-file <file.key> --cert-file <file.crt> [global options]

tsm security custom-tsm-ssl list

列出 TSM 自定义证书配置的详细信息。

概要

tsm security custom-tsm-ssl list[global options]

tsm security external-ssl disable

删除服务器现有的 SSL 配置设置，并停止加密外部客户端与服务器之间的流量。

概要

tsm security external-ssl disable [global options]

tsm security kms set-mode aws

将 KMS 模式设置为 AWS。

您将需要 AWS KMS 中的完整 ARN 字符串。此字符串位于 AWS KMS 管理页面的“常规配置”部分中。ARN 以此格式显示： arn:aws:kms:<region>:<account>:key/<CMK_ID>，例如，arn:aws:kms:us-west-2:867530990073:key/1abc23de-fg45-6hij-7k89-1l0mn1234567。

有关详细信息，请参见AWS 密钥管理系统。

概要

tsm security kms set-mode aws --key-arn "<arn>" --aws-region "<region>" [global options]

选项

--key-arn

必需。--key-arn 选项从 AMS KMS 管理页面的“常规配置”中的 ARN 中直接复制字符串。

--aws-region

必需。按 Amazon API 网关表(链接在新窗口中打开)的“区域”列中所示的方式指定区域。

示例

举例来说，如果 AWS KMS 实例正在 us-west-2 区域中运行，您的帐号为 867530990073，CMK 密钥为 1abc23de-fg45-6hij-7k89-1l0mn1234567，则命令将为：

tsm security kms set-mode aws --aws-region "us-west-2" --key-arn "arn:aws:kms:us-west-2:867530990073:key/1abc23de-fg45-6hij-7k89-1l0mn1234567"

tsm security kms set-mode azure

将 KMS 模式设置为 Azure 密钥库。

注意：运行 tsm security kms status 时，KMS 模式将显示“Azure 密钥库”，但可将其设置为“Azure”。

您将需要 Azure 密钥库的名称和 Azure 中密钥的名称。

有关详细信息，请参见Azure Key Vault。

概要

tsm security kms set-mode azure --key-name "<key_name>" --vault-name "<vault_name>" [global options]

选项

--key-name

必需。存储在 Azure 密钥库中的不对称密钥的名称。

--vault-name

必需。Azure 密钥库的名称。

示例

举例来说，如果您的 Azure 密钥库名为 tabsrv-keyvault，并且您的密钥为 tabsrv-sandbox-key01，则命令将为：

tsm security kms set-mode azure --key-name "tabsrv-sandbox-key01" --vault-name "tabsrv-keyvault"

tsm security kms set-mode local

将 KMS 模式设置或重置为本地。本地是默认 KMS 模式。有关详细信息，请参见Tableau Server 密钥管理系统。

概要

tsm security kms set-mode local [global options]

tsm security kms status

查看 KMS 配置的状态。返回的状态包括：

• 状态：OK 表示，在多节点安装的情况下，则 Tableau 或控制器节点可访问 KMS。
• 模式：本地、AWS 或 Azure 密钥库。指示正在使用哪种 KMS 模式。

• 加密和解密主加密密钥：

  KMS 存储主数据提取密钥 (MEK) 的集合。每个 MEK 具有：

  • 一个 ID，例如 8ddd70df-be67-4dbf-9c35-1f0aa2421521
  • “加密或解密密钥”或“仅解密密钥”状态。如果密钥为“加密或解密”，Tableau Server 将使用它对新数据进行加密。否则，密钥将仅用于解密。
  • 创建时间戳，例如“创建时间: 2019-05-29T23:46:54Z。”
  • 首次过渡到加密和解密：指示密钥何时成为加密或解密密钥的时间戳。
  • 过渡到仅解密：指示密钥何时过渡到仅解密的时间戳。

返回的其他值取决于 KMS 模式。

概要

tsm security kms status [global options]

tsm security maestro-rserve-ssl disable

禁用 Rserve 连接。

有关详细信息，请参见在您的流程中使用 R (Rserve) 脚本。

tsm security maestro-rserve-ssl enable

配置 Rserve 服务器和 Tableau Server 版本 2019.3 或更高版本的连接。

有关详细信息，请参见在您的流程中使用 R (Rserve) 脚本。

概要

tsm security maestro-rserve-ssl enable --connection-type <maestro-rserve-secure | maestro-rserve> --rserve-host <Rserve IP address or host name> --rserve-port <Rserve port> --rserve-username <Rserve username> --rserve-password <Rserve password> --rserve-connect-timeout-ms <RServe connect timeout>

选项

--connection-type

选择 maestro-rserve-secure 以启用安全连接，或选择 maestro-rserve 以启用不安全的连接。如果选择 maestro-rserve-secure，请在命令行中指定证书文件路径。

--rserve-host

主机

--rserve-port

端口

--rserve-username

用户名

--rserve-password

密码

--rserve-connect-timeout-ms

连接超时（以毫秒为单位）。例如，--rserve-connect-timeout-ms 900000。

tsm security maestro-tabpy-ssl disable

禁用 TabPy 连接。

有关详细信息，请参见在您的流程中使用 Python 脚本。

tsm security maestro-tabpy-ssl enable

配置 TabPy 服务器和 Tableau Server 版本 2019.3 或更高版本的连接。

有关详细信息，请参见在您的流程中使用 Python 脚本。

概要

tsm security maestro-tabpy-ssl enable --connection-type <maestro-tabpy-secure | maestro-tabpy> --tabpy-host <TabPy IP address or host name> --tabpy-port <TabPy port> --tabpy-username <TabPy username> --tabpy-password <TabPy password> --tabpy-connect-timeout-ms <TabPy connect timeout>

选项

--connection-type

选择 maestro-tabpy-secure 以启用安全连接，或选择 maestro-tabpy 以启用不安全的连接。如果选择 maestro-tabpy-secure，请在命令行中指定证书文件 -cf<证书文件路径> 。

--tabpy-host

主机

--tabpy-port

端口

--tabpy-username

用户名

--tabpy-password

密码

--tabpy-connect-timeout-ms

连接超时（以毫秒为单位）。例如，--tabpy-connect-timeout-ms 900000。

tsm security regenerate-internal-tokens

此命令执行以下操作：

1. 如果 Tableau Server 正在运行，请将其停止。

2. 为搜索服务器的 Postgres 存储库生成新的内部 SSL 证书。

3. 为所有内部管理的密码生成新密码。

4. 更新所有 Postgres 存储库密码。

5. 为资产密钥管理生成新的加密密钥，并使用新密钥对资产密钥进行加密。

6. 为配置密文（主密钥）生成新的加密密钥，并使用该密钥对配置进行加密。

7. 使用所有这些密文重新配置和更新 Tableau Server。在分布式部署中，此命令还会分发重新配置内容，并跨群集中的所有节点进行更新。

8. 重新生成新的主密钥，将其添加到主密钥存储文件，然后创建新的安全令牌供内部使用。

9. 启动 Tableau Server。

如果打算在运行此命令后向群集中添加节点，您将需要生成新的节点配置文件，以便更新此命令生成的令牌、密钥和密文。请参见安装和配置附加节点。

有关内部密码的详细信息，请参见管理服务器密文。

概要

tsm security regenerate-internal-tokens [options] [global options]

选项

--ignore-prompt

可选。

在没有提示的情况下执行重新启动（如有必要）。此选项只会隐藏提示。重新启动行为不会改变。

--request-timeout <timeout in seconds>

可选。

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

tsm security repository-ssl disable

停止加密存储库与其他服务器组件之间的流量，并停止支持 Tableau 客户端的直接连接。

概要

tsm security repository-ssl disable [global-options]

tsm security repository-ssl get-certificate-file

获取用于与 Tableau 存储库进行 SSL 通信的公共证书文件。必须为存储库通信启用 SSL，然后才能检索证书。证书文件将自动分发给 Tableau Server 群集中的内部存储库客户端。为了使远程客户端能够通过 SSL 连接到存储库，您必须将公共证书文件复制到每个客户端。

此命令仅适用于使用本地存储库的 Tableau Server，并且在 Tableau Server 配置有外部存储库时会导致错误。

概要

tsm security repository-ssl get-certificate-file [global-options]

选项

-f, --file

必需。

应在其中保存证书文件的完整路径和文件名（扩展名为 .cert）。如果存在重复文件，则将覆盖文件。

tsm security rotate-coordination-service-secrets

版本：版本 2022.1 中新增

生成协调服务用于安全连接的新证书、密钥和信任存储。

概要

tsm security rotate-coordination-service-secrets [options][global options]

选项

--coord-svc-restart-timeout <秒数>

可选。

等待指定的秒数让协调服务重新启动。默认值：1200（20 分钟）。

--ignore-prompt

可选。

在没有提示的情况下执行重新启动（如有必要）。

--request-timeout <秒数>

可选。

等待指定的秒数让命令完成。默认值：1800 秒（30 分钟）。