Tabadmin から TSM CLI への移行

Tableau Server on Linux および Tableau Server on Windows バージョン 2018.2 では、Tableau サービス マネージャー (TSM) のコマンドライン インターフェイス (CLI) は tabadmin CLI に取って代わります。このページでは、TSM への移行に役立つよう、tabadmin コマンドを TSM CLI コマンドにマッピングしています。

TSM CLI の詳細については、tsm コマンド ライン リファレンスを参照してください。

対応する TSM CLI コマンドがある tabadmin コマンド

以下の表は、どの tabadmin コマンドが、TSM CLI で利用できるコマンドに対応できるかを示しています。

コマンドの説明tabadmin コマンド相当する TSM CLI コマンド
ライセンス認証しますtabadmin activate --activatetsm licenses activate
ライセンス認証を解除しますtabadmin activate --returntsm licenses deactivate
Tableau Server によって管理されるデータのバックアップを作成しますtabadmin backuptsm maintenance backup

TSM を使用して作成されたバックアップには、サーバー構成データは含まれません。サーバー構成データを含めるオプションはありません。

サーバー キャッシュをクリアしますtabadmin clearcache tsm maintenance cleanup -r
一時ファイルと古いログ ファイルをクリーン アップしますtabadmin cleanuptsm maintenance cleanup
: このコマンドはバージョン 10.5.1 で追加されました
サーバー構成に対して行った変更を更新しますtabadmin configuretsm pending-changes apply
サーバー名とロゴをカスタマイズしますtabadmin customizetsm customize
リポジトリへのアクセスを有効にしますtabadmin dbpasstsm data-access repository-access enable
リポジトリへのアクセスを無効にしますtabadmin dbpass --disabletsm data-access repository-access disable
ファイル ストア インスタンスを読み取り専用モードに設定しますtabadmin decommissiontsm topology filestore decommission
Tableau Server から 1 つ以上の Web データ コネクタ (WDC) を削除しますtabadmin delete_webdataconnectortsm data-access web-data-connectors delete

詳細については、Tableau Server での Web データ コネクタを参照してください。

Tableau Server に Web データ コネクタ (WDC) を追加しますtabadmin import_webdataconnector

および

tabadmin whitelist_webdataconnector

tsm data-access web-data-connectors add

: TSM は WDC のインポートをサポートせず、代わりに WDC を許可リストに追加するのを許可します。詳細については、Tableau Server での Web データ コネクタを参照してください。

Tableau Server が使用する Web データ コネクタ (WDC) を一覧にしますtabadmin list_webdataconnectorstsm data-access web-data-connectors list

詳細については、Tableau Server での Web データ コネクタを参照してください。

Tableau Server からサイトをエクスポートしますtabadmin exportsitetsm sites export
リポジトリ フェールオーバーを開始しますtabadmin failoverrepositorytsm topology failover-repository
構成オプションを取得するtabadmin gettsm configuration get
OpenID リダイレクト URL を取得しますtabadmin get_openid_redirect_urltsm authentication openid get-redirect-url
サイトの .csv ファイルを Tableau Server にインポートしますtabadmin importsitetsm sites import
.csv ファイルを使用してサイトを Tableau Server にインポートしますtabadmin importsite_verifiedtsm sites import-verified
Tableau Server 用のライセンス情報を表示しますtabadmin licensestsm licenses list

注: このコマンドの出力の詳細については、サーバー ライセンスの表示を参照してください。

ファイル ストアを読み取り専用モードからアクティブな読み取り/書き込み状態に移行しますtabadmin recommissiontsm topology filestore recommission
内部セキュリティ トークンを再生成しますtabadmin regenerate_internal_tokenstsm security regenerate-internal-tokens
Tableau Server の登録tabadmin registertsm register
Tableau Server の検索インデックスを再構築しますtabadmin reindextsm maintenance reindex-search
Tableau Server 管理者アカウントをリセットしますtabadmin resettsm reset

