tsm topology

tsm topology コマンドを使用してファイル ストア ノードを安全に取り外す準備をするか、読み取り/書き込みモードに戻します。また、リポジトリのフェールオーバー開始、ノードまたはポートのリスト取得、クラスタにノードを追加するために必要な bootstrap 構成ファイルの取得、ノードの削除、外部リポジトリと外部ファイル ストアの構成も実行できます。

トポロジを変更する場合は、保留中の変更も適用する必要があります。詳細については、tsm pending-changesを参照してください。

tsm topology cleanup-coordination-service

注: バージョン 2020.1.0 以降、すべての調整サービス アンサンブルのコマンドでは、サーバーの再起動が行われることを確認する「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 以降、すべての調整サービス アンサンブルのコマンドでは、サーバーの再起動が行われることを確認する「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 storage disable [options] [global options]

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

tsm topology external-services list

tsm topology external-service-list コマンドは、Tableau Server 外部リポジトリ用に使用されるサービスを取得するのに使用します。たとえば、Amazon RDS を使用するように Tableau Server を構成している場合、次のメッセージが表示されます。

これらの外部で構成されたサービスは 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

オプション

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>

必須。

外部リポジトリに Amazon RDS を使用している場合は SSL を使用する必要があります。このオプションで使用するため、.pem ファイルをダウンロードし、この .pem ファイルを指定します。.pem ファイルの取得方法の詳細については、「SSL を使用して DB への接続を暗号化する」(Link opens in a new window)を参照してください。

tsm topology external-services repository replace-host

このコマンドを使用して、指定された外部リポジトリを使用するように Tableau Server の構成設定を更新します。tsm topology external-services repository replace-host コマンドを使用して、現在の外部リポジトリからデータを移動することなく、新しい外部リポジトリを直ちに使用するように Tableau Server を再構成します。データを手動で移行する必要が生じる場合があります。この操作は、データ損失の可能性を十分に評価し、その影響を理解したうえで行う必要があります。

このコマンドは、次のシナリオで使用できます。

• RDS インスタンスで使用する SSL 証明書の予定される有効期限: RDS インスタンスを新しい証明書で更新する必要があります。また、新しい証明書ファイルを使用して RDS インスタンスに接続するように Tableau Server を構成する必要があります。

• 災害復旧: 災害復旧シナリオで新しい RDS インスタンスに接続します。詳細については、AWS Relational Database Service (RDS) での PostgreSQL DB インスタンスの作成を参照してください。

シノプシス

tsm topology external-services repository enable -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 Server を更新します。

詳細については、「SSL/TLS を使用した DB インスタンスへの接続の暗号化」を参照してください。

.pem ファイルの取得方法の詳細については、「SSL を使用して DB への接続を暗号化する」(Link opens in a new window)を参照してください。

--ignore-prompt

任意の項目です。

プロンプトを表示せずにこのコマンドを実行します。

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 コマンドを使用して、ファイル ストア ノードを安全に取り外す準備をする必要があります。このコマンドは指定ノードを読み取り専用モードにして、指定ノード上に固有のコンテンツがないようにします。

コミッション解除の結果としてファイル ストア ノードが 1 台だけになってしまう場合、--override オプションを使用しないとコミッション解除が失敗します。

シノプシス

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

オプション

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

必須。

コンマで区切られたノード ID で指定されたコミッション解除する 1 台以上のノードのリスト。

--delete-filestore

オプション。

コミッション解除されていない場合でも、強制的にファイル ストアを削除します。このオプションを使用するのは、ファイル ストアがあるノードがエラー状態で、コミッション解除を行えない場合のみにしてください。ノード上の一意のファイルが完全に削除されます。

-o, --override

オプション。

対象のファイル ストア ノードを削除すると、ファイル ストア ノードが 1 台になってしまう場合に通常発生する警告または失敗を上書きします。

--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 で指定された再コミッションする 1 台以上のノードのリスト。

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 nodes get-bootstrap-file

tsm topology nodes get-bootstrap-file コマンドを使用して、クラスタへの新しいノードの追加に必要な bootstrap ファイルを取得できます。

重要: bootstrap ファイルには、構成シークレットの暗号化に使用されるマスター キーストア ファイルのコピーが含まれています。また、このファイルには事前定義された時間で有効となる埋め込み認証資格情報も含まれており (tabadmincontroller.auth.expiration.minutes を参照)、セッション Cookie として機能します。インポートおよびエクスポート操作におけるシークレットの保護で説明するメカニズムを使用して、bootstrap ファイルを保護するために追加の措置を講じることを強くお勧めします。

シノプシス

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

オプション

-f,--file <file>

必須。

構成ファイルを保存するフル パスとファイル名。重複ファイルがある場合は上書きされます。

-nec,--no-embedded-credential

オプション。

バージョン 2019.3 での追加。

既定では埋め込みの認証資格情報は bootstrap ファイルに含まれています。このオプションは、bootstrap ファイルに認証資格情報を含めない場合に使用します。埋め込みの認証資格情報は一時的なもので、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,...>

必須。

削除するノードを 1 つ以上指定します。複数のノードを指定する場合は、ノード ID の間をコンマで区切ります。

tsm topology set-node-role

バックグラウンダーおよび抽出クエリ ノードの役割を設定します。これにより、ノード上で実行されるタスクのタイプが決まります。次のノードの役割は、マルチノード クラスタがあり、アドオン ライセンスが必要な場合に役立ちます。詳細については、ノード ロールによるワークロード管理を参照してください。

注: ノードの役割を構成するには、サーバーを再起動する必要があり、いくらかのダウンタイムが必要になります。詳細については、tsm pending-changesを参照してください。

シノプシス

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

オプション

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

必須。

ノード ID で指定され、コンマで区切られたノードの役割を設定する 1 台以上のノードのリスト。ノード間にスペースはありません。

-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>

必須

指定されたノードの役割を設定します。このオプションの有効な値は次のとおりです。

• 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 として実行され、抽出クエリの処理を優先して実行します。

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

ノードのプロセスのインスタンス数を設定します。ノードに指定されたプロセスがすでにある場合は、指定されたカウントに一致するようにこの数が更新されます。

一度に 1 つのプロセスしか設定できません。複数のプロセスを指定した場合、最初のプロセス以外のプロセスは、通知なく無視されます。

ノード上のプロセス数を更新したら、保留中の変更も適用する必要があります。ほとんどの場合、ここでサーバーの再起動が必要となります (メッセージが表示されます) が、サーバーを再起動せずに動的なトポロジの変更を実行できる特殊なケースもあります。詳細については、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 以降、すべての調整サービス アンサンブルのコマンドでは、サーバーの再起動が行われることを確認する「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 Services Manager で指定したアドレスを使用します。URL は https で始まる必要があります。また、ポート 8850 を含めるとともに、IP アドレスではなくサーバー名を使用します。たとえば https://<tsm_hostname>:8850。サーバーが指定されていない場合は、仮に https://<localhost | dnsname>:8850 とします。

--trust-admin-controller-cert

オプション。

このフラグは、TSM コントローラで自己署名証明書を信頼するために使用します。証明書の信頼および CLI 接続の詳細については、TSM クライアントの接続を参照してください。

-u, --username <user>

アクティブなセッションがない場合は、必要に応じて -p または --password と一緒に使用します。

ユーザー アカウントを指定します。このオプションが含まれていない場合は、コマンドがサインインに使用した認証資格情報を使用して実行されています。