tsm maintenance

tsm maintenance コマンドを使用して、定期的なバックアップの作成や以前に作成したバックアップからの Tableau Server の復元などのサーバー メンテナンス タスクを管理できます。

tsm maintenance backup

Tableau Server によって管理されるデータのバックアップを作成します。このデータには、Tableau の PostgreSQL データベース (リポジトリ) が含まれます。これには、ワークブック、ユーザーのメタデータ、および抽出 (.tde または .hyper) ファイルが含まれます。このデータには、構成データは含まれません。Tableau Server の完全なバックアップと復元を実行しますを参照してください。

リポジトリ (pgsql) とファイル ストアを管理コントローラと同じノードに配置すると、Tableau Server のバックアップにかかる時間を短縮できます。管理コントローラは、最初のノードの障害が発生したために別のノードに移動する必要があった場合を除いて、通常は最初のノードにあります。

リポジトリがコントローラと同じノードに配置されていると、バックアップ プロセス中にデータを圧縮してノード間で転送する必要がなくなるか大幅に少なくなります。ファイル ストアについても、特に組織で抽出が多用される場合に、これと同じことが当てはまります。

シノプシス

tsm maintenance backup --file <backup_file> [options] [global options]

オプション

-d, --append-date

オプション。

バックアップ ファイル名に現在の日付を追加します。

-f, --file <backup_file>

必須。

指定したファイルにバックアップを書き込みます。拡張子 .tsbak が自動的に使用されます。ファイルは basefilepath.backuprestore 変数で TSM  に定義したディレクトリに書き込まれます。既定のディレクトリは次のとおりです。

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

ファイル パスとその変更方法の詳細については、tsm ファイル パスを参照してください。

-i, --description <string>

オプション。

指定したバックアップ ファイルの説明が含まれます。

--skip-compression

オプション。

圧縮を使用せずにバックアップを作成します。バックアップ ファイルは大きくなりますが、バックアップの完了にかかる合計時間が短くできます。これをマルチノード インストールで使用している場合は、ファイル ストア インスタンスを最初のノードで構成することを強くお勧めします。

-k, --skip-verification

オプション。

データベースのバックアップの整合性を検証しないでください。

--override-disk-space-check

オプション。

ディスク容量の低下が警告されている場合でもバックアップの作成を試行します。

-po, --pg-only

オプション。

リポジトリ バックアップのみを生成します。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

この例では、次のように <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\ フォルダーに ts_backup-<yyyy-mm-dd>.tsbak というバックアップを作成します。

tsm maintenance backup -f ts_backup -d

tsm maintenance cleanup

古いログ ファイルと一時ファイルを削除します。

Tableau Server を分散展開で実行している場合は、このコマンドを認証コントローラ (TSM コントローラとも呼ばれる) プロセスを実行しているノード上で実行してください。既定では、コントローラはクラスタの最初のノード上にあります。

このコマンドの目的は、古いファイルを削除し、Tableau の展開で空き容量を作ることです。そのため、サーバーの起動時にこのコマンドを実行すると、このシナリオの古いコンテンツの大部分が削除されます。現在のログ ファイルを削除するには、このコマンドの実行前にサーバーを停止する必要があります。

注: このコマンドは、Tableau Server バージョン 10.5.1 で追加されました。また、一部のオプションはバージョン 2018.1 で追加されました。

シノプシス

tsm maintenance cleanup [options] [global options]

オプション

-a, --all

オプション。

既定の保持値を使用してすべてのクリーンアップ操作を実行します。 -l -t -r -q オプションを指定して cleanup コマンドを実行する操作と同じです。

--http-requests-table-retention <# of days>

オプション。

既定: 7 日

保持するテーブル エントリの http_requests 日数を指定します。指定した日数より古いエントリは削除されます。このオプションは保存期間を指定しますが、テーブル エントリは削除しません。エントリを削除するには、 このオプションに加えて -q オプションを使用します。

-ic, --sheet-image-cache

任意の項目です。

イメージのキャッシュをクリアします。このキャッシュには、オフライン プレビューのイメージ、サブスクリプション メール メッセージのスナップショット、サブスクリプション PDF、およびパブリッシュされた REST API エンドポイントで要求されたすべてのイメージが含まれている可能性があります。(詳細については、「rest_api_ref.htm」を参照してください。)

注: バージョン 2019.4 で追加されたオプション

-l, --log-files

オプション。

retention-period より古いログ ファイルを削除します。data\tabsvc\logs の下にあるサブディレクトリのファイルは削除されます。

--log-files-retention <# of days>

オプション。

既定: 1 (24 時間)

この日数より古いログを削除します。このコマンドは、一時ファイルには適用されません。

-q, --http-requests-table

オプション。

古い http_requests テーブル エントリーを削除します。テーブル エントリを削除するには、Tableau Server が実行されている必要があります。Tableau Server が停止している場合、このオプションは無視されます。

-r, --redis-cache

オプション。

Redis キャッシュをクリアします。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

-t, --temp-files

オプション。

