tsm maintenance


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

tsm maintenance backup

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

注: 外部ファイル ストアを使用している Tableau Server インストールでは、このコマンドを使用しないでください。「外部ファイル ストアによるバックアップと復元」を参照してください。

トポロジの構成を使用した最適化:

  • 管理コントローラーと同じノード上にファイル ストアを配置すると、バックアップ プロセス中にノード間でデータを転送する必要性が減少するか排除されるため、Tableau Server のバックアップにかかる時間を短縮できます。これは、組織で多数の抽出を使用している場合に特に当てはまります。
  • リポジトリ (pgsql) を管理コントローラー ノードと同じ場所に配置すると、バックアップ時間は短縮できますが、ファイル ストアの場合ほど時間の節約は顕著ではありません。

最初のノードでエラーがあった場合や、コントローラーを別のノードに移動した場合を除き、管理コントローラーは通常最初のノード上にあります。

バックアップ ファイルは、データ ディレクトリの一時的な場所に集められ、TSM basefilepath.backuprestore 変数に定義したディレクトリに書き込まれます。既定のディレクトリは次のとおりです。

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\<filename>.tsbak

バックアップ ファイルの書き込み先とその場所の変更方法の詳細については、tsm ファイル パスを参照してください。注: バックアップの場所を変更する場合でも、バックアップ プロセスではデータ ディレクトリの一時的な場所を使用してバックアップ ファイルを集めます。

シノプシス

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

オプション

-f, --file <backup_file>

必須。

リポジトリ データのバックアップの詳細については、「Tableau Server データのバックアップ」を参照してください。

-d, --append-date

オプション。

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

注: スケジュールを使用して作成されたバックアップには、バックアップファイル名の先頭に日付/時刻が自動的に含まれます。-d オプションも使用する場合、ファイル名には日付が 2 回含まれます。バックアップのスケジュール設定についての詳細は、「バックアップのスケジュール設定と管理」を参照してください。

-i, --description <string>

オプション。

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

--ignore-prompt

オプション。バージョン 2020.2 での追加

ファイル ストアが管理コントローラーと同じノード (通常は初期ノード) に存在しない場合でも、プロンプトを表示せずにバックアップします。このプロンプトは、バックアップを自動化する (たとえば、スクリプトを使用して) 場合に使用します。

-k, --skip-verification

オプション。

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

--multithreaded

任意の項目です。バージョン 2021.1 での追加

Tableau Server のバックアップを作成する場合、既定では単一のスレッドが使用されます。このオプションを指定すると、複数のスレッドを使用したバックアップが作成されます。このオプションを指定すると、既定で 2 つのスレッドが使用されます。使用するスレッドの数は backup.zstd.thread_count 構成キーを設定して変更できます。

--override-disk-space-check

オプション。

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

-po, --pg-only

オプション。

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

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまでの待機秒数既定値は 86400 (1440 分) です。

-sd, --schedule-days <day[,day]>

オプション。バージョン 2020.4 での追加

スケジュールを実行する日数週単位のスケジュールには 1 ～ 7 (月曜日は 1、日曜日は 7)、月単位のスケジュールには 1 ～ 31 を使用します (月に指定した日が含まれていない場合は、その月の最終日を使用します)。複数の値はコンマで区切ります。

-si, --schedule-id <ID>

オプション。バージョン 2020.4 での追加

更新する既存のスケジュールの ID を指定します。

--skip-compression

オプション。

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

-sn, --schedule-name <name>

オプション。バージョン 2020.4 での追加

作成または更新するスケジュールの名前を指定します。

-sr, --schedule-recurrence <frequency>

オプション。バージョン 2020.4 での追加

スケジュールを繰り返す頻度有効なオプションは、"毎日"、"毎週"、"毎月".です。

-st, --schedule-time <HH:MM>

オプション。バージョン 2020.4 での追加

スケジュールを実行する必要がある時刻 (24 時間形式: HH:MM)。

例

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

tsm maintenance backup -f ts_backup -d

この例では、毎週土曜日の正午に実行する "weekly-saturday-backup" という名前の毎週定期的に行うバックアップ スケジュールを作成し、<yyyy.mm.dd.hh.mm>-ts_saturday_backup.tsbak: という名前のバックアップを作成します。

