tabcmd

附註:tabcmd 命令列公用程式版本 2.0 可從 Tableau tabcmd(連結在新視窗開啟) 取得。此新版本可讓您在 MacOS 和 Linux 上執行 tabcmd 命令,並使用個人存取權杖 (PAT) 進行驗證。版本 2.0 依據基於 Python 的 Tableau Server 用戶端 (TSC) 中可用的公用端點建置。此最新版本對 Tableau Server 的支援有限。

Tableau 提供了 tabcmd 命令列公用程式,您可以使用它在 Tableau Server 網站上自動完成網站管理工作。舉例來說,建立或刪除使用者、專案和群組。

附註:在 2024.1 之前的 Tableau 版本中,tabcmd 版本 1 不適用於匯出視覺效果。

此公用程式隨 Tableau Server 一起提供,將在初始伺服器節點中自動安裝。您也可以從其他電腦上執行該公用程式,即使這些電腦不是 Tableau Server 安裝的一部分,但是,您需要從 Tableau 網站下載 tabcmd 安裝程式才能這樣做。有關詳情,請參閱以下的安裝 tabcmd

安裝 tabcmd

附註:這些說明用於安裝 tabcmd 1.0 命令列公用程式。要安裝 tabcmd 2.0 命令列公用程式,請前往 Tableau tabcmd(連結在新視窗開啟) (新視窗)。

將 Tableau Server 或 Tableau Cloud 升級到新版本時,若需要 tabcmd 的更新版本,可以從 Tableau 網站上「Tableau Server 版本」頁面下載該版本。

對於 Tableau Server,我們建議下載與伺服器版本相符的版本。對於 Tableau Cloud,我們建議始終下載最新版本,以避免版本不相容引起的問題。無論任一種情況,使用 tabcmd 的過時版本可能會導致錯誤和不可預知的結果。

  1. 開啟網頁瀏覽器,然後前往「Tableau Server 版本」(連結在新視窗開啟)頁面。即使使用的是 Tableau Online,也請前往此頁面。

  2. 若使用的是;

    無論任一種情況,若展開的資訊顯示維護版本,請選取最新維護版本,或選取與伺服器版本相符的維護版本。

    選取使用的伺服器版本(Tableau Cloud 的最新版本)

    這會帶您進入版本說明頁面(稱為「已解決的問題」),您可以在其中閱讀有關安全性改進和已解決問題的資訊。

  3. 滾動到已解決問題下的「下載檔案」部分,選取與您將從中執行 tabcmd 命令的電腦相容的 tabcmd 下載連結。 

    選取要用於的電腦上的 tabcmd 安裝程式(32 或 64 位元)

    其餘步驟將此電腦稱為「tabcmd 電腦」。

  4. 將安裝程式儲存到 tabcmd 電腦,或儲存到可從該電腦存取的位置(例如,裝載的驅動器)

  5. 完成適合於 tabcmd 電腦作業系統的安裝步驟:

    • Windows

      預設情況下,tabcmd 會安裝至 C:\Program Files\Tableau\Tableau Server\<version>\extras\Command Line Utility。您可以在安裝其間變更改此項目,並建議您將 tabcmd 安裝至名稱為 tabcmd 的資料夾,路徑位於 C:\ drive (C:\tabcmd) 的根目錄。如此可便於尋找和執行,並且如果將 tabcmd 目錄新增至 Windows PATH,則它會適應 Windows 作業系統的一些限制。

      附註: tabcmd 安裝程式不會向 Windows PATH 變數新增 tabcmd 目錄。您可以手動新增它,也可以在每次調用 tabcmd 時包含其完整路徑。

      您可以採用兩種方式在 Windows 上安裝 tabcmd:

      • 按兩下安裝程式以執行 UI 中的步驟:

        1. 接受授權合約。

        2. 若要安裝到非預設位置,請按一下「自訂」並輸入或流覽至要安裝 tabcmd 的位置。

        3. 按一下「安裝」

          如果 Windows Defender 防火牆或「使用者帳戶控制」發出提示,請按一下「允許存取」

      • 透過命令提示字元執行安裝程式:

        1. 在 tabcmd 電腦上以管理員身分開啟命令提示字元。

        2. 巡覽至您在其中複製了 tabcmd 安裝程式的目錄。

        3. 安裝 tabcmd:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1

          若要安裝到非預設位置:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="<path\to\install\directory>"

          例如:

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="C:\tabcmd"

          如需可搭配 tabcmd 安裝程式使用的命令列選項的完整清單,請搭配 /? 執行安裝程式。如需有關 tabcmd 安裝程式命令列選項的詳情,請參閱 tabcmd 的安裝參數和屬性 (Windows)

      tabcmd 安裝程式會在 C:\Users\<user>\AppData\Local\Temp 中建立記錄,您可以在安裝 tabcmd 發生問題時加以使用。這些記錄會使用命名慣例 Tableau_Server_Command_Line_Utility_(<version_code>)_##############.log

    • Linux

      附註:若要在 Linux 電腦上執行 tabcmd,您必須安裝 Java 11。在類似 RHEL 的系統上安裝 tabcmd 時,它將做為相依項目來安裝。在 Ubuntu 系統上,如果尚未安裝 Java 11,就需要單獨安裝。

      自 2022 年 7 月起,不再支援 Debian 發行版。有關詳細資訊,請參閱此 Tableau 社群貼文(連結在新視窗開啟)

      1. 以具有 sudo 存取權限的使用者身分登入到 tabcmd 電腦。

      2. 巡覽到您將所下載的 .rpm.deb 套裝軟體複製到的目錄。

        • 在類似於 RHEL 的分發(包括 CentOS)上,執行以下命令:

          sudo yum install tableau-tabcmd-<version>.noarch.rpm

        • Ubuntu 上,執行以下命令:

          sudo apt-get install ./tableau-tabcmd-<version>_all.deb

    如要從 Linux 電腦解除安裝 tabcmd,請參閱您所執行的 Linux 版本所屬文件。

  6. (可選)將安裝 tabcmd 的完全限定位置新增到系統路徑中,以允許執行 tabcmd 命令,而無需更改該位置,或使用各個命令指定位置。執行此操作的步驟取決於作業系統的類型和版本。有關詳情,請參閱 PATH(變數)

