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命令列公用程式，某些命令可能會有所不同。例如，只有RMT Server才可以使用users命令。任何位置皆可使用ziplogs命令，但包含的記錄檔只會來自執行命令的應用程式。
以下是可與 rmtadmin 命令列搭配使用的命令：
附註：rmtadmin 命令會同時使用位置參數和選項。
只能使用數值指定位置參數。不需要指定實際的關鍵字。使用等號指定選項關鍵字和數值。
範例： rmtadmin <command> <positional parameter value> --<option keyword>=<value>
- rmtadmin agents
- rmtadmin bootstrap-file
- rmtadmin cleanup
- rmtadmin create-admin-user
- rmtadmin create-env
- rmtadmin delete-env
- rmtadmin data-access
- rmtadmin delete-env-data
- rmtadmin delete-server
- rmtadmin delete-server-data
- rmtadmin deregister-agent
- rmtadmin environments
- rmtadmin get
- rmtadmin help
- rmtadmin master-setup
- rmtadmin passwd
- rmtadmin query
- rmtadmin register
- rmtadmin restart
- rmtadmin rotate-mq-certificate
- rmtadmin rotate-mq-certificates
- rmtadmin-servers
- rmtadmin-service-setup
- rmtadmin set
- rmtadmin start
- rmtadmin stop
- rmtadmin status
- rmtadmin test-env
- rmtadmin update-baseline
- rmtadmin update-env
- rmtadmin users
- rmtadmin version
- rmtadmin ziplogs
為了致力於符合本公司平等的價值觀，我們已盡可能變更了非包容性術語。由於在某些地方變更字詞可能會導致重大變更，因此我們保留現有字詞：因此，您可能會繼續在 CLI 命令和選項、安裝程式資料夾、組態檔和其他執行個體中看到這些術語，有關詳情，請參閱關於 Tableau 說明(連結在新視窗開啟)。
rmtadmin agents
附註：版本 2021.2 中新增
列出全部環境在 Tableau Server 節點上所有註冊的代理程式。
這對於查看Resource Monitoring Tool代理程式安裝在 Tableau Server 上的位置非常有用。
此命令僅適用於 RMT Server。
概要
rmtadmin agents [options][global option]
選項
--env
可選：使用此選項查看特定環境的代理程式清單。這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments >
--keys
可選：在輸出中包含代理程式金鑰。
範例：rmtadmin agents --env=<myenvironmentidentifier> --keys
rmtadmin bootstrap-file
附註：版本 2021.2 中新增
建立並儲存用在 Tableau Server 節點上註冊代理程式的啟動程序檔。
啟動程序檔案將被建立並儲存到指定的絕對路徑或相對路徑。相對路徑被解析為當前工作目錄。
此命令僅適用於 RMT Server。
概要
rmtadmin bootstrap-file [options][global option]
選項
--env
必要。這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments >
Tableau Server 節點上的代理程式一次只能註冊到一個環境。--filename
可選。包含檔名的絕對或相對路徑。相對路徑被解析為當前工作目錄。如果未指定，則使用預設的輸出檔名。
--force
可選。覆寫具有相同名稱的現有檔案。
範例：rmtadmin bootstrap-file --env=<myenvironmentidentifier>
rmtadmin cleanup
附註：版本 2021.2 中新增
刪除超過特定天數的記錄檔。預設刪除超過 31 天的記錄檔。
此命令可用於 RMT Server 和代理程式。
附註：如果Resource Monitoring Tool程序正在執行，有效記錄檔將不會被該命令清除。如果要確保刪除所有檔案，則需使用rmtadmin_stop命令停止 RMT，然後使用以下命令執行清理，rmtadmin cleanup --log-files-retention=0 ，然後使用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]
選項
| 選項 | 是否為必要項目？ | 預設值 | 說明 |
|---|---|---|---|
| --name | 是 | 不適用 | 環境的名稱。 |
| --gateway-url | 是
| 不適用 | 用於存取 Tableau Server 閘道的 URL。 |
| --version | 是 | 不適用 | 此環境將監控的 Tableau Server 版本。 |
| --non-interactive | 否 | 互動提示預設為啟用。 | 禁用所有互動式提示。 |
| --no-test | 否 | API 和存放庫連線測試預設為啟用。 | 禁用測試 API 和存放庫連線。 |
| --api-username | 否 | Null | 用於連接 Tableau Server API 的帳戶使用者名稱。使用者帳戶應該是可以存取所有 Tableau Server 網站的 Tableau Server 管理員。 |
| --api-password | 否 （如果指定 Tableau API 使用者名稱，則需提供密碼，或指定檔案路徑和具有密碼的檔案） | Null | 用來連接 Tableau Server API 的 Tableau Server API 使用者帳戶密碼。 |
| --admin-password-file | 否 | Null | 檔案的路徑和包含 Tableau Server API 使用者帳戶密碼的檔案名稱。 |
| --repository-server | 是 | Null | 這是隨 Tableau Server 安裝的 PostgreSQL 資料庫的伺服器名稱。 |
| --repository-database | 是 | Null | 這是隨 Tableau 的 PostgreSQL 資料庫的伺服器名稱。 |
| --repository-port | 是 | Null | Tableau Server 存放庫資料庫的連接埠號碼。 |
| --repository-username | 是 | Null | 用於連線到隨 Tableau Server 存放庫安裝的 PostgreSQL 資料庫的使用者名稱。 基於效能考量，Resource Monitoring Tool 要直接存取 Tableau Server 存放庫資料庫。為求順利使用，必須啟用存放庫存取，並為唯讀資料庫使用者設定密碼。有關詳情，請參閲啟用對 Tableau Server 存放庫的存取。 |
| --repository-password | 是 | Null | 用於連線到隨 Tableau Server 安裝的 PostgreSQL 資料庫的使用者帳戶密碼。 基於效能考量，Resource Monitoring Tool 要直接存取 Tableau Server 存放庫資料庫。為求順利使用，必須啟用存放庫存取，並為唯讀資料庫使用者設定密碼。有關詳情，請參閲啟用對 Tableau Server 存放庫的存取。 |
| --repository-password-file | 否，但如果沒有在命令提示字元或指令碼中直接提供密碼，則需要。 | Null | 包含檔案名稱的路徑，其中具有使用者帳戶的密碼，用於連線到隨 Tableau Server 安裝的 PostgreSQL 資料庫。 |
| --repository-ssl-mode | 否 | 偏好 | Tableau Server 存放庫 SSL 模式： 偏好SSL 或需要SSL 來設定 SSL 連線到 Tableau 存放庫。 禁用來禁止使用 SSL 連線到 Tableau Server 存放庫。 |
| --repository-ssl-thumbprint | 否 | Null | 將 Tableau Server PostgreSQL 設定為允許直接連線時，Tableau Server 會建立憑證和金鑰。可以選擇為 Tableau Server 產生的憑證提供指紋，或將 server.crt 檔案複製到「Resource Monitoring Tool 伺服器」電腦。若選擇複製憑證檔案，則不必提供指紋。有關詳情，請參閱設定 Postgres SSL 以允許從用戶端直接連線。 |
範例：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 資料庫的存取。注意：從 2022.3 版本開始需要存取 PostgreSQL 資料庫以讓 Resource Monitoring Tool 從 Tableau Server 成功收集所有監視資料。
此命令僅適用於 RMT Server
注意：此設定必須重啟 PostgreSQL 資料庫才能生效。
概要
rmtadmin data-access [positional parameter][options] [global option]
位置參數
模式
必需。用於對 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 >
選項
--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 >
選項
--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 >
--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 >
--hostname
如果未指定--all，則需要刪除與環境連線的一個或多個資料。
這是 Tableau Server 節點的電腦名稱。如果指定多個主機名稱，請使用逗號分隔多個數值。
--all
可選，但如果未指定--hostname，則是必要的。
刪除連接到環境的所有 Tableau Server 節點的監控資料。
--confirm
確認想要從 Tableau Server 節點中刪除的所有監控資料。如果未提供選項，則會提示您進行確認。
範例：rmtadmin delete-server-data --all
rmtadmin register
附註：版本 2021.2 中新增
從環境中註銷代理程式。不再收集此節點的監控資料。現有資料將保留且不會被刪除。
此命令僅適用於在 RMT 代理程式中執行。在要取消註冊的代理程式上執行此命令。
概要
rmtadmin deregister [options]
選項
--confirm
可選。確認想要取消註冊的代理程式。這會繞過確認提示。
--ignore-master-errors
可選。如果在此過程中無法與 RTM 伺服器通訊，則忽略發生的任何錯誤。
範例：rmtadmin deregister --confirm
rmtadmin deregister-agent
附註：版本 2021.2 中新增
從該環境中取消註冊代理程式。不再收集此節點的監控資料。現有資料將保留且不會被刪除。
此命令僅適用於在 RMT 伺服器中執行。
概要
rmtadmin deregister-agent [options][global option]
選項
--env
如果未指定--key，則是必要的。
這是目前註冊代理程式之環境的識別碼。這是系統產生的識別碼。這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments >
--key
若已指定 --env，則為可選。
這是代理程式金鑰。使用逗號分隔多個數值。可以透過執行rmtadmin 代理程式命令來獲取金鑰值。
--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
支援的組態機碼
| 主要 | 資料類型 | 適用於 | 預設值 | 說明 |
|---|---|---|---|---|
db:database | 字串 | RMT Server | tabrmtdb | RMT 使用的 PostgreSQL 資料庫名稱。 |
db:readOnlyUsername | 字串 | RMT Server | readonly | PostgreSQL 使用者帳戶的使用者名稱，該使用者帳戶對 RMT 資料只有唯讀存取權。 |
db:readOnlyPassword | 字串 | RMT Server | 由安裝程式產生。 | PostgreSQL 唯讀使用者的密碼。 |
mq:tls:certificateHostName | 字串 | RMT Server 與代理程式 | 不適用 | 透過 TLS 連線到 RabbitMQ 時，憑證中使用的主機名稱。 |
mq:tls:enabled | 布林值 | RMT Server 與代理程式 | FALSE | 啟用/停用與 RabbitMQ 的 TLS 連線。 |
mq:port | 整數 | RMT Server 與代理程式 | 5672 | RabbitMQ 主機連接埠號碼。 |
mq:virtualHost | 字串 | RMT Server 與代理程式 | tabrmt | 連線到 RMT Server 或代理程式。對於代理程式，您可以藉由使用啟動程序檔案來註冊代理程式，修改此設定。對於 RMT Server，此值是由安裝程式管理。 |
server.web.run | 布林值 | 代理程式 | TRUE | 啟用或停用代理程式的 Web 介面。 |
使用 set 命令來變更目前的組態值。
rmtadmin help
顯示命令列介面及可用命令的一般說明。
此命令可用於 RMT Server 和代理程式。
概要
rmtadmin help
顯示特定命令的說明和使用情況資訊：
此命令可用於 RMT Server 和代理程式。
rmtadmin help [command]
rmtadmin master-setup
使用指定的選項設定 RMT Server。在安裝和安裝後設定期間均使用。
概要
rmtadmin master-setup [options][global option]
設定選項如下所示：
| 選項 | 是否為必要項目？ | 預設值 | 說明 |
|---|---|---|---|
| --admin-password | 是（僅對於初始安裝是必需的） 密碼可以在命令列中提供，也可以提供包含密碼的檔案以供使用。若兩者均未提供，系統會提示您輸入密碼。 | 不適用 | 管理員使用者的密碼。 |
| --admin-password-file | 是（僅對於初始安裝是必需的） 密碼可以在命令列中提供，也可以提供包含密碼的檔案以供使用。若兩者均未提供，系統會提示您輸入密碼。 | 不適用 | 管理員使用者的密碼。 |
| --admin-username | 否 | admin | 管理員使用者的使用者名稱。 |
| --skip-admin-creation 已新增：版本 2020.4.0 已淘汰： 版本 2022.3.0 | 否 此選項必須並且僅在安裝後進行設定更新時才使用。 在此選項有效的版本 (2020.4.0 - 2022.2.x) 中，若在安裝後設定更新期間未使用，則該命令將失敗並且不會進行任何更新。 在版本 2022.3.0 及更高版本中，該命令將在必要時建立管理員。 | False | 跳過建立管理員使用者和密碼。 |
| --http-port | 否 | 80 | |
| --require-https | 否 | False | 將 HTTP 流量重新導向 HTTPS。 |
| --https-certificate-mode | 否 | 「預設」 可用選項：
| 為 HTTPS 憑證執行的憑證類型搜尋。 預設值：此模式使用安裝程式提供的預設自我簽署憑證。 儲存：可在 Windows 憑證儲存區中輸入憑證的指紋。 本機：允許您在 config 資料夾中指定檔案型憑證。 |
| --https-certificate-store-thumbprint | 否 | Null | 在「儲存」憑證模式下要搜尋的 HTTPS 憑證雜湊/ 指紋。 |
| --https-certificate-local-name | 否 | Null 附註：若未指定，Resource Monitoring Tool 會使用自我簽署憑證進行安裝，並將使用該憑證進行 HTTPS 通訊。 | HTTPS 憑證檔案的名稱。 |
| --https-certificate-local-password | 否 | Null | HTTPS 憑證的密碼。 |
| --https-certificate-local-password-file | 否 | Null | 包含 HTTPS 憑證密碼的檔案路徑 |
| --confirm | 否 | 提示確認。 | 確認重新啟動 RMT Server。 |
| --host | 否 附註：不建議變更此值。 | 目前設定值或電腦名稱。 | 存取 Resource Monitoring Tool 伺服器的慣用 URL。無論主機名稱為何，伺服器都會接聽所有 IP。 |
| --db-config=external | 否 | 無。 這僅在存放庫設定在 RMT 伺服器外部時使用。 | 使用它來設定 RMT 伺服器以使用外部存放庫。如果希望將 PostgreSQL 資料庫安裝在本機，則無需指定此項。 |
| --db-server | 否 | 目前設定值或安裝程式預設值。 | 這是隨 Resource Monitoring Tool 安裝的 PostgreSQL 資料庫的伺服器名稱。 如果使用託管在 AWS RDS 上的外部存放庫，則這應該是 RDS 執行個體名稱。 |
--db-ssl-mode 版本：在版本 2023.1.0 中新增 | 否 | Prefer | 這可以決定隨 Resource Monitoring Tool 安裝的 PostgreSQL 資料庫連線的 SSL/TLS 加密。 選項為 |
| --db-port | 否 | 目前設定值或安裝程式預設值。 | 資料庫伺服器的連接埠號。 |
| --db-username | 否 | 目前設定值或安裝程式預設值。 | 用於連線到隨 Resource Monitoring Tool 安裝的 PostgreSQL 資料庫的使用者名稱。 如果使用託管在 AWS RDS 上的外部存放庫，則應為「postgres」。 |
| --db-password | 否 | 目前設定值或安裝程式預設值。 | 用於連線到隨 Resource Monitoring Tool 安裝的 PostgreSQL 資料庫的使用者帳戶的密碼。 如果您使用託管在 AWS RDS 上的外部存放庫，則這是您在建立 RDS 執行個體時建立的使用者密碼。 |
| --mq-config=external | 否 | 無 僅當訊息傳遞服務託管在 RMT 伺服器外部時才指定此選項。 | 此選項將 RMT 伺服器設定為使用外部 Rabbit MQ 訊息傳遞服務。 |
| --mq-server | 否 | 目前設定值或安裝程式預設值。 | 訊息佇列伺服器的名稱。 |
| --mq-port | 否 | 目前設定值或安裝程式預設值。 | 訊息佇列連接埠。 |
| --mq-vhost | 否 | 目前設定值或安裝程式預設值。 | 訊息佇列虛擬主機。 |
| --mq-username | 否 | 目前設定值或安裝程式預設值。 | 用於連線到訊息佇列的使用者名稱。 |
| --mq-password | 否 | 目前設定值或安裝程式預設值。 | 用於連線到訊息佇列的使用者帳戶的密碼。 |
| --mq-enable-tls | 否 | 目前設定值或 false。 | 需要 TLS 連線才能連線到訊息佇列。 |
| --mq-tls-certificate-host | 否 | 目前設定值或 null。 | 訊息佇列伺服器的正式名稱。必須與憑證上的名稱相符。 |
| --password-salt | 否 | 隨機 | 用於對密碼進行雜湊處理的全域 salt。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --password-min-length | 否 | 目前設定值或 10。 | 密碼的最小長度。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --password-min-numeric | 否 | 目前設定值或 1。 | 密碼中所需的最少數字字元。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --password-min-special | 否 | 目前設定值或 1。 | 密碼中所需的最少特殊字元。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --password-min-latin | 否 | 目前設定值或 5。 | 密碼中所需的最少拉丁字元。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --password-require-mixed-case | 否 | 目前設定值或 true。 | 密碼中所需的混合大小寫字元。 這適用於在 Resource Monitoring Tool 中建立的本機使用者帳戶。 |
| --auth-timeout-minutes | 否 | 目前設定值或 240。 | 工作階段的使用者驗證到期前的分鐘數。 |
| --auth-sliding-expiration | 否 | 目前設定或 true。 | 是否對使用者活動重設驗證逾時期限。 |
範例：
要指定管理員密碼：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=VALUE
--force
覆寫現有檔案。
--timeout=VALUE
查詢逾時。以秒為單位指定此值
--commit
提交 SQL 命令對資料庫所做的任何變更。預設情況下，會以交易形式執行 SQL 命令，但會在完成時復原。
要輸出查詢結果的 zip 檔案名稱。預設值為 queryresults.zip
範例：rmtadmin query <SQLCommand> --outfile=<path and the output file name>
rmtadmin register
附註：版本 2021.2 中新增
使用啟動程序檔案註冊代理程式。可以使用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 和代理程式執行此命令。
概要
rmtadmin restart [options] [global option]
選項
必須至少指定一個選項：
RMT Server：
--all
重新啟動所有服務。
--master
重新啟動 RMT Server。
--mq
重新啟動訊息佇列服務。
--db
重新啟動資料庫服務。
代理程式：
--agent
重新啟動電腦上執行的代理程式服務。
範例：rmtadmin restart --db
rmtadmin rotate-mq-certificate
在代理電腦中旋轉代理程式訊息佇列用戶端憑證。在伺服器機電腦中執行 rmtadmin rotate-mq-certificate 後執行此命令。
該命令必須從 RMT 代理程式執行。
概要
rmtadmin rotate-mq-certificate [options] [positional parameter]
位置參數
啟動程序
包含啟動程序檔案名稱的檔案路徑。
選項
--username
必需。主要伺服器的使用者名稱。
--password
必需。主要伺服器使用者帳戶的密碼。
--password-file
包含檔案名稱的路徑，檔案名稱中包含主要伺服器密碼資訊。密碼可以在命令列中提供，也可以提供包含密碼的檔案。如果未提供任何一種，系統會提示您輸入密碼。
--confirm-restart
確認服務重新啟動並繞過確認提示。
rmtadmin rotate-mq-certificates
在伺服器電腦中旋轉訊息佇列伺服器和用戶端憑證。
該命令必須從 RMT 伺服器執行。
概要
rmtadmin rotate-mq-certificates [options]
選項
--confirm-restart
確認服務重新啟動並繞過確認提示。
Rmtadmin 伺服器
附註：版本 2021.2 中新增
列出所有環境或特定環境中的所有 Tableau Server 節點。
此命令僅適用於 RMT Server。
概要
rmtadmin servers [positional parameter][global option]
位置參數
env
可選。指定環境的識別碼，以取得在該環境中註冊的 Tableau Server 節點的清單。這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments >
rmtadmin service-setup
附註：版本 2021.4 中新增。用於安裝或更新 Resource Monitoring Tool 服務的使用者認證，包括 RMT 伺服器、代理程式、Rabbit MQ 和 PostgreSQL 資料庫。這對於在安裝後更新服務資訊很有用。
此命令適用於 RMT 伺服器和代理程式。
概要
rmtadmin service-setup [positional parameter][options][global option]
位置參數
必須至少指定以下值之一：
所有
更新所有可用的服務。可以在 RMT 和代理程式上執行。在 Tableau Server 節點上執行時，更新該節點上的代理程式。
master
更新 RMT 伺服器。
agent
更新代理程式。只能在代理程式（Tableau Server 節點）上執行。
db
更新資料庫服務。只能在 RMT 伺服器上執行。
mq
更新訊息佇列服務。只能在 RMT 伺服器上執行。
選項
--confirm
可選。確認您要進行更新。可以在 RMT 和代理程式上執行。在 Tableau Server 節點上執行時，更新該節點上的代理程式。
--user-type
RMT 伺服器和代理程式需要。用於執行 RMT 伺服器或代理程式的帳戶類型。允許的值為：
- 虛擬帳戶（僅限 RMT 伺服器）
- network-service
- local-system
- local-service
- 使用者名稱（本機或網域使用者帳戶的使用者名稱）
--username
指定帳戶的使用者名稱。若使用本機或者網域使用者帳戶，則需要指定。
--password
指定帳戶的密碼。若使用本機或者網域使用者帳戶，則需要指定。
--password-file
可選。檔案位置的路徑，包括儲存密碼資訊的檔案名稱。
--append-permissions
可選。附加新權限。若不想覆寫現有權限，請使用此選項。
rmtadmin set
設定指定組態機碼的值。
此命令可用於 RMT Server 和代理程式。
概要
rmtadmin set [positional parameter] [global option]
位置參數
key
要變更值的組態金鑰。
value
要使用的新值。
範例：rmtadmin set mq:port <port number>，其中 mq:port 是金鑰，<port number> 是值。
支援的組態機碼
| 主要 | 資料類型 | 適用於 | 預設值 | 說明 |
|---|---|---|---|---|
mq:tls:certificateHostName | 字串 | RMT Server 與代理程式 | 不適用 | 透過 TLS 連線到 RabbitMQ 時，憑證中使用的主機名稱 |
mq:tls:enabled | 布林值 | RMT Server 與代理程式 | FALSE | 啟用/停用與 RabbitMQ 的 TLS 連線 |
mq:port | 整數 | RMT Server 與代理程式 | 5672 | RabbitMQ 主機連接埠號碼。 |
server.web.run | 布林值 | 代理程式 | TRUE | 啟用或停用代理程式的 Web 介面。 |
選項
--backup
進行變更之前，先建立組態檔的備份。
使用 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 伺服器上執行時，該命令將傳回：
如果本機資料庫中的訊息表使用的空間超過警告閾值 (4 GB) 後會發出磁碟空間使用警告。有關更多資訊，請參閱 疑難排解訊息表磁碟使用警告
概要
rmtadmin status [global option]
rmtadmin stop
停止 Resource Monitoring Tool 服務。當此命令在 RMT Server 執行時，它只會停止 RMT Server。在安裝代理程式的機器上執行時，它只會停止該機器的代理程式。
此命令可在 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 >
--force
可選。即使沒有足夠的資料可用，也可以使用此選項立即更新基準。預設情況下，該命令將等待 50 次成功載入來計算基準
rmtadmin update-baseline
附註：版本 2021.4 中的新增功能
更新所有檢視載入的基準。基準是檢視的 50 次成功初始載入時間的第 95 個百分位數。
此命令僅適用於 RMT Server。
概要
rmtadmin update-baseline [options][global option]
選項
env
必要。這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments >
rmtadmin update-env
附註：版本 2021.2 中新增
更新環境設定。
此命令僅適用於 RMT Server。
概要
rmtadmin update-env [options][global option]
選項
| 選項 | 是否為必要項目？ | 說明 |
|---|---|---|
| --non-interactive | 否 | 禁用所有互動式提示。 |
| --no-test | 否 | 禁用測試 API 和存放庫連線。 |
| --name | 是 | 環境的名稱。 |
| --id | 否 | 網路介面 URL 中使用的環境標識符。 這是系統產生的識別碼。可以前往以下路徑找到該識別碼：Admin>Environments > |
| --gateway-url | 否
| 用於存取 Tableau Server 閘道的 URL。 |
| --version | 否 | 此環境將監控的 Tableau Server 版本。 |
| --api-username | 否 | 用於連接 Tableau Server API 的帳戶使用者名稱。使用者帳戶應該是可以存取所有 Tableau Server 網站的 Tableau Server 管理員。 |
| --api-password | 否 | 用來連接 Tableau Server API 的 Tableau Server API 使用者帳戶密碼。 |
| --admin-password-file | 否 | 包含 Tableau Server API 使用者帳戶密碼的檔案路徑。 |
| --repository-server | 否 | 這是隨 Resource Monitoring Tool 安裝的 PostgreSQL 資料庫的伺服器名稱。 |
| --repository-port | 否 | Tableau Server 存放庫資料庫的連接埠號碼。 |
| --repository-username | 否 | 用於連線到隨 Tableau Server 存放庫安裝的 PostgreSQL 資料庫的使用者名稱。 基於效能考量，Resource Monitoring Tool 要直接存取 Tableau Server 存放庫資料庫。為求順利使用，必須啟用存放庫存取，並為唯讀資料庫使用者設定密碼。有關詳情，請參閲啟用對 Tableau Server 存放庫的存取。 |
| --repository-password | 否 | 用於連線到隨 Tableau Server 安裝的 PostgreSQL 資料庫的使用者帳戶密碼。 基於效能考量，Resource Monitoring Tool 要直接存取 Tableau Server 存放庫資料庫。為求順利使用，必須啟用存放庫存取，並為唯讀資料庫使用者設定密碼。有關詳情，請參閲啟用對 Tableau Server 存放庫的存取。 |
| --repository-password | 否 | 包含檔案名稱的路徑，其中具有使用者帳戶的密碼，用於連線到隨 Tableau Server 安裝的 PostgreSQL 資料庫。 |
| --repository-ssl-mode | 否 | Tableau Server 存放庫 SSL 模式： 偏好SSL 或需要SSL 來設定 SSL 連線到 Tableau 存放庫。 禁用來禁止使用 SSL 連線到 Tableau Server 存放庫。 |
| --repository-ssl-thumbprint | 否 | 將 Tableau Server PostgreSQL 設定為允許直接連線時，Tableau Server 會建立憑證和金鑰。可以選擇為 Tableau Server 產生的憑證提供指紋，或將 server.crt 檔案複製到「Resource Monitoring Tool 伺服器」電腦。若選擇複製憑證檔案，則不必提供指紋。有關詳情，請參閱設定 Postgres SSL 以允許從用戶端直接連線。 |
範例：rmtadmin update-env --name=<new name>
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