Windows 版 Tableau Server 說明

使用 tsm topology 命令準備檔案存放區節點，以便安全移除或使其復原為讀寫模式。您也可以啟動存放庫容錯移轉、取得節點或連接埠清單、取得為叢集新增其他節點所需的啟動程序組態檔、移除節點、設定外部存放庫和外部檔案存放區。

重要提示：對拓撲進行變更時，需要套用這些暫止的變更才能使變更生效。有關詳情，請參閱 tsm pending-changes。

tsm topology cleanup-coordination-service

附註︰從版本 2020.1.0 開始，所有 Coordination Service 整體命令都需要輸入「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 <timeout in seconds>

可選。

等待指定的時間以完成命令。預設值為 2700（45 分鐘）。

tsm topology deploy-coordination-service

附註︰從版本 2020.1.0 開始，所有 Coordination Service 整體命令都需要輸入「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 <nodeID,nodeID,...> [option] [global-options]

選項

-n, --nodes <nodeID,nodeID,...>

必要。

要包括在新協調服務整體中的節點的節點 ID，用逗號分隔。您可以指定 1、3 或 5 個協調服務節點，具體取決於叢集中的節點總數。有關詳情，請參閱協調服務法定數量。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。預設值為 2700（45 分鐘）。

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

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

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

tsm topology external-service 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 <nodeID>

必要。

指定作為移動存放庫目的地之節點的節點識別碼。

重要資訊：這不會停止或刪除 RDS 執行個體。有關如何刪除 RDS 執行個體的詳情，請參閱 AWS 網站上的刪除資料庫執行個體(連結在新視窗開啟)。

tsm topology external-services repository enable

使用 tsm topology external-services repository enable 命令設定 Tableau Server 使用外部存放庫。在安裝新的 Tableau Server 時，可以使用此命令來設定外部存放庫。如果已經在現有且正在執行的 Tableau Server 上執行此命令，則會將資料從本機節點遷移至外部存放庫，並將 Tableau Server 設定為在遷移完成後使用外部存放庫。

概要

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

選項

--f <file name>

必需。

用於儲存組態檔的完整路徑和檔案名。有關詳情，請參閱重新設定 Tableau Server 存放庫。

--c <ssl certificate file>

版本 2021.2 和 2021.2.1 需要。對版本 2021.2.2 及更高版本為可選。

對於 SSL 設定，下載憑證檔案，並指定用於此選項的檔案。

1. Amazon RDS：請參閱使用 SSL 加密與資料庫執行個體的連線(連結在新視窗開啟)。

2. Azure 資料庫：請參閱為適用於 PostgreSQL 的 Azure 資料庫設定 TLS 連線(連結在新視窗開啟)。
3. 獨立的 PostgreSQL 執行個體：請參閱設定 SSL。

--no-ssl

可選。此選項在版本 2021.2.2 及更高版本中可用。

這意味著連線到外部存放庫時不需要 SSL。若不需要使用加密連線，還必須設定外部存放庫以允許未加密連線。使用此選項時，若外部存放庫設定為支援 TLS/SSL 連線，則連線將被加密。否則，Tableau Server 將使用非加密連線。

略過檢查以查看外部存放庫是否已設定為與 Tableau Server 一起使用。通常不建議使用此選項，因為它可能會導致多個 Tableau Server 安裝使用同一個存放庫，從而導致錯誤。此選項可能對測試或災難復原有用。

--skip-state-check

可選。此選項在版本 2022.3.0 及更高版本中可用。

略過檢查以查看外部存放庫是否已設定為與 Tableau Server 一起使用。此選項可能對測試或災難復原有用，但不建議一般情況使用，因為它可能導致多個 Tableau Server 安裝使用同一個存放庫。

tsm topology external-services repository replace-host

此命令將 Tableau Server 組態設定更新為使用特定的外部存放庫。使用 tsm 拓撲外部服務存放庫取代主機命令，將 Tableau Server 重新設定為立即使用新的外部存放庫，而無需將資料從目前的外部存放庫移至該存放庫。您可能需要手動移轉資料。只有在您完全評估和瞭解潛在資料遺失的影響之後，才需執行此操作。

此命令可用於下列情況：

• RDS 執行個體使用的 SSL 憑證的計劃過期：RDS 執行個體需要使用新憑證進行更新，而且 Tableau Server 需要設為使用新的憑證檔案以連線至 RDS 執行個體。

• 災難復原：在災難復原的情況下，使用此憑證連線到新的 RDS 執行個體。有關詳情，請參閱在 AWS 關聯式資料庫服務 (RDS) 上建立 PostgreSQL 資料庫執行個體。

概要

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

選項

-f <file name>

必要。

用於儲存組態檔的完整路徑和檔案名。有關詳情，請參閱重新設定 Tableau Server 存放庫。

