tsm 命令列參考

此部分中的主題包括 Tableau Services Manager (TSM) 命令列介面 (CLI) 的參考內容,為 Tableau Server 提供支援。

TSM 用於管理 Tableau Server 的安裝和設定。若要瞭解有關 TSM 的詳情,請參閱Tableau 服務管理員概觀

您可以使用 TSM API 自動執行 TSM CLI 支援的安裝和設定工作。若要瞭解有關預發行版本 (Alpha) TSM API 詳情,請參閱 Tableau Services Manager API

使用 tsm CLI

您可在初始節點(安裝 TSM 的所在節點),或是叢集中的任何其他節點上執行 tsm 命令。

若要執行 tsm 命令,您需要開啟命令提示字元。

  1. 藉由叢集節點上,屬於 tsmadmin 群組之成員帳戶,開啟命令提示字元。

  2. 執行您要的命令。如果您透過非初始節點執行命令,請加入 -s 選項以按照名稱(而非 IP 位址)指定初始節點的 URL,以及加入 TSM 連接埠 8850。

    若要從初始節點查看 TSM 和 Tableau Server 的版本:

    tsm version

    若要從其他節點查看 TSM 和 Tableau Server 的版本:

    tsm version -s https://<inital_node_name>:8850

    例如:

    tsm version -s https://myTableauHost:8850

藉由 tsm CLI 進行驗證

從 Tableau Server 2019.2 版開始,如果符合以下條件,執行 tsm 命令就不會要求您輸入密碼:

  • 您執行命令的帳戶是 TSM-authorized 群組的成員,預設是 tsmadmin 群組。不具權限的 Tableau 使用者(預設是, tableau 使用者)與根帳戶也可以執行 TSM 命令。
  • 您正在執行 Tableau Server Administration Controller 服務的 Tableau Server 上本機執行命令。預設情況下,在分散式部署的起始節點上,會安裝及設定 Tableau Server Administration Controller 服務。

本機登入 tsm CLI

如果您在本機電腦上執行 tsm 命令,且使用者帳戶屬於 TSM-authorized 群組成員,則不需要指定密碼。在此情況下,直接執行命令即可,例如:

tsm version

遠端登入 tsm CLI

若您是透過未執行 Tableau Server Administration Controller 服務的叢集中的節點執行 TSM 命令,則您必須先藉由遠端電腦上的 Tableau Server Administration Controller 服務來驗證工作階段,才能執行命令。例如,執行以下命令:

tsm login -s <server_name> -u <account_name>

其中 <server_name> 是執行 Tableau Server Administration Controller 服務所在之處的節點名稱,而 <account_name> 是屬於 TSM-authorized 群組成員之帳戶。

執行此命令之後,系統會提示您輸入密碼。帳戶經過驗證後,您便可以執行 TSM 命令。

在 TSM-authorized 群組中檢視和新增帳戶

TSM-authorized 群組是在伺服器安裝期間建立的群組。預設情況下,TSM-authorized 群組會命名為 tsmadmin。如果您在安裝期間建立了替代性 TSM-authorized 群組,請在下列程式碼範例中以您的群組名稱 tsmadmin 替換。

若要檢視 tsmadmin 群組中的使用者帳戶,請執行以下命令:

grep tsmadmin /etc/group

若要將使用者帳戶新增至 tsmadmin 群組:

sudo usermod -G tsmadmin -a <username>

使用 tsm CLI 編寫指令碼以及執行自動化作業

若要在指令碼檔案未使用密碼保護的 Tableau Server 上執行自動化作業,請在初始節點上執行指令碼,並在適當的 TSM-authorized 群組中以帳戶執行。請參閱上述「驗證」一節以瞭解更多詳細資料。

在 shell 中查看說明內容

若要從命令列中查看最少的說明內容,請使用 tsm help 類別。

概要

tsm help [category] [command]

命令

tsm help

所有 tsm 命令的說明

tsm help <category>

顯示特定命令類別的說明。例如,tsm help authentication

tsm help <category> <command>

顯示特定命令的說明。例如,tsm help authentication open-id

tsm help command

所有頂級命令或類別的清單。

類別

此區段的其他文章

感謝您的回饋! 提交意見回饋時發生錯誤。重試或傳送訊息給我們