如何使用 tabcmd

使用 tabcmd 的基本步驟如下:

  1. 以管理員身分開啟命令提示字元。

    附註:請勿使用 PowerShell 在 Windows 上執行 tabcmd 命令。使用 PowerShell 可能會出現非預期的行為。

  2. 在 Windows 電腦上,如果在不是初始節點的電腦上安裝了 tabcmd,請切換到安裝了 tabcmd 的目錄。

    在 Linux 電腦上,您無需切換到安裝目錄。

  3. 執行 tabcmd 命令。

在使用 tabcmd 時,您必須建立經過身分驗證的伺服器會話。會話會識別伺服器或 Tableau Cloud 網站以及執行該會話的使用者。您可以先啟動會話,然後指定命令,或者在啟動會話的同時執行命令。

重要資訊:如果您要使用 tabcmd 執行多項工作,則必須依次(連續)執行工作,而非同時(並行)執行。

命令(例如 login)和選項(例如 -s-u 等)不區分大小寫,但您提供的值(例如 User@Example.com)區分大小寫。

範例

下面的命令示範了如何對名為 tabserver.mycompany.com 的 Tableau Server 啟動會話:

tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword

下一個範例示範用於刪除名為 Sales_Workbook 的工作簿的命令:

tabcmd delete "Sales_Workbook" 

下面介紹了如何用一條命令完成上述所有操作,請附註:此處不需要 login

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -u admin -p mypassword 

一個 Tableau Server 可以執行多個網站。當工作簿執行在多網站伺服器的 Default 網站上時,不需要指定 Default,上述命令已足夠。但是,如果命令應用於 Default 之外的網站,則需要指定該網站的網站 ID(請參閱login)。下面是用於 West Coast Sales 網站上的一個工作簿的命令(網站 ID wsales):

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword 

選項 -s-t-u-p 是 tabcmd 的全域變數,可與任何命令一起使用。

有關詳情,請參閱 tabcmd 命令

狀態訊息和記錄

當命令成功執行時,tabcmd 將返回零狀態碼。對於非零狀態碼,將向 stderr 列印完整錯誤訊息。此外,還可向 stdout 列印資訊性訊息或進度訊息。

會將一個名為 tabcmd.log 並包括偵錯、進度和錯誤訊息的完整記錄寫入 <home dir>/.tableau/tabcmd/

感謝您的意見反應!已成功提交您的意見回饋。謝謝!