---
schema_version: "1"
id: f3b57c8738100db056fa81c0e1a945efa1a2e82cbb1552d60209bd6db00c892f
title: rmtadmin 命令行实用工具
collection: tableau
version: current
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/current/zh-cn/server/rmt-admin-cmdline.md
canonical_url: https://help.tableau.com/current/server/zh-cn/rmt-admin-cmdline.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 5255b9b465ee471ee4e412f626f5fb633ae1b598df5fc0d9636f51604121a061
description: Reference for the rmtadmin command line utility in the Resource Monitoring Tool.
---
[跳转到主要内容](#main-content)

# rmtadmin 命令行实用工具

Resource Monitoring Tool 包括一个命令行界面 `rmtadmin.cmd`（位于安装文件夹中）。默认安装文件夹为：

- RMT Server `%PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\Master`
- 代理：`%PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent`

**注意：**您必须以管理员身份运行命令提示符，才能成功运行这些命令。

> **RMT Server** 安装和**代理**安装中均包括了 `rmtadmin`。根据您使用的是 RMT Server 还是代理 `rmtadmin` 命令行实用工具，某些命令可能有所不同。例如，`users` 命令只能从 _RMT Server_ 中工作。`ziplogs` 命令可在任何地方使用，但只包括对其运行该使命主的应用程序中的日志文件。

下面是可用于 `rmtadmin` 命令行的命令：

**注意：**`rmtadmin` 命令同时使用位置参数和选项。  
应仅使用值指定位置参数。您不需要指定实际关键字。应使用等号指定选项关键字和值。  
示例：  
`rmtadmin <command> <positional parameter value> --<option keyword>**=**<value>`

- [rmtadmin add-user](#rmtadmin_add-user)
- [rmtadmin agents](#rmtadmin_agents)
- [rmtadmin bootstrap-file](#rmtadmin_bootstrap_file)
- [rmtadmin cleanup](#rmtadmin-cleanup)
- [rmtadmin create-admin-user](#rmtadmin-create-admin-user)
- [rmtadmin create-env](#rmtadmin-create-env)
- [rmtadmin delete-env](#rmtadmin-delete-env)
- [](#rmtadmin-data-access)[rmtadmin data-access](#rmtadmin-data-access)
- [rmtadmin delete-env-data](#rmtadmin_delete_env_data)
- [rmtadmin delete-server](#rmtadmin-delete-server)
- [rmtadmin delete-server-data](#rmtadmin-delete-server-data)
- [rmtadmin delete-user](#rmtadmin_delete-user)
- [rmtadmin deregister-agent](#rmtadmin-deregister-agent)
- [rmtadmin environments](#rmtadmin-environments)
- [rmtadmin get](#rmtadmin_get)
- [rmtadmin get-user](#rmtadmin_get-user)
- [rmtadmin help](#rmtadmin_help)
- [](#rmtadmin_master_setup)[rmtadmin master-setup](#rmtadmin_master_setup)
- [rmtadmin passwd](#rmtadmin_passwd)
- [rmtadmin query](#rmtadmin_query)
- [rmtadmin register](#rmtadmin_register)
- [rmtadmin restart](#rmt_restart)
- [rmtadmin rotate-mq-certificate](#rmtadmin_rotate_mq_cert-agent)
- [rmtadmin rotate-mq-certificates](#rmtadmin_rotate_mq_certs)
- [rmtadmin servers](#rmtadmin-servers)
- [rmtadmin service-setup](#rmtadmin-service-setup)
- [rmtadmin set](#rmtadmin_set)
- [rmtadmin start](#rmtadmin_start)
- [rmtadmin stop](#rmtadmin_stop)
- [rmtadmin status](#rmtadmin_status)
- [rmtadmin test-env](#rmtadmin_test_env)
- [rmtadmin update-baseline](#rmtadmin-update-baseline)
- [rmtadmin update-env](#rmtadmin-update-env)
- [rmtadmin users](#rmtadmin_users)
- [rmtadmin version](#rmtadmin_version)
- [rmtadmin ziplogs](#rmtadmin_ziplogs)

为了与我们公司的平等价值观保持一致，我们在可能的情况下更改了非包容性术语。由于在某些地方更改术语可能会导致重大更改，因此我们保留现有术语。因此，您可能会继续在 CLI 命令和选项、安装文件夹、配置文件和其他实例中看到这些术语。有关详细信息，请参见[“关于 Tableau 帮助”](https://help.tableau.com/current/tableau/zh-cn/about-tableau-help.htm)。

## rmtadmin add-user

**注意：**版本 2024.2 中新增。

如果不存在用户帐户，则使用给定的用户名创建一个。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin add-user [options][global option]`

### 选项

\--username

要添加的新用户帐户的用户名。

\--auth-mode

新用户帐户的身份验证模式。值可以是 `Local` 或 `Delegated`。

\--password

用户帐户的密码。仅当身份验证模式为 `Local` 时才需要。

\--password-file

包含用户帐户密码的文件的路径。如果您不想直接键入密码并将密码存储在可访问的文件中，则可以使用此选项。仅当身份验证模式为 Local 时才需要。

角色

\--download-log-bundles

可选。授予用户下载日志包的权限。

\--download-tds-files

可选。授予用户下载 TDS 文件的权限。

\--generate-chargeback-report

可选。授予用户生成计费报告的权限。

\--environment-management

可选。授予用户管理环境的权限。

\--user-management

可选。授予用户管理用户的权限。

\--webhook-management

可选。授予用户管理 webhook 的权限。

**示例：**

rmtadmin add-user --username=<username> --password=<password> --auth-mode=<Local|Delegated> --download-log-bundles=\[T|F\] --download-tds-files=\[T|F\] --generate-chargeback-report=\[T|F\] --environment-management=\[T|F\] --user-management=\[T|F\] --webhook-management=\[T|F\]

**注意**：如果 `DisableLocalAuthentication` 配置键设置为 true，则禁用 Local 身份验证模式。

## rmtadmin agents

**注意**：版本 2021.2 中新增

列出所有环境的 Tableau Server 节点上的所有注册代理。

这有助于查看 Resource Monitoring Tool 代理在 Tableau Server 上的安装位置。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin agents [options][global option]`

### 选项

\--env

可选：使用此选项查看特定环境的代理列表。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

\--keys

可选：在输出中包括代理密钥。

**示例：**`rmtadmin agents --env=<myenvironmentidentifier> --keys`

## rmtadmin bootstrap-file

**注意**：版本 2021.2 中新增

创建并保存用于在 Tableau Server 节点上注册代理的引导程序文件。

系统将创建引导程序文件，并将其保存到指定的绝对路径或相对路径。相对路径将解析为当前工作目录。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin bootstrap-file [options][global option]`

### 选项

\--env

必需。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。  
Tableau Server 节点上的代理一次只能注册到一个环境。

\--filename

可选。包括文件名的绝对或相对路径。相对路径将解析为当前工作目录。如果未指定，则使用默认输出文件名。

\--force

可选。覆盖同名的现有文件。

**示例：**`rmtadmin bootstrap-file --env=<myenvironmentidentifier>`

## rmtadmin cleanup

**注意**：版本 2021.2 中新增

删除超过特定天数的日志文件。默认情况下，它会删除超过 31 天的日志文件。

**此命令既可在 RMT Server 上工作，也可在代理上工作。**

**注意：**如果 Resource Monitoring Tool 进程正在运行，则该命令将不会清除活动日志文件。如果要确保删除所有文件，则需要使用 [rmtadmin\_stop](#rmtadmin_stop) 命令停止 RMT，然后使用以下命令运行清理，`rmtadmin cleanup --log-files-retention=0`，接头使用 [rmtadmin\_start](#rmtadmin_start) 命令重新启动进程。

### 概要

`rmtadmin cleanup [option][global option]`

### 选项

\--log-files-retention

可选。删除超过指定天数的日志文件。

**示例：**`rmtadmin cleanup --log-files-retention=<number of days>`

## rmtadmin create-admin-user

**版本：**版本 2022.1 中新增

如果不存在其他用户，则创建初始管理员用户。

**注意：**从版本 2023.1 开始，您可以创建多个管理员用户。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin create-admin-user [options][global option]`

### 选项

\--username

可选。管理员用户帐户的用户名。如果未指定，则默认为“admin”。

\--password

必需。管理员用户帐户的密码。

\--password-file

可选。包含管理员用户帐户密码的文件的路径。如果您不想直接键入密码并将密码存储在可访问的文件中，则可以使用此选项。

**示例：**`rmtadmin create-admin-user --username<admin user name> --password <password for the admin user account>`

## rmtadmin create-env

**注意**：版本 2021.2 中新增

创建一个新环境。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin create-env [options][global option]`

### 选项

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 115px;"><col><col><col style="width: 234px;"></colgroup><thead><tr><th>选项</th><th>是否必需？</th><th>默认值</th><th>描述</th></tr></thead><tbody><tr><td>--name</td><td>是</td><td>不适用</td><td>环境的名称。</td></tr><tr><td>--gateway-url</td><td><p>是</p><p>&nbsp;</p></td><td>不适用</td><td><p>用于访问 Tableau Server 网关的 URL。</p></td></tr><tr><td>--version</td><td>是</td><td>不适用</td><td>此环境将监控的 Tableau Server 版本。</td></tr><tr><td>--non-interactive</td><td><p>否</p><p></p></td><td>默认情况下启用交互式提示。</td><td>禁用所有交互式提示。</td></tr><tr><td>--no-test</td><td><p>否</p><p></p></td><td>默认情况下启用 API 和存储库连接测试。</td><td>禁用测试 API 和存储库连接。</td></tr><tr><td>--api-username</td><td>否</td><td>Null</td><td>用于连接到 Tableau Server API 的帐户的用户名。用户帐户应该是可以访问所有 Tableau Server 站点的 Tableau Server 管理员。</td></tr><tr><td>--api-password</td><td><p>否</p><p>（如果您指定 Tableau API 用户名，您将提供密码，或指定文件路径和包含密码的文件）</p></td><td><p>Null</p></td><td><p>用于连接到 Tableau Server API 的 Tableau Server API 用户帐户的密码。</p></td></tr><tr><td>--api-password-file</td><td>否</td><td>Null</td><td>文件的路径和包含 Tableau Server API 用户帐户密码的文件的名称。</td></tr><tr><td>--repository-server</td><td>是</td><td><p>Null</p></td><td>这是与 Tableau Server 一起安装的 PostgreSQL 数据库的服务器名称。</td></tr><tr><td>--repository-database</td><td>是</td><td>Null</td><td>这是与 Tableau Server 一起安装的 PostgreSQL 数据库的名称。</td></tr><tr><td>--repository-port</td><td>是</td><td>Null</td><td>Tableau Server 存储库数据库的的端口号。</td></tr><tr><td>--repository-username</td><td>是</td><td>Null</td><td><p>用于连接到随 Tableau Server 存储库一起安装的 PostgreSQL 数据库的用户名。</p><p>出于性能原因，<span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 会直接访问 Tableau Server 存储库数据库。为了实现这一点，必须启用对存储库的访问，并为 <b>readonly</b> 数据库用户设置密码。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/perf_collect_server_repo.htm#Get" class="xref">启用对 Tableau Server 存储库的访问</a>。</p></td></tr><tr><td>--repository-password</td><td>是</td><td>Null</td><td><p>用于连接到随 Tableau Server 一起安装的 PostgreSQL 数据库的用户帐户的密码。</p><p>出于性能原因，<span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 会直接访问 Tableau Server 存储库数据库。为了实现这一点，必须启用对存储库的访问，并为 <b>readonly</b> 数据库用户设置密码。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/perf_collect_server_repo.htm#Get" class="xref">启用对 Tableau Server 存储库的访问</a>。</p></td></tr><tr><td>--repository-password-file</td><td>否，但如果您没有在命令提示符或脚本中直接提供密码，则为必需。</td><td>Null</td><td>包含用于连接到与 Tableau Server 一起安装的 PostgreSQL 数据库的用户帐户密码所在文件名的路径。</td></tr><tr><td>--repository-ssl-mode</td><td><p>否</p></td><td>首选</td><td><p>Tableau Server 存储库 SSL 模式：</p><p>选择“<b>首选</b>SSL”或“<b>需要</b> SSL”以配置与 Tableau 存储库的 SSL 连接。</p><p>选择<b>“禁用”</b>以从不使用 SSL 建立 Tableau Server 存储库连接。</p></td></tr><tr><td>--repository-ssl-thumbprint</td><td><p>否</p></td><td>Null</td><td>将 Tableau Server PostgreSQL 配置为允许直接连接时，Tableau Server 会创建证书和密钥。您可以选择提供 Tableau Server 生成的证书的指纹，也可以将 <b>server.crt</b> 文件复制到 Resource Monitoring Tool RMT Server 计算机。如果您选择复制证书文件，则不必提供指纹。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/ssl_config_direct_cx.htm" class="xref">配置 Postgres SSL 以允许从客户端直接连接</a>。</td></tr></tbody></table>

**示例：**`rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account> --gateway-url <Tableau Server Gateway URL> --version <Tableau Server version>`

## rmtadmin data-access

**注意**：版本 2022.3 中新增

启用或禁用对 PostgreSQL 数据库的访问。注意：从 Resource Monitoring Tool 版本 2022.3 开始，需要访问 PostgreSQL 数据库才能成功从 Tableau Server 收集所有监控数据。

**此命令仅适用于 RMT Server**

**注意：**必须重新启动 PostgreSQL 数据库，此配置才能生效。

### 概要

`rmtadmin data-access [positional parameter][options] [global option]`

### 位置参数

mode

必需。对 PostgreSQL 数据库进行远程数据访问时应使用的模式。值应为以下值之一：_None_、_ReadOnly_、_Admin_。设置为 _None_ 时，将禁用数据访问。ReadOnly 和 Admin 指定要使用哪个用户帐户访问数据库。.

### 选项

\--

**示例：**

`rmtadmin data-access ReadOnly`

`rmtadmin restart --db`

## rmtadmin delete-env

**注意**：版本 2021.2 中新增

删除特定环境以及为该环境收集的所有数据。它还移除有关环境正在监视的 Tableau Server 的连接和拓扑信息，并取消注册所有 Resource Monitoring Tool 代理。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin delete-env [positional parameter][options] [global option]`

### 位置参数

env

必需。这是系统生成的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

### 选项

\--confirm

可选。确认您想要删除环境。如果未提供此选项，则会提示您确认。

\--skip-agent-disconnect

可选。跳过与代理断开连接并继续取消注册代理。如果您认为代理不可访问，请使用此选项 - 举例来说，如果已移除 Tableau Server 节点或已在该节点上卸载代理。

**示例：**`rmtadmin delete-env <myenvironmentidentifier>`

## rmtadmin delete-env-data

永久删除为特定环境收集的所有 Tableau Server 相关数据。将不会移除环境配置、Tableau Server 信息和代理注册。

这对于清除环境中的所有现有数据非常有用，而无需移除环境本身。删除现有数据后，将继续处理代理发送的新数据。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin delete-env-data [positional parameter][option][global option]`

### 位置参数

env

应删除其数据的环境的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

### 选项

\--confirm

可选。确认您想要删除环境数据。如果未提供此选项，则会提示您确认。

**示例：**`rmtadmin delete-env-data <myenvironmentidentifier>`

## rmtadmin delete-server

**注意**：版本 2021.2 中新增

从环境中删除 Tableau Server 节点的配置信息，取消注册该节点上的代理，并删除针对该节点收集的所有监控数据。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin delete-server [options][global option]`

### 选项

\--env

必需。Tableau Server 节点连接到的环境的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

\--hostname

如果未指定 **\--all**，则需要该选项才能删除有关连接到环境的一个或多个主机的信息。

这是 Tableau Server 节点的计算机名称。如果指定多个主机名，请使用逗号分隔多个值。

\--all

可选，但如果未指定 **\--hostname** 则是必需的。

删除连接到环境的所有 Tableau Server 节点的信息。

\--skip-agent-disconnect

可选。跳过与代理断开连接并继续取消注册代理。如果代理不可访问，请使用此选项 - 举例来说，如果已从节点中移除 Tableau Server 或已在该节点上卸载代理。

\--confirm

确认您要删除有关 Tableau Server 节点的所有信息。如果未提供此选项，则会提示您确认。

**示例：**`rmtadmin delete-server --hostname=<machine name of the Tableau Server node>`

## rmtadmin delete-server-data

**注意**：版本 2021.2 中新增

删除从一个或多个 Tableau Server 节点收集的数据。移除的数据仅与指定的节点有关。如果指定 _all_ ，则将删除从所有节点收集的所有数据。将不会被删除环境配置、Tableau Server 信息和代理注册。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin delete-server-data [options][global option]`

### 选项

\--env

必需。Tableau Server 节点连接到的环境的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

\--hostname

如果未指定 **\--all**，则需要该选项才能删除有关连接到环境的一个或多个主机的信息。

这是 Tableau Server 节点的计算机名称。如果指定多个主机名，请使用逗号分隔多个值。

\--all

可选，但如果未指定 **\--hostname** 则是必需的。

删除连接到环境的所有 Tableau Server 节点的监控数据。

\--confirm

确认您要从 Tableau Server 节点中删除所有监控数据。如果未提供此选项，则会提示您确认。

**示例：**`rmtadmin delete-server-data --env=<myenvironmentidentifier> --all`

## rmtadmin delete-user

**注意：**版本 2024.2 中新增。

如果存在，则删除具有给定用户名的用户帐户。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin delete-user [options][global option]`

### 选项

\--username

要删除的用户帐户的用户名

**示例：**

rmtadmin delete-user --username=<username> 

## rmtadmin deregister

**注意**：版本 2021.2 中新增

从环境中取消注册代理。将不再收集来自该节点的监控数据。现有数据将保留且不会被删除。

**此命令仅在 RMT 代理上运行时有效。在要取消注册的代理上运行此命令。**

### 概要

`rmtadmin deregister [options]`

### 选项

\--confirm

可选。确认您想要取消注册代理。这会绕过确认提示。

\--ignore-master-errors

可选。忽略在此过程中与 RTM Server 通信时出现的任何错误。

**示例：**`rmtadmin deregister --confirm`

## rmtadmin deregister-agent

**注意**：版本 2021.2 中新增

从环境中取消注册指定的代理。将不再收集来自该节点的监控数据。现有数据将保留且不会被删除。

**此命令仅在 RMT Server 上运行时有效。**

### 概要

`rmtadmin deregister-agent [options][global option]`

### 选项

\--env

如果未指定 **\--key** 则为必需。

这是当前注册代理的环境的标识符。这是系统生成的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

\--key

如果已指定 **\--env** 则为可选。

这是代理密钥。使用逗号分隔多个值。您可以通过运行 [rmtadmin agents](#rmtadmin_agents) 命令来获取密钥值。

\--hostname

可选。安装代理的 Tableau Server 节点的计算机名称。使用逗号分隔多个值。

\--all

可选。使用此选项可在所有节点上取消注册代理。

\--ignore-agent-errors

可选。如果在此过程中无法与代理连接，则忽略发生的任何错误。

\--skip-agent-disconnect

可选。跳过与代理断开连接并继续取消注册代理。如果您认为代理不可访问，请使用此选项 - 举例来说，如果已从节点中移除 Tableau Server 或已在该节点上卸载代理。

\--confirm

可选。确认您想要取消注册代理。如果未提供此选项，则会提示您确认。

**示例：**`rmtadmin deregister-agent --env=<myenvironmentidentifier> --all`

## rmtadmin environments

**注意**：版本 2021.2 中新增

列出 Resource Monitoring Tool Server 上的所有环境。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin environments [global option]`

## rmtadmin get

获取指定配置键的值。

此命令既可在 RMT Server 上使用，也可在代理上使用。

### 概要

`rmtadmin get <config.key> [global option]`

### 位置参数

key

配置键的名称。

**示例：**`rmtadmin get db:database`

### 支持的配置键

<table><colgroup><col><col><col><col><col></colgroup><thead><tr class="header"><th>键</th><th>数据类型</th><th>适用于</th><th>默认值</th><th>描述</th></tr></thead><tbody><tr class="even"><td><code>auth:disableLocalAuthentication</code></td><td>布尔值</td><td>RMT Server</td><td>FALSE</td><td>如果为 TRUE，则不允许创建身份验证模式为 local 的用户。版本 2024.2 中新增</td></tr><tr class="even"><td><code>auth:disableUserManagementUI</code></td><td>布尔值</td><td>RMT Server</td><td>FALSE</td><td>如果设置为 TRUE，则不允许从 UI 进行用户管理。版本 2024.2 中新增</td></tr><tr class="even"><td><code>db:cleanup:batchSize</code><p>&nbsp;</p></td><td>整数</td><td>RMT Server</td><td>100000</td><td>PostgreSQL 清理操作期间每批删除的最大行数。版本 2025.3.4 中新增</td></tr><tr class="even"><td><code>db:database</code></td><td>字符串</td><td>RMT Server</td><td>tabrmtdb</td><td>RMT 使用的 PostgreSQL 数据库的名称。</td></tr><tr class="even"><td><code>db:readOnlyUsername</code></td><td>字符串</td><td>RMT Server</td><td>readonly</td><td>PostgreSQL 用户帐户的用户名，该用户帐户对 RMT 数据只有只读访问权限。</td></tr><tr class="even"><td><code>db:readOnlyPassword</code></td><td>字符串</td><td>RMT Server</td><td>由安装程序生成。</td><td>PostgreSQL 只读用户的密码。</td></tr><tr class="even"><td><code>monitoring:antiDomainLockoutEnabled</code></td><td>布尔值</td><td>RMT Server</td><td>TRUE</td><td>设置为 TRUE（默认值）时，将启用反域锁定功能。版本 2025.1.1 中新增。此功能允许您将 RMT 配置为在域锁定之前停止尝试登录。</td></tr><tr class="even"><td><code>monitoring:antiDomainLockoutTimeSeconds</code></td><td>整数</td><td>RMT Server</td><td>600</td><td>在再次尝试连接之前，所有连接 Tableau Server 的尝试都将受到限制的持续时间。版本 2025.1.1 中新增。</td></tr><tr class="even"><td><code>monitoring:antiDomainMaxFailedLoginAttempts</code></td><td>整数</td><td>RMT Server</td><td>3</td><td>为激活反域锁定，尝试登录 Tableau Server 连续失败次数的阈值。版本 2025.1.1 中新增。</td></tr><tr class="even"><td><code>mq:tls:certificateHostName</code></td><td>字符串</td><td>RMT Server 和代理</td><td>不适用</td><td>通过 TLS 连接到 RabbitMQ 时使用的证书中的主机名。</td></tr><tr class="even"><td><code>mq:tls:enabled</code></td><td>布尔值</td><td>RMT Server 和代理</td><td>FALSE</td><td>启用/禁用与 RabbitMQ 的 TLS 连接。</td></tr><tr class="even"><td><code>mq:port</code></td><td>整数</td><td>RMT Server 和代理</td><td>5672</td><td>RabbitMQ 主机端口号。</td></tr><tr class="even"><td><code>mq:virtualHost</code></td><td>字符串</td><td>RMT Server 和代理</td><td>tabrmt</td><td>与 RMT Server 或代理的连接。对于代理，您可以通过使用引导程序文件注册代理来修改此设置。对于 RMT Server，该值由安装程序管理。</td></tr><tr class="even"><td><code>server:web:responseheader</code></td><td>字符串</td><td>RMT Server</td><td>&nbsp;</td><td>查看特定的自定义响应标头。<p>有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/rmt-response-headers.htm" class="xref">Tableau Resource Monitoring Tool (RMT) 响应标头</a>。</p></td></tr><tr class="even"><td><code>server:web:responseheaders</code></td><td>字符串</td><td>RMT Server</td><td>&nbsp;</td><td>查看所有自定义响应标头。<p>有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/rmt-response-headers.htm" class="xref">Tableau Resource Monitoring Tool (RMT) 响应标头</a>。</p></td></tr><tr class="even"><td><code>server.web.run</code></td><td>布尔值</td><td>代理</td><td>TRUE</td><td>启用或禁用代理的 Web 接口</td></tr></tbody></table>

使用 [set](#heading--set) 命令更改当前配置值。

## rmtadmin get-user

**注意：**版本 2024.2 中新增。

如果用户帐户存在，则列出给定用户名的用户帐户详细信息。详细信息包括用户名、身份验证模式和角色权限。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin get-user [options][global option]`

### 选项

\--username

用户帐户的用户名。

**示例：**

rmtadmin get-user --username=<username> 

## rmtadmin help

显示有关命令行界面和可用命令的一般帮助。

**此命令既可在 RMT Server 上使用，也可在代理上使用。**

### 概要

`rmtadmin help`

显示特定命令的帮助和用法信息：

**此命令既可在 RMT Server 上使用，也可在代理上使用。**

`rmtadmin help [command]`

## rmtadmin master-setup

使用指定选项配置 RMT Server。在安装和安装后配置期间都使用。

### 概要

`rmtadmin master-setup [options][global option]`

下面列出了配置选项：

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 115px;"><col><col><col style="width: 234px;"></colgroup><thead><tr><th>选项</th><th>是否必需？</th><th>默认值</th><th>描述</th></tr></thead><tbody><tr><td>--admin-password</td><td><p>是（仅初始安装需要）</p><p>密码可以在命令行中提供，也可以提供包含要使用的密码的文件。如果未提供任何一项，系统将提示您输入密码。</p></td><td>不适用</td><td>管理员用户的密码。</td></tr><tr><td>--admin-password-file</td><td><p>是（仅初始安装需要）</p><p>密码可以在命令行中提供，也可以提供包含要使用的密码的文件。如果未提供任何一项，系统将提示您输入密码。</p></td><td>不适用</td><td>管理员用户的密码。</td></tr><tr><td>--admin-username</td><td>否</td><td>admin</td><td>管理员用户的用户名。</td></tr><tr><td>--skip-admin-creation<p><strong>新增：</strong>版本 2020.4.0</p><p><strong>已停用：</strong>版本 2022.3.0</p></td><td><p>否</p><p>此选项必须并且仅在安装后进行配置更新时使用。</p><p>在此选项有效的版本 (2020.4.0 - 2022.2.x) 中，如果此选项在安装后配置更新期间未使用，则命令将失败，并且不会进行更新。</p><p>在版本 2022.3.0 及更高版本中，该命令将在必要时创建管理员。</p></td><td>False</td><td><p>跳过创建管理员用户和密码的过程。</p></td></tr><tr><td>--http-port</td><td>否</td><td>80</td><td>&nbsp;</td></tr><tr><td>--require-https</td><td>否</td><td>False</td><td>将 http 流量重定向到 HTTPS。</td></tr><tr><td>--https-certificate-mode</td><td>否</td><td><p>'Default'</p><p>可用选项：</p><ul><li>默认值</li><li>存储（仅限 Windows）</li><li>本地</li></ul></td><td><p>要对 HTTPS 证书执行的证书搜索的类型。</p><p><b>默认</b>：此模式使用安装程序提供的默认自签名证书。</p><p><b>存储</b>：此模式允许您在 Windows 证书存储中输入证书的指纹。</p><p><b>本地</b>：允许您在 <b>config</b> 文件夹中指定基于文件的证书。</p></td></tr><tr><td>--https-certificate-store-thumbprint</td><td>否</td><td>Null</td><td>在“存储”证书模式下要搜索的 HTTPS 证书哈希/指纹。</td></tr><tr><td>--https-certificate-local-name</td><td>否</td><td><p>Null</p><p>注意：如果未指定，<span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 安装时将附带自签名证书，并将使用该证书进行 HTTPS 通信。</p></td><td>HTTPS 证书文件的名称。</td></tr><tr><td>--https-certificate-local-password</td><td>否</td><td>Null</td><td>用于 HTTPS 证书的密码。</td></tr><tr><td>--https-certificate-local-password-file</td><td>否</td><td>Null</td><td>包含用于 HTTPS 证书的密码的文件的路径。</td></tr><tr><td>--confirm</td><td>否</td><td>提示进行确认。</td><td>确认重新启动 RMT Server。</td></tr><tr><td>--host</td><td><p>否</p><p class="note"><b>注意</b>：我们不建议更改此值。</p></td><td>当前配置值或计算机名称。</td><td>用于访问 Resource Monitoring Tool 服务器的首选 URL。无论主机名如何，服务器都将侦听所有 IP。</td></tr><tr><td>--db-config=external</td><td>否</td><td>无。<br>只有在 RMT Server外部配置存储库时，才使用此选项。</td><td>使用此选项可将 RMT Server 配置为使用外部存储库。如果希望 PostgreSQL 数据库安装在本地，则不需要指定此选项。</td></tr><tr><td>--db-server</td><td>否</td><td>当前配置值或安装程序默认值。</td><td><p>这是与 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 一起安装的 PostgreSQL 数据库的服务器名称。</p><p>如果使用 AWS RDS 上托管的外部存储库，这应该是 RDS 实例名。</p></td></tr><tr><td><p>--db-ssl-mode</p><p>版本：版本 2023.1.0 中新增</p></td><td>否</td><td><code>Prefer</code></td><td><p>这决定了与 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 一起安装的 PostgreSQL 数据库的连接的 SSL/TLS 加密。</p><p>选项包括 <code>Prefer </code>（默认值）、<code>VerifyCA</code> 和 <code>VerifyFull</code>。有关详细信息，请参见 <a href="https://www.npgsql.org/doc/security.html?tabs=tabid-1#encryption-ssltls" target="_blank">Npgsql 文档</a>。</p></td></tr><tr><td>--db-port</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>数据库服务器的端口号。</td></tr><tr><td>--db-username</td><td>否</td><td>当前配置值或安装程序默认值。</td><td><p>用于连接到随 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 一起安装的 PostgreSQL 数据库的用户名。</p><p>如果使用 AWS RDS 上托管的外部存储库，这应该是“postgres”。</p></td></tr><tr><td>--db-password</td><td>否</td><td>当前配置值或安装程序默认值。</td><td><p>用于连接到随 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 一起安装的 PostgreSQL 数据库的用户帐户的密码。</p><p>如果使用 AWS RDS 上托管的外部存储库，这是您在创建 RDS 实例时创建的用户密码。</p></td></tr><tr><td>--mq-config=external</td><td>否</td><td>无 <br>只有在 RMT Server 外部托管消息服务时，才指定此选项。</td><td>该选项将 RMT Server 配置为使用外部 Rabbit MQ 消息服务。</td></tr><tr><td>--mq-server</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>消息队列服务器的名称。</td></tr><tr><td>--mq-port</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>消息队列端口。</td></tr><tr><td>--mq-vhost</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>消息队列虚拟主机。</td></tr><tr><td>--mq-username</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>用于连接到消息队列的用户名。</td></tr><tr><td>--mq-password</td><td>否</td><td>当前配置值或安装程序默认值。</td><td>用于连接到消息队列的用户帐户的密码。</td></tr><tr><td>--mq-enable-tls</td><td>否</td><td>当前配置值或 <b>false</b>。</td><td>需要 TLS 连接才能连接到消息队列。</td></tr><tr><td>--mq-tls-certificate-host</td><td>否</td><td>当前配置值或 <b>null</b>。</td><td>消息队列服务器的规范名称。此名称必须与证书上的名称匹配。</td></tr><tr><td>--password-salt</td><td>否</td><td>随机</td><td><p>用于对密码进行哈希处理的全局 salt 值。</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--password-min-length</td><td>否</td><td>当前配置值或 <b>10</b>。</td><td><p>密码的最小长度。</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--password-min-numeric</td><td>否</td><td>当前配置值或 <b>1</b>。</td><td><p>密码中所需的最小数字字符数。</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--password-min-special</td><td>否</td><td>当前配置值或 <b>1</b>。</td><td><p>The minimum required special characters in the password.</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--password-min-latin</td><td>否</td><td>当前配置值或 <b>5</b>。</td><td><p>密码中所需的最小拉丁字符数。</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--password-require-mixed-case</td><td>否</td><td>当前配置值或 <b>true</b>。</td><td><p>密码中需要混合大小写字符。</p><p>这适用于在 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 中创建的本地用户帐户。</p></td></tr><tr><td>--auth-timeout-minutes</td><td>否</td><td>当前配置值或 <b>240</b>。</td><td>会话的用户身份验证到期前的分钟数。</td></tr><tr><td>--auth-sliding-expiration</td><td>否</td><td>当前配置或 <b>true</b>。</td><td>是否重置用户活动的身份验证超时期限。</td></tr></tbody></table>

**示例：**

**指定管理员密码：**`rmtadmin master-setup --admin-password=<password> --skip-admin-creation`

**在安装之后更新端口：** `rmtadmin master-setup --http-port=8000 --skip-admin-creation`

## rmtadmin passwd

重设特定 Resource Monitoring Tool 用户帐户的密码。

此命令仅适用于 RMT Server。

### 概要

`rmtadmin passwd [positional parameter][global option]`

### 位置参数

username

要更改其密码的用户的名称。

**示例：**`rmtadmin passwd <username>`

## rmtadmin query

对 Resource Monitoring Tool 数据库执行原始 SQL 查询，并将结果保存到输出文件。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin query [positional parameter][options] [global option]`

### 位置参数

sql

要运行的 SQL 命令文本。您可以提供多个 SQL 命令。若要将文件与 SQL 命令一起使用，请使用 **@** 作为文件名称的前缀。

### 选项

\--outfile=值

要输出查询结果的 zip 文件的名称。默认值为 _queryresults.zip_

\--force

覆盖现有文件。

\--timeout=值

查询的超时。以秒为单位指定

\--commit

提交 SQL 命令对数据库所做的任何更改。默认情况下，SQL 命令作为事务运行，但在完成时回滚。

**示例：**`rmtadmin query <SQLCommand> --outfile=<path and the output file name>`

## rmtadmin register

**注意**：版本 2020.2 中新增

使用引导程序文件注册代理。可以使用 [rmtadmin bootstrap-file](#rmtadmin_bootstrap_file) 命令下载引导程序文件。

此命令只能在代理上使用，并且应在要安装代理的计算机上运行。

### 概要

`rmtadmin register [options][positional parameter] [global option]`

### 位置参数

引导程序

包括引导程序文件名称的文件路径。

### 选项

\--username

必需。在 RMT Server 安装期间创建的管理员用户的名称。

\--password

必需。用户帐户的密码。

\--password-file

包含密码信息的文件名的路径。密码可以在命令行中提供，或者在包含密码的文件中提供。如果未提供任何一项，系统将提示您输入密码。

\--server-name

安装代理的节点的名称。如果未指定名称，则默认为计算机名称。

\--server-description

服务器的自定义描述。

**示例：**`rmtadmin register <bootstrap file name and path> --server-name=<server name>`

## rmtadmin restart

重新启动 Resource Monitoring Tool 应用程序。当从安装了 RMT Server 的计算机上运行时，它会重新启动 RMT Server 应用程序。在安装了代理的节点上运行时，它只会重新启动该特定节点上的代理应用程序。

此命令既可从 RMT Server 运行，也可从代理运行。

**注意：**RMT Server 不支持远程代理重新启动。 `--agent` 选项仅在代理节点上本地工作。如果您有多个代理，则必须直接在每个代理主机上运行 `rmtadmin restart --agent`（或 `rmtadmin restart`）。

### 概要

`rmtadmin restart [options] [global option]`

### 选项

如果未指定任何选项，则该命令的行为就像使用了 `-all` 一样：

**RMT Server：**

\--all

重新启动所有服务。

重新启动 RMT Server。

\--mq

重新启动消息队列服务。

\--db

重新启动数据库服务。

**代理：**

\--agent

重新启动计算机上运行的代理服务。

**示例：**`rmtadmin restart --db`

## rmtadmin rotate-mq-certificate

在代理计算机上轮换代理消息队列客户端证书。在 Server 计算机上运行 `rmtadmin rotate-mq-certificate` 后运行此命令。

此命令必须从 RMT 代理中运行。

### 概要

`rmtadmin rotate-mq-certificate [options] [positional parameter]`

### 位置参数

引导程序

包括引导程序文件名称的文件路径。

### 选项

\--username

必需。主服务器的用户名。

\--password

必需。主服务器用户帐户的密码。

\--password-file

包含主服务器密码信息的文件名的路径。密码可以在命令行中提供，或者在包含密码的文件中提供。如果未提供任何一项，系统将提示您输入密码。

\--confirm-restart

确认服务重新启动并绕过确认提示。

## rmtadmin rotate-mq-certificates

在 Server 计算机上轮换消息队列服务器和客户端证书。

此命令必须从 RMT Server 中运行。

### 概要

`rmtadmin rotate-mq-certificates [options]`

### 选项

\--confirm-restart

确认服务重新启动并绕过确认提示。

## rmtadmin servers

**注意**：版本 2021.2 中新增

列出所有环境或特定环境中的所有 Tableau Server 节点。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin servers [positional parameter][global option]`

### 位置参数

env

可选。指定环境标识符以获取在该环境中注册的 Tableau Server 节点的列表。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

## rmtadmin service-setup

**注意：**版本 2021.4 中新增。用于安装或更新 Resource Monitoring Tool 服务的用户凭证，这些服务包括 RMT Server、代理、Rabbit MQ 和 PostgreSQL 数据库。这对于在安装后更新服务信息很有用。

**此命令既可在 RMT Server 上工作，也可在 Windows 上安装的代理上工作。**

### 概要

`rmtadmin service-setup [positional parameter][options][global option]`

### 位置参数

至少必须指定以下值之一：

所有

更新所有可用的服务。可以在 RMT 和代理上上运行。在 Tableau Server 节点上运行时，更新该节点上的代理。

master

更新 RMT Server。

agent

更新代理。只能在代理（Tableau Server 节点）上运行。

db

更新数据库服务。只能在 RMT Server 上运行。

mq

更新消息队列服务。只能在 RMT Server 上运行。

### 选项

\--confirm

可选。确认您想要进行更新。可以在 RMT 和代理上上运行。在 Tableau Server 节点上运行时，更新该节点上的代理。

\--user-type

RMT Server 和代理需要。用于运行 RMT Server 或代理的帐户类型。允许的值为：

- 虚拟帐户（仅限 RMT Server）
- network-service
- local-system
- local-service
- 用户名（本地或域用户帐户的用户名）

\--username

指定帐户的用户名。如果使用本地或域用户帐户，则为必需。

\--password

指定帐户的密码。如果使用本地或域用户帐户，则为必需。

\--password-file

可选。文件位置的路径，包括存储密码信息的文件名。

\--append-permissions

可选。附加新权限。如果您不想覆盖现有权限，请使用此选项。

## rmtadmin set

设置指定配置键的值。

**此命令既可在 RMT Server 上工作，也可在代理上工作。**

### 概要

`rmtadmin set [positional parameter] [global option]`

### 位置参数

key

要更改其值的配置键。

value

\--master

要使用的新值。

**示例：**`rmtadmin set mq:port <port number>`，其中 mq:port 是键， <port number> 是值。

### 支持的配置键

<table><colgroup><col><col><col><col><col></colgroup><thead><tr class="header"><th>键</th><th>数据类型</th><th>适用于</th><th>默认值</th><th>描述</th></tr></thead><tbody><tr class="even"><td><code>auth:disableLocalAuthentication</code></td><td>布尔值</td><td>RMT Server</td><td>FALSE</td><td>将其设置为 true 时，不允许创建身份验证模式为 local 的用户。版本 2024.2 中新增</td></tr><tr class="even"><td><code>auth:disableUserManagementUI</code></td><td>布尔值</td><td>RMT Server</td><td>FALSE</td><td>将其设置为 true 时，不允许从 UI 进行用户管理。版本 2024.2 中新增</td></tr><tr class="even"><td><code>db:cleanup:batchSize</code><p>&nbsp;</p></td><td>整数</td><td>RMT Server</td><td>100000</td><td>PostgreSQL 删除清理操作期间每批删除的最大行数。如果您的安装非常大，数据库中有数十万或数百万个陈旧行，则增加此值以加快数据库清理速度。版本 2025.3.4 中新增。</td></tr><tr class="even"><td><code>monitoring:antiDomainLockoutEnabled</code></td><td>布尔值</td><td>RMT Server</td><td>TRUE</td><td>设置为 TRUE（默认值）时，将启用反域锁定功能。版本 2025.1.1 中新增。</td></tr><tr class="even"><td><code>monitoring:antiDomainLockoutTimeSeconds</code></td><td>整数</td><td>RMT Server</td><td>600</td><td>在再次尝试连接之前，所有连接 Tableau Server 的尝试都将受到限制的持续时间。版本 2025.1.1 中新增。</td></tr><tr class="even"><td><code>monitoring:antiDomainMaxFailedLoginAttempts</code></td><td>整数</td><td>RMT Server</td><td>3</td><td>为激活反域锁定，尝试登录 Tableau Server 连续失败次数的阈值。版本 2025.1.1 中新增。</td></tr><tr class="even"><td><code>mq:tls:certificateHostName</code></td><td>字符串</td><td>RMT Server 和代理</td><td>不适用</td><td>通过 TLS 连接到 RabbitMQ 时使用的证书中的主机</td></tr><tr class="even"><td><code>mq:tls:enabled</code></td><td>布尔值</td><td>RMT Server 和代理</td><td>FALSE</td><td>启用/禁用与 RabbitMQ 的 TLS 连接</td></tr><tr class="even"><td><code>mq:port</code></td><td>整数</td><td>RMT Server 和代理</td><td>5672</td><td>RabbitMQ 主机端口号。</td></tr><tr class="even"><td><code>server:web:responseheader</code></td><td>字符串</td><td>RMT Server</td><td>&nbsp;</td><td>设置特定自定义响应标头的值。<p>有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/rmt-response-headers.htm" class="xref">Tableau Resource Monitoring Tool (RMT) 响应标头</a>。</p></td></tr><tr class="even"><td><code>server:web:responseheaders</code></td><td>字符串</td><td>RMT Server</td><td>&nbsp;</td><td>设置多个自定义响应标头的值。<p>有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/rmt-response-headers.htm" class="xref">Tableau Resource Monitoring Tool (RMT) 响应标头</a>。</p></td></tr><tr class="even"><td><code>server.web.run</code></td><td>布尔值</td><td>代理</td><td>TRUE</td><td>启用或禁用代理的 Web 接口。</td></tr></tbody></table>

### 选项

\--backup

在进行更改之前创建配置文件的备份。

使用 [get](#heading--get) 命令查看当前配置值。

## rmtadmin start

启动 Resource Monitoring Tool 服务。当此命令在 RMT Server 上运行时，它将仅启动 RMT Server。在代理上运行时，它将在运行命令的计算机上启动代理。

此命令既可在 RMT Server 上工作，也可在代理上工作

### 概要

`rmtadmin start [options] [global option]`

### 选项

至少必须指定一个选项：

**RMT Server：**

\--all

启动所有服务。

\--master

启动 RMT Server。

\--mq

启动消息队列服务。

\--db

启动数据库服务。

**代理：**

\--agent

启动计算机上运行的代理服务。

**示例：**`rmtadmin start --all`

## rmtadmin status

在运行此命令的计算机上检查应用程序和正在运行的服务的状态。对于 RMT Server，状态报告确认 RMT Server 已连接到数据库和消息队列。对于代理，状态报告确认代理已连接到 RMT Server。

**此命令既可在 RMT Server 上运行，也可在代理上运行。**

此命令返回以下信息：

- 应用程序状态（是否正在运行）
- 许可证状态
- MQ 连接
- 队列详细信息
- 使用的内存
- 使用的磁盘空间
- 计算机上的 Tableau Server 版本
- 存储在代理配置文件中的 Tableau Server 进程拓扑。

从版本 2024.2.0 开始，在 RMT Server 上运行时，该命令返回：

- 如果本地数据库中的消息传递表使用的空间超过警告阈值 (4 GB)，则会出现磁盘空间使用情况警告。有关详细信息，请参见[排查消息传递表磁盘使用情况警告问题](https://help.tableau.com/current/server/zh-cn/rmt-troubleshoot-messaging-table-disk-usage-warning.htm)

### 概要

`rmtadmin status [global option]`

## rmtadmin stop

停止 Resource Monitoring Tool 服务。当此命令在 RMT Server 上运行时，它只会停止 RMT Server。在安装 Agent 的计算机上运行时，它只会停止该计算机上的代理。

**此命令既可在 RMT Server 上运行，也可在代理上运行。**

### 概要

`rmtadmin stop [options] [global option]`

### 选项

至少必须指定一个选项：

**RMT Server：**

\--all

停止所有服务。

\--master

停止 RMT Server。

\--mq

停止消息队列服务。

\--db

停止数据库服务。

**代理：**

\--agent

停止计算机上运行的代理服务。

**示例：**`rmtadmin stop --db`

## rmtadmin test-env

**注意**：版本 2021.2 中新增

测试 Resource Monitoring Tool 和 Tableau Server 之间的各种连接点。这包括测试 Tableau Server 存储库连接、Tableau Server API 连接和 Advanced Management 功能。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin test-env [positional parameter][global option]`

### 位置参数

\--env

可选。Resource Monitoring Tool 正在监控的环境的标识符。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

\--force

可选。即使没有足够的数据可用，也可以使用此选项立即更新基线。默认情况下，该命令将等待 50 次成功加载来计算基线

## rmtadmin update-baseline

**注意：**版本 2021.4 中新增

更新所有视图加载的基线。基线是视图的 50 次成功初始加载的第 95 个百分位。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin update-baseline [options][global option]`

### 选项

env

必需。这是系统生成的标识符。您可以通过转到“**Admin**”>“**Environments**”**\>“****Edit Environment**”来找到此标识符。在此页面上的“**Environment Details**”部分，您将看到适用于该环境的标识符。

## rmtadmin update-env

**注意**：版本 2021.2 中新增

更新环境设置。

**此命令仅适用于 RMT Server。**

### 概要

`rmtadmin update-env [options][global option]`

### 选项

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 115px;"><col><col style="width: 234px;"></colgroup><thead><tr><th>选项</th><th>是否必需？</th><th>描述</th></tr></thead><tbody><tr><td>--non-interactive</td><td><p>否</p><p></p></td><td>禁用所有交互式提示。</td></tr><tr><td>--no-test</td><td><p>否</p><p></p></td><td>禁用测试 API 和存储库连接。</td></tr><tr><td>--name</td><td>是</td><td>环境的名称。</td></tr><tr><td>--id</td><td>否</td><td>Web 界面 URL 中使用的环境标识符。 <p>这是系统生成的标识符。您可以通过转到“<b>Admin</b>”&gt;“<b>Environments</b>”<b>&gt;“</b><b>Edit Environment</b>”来找到此标识符。在此页面上的“<b>Environment Details</b>”部分，您将看到适用于该环境的标识符。</p></td></tr><tr><td>--gateway-url</td><td><p>否</p><p>&nbsp;</p></td><td><p>用于访问 Tableau Server 网关的 URL。</p></td></tr><tr><td>--version</td><td>否</td><td>此环境将监控的 Tableau Server 版本。</td></tr><tr><td>--api-username</td><td>否</td><td>用于连接到 Tableau Server API 的帐户的用户名。用户帐户应该是可以访问所有 Tableau Server 站点的 Tableau Server 管理员。</td></tr><tr><td>--api-password</td><td>否</td><td><p>用于连接到 Tableau Server API 的 Tableau Server API 用户帐户的密码。</p></td></tr><tr><td>--api-password-file</td><td>否</td><td>包含 Tableau Server API 用户帐户密码的文件的路径。</td></tr><tr><td>--repository-server</td><td>否</td><td>这是与 <span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 一起安装的 PostgreSQL 数据库的服务器名称。</td></tr><tr><td>--repository-port</td><td>否</td><td>Tableau Server 存储库数据库的的端口号。</td></tr><tr><td>--repository-username</td><td>否</td><td><p>用于连接到随 Tableau Server 存储库一起安装的 PostgreSQL 数据库的用户名。</p><p>出于性能原因，<span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 会直接访问 Tableau Server 存储库数据库。为了实现这一点，必须启用对存储库的访问，并为 <b>readonly</b> 数据库用户设置密码。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/perf_collect_server_repo.htm#Get" class="xref">启用对 Tableau Server 存储库的访问</a>。</p></td></tr><tr><td>--repository-password</td><td>否</td><td><p>用于连接到随 Tableau Server 一起安装的 PostgreSQL 数据库的用户帐户的密码。</p><p>出于性能原因，<span class="mc-variable Variables.PT_server variable">Resource Monitoring Tool</span> 会直接访问 Tableau Server 存储库数据库。为了实现这一点，必须启用对存储库的访问，并为 <b>readonly</b> 数据库用户设置密码。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/perf_collect_server_repo.htm#Get" class="xref">启用对 Tableau Server 存储库的访问</a>。</p></td></tr><tr><td>--repository-password</td><td>否</td><td>包含用于连接到与 Tableau Server 一起安装的 PostgreSQL 数据库的用户帐户密码所在文件名的路径。</td></tr><tr><td>--repository-ssl-mode</td><td><p>否</p></td><td><p>Tableau Server 存储库 SSL 模式：</p><p>选择“<b>首选</b>SSL”或“<b>需要</b> SSL”以配置与 Tableau 存储库的 SSL 连接。</p><p>选择<b>“禁用”</b>以从不使用 SSL 建立 Tableau Server 存储库连接。</p></td></tr><tr><td>--repository-ssl-thumbprint</td><td><p>否</p></td><td>将 Tableau Server PostgreSQL 配置为允许直接连接时，Tableau Server 会创建证书和密钥。您可以选择提供 Tableau Server 生成的证书的指纹，也可以将 <b>server.crt</b> 文件复制到 Resource Monitoring Tool RMT Server 计算机。如果您选择复制证书文件，则不必提供指纹。有关详细信息，请参见<a href="https://help.tableau.com/current/server/zh-cn/ssl_config_direct_cx.htm" class="xref">配置 Postgres SSL 以允许从客户端直接连接</a>。</td></tr></tbody></table>

**示例：**`rmtadmin update-env --name=<new name>`

## rmtadmin users

显示 Resource Monitoring Tool 用户帐户的列表。

此命令仅适用于 RMT Server。

### 概要

`rmtadmin users`

## rmtadmin version

在 RMT Server 上运行时，显示 RMT Server 的当前版本信息。它显示运行命令的计算机上安装的代理的当前版本信息。

**此命令既可在 RMT Server 上运行，也可在代理上运行。**

### 概要

`rmtadmin version`

## rmtadmin ziplogs

创建包含 Resource Monitoring Tool 日志文件的 ZIP 存档文件。

**此命令既可 RMT Server 上工作，也可在代理上工作，但仅包括运行命令的应用程序的日志文件。**

### 概要

`rmtadmin ziplogs [positional parameter] [option] [global option]`

### 位置参数

filename

输出 zip 文件的名称。如果未提供名称，默认值为 log.zip。

### 选项

\--force

覆盖现有文件。

**示例：**`rmtadmin ziplogs <zip file name> --force`

## 全局选项

\--help

显示命令帮助。