tsm maintenance backup -f ts_saturday_backup -sr weekly -st 12:00 -sd 6 -sn weekly-saturday-backup

スケジュールされたバックアップの管理の詳細については、バックアップのスケジュール設定と管理を参照してください。

tsm maintenance cleanup

既定では、tsm maintenance cleanup コマンドは、1 日以上経過した一時ファイルとログ ファイルを削除します。コマンド オプションを使用して、保持期間や削除するファイルを変更できます。

このコマンドの影響は、Tableau Server が実行中かどうかよって異なります。

  • サーバーが実行されている場合、ほとんどの古いファイルと http_requests テーブル エントリは削除できますが、使用中のファイル (オペレーティング システムによってロックされているファイル) は削除できないため、一時ファイルとアクティブなログ ファイルは削除されません。一時ファイルと現在のログ ファイルを削除するには、このコマンドの実行前にサーバーを停止する必要があります。http_requests テーブル エントリを削除するには、-q オプションを使用します。
  • サーバーが停止している場合、http_requests エントリは削除できません。

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

シノプシス

tsm maintenance cleanup [options] [global options]

オプション

-a, --all

オプション。

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

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

オプション。

既定: 7 日

保持するテーブル エントリの http_requests 日数を指定します。このオプションを -q と一緒に使用すると、保持するテーブル エントリの日数を指定して、既定の 7 日間を上書きすることができます。このオプションはテーブル エントリの保持期間を指定しますが、テーブル エントリの実際の削除をトリガーしません。これを -q オプションと一緒に使用すると、エントリの削除がトリガーされます。

-ic, --sheet-image-cache

オプション。バージョン 2019.4 での追加

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

-l, --log-files

オプション。

1 日以上前のログ ファイルを削除します。data\tabsvc\logs の下にあるサブディレクトリのファイルは削除されます。

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

オプション。

既定: 1 (24 時間)

この日数より古いログを削除します。このオプションを使用して、既定の保持期間 (1 日) を上書きすることができます。このコマンドは、一時ファイルには適用されません。

-q, --http-requests-table

オプション。

古い http_requests テーブル エントリーを削除します。テーブル エントリを削除するには、Tableau Server が実行されている必要があります。Tableau Server が停止している場合、このオプションは無視されます。このオプションのみを使用して、既定の保持期間 (7 日) より古いエントリの削除を指定したり、--http-requests-table-retention と一緒に使用して既定以外の保持期間を指定したりできます。

注: http_requests テーブル エントリを削除すると、カスタム管理ビューで使用できるデータが完全に削除されます。このデータを削除しても、必要なカスタム ビューに影響しないことを確認してください。

-r, --redis-cache

オプション。

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

--request-timeout <timeout in seconds>

オプション。

既定: 3600

コマンドが終了するまで指定した時間待機します。

-t, --temp-files

オプション。

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

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\temp: 各 Tableau Server プロセス ディレクトリの下のファイルを削除するには、コマンドを実行する前に Tableau Server を停止する必要があります。Tableau Server の実行中にコマンドを実行すると、期限切れの (実行されていない) セッションのファイルを保存しているディレクトリのみが削除されます。

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

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

例

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

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

tsm maintenance jmx disable

バージョン: バージョン 2022.1 で追加されたコマンド

Tableau Server で JMX を無効にするには、tsm maintenance jmx disable コマンドを使用します。

このコマンドを実行するには、TSM サービスを含む Tableau Server を再起動する必要があります。

シノプシス

tsm maintenance jmx disable [options] [global options]

オプション

--ignore-prompt

オプション。

プロンプトを表示せずに JMX を無効にします。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance jmx enable

バージョン: バージョン 2022.1 で追加されたコマンド

Tableau Server で JMX を有効にするには、tsm maintenance jmx enable コマンドを使用します。

このコマンドはインタラクティブであり、コマンド ライン パラメーターとしてオプションを指定しない場合は、適用可能なオプションの入力を求めるプロンプトが表示されます。

このコマンドを実行するには、TSM サービスを含む Tableau Server を再起動する必要があります。

シノプシス