以下のディレクトリにあるすべてのファイルとサブディレクトリを削除します。

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\temp: 有効期限が切れた (実行していない) セッションのファイルを格納しているディレクトリのみが削除されます。

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\httpd\temp

  • <install dir>\ProgramData\Tableau\Tableau Server\temp

-v, --verbose

オプション。

消去内容の詳細を表示します。

この例では、2 日を超えて経過したすべてのログ ファイルがクリーン アップされます。

tsm maintenance cleanup -l --log-files-retention 2

tsm maintenance metadata-services enable

tsm maintenance metadata-services enable コマンドを使用して、Tableau Server の Tableau メタデータ API を有効にします。

Tableau Server が Data Management アドオン でライセンスされている場合は、メタデータ API を有効にすると Tableau Catalog が有効になります。

メタデータ API を有効にすると、Tableau Server のコンテンツに関する情報が取り込まれ、メタデータ API ストアにインデックス化されます。メタデータ API を使用して、Tableau Server にパブリッシュされたコンテンツに関するスキーマ、系列、ユーザーが管理するメタデータをクエリできます。メタデータ API を有効にした後は、メタデータ API が無効になるまでメタデータは継続的に取り込まれ、インデックス化されます。

このコマンドを実行するときは、次の点に留意してください。

  • このコマンドでは、Tableau Server で使用されているいくつかのサービスが停止してから起動します。これによって、ユーザーは推奨事項などの一部の機能を一時的に使用できなくなります。
  • このコマンドを使用するたびに、メタデータの新しいインデックスが作成されて前のインデックスが置き換えられます。

Tableau Catalog の詳細については、Tableau Catalog についてを参照してください。

シノプシス

tsm maintenance metadata-services enable

オプション

--ignore-prompt

オプション。

メタデータ API を有効にするときに行う確認の要求を却下します。

tsm maintenance metadata-services disable

tsm maintenance metadata-services disable コマンドを使用して、Tableau メタデータ API を無効にします。

メタデータ API を無効にすると、Tableau Server でコンテンツに関する情報の継続的な取り込みとインデックス化が停止し、Tableau Server およびそのコンテンツに関連付けられたアセットにパブリッシュされたコンテンツに関する情報のインデックスが削除され、メタデータ API に対するクエリと Tableau Catalog へのアクセスを行う機能の両方が無効になります。

このコマンドの実行を停止し、Tableau Server で使用するいくつかのサービスを起動します。これによって、推奨事項など一部の機能が一時的に使用できなくなります。

シノプシス

tsm maintenance metadata-services disable

オプション

--ignore-prompt

オプション。

メタデータ API を無効にするときに行う確認の要求を却下します。

tsm maintenance metadata-services get-status

tsm maintenance metadata-services get-status コマンドを使用して、メタデータ サービスのステータス情報を取得します。

メタデータ サービスのステータスは、メタデータ API ストアが初期化されたかどうか、Tableau メタデータ API が実行されているかどうかを示します。

シノプシス

tsm maintenance metadata-services get-status

tsm maintenance reindex-search

tsm maintenance reindex-search コマンドを使用して検索インデックスを再構築します。

シノプシス

tsm maintenance reindex-search [options] [global options]

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

tsm maintenance reset-searchserver

検索サーバーをクリーンな状態にリセットし、検索情報を削除して検索インデックスを再構築します。

シノプシス

tsm maintenance reset-searchserver [options] [global options]

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

tsm maintenance restore

指定したバックアップ ファイルを使用して、Tableau Server を復元します。バックアップ ファイルを復元しても、構成データは復元されません。Tableau Server の完全なバックアップと復元を実行しますを参照してください。

稼働中のサーバーと同じタイプのアイデンティティ ストアを持つバックアップからのみ復元可能です。たとえば、ローカル認証を使用しているサーバーからのバックアップは、ローカル認証で初期化された Tableau Server に復元可能ですが、Active Directory 認証を使用しているサーバーからのバックアップは、ローカル認証で初期化されたサーバーには復元できません。

シノプシス

tsm maintenance restore --file <file_name> [--restart-server] [global options]

オプション

-ak, --asset-key-file <file_name>

オプション。このオプションは、Tableau Server (バージョン 2018.1 以前) で tabadmin により作成されたアセットから復元する場合にのみ指定します。

復元元のアセット キー ファイルの名前。アセット キー ファイルは、tabadmin assetkeys コマンドによって作成されます。ファイルがサーバー上の事前に定義されたバックアップ/復元場所に置かれている必要があります。

-f, --file <file_name>

必須。

復元するバックアップ ファイルを指定します。

restore コマンドは、TSM の basefilepath.backuprestore 変数で定義したディレクトリにバックアップ ファイルがあることを前提としています。既定のディレクトリは次のとおりです。

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

ファイル パスとその変更方法の詳細については、tsm ファイル パスを参照してください。

-k, --skip-identity-store-verification

オプション。このオプションは、Tableau Server (バージョン 2018.1 以前) で tabadmin により作成されたバックアップ ファイルから復元する場合にのみ指定します。

アイデンティティ ストアの確認をスキップします。このオプションは、tabadmin backup --no-config コマンドを使用して作成されたバックアップ ファイルを復元する場合に指定します。