-c <ssl certificate file>

可選。

憑證檔案是要匯入以允許連線到執行個體的憑證。對於 RDS，這是用於簽署執行個體憑證的 CA 憑證。這通常是最新的根憑證 rds-ca-XXXX-root.pem 檔案。如果憑證在 RDS 執行個體上已變更，請使用此參數來更新 Tableu 伺服器。

有關詳情，請參閱使用 SSL/TLS 來加密資料庫執行個體的連線。

如需有關如何獲取 .pem 檔案的詳細資訊，請參閱 使用 SSL 加密與 DB 執行個體的連線(連結在新視窗開啟)。

--ignore-prompt

可選。

執行此命令，無需提示。

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

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

tsm topology external-services storage switch-share [option] [global options]

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 <node_id> [global options]

選項

-r, --preferred

如果未使用 -t 或 --target，則為必需。

使用設定的首選節點作為存放庫容錯移轉的目標。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。預設值為 1800（30 分鐘）。

-t, --target <node_id>

如果未使用 -r 或 --preferred，則為必需。

將在其中發生容錯移轉的目標節點的節點 ID。使用 tsm topology list-nodes 命令來尋找節點 ID。

tsm topology filestore decommission

您必須使用 tsm topology filestore decommission 命令來準備一個或多個檔案存放區節點以便安全刪除。此命令會將指定節點置於唯讀模式，並確保指定節點上沒有唯一內容。

如果停止使用單個檔案存放區節點中的結果，則必須使用 --override 選項，否則停止使用將失敗。

概要

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

選項

-n, --nodes <nodeID,nodeID,...>

必要。

由節點 ID 指定並用逗號分隔的一個或多個待停用節點的清單。

--delete-filestore

可選。

強制移除檔案存放區，即使尚未將其停止使用。只有在檔案存放區所在的節點處於錯誤狀態並且無法完成停止使用操作時，才應使用此選項。將永久性刪除該節點上的任何唯一檔案。

-o, --override

可選。

如果刪除目的檔案存放區節點會將剩餘檔案存放區節點的數量減少到一個，則覆蓋通常會發生的警告或故障。此選項無法與 --delete-filestore 選項一起使用。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。預設值為 1800（30 分鐘）。

tsm topology filestore recommission

使用 tsm topology filestore recommission 命令將任何已停用的節點復原為讀寫模式。

概要

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

選項

-n, --nodes <nodeID,nodeID,...>

必要。

由節點 ID 指定並用逗號分隔的一個或多個待重新使用節點的清單。

tsm topology list-nodes

顯示叢集中的節點和（可選）每個節點上的服務。

概要

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

選項

tsm topology list-ports

顯示叢集中的埠。

概要

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

選項

--node-name <nodeID>

可選。

指定要列出其埠的節點。

--service-name

可選。

指定要列出其埠的服務。

tsm topology node-nickname list

顯示叢集中節點的節點暱稱。

概要

tsm topology node-nickname list [options] [global options]

選項

--nodes <nodeID,nodeID,...>

可選。

指定要與暱稱一起列出的節點的節點 ID。

tsm topology node-nickname remove

從指定的一個或多個節點中移除暱稱。

概要

tsm topology node-nickname remove [options] [global options]

選項

--all

若未指定 --nodes，則為必要。

從叢集中的所有節點中移除暱稱。

--nodes <nodeID,nodeID,...>

若未指定 --all，則為必要。

指定應移除暱稱的一個或多個節點的節點 ID。

tsm topology node-nickname set

設定指定節點的暱稱。

概要

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

選項

-id, --node <nodeID>

必要。

指定要為其設定暱稱的節點。

-nn, --nickname <name>

必要。

指定節點的暱稱。

tsm topology nodes get-bootstrap-file

您可以使用 tsm topology nodes get-bootstrap-file 命令獲取將新節點新增到叢集所需的啟動程序檔案。

概要

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

選項

-f,--file <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 <nodeID,nodeID,...>

必要。

指定要移除的節點。如果要指定多個節點，請使用逗號分隔節點 ID。

tsm topology set-node-role

設定背景程式和擷取查詢節點角色。這會決定將在節點上執行的工作類型。如果您有多節點叢集，下列節點角色就很有用。不同的節點角色可能需要 Advanced Management 或 資料管理 授權，或同時需要兩者。有關授權要求的更多資訊，請參閱透過節點角色進行工作量管理。

附註：設定節點角色需要重新啟動伺服器，且需要一些停機時間。有關詳情，請參閱 tsm pending-changes。

概要

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

選項

-n, --nodes <nodeID,nodeID,...>

必要。

由節點 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,extract-queries-interactive>

必要

為指定的節點設定角色。此選項的有效值為：