tsm maintenance jmx enable

オプション

--access <readonly | readwrite>

オプション。

読み取り専用または読み取り/書き込みアクセスのいずれかで JMX を有効にします。既定は readonly です。

--ignore-prompt

オプション。

追加のセキュリティ オプションのプロンプトを表示せずに JMX を有効にします。これにより、他のコマンド オプションを含めない場合は、SSL を使用した JMX が有効になり、Tableau Server を再起動します。例:

tsm maintenance jmx enable --ignore-prompt

--no-ssl

オプション。

SSL なしで JMX を有効にします。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

--ssl-client-auth

オプション。

SSL のクライアント認証を要求する JMX を有効にします。

--unsecured

オプション。

セキュリティ機能を有効にせずに JMX を有効にします (これは推奨されていません)。これは、2022.1 より前のバージョンで service.jmx_enabled 構成キーを true に設定することと同じです。

tsm maintenance metadata-services disable

バージョン: バージョン 2019.3 で追加されたコマンド

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 enable

バージョン: バージョン 2019.3 で追加されたコマンド

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

Tableau Server が データ管理 でライセンスされている場合は、メタデータ 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 get-status

バージョン: バージョン 2019.3 で追加されたコマンド

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

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

シノプシス

tsm maintenance metadata-services get-status

tsm maintenance preflight-check permissions

バージョン: バージョン 2020.3 で Tableau Server on Windows 用に追加されたコマンド

tsm maintenance preflight-check permissions コマンドを使用して、ディレクトリ パーミッションを確認します。

シノプシス

tsm maintenance preflight-check permissions [options] [global options]

オプション

-d, --data-dir <data directory>

オプション。

パーミッションを検証するデータ ディレクトリを指定します。データ ディレクトリが含まれていない場合、データ ディレクトリは Tableau Server の現在の構成に基づいて決定されます。

-i, --install-dir <install directory>

オプション。

パーミッションを検証するインストール ディレクトリを指定します。インストール ディレクトリが含まれていない場合、インストール ディレクトリは Tableau Server の現在の構成に基づいて決定されます。

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

オプション。

パーミッション チェックに明確に含める、ノードのノード ID。指定しない場合、クラスタ内のすべてのノードでチェックが実行されます。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

-ru --runas-user <timeout in seconds>

オプション。

パーミッションを検証する実行ユーザー名。指定しない場合、実行ユーザーは現在の構成から決定されます。

tsm maintenance preflight-check ports

バージョン: バージョン 2020.3 で Tableau Server on Windows 用に追加されたコマンド

tsm maintenance preflight-check ports コマンドを使用して、現在インストールされているすべてのサービスでポートが使用できることを確認します。サービスが現在インストールされていない場合でも、サービスとポートを指定して、そのサービスでポートが使用できることを確認します。

シノプシス

tsm maintenance preflight-check ports [options] [global options]

オプション

-a, --tabadminagent-addresses <hostname:port>

オプション。

管理エージェントへのアクセスをチェックするホストとポートを指定します。アドレスは、hostname:port のように書式設定されます。複数のホストおよびポートをチェックする場合は、アドレスをコンマで区切ります。このオプションを使用して、ポートをインストールまたは変更する前にポートが使用可能かどうかを確認します。

-g, --gateway-addresses <hostname:port>

オプション。

ゲートウェイ サービスへのアクセスをチェックするホストとポートを指定します。アドレスは、hostname:port のように書式設定されます。複数のホストおよびポートをチェックする場合は、アドレスをコンマで区切ります。このオプションを使用して、ポートをインストールまたは変更する前にポートが使用可能かどうかを確認します。

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

オプション。

事前チェックを実行する、ノードのノード ID。指定しない場合、クラスタ内のすべてのノードでチェックが実行されます。

-r, --repository-addresses <hostname:port>

オプション。

リポジトリ サービスへのアクセスをチェックするホストとポートを指定します。アドレスは、hostname:port のように書式設定されます。複数のホストおよびポートをチェックする場合は、アドレスをコンマで区切ります。このオプションを使用して、ポートをインストールまたは変更する前にポートが使用可能かどうかを確認します。

-re --remote

オプション。

