Tableau Server on Linux ヘルプ

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

tsm maintenance backup

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

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

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

/var/opt/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

オプション。

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

重要: Tableau サポートからの指示がない限り、バックアップを生成するときに pg-only オプションを使用しないでください。このオプションはリポジトリのみをバックアップし、Server の復元には使用できません。主な用途はトラブルシューティングであり、必要があれば Tableau サポートから --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)。

例

この例では、次のように /var/opt/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 jmx disable [options] [global options]

tsm maintenance jmx enable

tsm maintenance metadata-services disable

tsm maintenance metadata-services enable

tsm maintenance metadata-services get-status

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 変数で定義したディレクトリにバックアップ ファイルがあることを前提としています。既定のディレクトリは次のとおりです。

/var/opt/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 validate-resources

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

tsm maintenance ziplogs

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

注: ziplogs コマンドを正常に実行できない場合は、Tableau Server ログを手動で圧縮できます。詳細については、「Linux での Tableau Server のトラブルシューティング」を参照してください。

シノプシス

tsm maintenance ziplogs [options] [global options]

オプション

-a, --all

オプション。

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 に定義したディレクトリに書き込まれます。既定のディレクトリは次のとおりです。

/var/opt/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 と一緒に使用することはできません。

--nodes

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

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

tsm maintenance ziplogs --nodes node2,node4

-o、--overwrite

オプション。

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

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

/var/opt/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"

グローバル オプション

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

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