tsm コマンド ライン リファレンス

このセクションのトピックには、Tableau Server をサポートする Tableau Services Manager (TSM) コマンド ライン インターフェイス (CLI) の参照コンテンツが含まれています。

TSM は、Tableau Server のインストールおよび構成の管理に使用されます。TSM の詳細については、Tableau Services Manager の概要を参照してください。

TSM API を使用して、TSM CLI によってサポートされているインストールと構成を自動化できます。プレリリース (アルファ版) TSM API の詳細については、「Tableau サービス マネージャー API」を参照してください。

tsm CLI の使用

tsm コマンドは、最初のノード (TSM がインストールされているノード)、またはクラスタ内の任意の追加ノードで実行できます。

tsm コマンドを実行するには、コマンド プロンプトを開く必要があります。

  1. クラスタ内のノードでコマンド プロンプトを管理者として開きます。

  2. 必要なコマンドを実行します。最初のノード以外のノードからコマンドを実行する場合は、-s オプションを含めて最初のノードの URL を名前 (IP アドレスではない) で指定すると共に、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 リリースから、次の条件が該当する場合に、Tableau サービスマネージャーコマンドを実行する必要はありません。

  • コマンドを実行しているアカウントが TSM承認リストグループのメンバーであり、既定では tsmadmin グループである。Tableau 権限なしユーザー(既定では、tableau ユーザー)および root アカウントも Tableau サービスマネージャーコマンドを実行している。
  • Tableau Server 管理コントローラサービスを実行している Tableau Server でローカルでコマンドを実行している。既定では、Tableau Server 管理コントローラサービスが、分散展開の最初のノードにインストールされ構成されます。

Tableau サービスマネージャー CLI へのローカルでのログイン

Tableau サービスマネージャー 承認グループのメンバーであるユーザーアカウントを使用して、ローカルコンピューターで Tableau サービスマネージャーコマンドを実行している場合、パスワードを指定する必要はありません。この場合は、たとえば、次のようにコマンドを実行します。

tsm version

tsm CLI へのリモートでのログイン

Tableau Server 管理コントローラサービスが実行されていないクラスタ内のノードから Tableau サービスマネージャーコマンドを実行している場合は、コマンドを実行する前に、リモートコンピューターの Tableau Server 管理コントローラーサービスとのセッションを認証する必要があります。たとえば、次のコマンドを実行します。

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

ここで、 <server_name> は Tableau Server 管理コントローラサービスが実行されているノードの名前であり、<account_name> は Tableau サービスマネージャー承認グループのメンバーであるアカウントです。

このコマンドを実行すると、パスワードの入力を求められます。アカウントが認証されたら、Tableau サービスマネージャーコマンドを実行できます。

Tableau サービスマネージャー承認グループへのアカウントの表示と追加

サーバーのインストール中に、Tableau サービスマネージャー承認グループが作成されます。既定では、tsmadminという名前のTableau サービスマネージャー承認グループです。インストール中に代替のTableau サービスマネージャー認可グループを作成した場合は、次のコード例での tsmadmin のグループ名を置き換えます。

tsmadmin グループのユーザー アカウントを表示するには、次のコマンドを実行します。

grep tsmadmin /etc/group

ユーザーを tsmadmin グループに追加するには:

sudo usermod -G tsmadmin -a <username>

Tableau サービスマネージャー CLI でのスクリプト作成と自動化

スクリプトファイル内のパスワードを使用せずに Tableau Server でオートメーションを実行するには、最初のノードおよび適切なTableau サービスマネージャー承認グループのアカウントでスクリプトを実行します。詳細については、上記の「認証」セクションを参照してください。

シェルでヘルプ コンテンツを表示する

コマンド ラインから最小限のヘルプ コンテンツを表示するには、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

上位のすべてのコマンドまたはカテゴリをリストします。

カテゴリ

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

ご意見をお寄せくださりありがとうございます。 ご意見の送信中にエラーが発生しました。もう一度実行するか、当社にメッセージを送信してください