管理エージェントへのすべてのノードからのモート アクセスをチェックします。このチェックは、既定では行われません。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

-t, --tabadmincontroller-addresses <hostname:port>

オプション。

管理コントローラーへのアクセスをチェックするホストとポートを指定します。アドレスは、hostname:port のように書式設定されます。複数のホストおよびポートをチェックする場合は、アドレスをコンマで区切ります。このオプションを使用して、ポートをインストールまたは変更する前にポートが使用可能かどうかを確認します。

tsm maintenance reindex-search

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

シノプシス

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

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance reset-searchserver

バージョン: このコマンドは 2023.3.0 で廃止 (削除) され、検索と参照 (検索サーバーとも呼ばれます) は廃止されました。検索と参照は、インデックスと検索サーバーに置き換えられました。

注: バージョン 2023.3.0 以降でこのコマンドを実行しても何も起こりません。

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

シノプシス

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

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance restore

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

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

バージョン 2022.3 以降、tabadmin を使用して作成したバックアップ (「以前の TSM バックアップ」) はサポートされていません。TSM 以前のバックアップを Tableau Server バージョン 2022.3 以降に復元することはできません。

シノプシス

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

オプション

-f, --file <file_name>

必須。

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

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

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

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

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

オプション。バージョン 2021.4.0 で非推奨になりました。

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

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

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

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

元のバックアップ ファイルを作成した Tableau Server からアイデンティティ ストアのタイプを変更する場合は、このキーを使用しないでください。ID ストアを変更するには、アイデンティティ ストアの変更 を参照してください。

-po, --pg-only

オプション。

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

-r, --restart-server

オプション。

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

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

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>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance snapshot-backup complete

バージョン: コマンドはバージョン 2020.1 で追加され、Tableau Server が外部ファイル ストア用に構成されている場合にのみ使用できます。

Tableau Server でスナップショット バックアップ プロセスを完了します。外部ストレージのスナップショット バックアップを作成した後、この手順を実行します。

tsm maintenance snapshot-backup prepare コマンドと tsm maintenance snapshot-backup complete コマンドは、外部ファイル ストアを使用して構成された Tableau Server インストール用の Tableau Server データのバックアップを作成するために使用します。詳細については、「外部ファイル ストアによるバックアップと復元」を参照してください。

シノプシス

tsm maintenance snapshot-backup complete [options] [global options]

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance snapshot-backup prepare

バージョン: コマンドはバージョン 2020.1 で追加され、Tableau Server が外部ファイル ストア用に構成されている場合にのみ使用できます。

スナップショット バックアップの準備を行います。準備手順が完了したら、ネットワーク ストレージのスナップショット バックアップを作成できます。

tsm maintenance snapshot-backup prepare コマンドと tsm maintenace snapshot-backup complete コマンドは、外部ファイル ストアを使用して構成された Tableau Server インストールを行うための Tableau Server データのバックアップを作成するために使用します。詳細については、「外部ファイル ストアによるバックアップと復元」を参照してください。

シノプシス

tsm maintenance snapshot-backup prepare [options] [global options]

オプション

--include-pg-backup

任意の項目です。バージョン 2021.1 での追加以前のバージョンには、常に外部リポジトリのバックアップが含まれていました。

任意の項目です。

リポジトリのバックアップが作成され、ネットワーク共有にコピーされます。これは、外部リポジトリと外部ファイル ストアの両方が構成されている展開にのみ適用されます。詳細については、外部ファイル ストアによるバックアップと復元を参照してください。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance snapshot-backup restore

バージョン: コマンドはバージョン 2020.1 で追加され、Tableau Server が外部ファイル ストア用に構成されている場合にのみ使用できます。

ストレージ スナップショットから Tableau Server にリポジトリ バックアップを復元します。

詳細については、「外部ファイル ストアによるバックアップと復元」を参照してください。

シノプシス

tsm maintenance snapshot-backup restore [options] [global options]

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance validate-backup-basefilepath

バージョン: バージョン 2022.1 で追加されたコマンド

バックアップ / 復元のベース ファイルパスの場所に、バックアップおよび復元機能が正常に動作するための正しいパーミッションがあることを確認します。バックアップと復元のベースファイルパスを設定した後、これを実行します。詳細については、現在のファイルの場所を変更するを参照してください。