注: バージョン 2018.1 で追加。

すべての Tableau Server プロセスを停止および再開しますtabadmin restarttsm restart
Tableau Server バックアップ ファイルから復元しますtabadmin restoretsm maintenance restore

復元コマンドを使用しても、サーバー構成データは復元されません。TSM を使用して作成されたバックアップや tabadmin で作成されたバックアップを使用している場合にも該当します。

構成オプションを設定しますtabadmin settsm configuration set
サイトを有効化または一時停止しますtabadmin sitestatetsm sites unlock
すべての Tableau Server プロセスを開始しますtabadmin starttsm start
Tableau Server およびサーバー プロセスの状態を取得しますtabadmin statustsm status
すべての Tableau Server プロセスを停止しますtabadmin stoptsm stop
Tableau Server ログ ファイルを含むアーカイブ (.zip) ファイルを作成しますtabadmin ziplogstsm maintenance ziplogs

ziplogs コマンドの既定の動作が変更され、tsm を使用する場合、このコマンドにより既定で直近 2 日分のログ ファイルが収集されます。tabadmin ziplogs コマンドでは、最大 7 日分のログ ファイルが収集されていました。詳細については、tsm maintenance ziplogsを参照してください。

対応する TSM CLI コマンドがない tabadmin コマンド

以下の表は、相当する TSM CLI コマンドが利用できない tabadmin コマンドを示しています。

コマンドの説明tabadmin コマンド
システム管理者グループでユーザーの追加または削除を行いますtabadmin administratorシステム管理者グループでユーザーの追加または削除を行うには、Tableau Server REST API の「グループへのユーザーの追加」および「グループからのユーザーの削除」の方法を使用できます。
リポジトリに保存されている機密情報を暗号化する新しいキーを作成しますtabadmin assetkeystsm security regenerate-internal-tokens コマンドを使用して、シークレットおよびマスター キーを作成するか再生成します。
Tableau Server がシステム開始時刻に起動するかどうかを指定しますtabadmin autostartTableau Server は、システムが再起動する前の状態に戻ります。実行中だった場合は、再起動します。停止していた場合は、システムの起動後に停止します。
バックアップ用の 2 番目のサーバー ノードを特定しますtabadmin failoverprimaryTSM にはプライマリ ノードがないため、このコマンドに相当する TSM は必要ありません。
Tableau Server で委任されたデータ アクセスの認証資格情報を管理しますtabadmin manage_global_credentials認証資格情報を全体的に管理するために、Apache Impala 用に Kerberos 委任を使用することを推奨します。詳細については、Tableau コミュニティのKerberosおよび「Hive/Impala 用に Kerberos 委任を有効にする」(新しいウィンドウでリンクが開く)を参照してください。
Tableau Server アカウントのパスワードをリセットしますtabadmin passwdサーバーでローカル認証を使用している場合、ユーザー アカウントのパスワードをリセットするには、Tableau Server REST API の「ユーザーを更新 (英語)」の方法を使用できます。
Tableau Server ユーザー ID と Open ID Connect アイデンティティ プロバイダーの間のバインディングをリセットしますtabadmin reset_openid_sub
お使いの環境が、Tableau Server を実行するための最小要件を満たしているかどうかを確認しますtabadmin validate
Tableau Server リポジトリのバックアップが正常に復元されることを検証しますtabadmin verify_databasetsm maintenance backup コマンドを実行すると、--skip-verification パラメーターを使用する場合を除き、バックアップが正しく復元されることを自動的に検証します。
Tableau Server 再起動後に VizQL プロセスで読み込み時間の短縮を準備しますtabadmin warmuptabadmin warmup コマンドはもう必要ありません。Tableau Server では再起動後でも読み込み時間が自動的に短縮されるように最適化されるようになったためです。

 

 

フィードバックをありがとうございます。フィードバックは正常に送信されました。ありがとうございます!