-po, --pg-only

オプション。

リポジトリのみを復元します。

-r, --restart-server

オプション。

復元後にサーバーを再起動します。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

tsm maintenance send-logs

指定したファイルを Tableau にアップロードし、サポートするケースと関連付けます。Tableau にファイルを正常にアップロードするには、Tableau Server が https://report-issue.tableau.com の送信ログ サーバーと通信できる必要があります。

シノプシス

tsm maintenance send-logs --case <case_number> --email <contact_email> --file <path/to/file> [global options]

オプション

-c,--case <case_number>

必須。

サポートするケースの番号。

-e,--email <contact_email>

必須。

連絡先メール。

-f, --file <path/to/file>

必須。

送信するログ ファイル アーカイブの場所と名前を指定します。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

tsm maintenance validate-resources

サイトのワークブックおよびデータ ソースを検証します。

シノプシス

tsm maintenance validate-resources --site-id <site ID> [global options]

オプション

-id,--site-id <site ID>

必須。

リソースの検証を行っているサイトの ID。

-r,--repair

任意の項目です。

無効なリソースを修復します。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 1800 (30 分) です。

 

tsm maintenance ziplogs

ziplogs コマンドを使用して、Tableau Server ログ ファイルのアーカイブを作成します。

シノプシス

tsm maintenance ziplogs [options] [global options]

オプション

-a, --all

オプション。

msinfo、netstat、latest dump を含めます。-mi -t -l オプションを指定してコマンドを実行する操作と同じです。PostgreSQL データは含まれません。

-d, --with-postgresql-data

オプション。

Tableau Server が停止している場合は PostgreSQL データ フォルダーを含め、Tableau Server が実行中の場合は PostgreSQL ダンプ ファイルを含めます。

--description <string>

オプション。

指定したアーカイブ ファイルの説明が含まれます。

--enddate <mm/dd/yyyy>

任意の項目です。

含むべきログ ファイルの最終日付。このオプションは --startdate と一緒に使用する必要があり、--minimumdate オプションとは一緒に使用できません。このオプションを指定しない場合は、最大 2 日間のログが含まれます。

バージョン 2019.3 での追加

-f, --file <name>

オプション。

zip 形式で圧縮されたアーカイブ ファイルの名前を指定します。名前が指定されていない場合は logs.zip となります。ファイルは basefilepath.log_archive 変数で TSM  に定義したディレクトリに書き込まれます。既定のディレクトリは次のとおりです。

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

ファイル パスとその変更方法の詳細については、tsm ファイル パスを参照してください。

-i, --description <string>

オプション。

指定したアーカイブ ファイルの説明が含まれます。

-mi, --with-msinfo

オプション。

OS、ハードウェア、実行中のソフトウェアに関するシステム情報と共に msinfo32 レポートを含めます。

-l, --with-latest-dump

オプション。

いずれかのサービスがクラッシュすると、Tableau Server がダンプ ファイルを生成します。このオプションを設定すると、最新のサービス クラッシュ ダンプ ファイルが追加されます。このオプションを設定しない場合、結果として生成される ziplog にはダンプ ファイルが追加されません。

-m, --minimumdate <mm/dd/yyyy>

オプション。

ログ ファイルを最初に含めた日付。指定しない場合は、ログ ファイルの中から最大で 2 日間が含まれます。日付形式はmm/dd/yyyy で指定する必要があります。.このオプションは、--startdate および --enddate と一緒に使用することはできません。

-o、--overwrite

オプション。

既存の ziplog ファイルの上書き。同じ名前のファイルが既に存在していてこのオプションが使用されていない場合、ziplog コマンドは失敗します。

既定では、ファイルは次のように書き込まれます。

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

ファイル パスとその変更方法の詳細については、tsm ファイル パスを参照してください。

--startdate <mm/dd/yyyy>

任意の項目です。

含むべきログファイルの最も早い日付。このオプションは --enddate と一緒に使用する必要があり、--minimumdate オプションとは一緒に使用できません。このオプションを指定しない場合は、最大 2 日間のログが含まれます。

バージョン 2019.3 での追加

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。既定値は 7200 (120 分) です。

-t, --with-netstat-info

オプション。

netstat 情報を含めます。

 

グローバル オプション

-h, --help

オプション。

コマンドのヘルプを表示します。

-p, --password <password>

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

-u または --username で指定されたユーザーのパスワードを指定します。

パスワードにスペースや特殊文字が含まれる場合、これを引用符で囲みます。

--password "my password"

-s, --server <url_to_tsm>

オプション。

Tableau Services Manager で指定したアドレスを使用します。URL は https で始め、ポート 8850 を含め、IP アドレスではなくサーバー名を使用する必要があります (たとえば、https://mytableauhost:8850)。サーバーが指定されていない場合は、仮に https://<localhost | dnsname>:8850 とします。

--trust-admin-controller-cert

オプション。

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

-u, --username <user>

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

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

 

フィードバックをくださりありがとうございます! フィードバックの送信中にエラが発生しました。もう一度やり直すか、メッセージをお送りください