tabcmd

Tableau では、Tableau Server サイトでのサイト管理タスクの自動化に使用できる tabcmd コマンドライン ユーティリティを提供しています。サイトの管理タスクを自動で実行できます (ユーザー、プロジェクト、グループの作成や削除など)

このユーティリティは Tableau Server に含まれ、最初のサーバー ノードに自動でインストールされています。このユーティリティは他のコンピューターから実行することもできます (Tableau Server のインストールに含まれていないコンピューターも含む)。ただし、これには Tableau の Web サイトから tabcmd インストーラをダウンロードする必要があります。詳細については、tabcmd のインストールを参照してください。

tabcmd のインストール

Tableau Server または Tableau Online を新しいバージョンにアップグレードする際に、更新後のバージョンの tabcmd が必要な場合は、Tableau Web サイトの Tableau Server リリース ページからダウンロードできます。

Tableau Server の場合は、サーバー バージョンと一致するバージョンをダウンロードすることをお勧めします。Tableau Online の場合は、バージョンの不適合によって生じる問題を避けるために、常に最新バージョンをダウンロードすることをお勧めします。どちらの場合でも、古いバージョンの tabcmd を使用すると、エラーや予期しない結果を引き起こすことがあります。

  1. Web ブラウザを開き、Tableau Server リリース(Link opens in a new window) ページに移動します。Tableau Online を使用している場合でも、このページに移動します。

  2. 次の製品を使用している場合:

    • Tableau Online: 最新の Tableau Server リリースを選択してください。
    • Tableau Server (Windows または Linux): お使いのサーバー バージョンと一致するリリースを選択してください。

    どちらの場合でも、展開された情報にメンテナンス リリースが表示されていれば、最新のメンテナンス リリースまたはサーバー バージョンと一致するものを選択してください。

    使用するサーバーのバージョンを選択します (Tableau Online の最新リリース)

    これによりリリース ノート ページ (解決済みの問題) が表示され、セキュリティ改善と解決した問題について読むことができます。

  3. 解決した問題の下にある [ファイルのダウンロード] セクションまでスクロールして、tabcmd コマンドを実行する予定のコンピューターと互換性のある tabcmd ダウンロード リンクを選択します。 

    使用するコンピューター (32 ビットまたは 64 ビット) の tabcmd インストーラーを選択します

    残りの手順では、このコンピューターを "tabcmd コンピューター" と呼びます。

  4. インストーラを tabcmd コンピューターまたはそのコンピューターからアクセス可能な場所 (たとえば、マウントされたドライブ) に保存します。

  5. tabcmd コンピューターのオペレーティング システムで適切なインストール手順を完了します。

    • Windows

      既定では、tabcmd は C:\Program Files\Tableau\Tableau Server\<version>\extras\Command Line Utility にインストールされています。これはインストール中に変更でき、C:\ドライブ (C:\tabcmd) の tabcmd という名前のフォルダに tabcmd をインストールすることを推奨します。これにより、検索と実行が容易になり、Windows PATH に tabcmd ディレクトリを追加すると、Windows オペレーティング システムに関するいくつかの制限に対応できます。

      :tabcmd 設定プログラムは、tabcmdディレクトリを Windows PATH 変数に追加しません。手動で追加するか、呼び出すたびに tabcmd への完全パスを含めることができます。

      tabcmd は、Windows に次の 2 つの方法でインストールできます。

      • インストーラーをダブルクリックして、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 のセットアップ プログラムでは、tabcmd のインストールで問題が発生した場合に使用できるログが C:\Users\<user>\AppData\Local\Temp 内に作成されます。ログでは、Tableau_Server_Command_Line_Utility_(<version_code>)_##############.log という命名規則が使用されます。

    • Linux

      注: Linux コンピューターで tabcmd を実行するには、Java 8 (Java 1.8 とも呼ばれる) がインストールされている必要があります。RHEL ライクなシステムでは、これは tabcmd のインストール時に依存関係としてインストールされます。Debian ライクなシステムでは、Java 8 (1.8) がまだインストールされていない場合は個別にインストールする必要があります。

      1. sudo アクセスのあるユーザーで tabcmd コンピューターにログインします。

      2. ダウンロードした .rpm または .deb パッケージをコピーしたディレクトリに移動します。

        • CentOS を含む RHEL ライクなディストリビューションで、次のコマンドを実行します。

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

        • Ubuntu および Debian で次のコマンドを実行します。

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

    Linux PC から tabcmd をアンインストールするには、実行中の各種 Linux に関するドキュメントを参照してください。

  6. (オプション) tabcmd がインストールされている完全修飾場所をお使いのシステム パスに追加すると、その場所へ変更したり、各コマンドで場所を指定したりせずに tabcmd コマンドを実行できます。この手順は、オペレーティング システムの種類とバージョンによって異なります。詳細については、「PATH (変数)」を参照してください。

tabcmd の使用方法

tabcmd を使用する基本的な手順は次のとおりです。

  1. 管理者としてコマンド プロンプトを開きます。

  2. Windows コンピューターで、最初のノード以外のコンピューターに tabcmd をインストールした場合は、tabcmd をインストールしたディレクトリに変更します。

    Linux コンピューターでは、インストール ディレクトリに変更する必要はありません。

  3. tabcmd コマンドを実行します。

tabcmd を使用する場合、認証されたサーバー セッションを確立する必要があります。セッションは、Tableau Server や Tableau Online サイト、およびセッションを実行している ユーザーを識別します。最初にセッションを開始してコマンドを指定するか、セッションの開始とコマンドの実行を一度に行うことができます。

重要: tabcmd を使用して複数のタスクを実行している場合、各タスクを同時に (並行して) ではなく、順番に (連続して) 実行する必要があります。

コマンド (login など) およびオプション ( -s-u など) は大文字と小文字を区別しませんが、ユーザーが指定する値 (User@Example.com など) は大文字と小文字を区別します。

次のコマンドは、Tableau Serverでの tabserver.mycompany.com という名前のセッションの開始を示します。

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

次の例は、Sales_Workbookというワークブックを削除するコマンドを示します。

tabcmd delete "Sales_Workbook" 

次に、1 つのコマンドで上記の手順すべてを達成する方法を示します。ここで login は必要ありません。

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

Tableau Server では複数のサイトを実行できます。ワークブックがマルチサイト サーバーの既定サイトにある場合、既定を指定する必要はありません。上記のコマンドで十分です。ただし、コマンドが既定以外のサイトのものに適用されている場合、そのサイト用にサイト 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はステータス コード 0 を返します。0 以外のステータス コードの詳しいエラー メッセージは stderr に出力されます。また、情報提供や進捗状況のメッセージも stdout に出力されます。

デバッグ、進捗状況、エラー メッセージを含む tabcmd.log という名前の詳細ログが <home dir>/.tableau/tabcmd/ に書き込まれます。

このセクションの他の記事

ありがとうございます!