シノプシス

tsm maintenance validate-backup-basefilepath [options][global options]

オプション

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

tsm maintenance validate-resources

サイトのワークブックおよびデータ ソースを検証します。サイトを移行する前にこのコマンドを使用して、サイトのインポートが失敗する原因となるワークブックやデータソースなどのサイトリソースに関する問題を検出します。リソースの問題の中には、ローカルソースから再発行することで解決できるものもあります。その他の問題では、Tableau サポートのサポートが必要になる場合があります。

シノプシス

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

オプション

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

必須。

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

-r,--repair

オプション。

無効なリソースの修復を試みます。修復できないものは出力に記載されています。

--request-timeout <timeout in seconds>

オプション。

コマンドが終了するまで指定した時間待機します。

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 ダンプ ファイルを含めます。このフラグは、Tableau Server 外部リポジトリで実行されている展開では無視されます。

--enddate "<mm/dd/yyyy H:mm>"

オプション。時刻オプション (H:mm) がバージョン 2021.4.0 で追加されました。

含むべきログ ファイルの最終日付。このオプションは --startdate と一緒に使用する必要があり、--minimumdate オプションとは一緒に使用できません。このオプションを指定しない場合は、00:00 GMT (グリニッジ標準時) を開始時刻として、最大 2 日間のログが含まれます。

時刻オプションを含める場合は、日付と時刻を引用符で囲む必要があります。時間オプションは GMT を使用しますが、結果のログ ファイルは Tableau Server マシンのローカル タイム ゾーンを使用して書き込まれます。

例: Tableau Server マシンのローカル タイム ゾーンが PDT で、ログ ファイルを 2022 年 7 月 28 日の午前 7 時 (太平洋夏時間) に開始し、午後 7 時 (太平洋夏時間) に終了する場合は、次を使用します。

tsm maintenance ziplogs -f logs.zip --startdate "07/28/2022 14:00" --enddate "07/29/2022 02:00"

-f, --file <name>

オプション。

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

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

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

-i, --description <string>

オプション。

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

-l, --with-latest-dump

オプション。

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

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

オプション。

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

-mi, --with-msinfo

オプション。

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

--nodes

任意の項目です。バージョン 2020.3 での追加

ziplog ファイルを作成するノードを指定します。指定しない場合、すべてのノードで ziplog ファイルが作成され、初期ノードに保存されます。ノードはコンマで区切ります。たとえば、ノード 2 と 4 のログを収集するには、次の手順を実行します。

tsm maintenance ziplogs --nodes node2,node4

-o、--overwrite

オプション。

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

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

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

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

--request-timeout <seconds>

任意の項目です。

コマンドが終了するまでの待機秒数既定値は 7200 (120 分) です。

--startdate "<mm/dd/yyyy H:mm>"

オプション。時刻オプション (H:mm) がバージョン 2021.4.0 で追加されました。

含むべきログ ファイルの最終日付。このオプションは --enddate と一緒に使用する必要があり、--minimumdate オプションとは一緒に使用できません。このオプションを指定しない場合は、00:00 GMT (グリニッジ標準時) を開始時刻として、最大 2 日間のログが含まれます。

時刻オプションを含める場合は、日付と時刻を引用符で囲む必要があります。時間オプションは GMT を使用しますが、結果のログ ファイルは Tableau Server マシンのローカル タイム ゾーンを使用して書き込まれます。

例: Tableau Server マシンのローカル タイム ゾーンが PDT で、ログ ファイルを 2022 年 7 月 28 日の午前 7 時 (太平洋夏時間) に開始し、午後 7 時 (太平洋夏時間) に終了する場合は、次を使用します。

tsm maintenance ziplogs -f logs.zip --startdate "07/28/2022 14:00" --enddate "07/29/2022 02:00"

-t, --with-netstat-info

オプション。

netstat 情報を含めます。

 

グローバル オプション

-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 と一緒に使用します。

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

 

一番上に戻る
フィードバックをお送りいただき、ありがとうございます。フィードバックは正常に送信されました。ありがとうございます!