• all-jobs：背景程式將執行所有類型的工作。

• flows：背景程式將僅執行流程執行工作。

• no-flows：背景程式將不執行流程執行工作。

• extract-refreshes：背景程式將僅執行擷取重新整理工作。這包括累加式重新整理、完全重新整理、所有擷取的加密和解密，包括流程輸出產生的擷取。

• subscriptions：背景程式將僅執行訂閱工作。

• extract-refreshes-and-subscriptions：背景程式將執行 extract-refreshes、所有擷取的加密和解密，包括流程輸出建立的擷取，以及訂閱工作。

• no-extract-refreshes：背景程式將執行除 extract-refreshes、所有擷取的加密和解密（包括從流程輸出建立的擷取）之外的所有工作。

• no-subscriptions：背景程式將執行除訂閱以外的所有工作。

• no-extract-refreshes-and-subscriptions：背景程式將執行除 extract-refreshes、所有擷取的加密和解密（包括流程輸出建立的擷取）以及訂閱以外的所有工作。

• Extract-queries：選取的節點會以 all-jobs 形式執行，且會優先處理擷取查詢。

• extract-queries-interactive：所選節點將作為全作業運行，並將優先處理互動式資料擷取查詢，例如當使用者查看其畫面，並等待載入基於資料提取的儀表板時運行的節點。這是一項進階設定，只有在叢集有大量的訂閱和通知作業工作量，而導致使用者感覺與排程載入執行時間相當的視覺效果，其載入時間效能降低，才應使用此設定。

• 系統：背景程式將僅執行與其他 Tableau Server 流程互動的系統維護作業，例如清理當機的作業、收穫資料庫事件和同步 Active Directory。

• 非系統：背景程式將執行除系統維護作業之外的所有作業。

tsm topology set-ports

設定服務執行個體的埠。

概要

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

選項

-i, --instance <instance_id>

可選。

指定服務的執行個體 ID。如果未指定，預設為 0（零）。

-n, --node-name <nodeID>

必要。

指定節點的節點 ID。

-pn, --port-name <port_name>

必要。

要設定的埠的名稱，格式為：service_name:port_type。如果沒有指定埠類型，則假定為主埠。對於埠名稱語法，請參閱動態對應埠。

-pv, --port-value <port_value>

必要。

要設定的埠。

-r, --restart

可選。

需要時，隱藏重新開機提示並重新啟動 Tableau Server。

tsm topology set-process

設定節點上的處理序執行個體數。如果節點已經具有指定的處理序，則將該數目更新為與指定的計數相符。

• 一次只能設定一個處理序。如果指定多個處理序，則會在無提示的情況下忽略第一個處理序後面的任何處理序。
• 您必須一次設置一個節點的處理序。如果指定多個節點，該指令將顯示「無效節點名稱」錯誤。

更新節點上的處理序數量時，您還需要套用擱置變更。在大多數情況下，這樣也需要重新啟動伺服器 (系統會出現提示)，但有一些特殊情況，您可以進行動態拓撲變更，而不需要重新啟動伺服器。有關詳情，請參閱 Tableau Server 動態拓撲變更。

附註：有關處理序名稱的完整清單，請參閱Tableau Server 處理序。

概要

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

選項

-c, --count <process_count>

必要。

要設定的處理序數（執行個體數）。

-n, --node <nodeID>

必要。

指定要對其設定處理序的節點的節點 ID。

-pr, --process <process_name>

必要。

要設定的處理序的名稱。

tsm topology toggle-coordination-service

附註︰從版本 2020.1.0 開始，所有 Coordination Service 整體命令都需要輸入「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 <timeout in seconds>

可選。

等待指定的時間以完成命令。預設值為 1800（30 分鐘）。

全域選項

-h, --help

可選。

顯示命令說明。

-p, --password <password>

在會話不是活動狀態的情況下為必需，-u 或 --username 也為必需。

為在 -u 或 --username 中指定的使用者指定密碼。

如果密碼包括窗格或特殊字元，請將其括在引號中：

--password "my password"

-s, --server https://<hostname>:8850

可選。

對 Tableau 服務管理器使用指定的位址。URL 必須以 https 開頭（包括連接埠 8850），並使用伺服器名稱而不是 IP 位址。例如 https://<tsm_hostname>:8850。如果沒有指定伺服器，則假定為 https://<localhost | dnsname>:8850。

--trust-admin-controller-cert

可選。

使用此旗標來信任 TSM 控制器上的自我簽署憑證。如需有關憑證信任和 CLI 連線的詳細資訊，請參閱連接 TSM 用戶端。

-u, --username <user>

在會話不是活動狀態的情況下為必需，-p 或 --password 也為必需。

請指定使用者名稱。如果未包括此選項，則使用您登入所使用的認證執行該命令。