tsm configuration set のオプション
以下は、 tsm configuration set
コマンドで設定できる設定オプションまたはキーのリストです。多くの場合、この tsm configuration get
コマンドを使用して、構成キーの現在の値を確認できます。
このリストは、Tableau Server の構成設定の完全なリストではありません。サーバー管理者が設定できる構成キーの一部です。Tableau Server が内部で使用するキーの一部は、このリストに表示されません。
注: 構成キーでは、大文字と小文字が区別されます。
tsm CLI を使用する
tsm コマンドは、第一ノード (TSM がインストールされているノード)、またはクラスター内の任意の追加ノードで実行できます。
tsm コマンドを実行するには、コマンド プロンプトを開く必要があります。
クラスター内のノード上で、
tsmadmin
グループのメンバー アカウントを使用してコマンド プロンプトを開きます。必要なコマンドを実行します。第一ノード以外のノードからコマンドを実行する場合は、
-s
オプションを含めて第一ノードの URL を名前 (IP アドレスではない) で指定し、TSM ポートの 8850 を含めます。第一ノードから TSM と Tableau Server のバージョンを確認するには、次のコマンドを実行します。
tsm version
追加のノードから TSM と Tableau Server のバージョンを確認するには、次のコマンドを実行します。
tsm version -s https://<inital_node_name>:8850
例:
tsm version -s https://myTableauHost:8850
Tsm 構成キーの基本的な使用方法
構成キーを設定する
tsm configuration set -k <config.key> -v <config_value>
場合によっては、以前に設定されていないキーの構成値を設定する --force-keys
オプションを含める必要があります。詳細については、「不明なキー」の応答を参照してください。
構成キーの値を設定後、tsm pending-changes apply
を使用して保留中の構成の変更を適用する必要があります。適用するまでは、新しい値は Tableau で使用されない、または tsm configuration get
コマンドの結果に表示されます。tsm pending-changes list
を使用すると、保留中の変更を表示できます。詳細については、tsm pending-changesを参照してください。
構成キーを既定値にリセットする
構成キーを既定値にリセットするには、以下の -d
オプションを使用します。
tsm configuration set -k <config.key> -d
構成キーの現在の値を確認する
現在設定されている構成キーを確認するには、次のように configuration get
コマンドを使用します。
tsm configuration get -k <config.key>
キーの有用な現在の値を返さない 2 つの特殊なケースがあります。
明示的に設定されていないキーの設定値を取得できない場合があります。代わりに、
tsm configuration get
コマンドは「不明なキー」応答を返します。詳細については、「不明なキー」の応答を参照してください。既定値が事前定義されている特定のキーの場合、
tsm configuration get
コマンドは "Null" 応答を返します。詳細については、"NULL" 値の応答を参照してください。
構成キー
adminviews.disabled
既定値: false
Tableau 管理ビューへのアクセスを無効にします。既定では、ビューへのアクセスが有効になっています (このオプションが [false] に設定されています)。
api.server.enabled
バージョン: バージョン 2023.1 で非推奨となりました。バージョン 2023.1 以降では、REST API を無効にすることはできません。
既定値: true
Tableau Server REST API(新しいウィンドウでリンクが開く) へのアクセスを許可します。
既定では、この機能が有効になっています。この設定を維持することを強くお勧めします。REST API を無効にすると、Tableau 機能が広範囲にわたって中断されます。パフォーマンスの向上やセキュリティの強化が行われません。Tableau Server インストールで REST API を無効にすることを選択した場合は、必要な機能のテストを十分に行うようにしてください。
REST API を無効にすることにより影響を受ける機能:
- 検索
- お気に入り
- コレクション
- コンテンツ管理ツール (CMT)
- Resource Monitoring Tool (RMT)
- パーソナル スペース
auditing.enabled
既定値: true
PostgreSQL (Tableau Server の独自のデータベース) 履歴監査テーブルへのアクセスを許可します。
backgrounder.default_run_now_priority
既定値 (整数): 0
この設定は、「今すぐ実行」するジョブに割り当てる優先度を制御します。0 が最高の優先度です。値は 0 から 100 の範囲で指定します。
backgrounder.enable_parallel_adsync
バージョン: バージョン 2018.3.6 で追加。
既定値: false
複数のバックグラウンダーがある場合に、外部ディレクトリ グループの同期ジョブの並列処理を許可するかどうかを制御します。既定では、外部ディレクトリ グループのスケジュールされた同期は、単一のバックグラウンダーによって順番に処理されます。この値を true
に設定すると、複数のバックグラウンダー インスタンスで並列処理が有効になります。
backgrounder.externalquerycachewarmup.enabled
バージョン: バージョン 2023.1 で非推奨となりました。ワークブックのビューの読み込み時間を改善するには、代わりにサイトでビューの高速化を許可してください。
既定値: false
スケジュールされた抽出の更新タスク後にワークブックのクエリ結果のキャッシュを制御します。
backgrounder.externalquerycachewarmup.view_threshold
バージョン: バージョン 2023.1 で非推奨となりました。ワークブックのビューの読み込み時間を改善するには、代わりにサイトでビューの高速化を許可してください。
既定値: 2.0
スケジュールされた抽出の更新タスク後にワークブックのクエリ結果をキャッシュするしきい値。しきい値は、ワークブックが過去 7 日間で受信したビューの数を今後 7 日間にスケジュールされている更新の数で割った数と等しくなります。
次の 2 つの backgrounder コマンド オプションにより、フローのバックグラウンド タスクがキャンセルされるまでのフロー タスクの実行時間が決まります。これらの 2 つのコマンドの組み合わせで、フロー タスクの合計タイムアウト値が決まります。
backgrounder.extra_timeout_in_seconds
既定値: 1800
backgrounder.querylimit
の設定を超えて、バックグラウンド ジョブがキャンセルされるまでの秒数。この設定により、停止したジョブが後続のジョブを保持しないようにします。設定は、backgrounder.timeout_tasks
にリストされているプロセスに適用されます。1,800 秒は 30 分です。
backgrounder.default_timeout.run_flow
既定値: 14400
フロー実行タスクがキャンセルされるまでの秒数。14,400 秒は 4 時間です。
backgrounder.failure_threshold_for_run_prevention
既定値: 5
サブスクリプション、抽出、またはフロー実行ジョブを連続して失敗するとジョブが一時停止される回数。連続して失敗した後にジョブを一時停止することで、他のジョブのバックグラウンダー リソースを保持するのに役立ちます。失敗したバックグラウンド タスクの一時停止を無効にするには、これを -1
に設定します。
backgrounder.log.level
バージョン: バージョン 2020.3.0 で追加。
既定値: info
バックグラウンダー プロセスのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
backgrounder.querylimit
既定値: 7200
1 つの抽出更新ジョブを完了するまでの秒単位の最大許容時間。7200 秒 = 2 時間。
注: バックグラウンド ジョブがこの時間制限に到達しても、キャンセルされる前に数分間引き続き実行される場合があります。
backgrounder.restrict_serial_collections_to_site_level
既定値: false
Tableau Server では、定期的に実行する抽出更新、サブスクリプション、フローなどをユーザーがスケジューリングできます。これらのスケジュールされた項目はタスクと呼ばれます。バックグラウンダー プロセスは、これらのタスクの固有のインスタンスを開始して、スケジュールされた時刻に実行します。結果として開始されたタスクの固有インスタンスは、ジョブと呼ばれます。
この設定は、順番に実行するように構成されているスケジュールに影響します。デフォルトでは、スケジュールを順番に実行するように設定している場合、そのスケジュールを使用するすべてのジョブは順番に実行されます。これを true
に設定すると、異なるサイトで実行するジョブは並行して実行できるようになります。同じサイトでスケジュールされたタスクのジョブは、引き続き順番に実行されます。
以下の例は、次のシナリオを示したものです。
毎日午前 7 時にジョブを実行する「毎日」という名前のスケジュールが Tableau Server にあります。「毎日」スケジュールは、順番に実行するように設定されています。「人事」サイトと「給与」サイトにはそれぞれ、「毎日」スケジュールを使用する複数のタスクがスケジュールされています。この設定が true
に設定されている場合、「人事」サイトのこれらのスケジュールされたタスクのジョブは、「給与」サイトのジョブと並行して実行できますが、同じサイト上のジョブは引き続き順番に実行されます。
backgrounder.notifications_enabled
既定値: true
サーバー上のすべてのサイトで抽出更新アラートとフロー実行アラートを有効化するかどうかを制御します。既定では、アラートは有効になっています。サーバー上のすべてのサイトでアラートを無効にするには、これを false
に設定します。
抽出アラートはサイト設定のサイト管理者別にサイト ベースで、またはユーザー設定のユーザー レベルで有効化または無効化できます。
backgrounder.sort_jobs_by_type_schedule_boundary_heuristics_milliSeconds
既定値: 60000
同じ開始時間をスケジュールするよう判断するバックグラウンダー ジョブを特定する時間枠を制御します。
バックグラウンダー プロセスは、最も速いカテゴリを最初に実行し、同時にジョブのタイプ別に実行するようスケジュールされた作業を命令します。サブスクリプション、増分抽出、完全抽出。
「同時」にスケジュールされているジョブを判断するため、ジョブが一括化されます。60,000 ミリ秒の値 (既定) は、1 分以内のウィンドウで開始するジョブを同じバッチに分類し、そのバッチ内でタイプ別に並べ替える必要があることを示します。
backgrounder.subscription_failure_threshold_for_run_prevention
既定値: 5
ある状態についてのアラートを一時停止する前に発生しなければいけない、連続するサブスクリプションの失敗数を決定します。既定値の 5
に設定されていると、サブスクリプションの失敗が連続 5 回発生した後に、アラートが一時停止になります。値を -1
にすると、通知メールを回数制限なしで送信できます。このしきい値はサーバー全体に対するものであるため、サーバー上で定義されているすべてのサブスクリプションに適用されます。
backgrounder.subscription_image_caching
既定値: true
サブスクリプション用に生成されたイメージのキャッシュをバッククグラウンダーで生成するかどうかを制御します。キャッシュによってサブスクリプションのパフォーマンスが改善されるため、キャッシュされたイメージを毎回再生成する必要はありません。既定では、イメージのキャッシュが有効になっています。サーバー上のすべてのサイトでイメージのキャッシュ作成を無効にするには、これを false
に設定します。
backgrounder.timeout_tasks
既定値: デフォルト値は、ご利用の Tableau Server のバージョンによって異なる場合があります。ご利用の Tableau のバージョンに対するデフォルト値のリストを表示するには、tsm configuration get
コマンドを実行します。
tsm configuration get -k backgrounder.timeout_tasks
タスクが backgrounder.querylimit
や backgrounder.extra_timeout_in_seconds
の組み合わされた値よりも長い時間実行する場合にキャンセルできるタスクのリスト。タスクのリストはコンマで区切られます。既定のリストは、この設定がとり得るすべての値を表します。
backgrounder.timeout.single_subscription_notify
バージョン: バージョン 2021.2 で追加。
既定値: 1800
秒 (30 分)
単一のサブスクリプション ジョブを完了するまでの、秒単位で指定された最大許容時間です。
backgrounder.timeout.sync_ad_group
バージョン: バージョン 2021.1.23、2021.2.21、2021.3.20、2021.4.15、2022.1.11、2022.3.3、2023.1 で追加されました。
既定値: 14400
秒 (4 時間)
これは、Active Directory のグループ同期を完了させるための最大許容時間 (秒単位) です。これはバックグラウンダー サービスによって実行されるスケジュールされたグループ同期に適用され、長時間実行される同期が無期限に実行されるのを防ぎます。これは、Tableau Server UI または REST API を使用して行われるグループ同期には影響しません。
backgrounder.vInstances_max_overflow_queue_size
バージョン: バージョン 2021.2 で追加。
既定値: 1000
セカンダリ キューに入れることができるジョブの最大数。実行中のジョブの数が設定された同時実行制限に達すると、セカンダリ キューが作成されます。デフォルトの最大値は 1000 ジョブに設定されています。つまり、同時実行制限に達したときに 1000 を超えるジョブがある場合、1000 を超えるジョブはキューに入れられません。オーバーフローの最大キュー サイズを変更するには、tsm コマンド backgrounder.vInstance_max_overflow_queue_size を使用します。
値は整数で指定する必要があります。
backup.zstd.thread_count
バージョン: バージョン 2021.1.0 で追加。このキーは動的に構成できます。詳細については、「Tableau Server の動的トポロジの変更」を参照してください。
既定値: 2
バックアップ作成時に使用するスレッドの数。
この数を増やすとバックアップのパフォーマンスが向上しますが、スレッド数は Tableau Server コンピューターの論理プロセッサー数を超えないようにし、多くても 4 つまでとすることをお勧めします。
basefilepath.backuprestore
既定値: /var/opt/tableau/tableau_server/data/tabsvc/files/backups/
tsm maintenance backup
コマンドでバックアップを作成する場所。これは、tsm maintenance restore
コマンドや tsm maintenance send-logs
コマンドを使用して復元する場合に、バックアップ ファイルが必要となる場所でもあります。これを設定した後、tsm maintenance validate-backup-basefilepath コマンド (バージョン 2022.1 以降で使用可能) を実行して、その場所の権限が正しく設定されていることを確認する必要があります。詳細については、tsm ファイル パスを参照してください。
basefilepath.log_archive
既定値: /var/opt/tableau/tableau_server/data/tabsvc/files/log-archives/
tsm maintenance ziplogs
コマンドで圧縮されたアーカイブを作成する場所。詳細については、tsm ファイル パスを参照してください。
basefilepath.site_export.exports
既定値: /var/opt/tableau/tableau_server/data/tabsvc/files/siteexports/
tsm sites export
コマンドでエクスポート ファイルを作成する場所。詳細については、tsm ファイル パスを参照してください。
basefilepath.site_import.exports
既定値: /var/opt/tableau/tableau_server/data/tabsvc/files/siteimports/
tsm sites import
コマンドによりインポート ファイルの配置が想定される場所。詳細については、tsm ファイル パスを参照してください。
clustercontroller.log.level
バージョン: バージョン 2020.3.0 で追加。
既定値: info
クラスタ コントローラーのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
clustercontroller.zk_session_timeout_ms
既定値: 300000
クラスタ コントローラーがフェールオーバーの必要性を判断するまで調整サービス (ZooKeeper) を待機する時間 (ミリ秒)。
dataAlerts.checkIntervalInMinutes
既定値: 60
データアラート条件が True かどうかを判断するために Tableau Server がチェックする頻度 (分)。
(また、サーバーでは、データ アラートに関連する抽出が更新される度にチェックを行います)。
dataAlerts.retryFailedAlertsAfterCheckInterval
既定値: true
失敗したデータアラートを Tableau Server が再チェックする頻度。true
に設定すると、サーバーは、dataAlerts.checkIntervalInMinutes
で定義した頻度で失敗したアラートを再チェックします。false
に設定すると、サーバーは 5 分ごとに失敗したアラートを再チェックし、アラートの受信者に対してより頻繁にデータ条件の変更を通知しますが、これによってサーバーのパフォーマンスは低下します。
(また、サーバーでは、データ アラートに関連する抽出が更新される度にチェックを行います)。
dataAlerts.SuspendFailureThreshold
既定値: 350
ある状態についてのアラートを一時停止する前に発生しなければいけない、連続するデータ アラートの失敗数を決定します。既定値の 350 に設定されているとき、アラートが約 2 週間発生した後に、アラートは一時停止になります。このしきい値はサーバー全体に対するものであるため、サーバー上で定義されているすべてのデータ アラートに適用されます。
databaseservice.max_database_deletes_per_run
バージョン: バージョン 2021.2 で追加。
既定値: NULL
このオプションを使用して、バックグラウンド処理のたびに削除できる埋め込み外部アセット (データベースおよびテーブル) の最大数を調整します。features.DeleteOrphanedEmbeddedDatabaseAsset
で制御します。このオプションを空のままにすると、削除できる埋め込み外部アセットのデフォルトの最大数は 100 になります。
詳細については、features.DeleteOrphanedEmbeddedDatabaseAsset を参照してください。
dataserver.log.level
バージョン: バージョン 2020.3.0 で追加。
既定値: info
Data Server のロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
elasticserver.vmopts
バージョン: バージョン 2019.1 で追加。削除: 2022.1
この構成オプションは、Tableau Server バージョン 2022.1 以降では無効です。Tableau Server バージョン 2022.1 以降の場合は、indexandsearchserver.vmopts
構成オプションを使用してください。
既定値: "-Xmx<default_value> -Xms<default_value>
"
既定値は、システム メモリの量によって異なります。JVM の最大ヒープ サイズは、システム RAM 全体の 3.125% にスケールされます。
Elastic Server のヒープ サイズを制御します。既定値は自動的にスケールされます。どうしても必要な場合にのみ、このオプションを使用して既定値を上書きしてください。キロバイトを示すには 'k'、メガバイトを示すには 'm'、ギガバイトを示すには 'g' を値に追加します。一般的なルールとして、ガベージ コレクションを最小化するには、初期ヒープ サイズ (-Xms
) を最大ヒープ サイズ (-Xmx
) と等しくなるように設定します。
excel.shadow_copy_all_remote.enabled
バージョン: バージョン 2019.1.5、2019.2.1 で追加。
既定値: false
ライブ データ ソースとして使用されている共有 Excel スプレッドシート (.xlxs
または .xlxm
) の "シャドウ コピー" を作成するかどうかを制御します。このオプションを有効にすると、Excel で「共有違反エラー」や「ファイルが使用中です」といったメッセージが表示されなくなります。大きい Excel ファイルの場合、このオプションはパフォーマンスに影響を与える可能性があります。Excel ユーザーが共有ファイルを編集する必要がない場合、このオプションを有効にする必要はありません。
注: .xls
ファイルの場合、Tableau Server ではシャドウ コピーの作成が常に試行されます。このオプションを選択してもこの動作は変更されません。
extractservice.command.execution.timeout
バージョン: バージョン 2021.4 で追加。
既定値: 7200
秒
VConn 抽出更新ランタイムのタイムアウト値を設定します。
例: tsm configuration set -k extractservice.command.execution.timeout -v <timeout_in_seconds> --force-keys
注: この値を変更するには、--force-keys
オプションを使用する必要があります。
features.ActiveMQ
バージョン: バージョン 2021.4 で追加。
既定値: true
Tableau Server で内部メッセージング メカニズムに Apache ActiveMQ サービス (Tableau Server Messaging Service) を使用するかどうかを制御します。
features.DeleteOrphanedEmbeddedDatabaseAsset
バージョン: バージョン 2021.2 で追加。
既定値: true
Tableau Catalog (または Tableau メタデータ API) のバックグラウンド プロセスを制御します。このプロセスは、ダウンストリームの Tableau コンテンツに関連付けられなくなった埋め込み外部アセット (データベースおよびテーブル) を削除します。このプロセスは毎日 22:00:00 UTC (協定世界時) に実行され、ダウンストリームの Tableau コンテンツへの接続がない外部アセットがなくなるまで、毎日最大 100 個の外部アセットを削除できます。このオプションを false
に設定すると、このプロセスの実行を停止できます。または、databaseservice.max_database_deletes_per_run を使用して、削除できる外部埋め込みアセットの最大数を調整することもできます。
詳細については、「トラブルシューティング - コンテンツが見つからない」を参照してください。
features.DesktopReporting
既定値: false
サーバー上でデスクトップ ライセンス レポートを有効化するかどうかを制御します。false
に設定すると (既定)、デスクトップ ライセンスに関連する管理ビューを使用できません。これを true
に設定してライセンス レポートを有効にし、[サーバーのステータス] ページでライセンス使用状況と有効期限の管理ビューを表示できるようにします。注:Tableau Server に情報を報告するには、クライアント (Tableau Desktop) でデスクトップ ライセンス レポートを有効にする必要があります。
features.IdentityMigrationBackgroundJob
バージョン: 2022.1 で追加。バージョン 2021.4.22、2022.1.18、2022.3.10、2023.1.6、2023.3 で、デフォルト値が false
に変更されました。
既定値: false
ID の移行を実行するプロセスを制御します。true
に設定すると、ID の移行は、Tableau Server をバージョン 2022.1 (またはそれ以降) にアップグレードしてバージョン 2021.4 (またはそれ以前) のバックアップを復元した直後に、既存の展開で実行されます。false
(デフォルト) に設定すると、ID の移行を無効にします。
たとえば、ID の移行を開始するには、次のコマンドを実行します。
tsm configuration set -k features.IdentityMigrationBackgroundJob -v true
詳細については、「ID の移行について」を参照してください。
注: ID の移行が無効になっている場合、Tableau Server は ID サービスを使用してユーザーの ID 情報を保存したり管理したりすることができません。ID プールなどの特定の機能は、ID サービスを使用することが前提条件になっています。
features.IdentityPools
バージョン: バージョン 2023.1 で追加されました
既定値: false
Tableau Server を新規にインストールする場合に有効にする必要があるアイデンティティ プール機能のコンポーネント。feature.NewIdentityMode
と wgserver.authentication.legacy_identity_mode.enabled
が必要です。アイデンティティ プールを有効にするには、true
に設定します。アイデンティティ プールを無効にするには、false
(既定) に設定します。
たとえば、アイデンティティ プールを有効するには、次のコマンドを実行します。
tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply
詳細については、「ID プールのトラブルシューティング」を参照してください。
features.MessageBusEnabled
バージョン: バージョン 2019.4 で追加。
既定値: true
Tableau Server で新しい内部メッセージング メカニズムを使用するかどうかを制御します。
features.NewIdentityMode
バージョン: 2022.1 で追加されました
既定値: false
既定値は、2023.1.6 で true
から false
に変更されました。
アイデンティティ プール機能の前提条件アイデンティティ プールを有効にするには、wgserver.authentication.legacy_identity_mode.enabled
を false
に設定する必要があります。アイデンティティ プールを無効にするには、true
に設定します。
tsm configuration set -k features.IdentityPools -v true
tsm configuration set -k features.NewIdentityMode -v true
tsm configuration set -k wgserver.authentication.legacy_identity_mode.enabled -v false
tsm pending-changes apply
詳細については、「ID プールのトラブルシューティング」を参照してください。
features.PasswordlessBootstrapInit
既定値: true
Tableau Server の bootstrap ファイル内で埋め込みの認証資格情報を許可するかどうかを制御します。有効にした場合 (既定)、埋め込みの認証資格情報を含めないことを指定しない限り、この情報が bootstrap ファイルに追加されます。生成するすべての bootstrap ファイルに認証資格情報を含めない場合は、これを false
に設定します。bootstrap ファイル生成の詳細については、tsm topology nodes get-bootstrap-fileを参照してください。
このオプションは Tableau Server バージョン 2019.3 で追加されました。
features.PasswordReset
既定値: false
ローカル認証を使用するサーバーにのみ適用されます。この値を true
に設定し、ユーザーがサインイン ページの [パスワードを忘れましたか] オプションでパスワードをリセットできるようにします。
filestore.empty_folders_reaper.enabled
バージョン: 2020.x (2020.1.14、2020.2.11、2020.3.6、2020.4.2) と 2021.1.x で追加。デフォルト値は、2021.2 で true
に変更されました。
既定値: true
空の Filestore フォルダーを“刈り取る” (削除する) ジョブを有効にします。
filestore_empty_folders_reap.frequency_s
バージョン: 2020.x (2020.1.14、2020.2.11、2020.3.6、2020.4.2) で追加。
既定値: 86400
(24 時間)
空の Filestore フォルダーを削除するジョブの実行頻度を分単位で指定します。
features.Hyper_DisallowTDEPublishing
バージョン: バージョン 2023.1.0 から true
がデフォルトになりました。
既定値: true
ユーザーが .tde 形式のファイルをアップロードできるかどうかを指定します。この形式は、Tableau Server のバージョン 10.5 から .hyper 形式に置き換えられましたが、アップロードはブロックされませんでした。バージョン 2024.3 以降、.tde 形式のファイルは使用できなくなりました。いくつかあるアクションのいずれかが実行されると、ファイルは自動的に .hyper 形式に変換されました。詳細については、「.hyper 形式への抽出のアップグレード」を参照してください。
filestore.log.level
features.Hyper_DisallowTDEPublishing
バージョン: バージョン 2020.3.0 で追加。
既定値: info
ファイル ストアのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
filestore.reapemptyfoldersholdoffms
バージョン: 2020.x (2020.1.14、2020.2.11、2020.3.6、2020.4.2) で追加。2021.1 ではまだ利用できません。
既定値: 300000
(5 分)
空の Filestore フォルダーを削除するまでに待機する時間をミリ秒単位で指定します。
floweditor.max_datafile_upload_size_in_kb
バージョン: バージョン 2020.4 で追加。
既定値: 1048576
Tableau Prep フローの Web オーサリングにおいて、Tableau Server にアップロードできる文字区切りテキスト ファイル (CSV や TXT など) の最大サイズ。
gateway.external_url
バージョン: バージョン 2023.1 で追加されました
既定値: Null
Tableau Server をセットアップするとき、または ID プールを使用するとき、OpenID Connect (OIDC) 認証を TSM で設定するために必要です。ID プロバイダー (IdP) が認証するユーザーを Tableau にリダイレクトするために使用する Tableau Server URL を指定します。ゲートウェイの外部 URL は、IdP でリダイレクト URL として指定したものと同じ URL であり、照合の目的で使用されます。
たとえば、OIDC 認証設定で関連付けた IdP を Tableau Server (http://myco) にリダイレクトするには、次のコマンドを実行します。
tsm configuration set -k gateway.external_url -v http://myco
gateway.http.cachecontrol.updated
既定値: false
Cache-Control HTTP ヘッダーは、クライアント ブラウザーが Tableau Server から送信されたコンテンツをキャッシュする必要があるかどうかを指定します。クライアントでの Tableau Server データのキャッシュを無効にするには、このオプションを true
に設定します。
gateway.http.hsts
既定値: false
HTTP Strict Transport Security (HSTS) ヘッダーによって、有効になっているドメインの HTTPS がブラウザーで強制的に使用されます。
gateway.http.hsts_options
既定値: "max-age=31536000"
既定では、HSTS ポリシーが 1 年に設定されています (31536000 秒)。ブラウザーが HTTPS 経由でサーバーにアクセスする期間を指定します。
gateway.httpd.loglevel
バージョン: 2021.3.0 で追加。
既定値: notice
ゲートウェイ (Apache HTTPD サーバー) のロギング レベルを指定します。既定では notice
に設定されています。その他の選択肢には、debug
、info
、warning
、および error
があります。ロギング レベルを変更する場合は、ディスク容量使用率とパフォーマンスに影響が及ぶ可能性があることに注意してください。ベスト プラクティスとして、必要な情報を収集した後、ロギング レベルを既定に戻します。Apache ロギングの詳細については、Apache HTTP に関するドキュメント(新しいウィンドウでリンクが開く)を参照してください。
gateway.httpd.shmcb.size
バージョン: 2021.4 で追加
既定値: 2048000
shmcb
ストレージ タイプを使用する場合の循環バッファーのメモリ量をバイト単位で指定します。この構成キーは、dbm
ストレージ タイプを使用する場合は適用されません。
gateway.httpd.socache
バージョン: 2021.4 で追加
既定値: shmcb
グローバルまたはプロセス間の SSL セッション キャッシュのストレージ タイプを指定します。デフォルトでは、shmcb
に設定されています。構成可能なもう一つのオプションは dbm
です。shmcb
と dbm
のストレージ タイプの詳細については、Apache Web サイトの「SSLSessionCache Directive」(新しいウィンドウでリンクが開く)を参照してください。
gateway.http.request_size_limit
既定値: 16380
HTTP 要求上で Apache ゲートウェイを通じて渡すことが許可されているヘッダー コンテンツの最大サイズ (バイト)。ヘッダーがこのオプションで設定された値を超えると、ブラウザーに HTTP Error 413 (要求するエンティティが長すぎます) や認証エラーなどのエラーが表示されます。
gateway.http.request_size_limit
の値が小さいと、認証エラーが発生する可能性があります。Active Directory (SAML および Kerberos) と統合するシングル サインオン ソリューションでは、多くの場合、HTTP ヘッダーに大きな認証トークンが必要です。本番環境に展開する前に、必ず HTTP 認証シナリオをテストしてください。
tomcat.http.maxrequestsize
オプションを、このオプションに設定した値と同じ値に設定することをお勧めします。
gateway.http.x_content_type_nosniff
既定値: true
X-Content-Type-Options の応答 HTTP ヘッダーによって、Content-Type ヘッダーの MIME タイプがブラウザーで変更されないように指定されます。MIME タイプが指定されていない場合、ブラウザーではペイロードの特性を評価して MIME タイプを判断しようとすることがあります。次に、ブラウザーにコンテンツが表示されます。このプロセスは「スニッフィング」と呼ばれます。MIME タイプを誤って解釈すると、セキュリティの脆弱性を招く恐れがあります。X-Content-Type-Options HTTP ヘッダーは、既定でこのオプションを使用して 'nosniff' に設定されます。
gateway.http.x_xss_protection
既定値: true
HTTP X-XSS-Protection 応答ヘッダーがブラウザーに送信され、クロスサイト スクリプティング (XSS) 保護が有効になります。X-XSS-Protection 応答ヘッダーは、ユーザーがブラウザーで XSS 保護を無効にした場合に構成を上書きします。既定では、X-XSS-Protection 応答ヘッダーがこのオプションを使用して有効になります。
gateway.log.level
バージョン: バージョン 2020.3.0 で追加。
既定値: info
ゲートウェイのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
gateway.public.host
既定値: <hostname>
Tableau Server への外部からのアクセスで使用されるサーバーの名前 (URL)。Tableau Server がプロキシ サーバーまたは外部ロード バランサーを使用するように構成されている場合は、Tableau Server にアクセスするためにブラウザーのアドレス バーに入力した名前です。たとえば、tableau.example.com
と入力して Tableau Server にアクセスする場合、gateway.public.host の名前はtableau.example.com
です。
gateway.public.port
既定値: 80
(SSL の場合は 443
)
プロキシ サーバー環境のみに適用。プロキシ サーバーがリッスンする外部ポート。
gateway.slow_post_protection.enabled
既定値: true
有効にすると、データを非常に遅いレートで転送する POST 要求をタイムアウトすることで、スロー POST (Denial-of-Service) 攻撃から保護することにある程度役立ちます。
注:これを有効にしても、これらの攻撃の脅威が排除されるわけではありません。また、接続速度の低下を終了させることによる影響が意図せずに出る場合があります。
gateway.slow_post_protection.request_read_timeout
既定値: header=10-30,MinRate=500 body=30,MinRate=500
前のオプション gateway.slow_post_protection.enabled
を有効にした場合、このオプションで Apache httpd ReadRequestTimeout を設定します。この httpd ディレクティブについては、「Apache Module mod_reqtimeout」(新しいウィンドウでリンクが開く)を参照してください。このオプションの主な用途は、Slowloris 攻撃からの防御です。Wikipedia のエントリ「Slowloris (computer security)」(新しいウィンドウでリンクが開く)を参照してください。
注: 以前のバージョンで使用していたデフォルト値: header=15-20,MinRate=500 body=10,MinRate=500
gateway.timeout
既定値: 7200
ゲートウェイが特定のイベントを待機する最大の秒数であり、この時間を過ぎると要求に失敗します (7200 秒 = 2 時間)。
gateway.trusted
既定値: プロキシ サーバー マシンの IP アドレス
プロキシ サーバー環境のみに適用。プロキシ サーバーの IP アドレスまたはホスト名。
gateway.trusted_hosts
既定値: プロキシ サーバーの代替名
プロキシ サーバー環境のみに適用。プロキシ サーバーの任意の代替ホスト名。
hyper.file_partition_size_limit
既定値: 0
0 に設定するとサイズが無制限となり、使用可能なディスク空き容量がすべて使用されます。
このオプションを使用して、ディスクをスプールするクエリのディスク容量制限を設定します。spool.<id>.tmp ファイルによるディスク容量使用率がお使いの環境で必要な容量より多い場合、クエリがスプールされており、ディスク容量を消費していることを意味します。このオプションを使用して、クエリで使用できるディスク容量を制限します。spool.<id>.tmp ファイルは、Tableau Server を実行しているユーザー アカウントの一時フォルダー内にあります。この値は K(KB)、M(MB)、G(GB)、T(TB) 単位で指定できます。たとえば、ディスク容量使用率を 100 GB に制限する場合は、サイズ制限を 100G と指定できます。
スプーリングの詳細については、Tableau Server データ エンジンの「メモリと CPU 使用率」セクションを参照してください。
hyper.global_file_partition_size_limit
既定値: 0
0 に設定するとサイズが無制限となり、使用可能なディスク空き容量がすべて使用されます。
このオプションを使用して、ディスクをスプールするすべてのクエリのディスク容量制限を設定します。spool.<id>.tmp ファイルによるディスク容量使用率がお使いの環境で必要な容量より多い場合、クエリがスプールされており、ディスク容量を消費していることを意味します。spool.<id>.tmp ファイルは、Tableau Server を実行しているユーザー アカウントの一時フォルダー内にあります。このオプションを使用して、ディスクをスプーリングするときにすべてのクエリで使用するディスク容量の合計を制限します。この値は K(KB)、M(MB)、G(GB)、T(TB) 単位で指定できます。たとえば、ディスク容量使用率を 100 GB に制限する場合は、サイズ制限を 100G と指定できます。Tableau では、スプーリングの制限を微調整する際にこの構成を使用して開始することをお勧めします。
スプーリングの詳細については、Tableau Server データ エンジンの「メモリと CPU 使用率」セクションを参照してください。
hyper.enable_accesspaths_symbolic_canonicalization
既定値: false
Windows OS システムでは、シンボリックリンクを解決するために、Hyper は、抽出が保存されているディレクトリとそのすべての親ディレクトリにアクセスできる必要があります。そうでない場合は、Hyper ログに次のエラー メッセージが表示されることがあります: 次の正規パスを取得できません //dirA/subdir/myextract.hyper ... Access is denied
。
このような場合、これを true
に設定することで、データ エンジン (Hyper) が正規パスを使用するときにシンボリックリンクを解決しようとしないようにすることができます。
注: 値を true
に設定すると、Hyper は、潜在的な攻撃者がシンボリックリンクを配置して Hyper がアクセスできる許可されたディレクトリ セットからエスケープしようとする場合に、保護を保証することができなくなります。
hyper.log_queries
既定値: true
true に設定すると、クエリ情報がログに記録されます。
既定では、クエリ情報がログに記録されます。ただし、ログ ファイルが使用可能なディスク容量に対して大きすぎると判明した場合は、これを false
に設定してクエリ情報のログへの記録を無効にできます。Tableau では、この設定を true
のままにしておくことをお勧めします。
hyper.log_query_cpu
既定値: false
この設定を使用して、クエリに要する時間と CPU 使用率をログに記録します。
hyper.log_timing
既定値: false
この設定は、編集時間や解析時間など、クエリに関する詳細情報を確認する際に便利です。既定では、この設定は無効化されています。この値を true
に変更して、クエリに関する詳細をさらに収集することができます。ただし、これによりデータ エンジンのログ ファイル (\logs\hyper) のサイズが大きくなりますのでご注意ください。
hyper.log_troublesome_query_plans
既定値: true
true
に設定すると、問題があると識別されたクエリのクエリ プランがログに記録されます。キャンセルされたクエリや 10 秒以上遅れて実行しているクエリ、またはディスクにスプーリングしているクエリは、このカテゴリに分類されます。ログの情報は、問題のあるクエリをトラブルシューティングする際に便利です。ログのサイズが心配なときは、この設定を false
に変更できます。
hyper.memory_limit
既定値: 80%
Hyper が使用するメモリの最大量を制御します。バイト数を指定します。キロバイトを示すには 'k'、メガバイトを示すには 'm'、ギガバイトを示すには 'g'、テラバイトを示すには 't' を値に追加します。たとえば、hyper.memory_limit="7g"
です。または、使用可能なシステム メモリ全体に対するパーセンテージとしてメモリ制限を指定します。たとえば、hyper.memory_limit="90%"
です。
hyper.memtracker_hard_reclaim_threshold
既定値: 80%
この設定は、Windows にのみ適用されます。Hyper では、抽出のうち解凍されて復号化された部分がメモリに保持されて、後続のアクセスが高速化されます。この設定は、メモリの負荷を軽減するためにワーカー スレッドがこのデータをディスク キャッシュに書き込み始めるタイミングを制御します。パーセンテージで指定した場合、値は全体的な設定 hyper.memory_limit
に対するパーセンテージとして解釈されます。たとえば、hyper.memtracker_hard_reclaim_threshold="60%"
です。絶対値は、'k' (キロバイト)、'm' (メガバイト)、'g' (ギガバイト)、't' (テラバイト) として指定できます。たとえば、hyper.memtracker_hard_reclaim_threshold="10g"
です。値はしきい値 hyper.memtracker_soft_reclaim
より大きくする必要があります。
hyper.memtracker_soft_reclaim_threshold
既定値: 50%
この設定は、Windows にのみ適用されます。Hyper ファイルを操作する際、Hyper はキャッシュまたは永続化するために一部のデータを書き出します。Windows には、新しく書き込まれたデータをメモリにロックするという特別な動作があります。スワップを避けるため、Hyper は再利用しきい値用に構成された制限に達したときにデータを強制的に書き出します。このソフト再利用しきい値に達すると、Hyper はバックグラウンドでキャッシュされたデータを再利用して、再利用しきい値より下の状態を維持しようとします。スワップが発生する可能性のある状況では、Hyper で再利用をトリガーすると、より良い結果が得られます。したがって、Tableau Server のインストールで大量のスワップが発生する場合は、この設定を使用してメモリの負荷を軽減できます。
バイト数を指定します。キロバイトを示すには 'k'、メガバイトを示すには 'm'、ギガバイトを示すには 'g'、テラバイトを示すには 't' を値に追加します。または、Hyper 用に構成されたメモリ全体に対するパーセンテージで値を指定します。たとえば、hyper.memtracker_soft_reclaim_threshold="20%"
です。
hyper.network_threads
既定値: 150%
Hyper が使用するネットワーク スレッドの数を制御します。ネットワーク スレッド数 (hyper.network_threads=4
など) を指定するか、論理コア数に対するスレッド数の割合 (hyper.network_threads="300%"
など) を指定します。
ネットワーク スレッドは、新しい接続を受け入れたりデータやクエリを送受信したりするために使用されます。Hyper では非同期ネットワークが使用されるため、1 つのスレッドで多くの接続を処理できます。通常、ネットワーク スレッドで行われる作業の量は非常に少なくなっています。1 つの例外は、低速のファイルシステムでデータベースを開く場合です。これには長い時間がかかるため、ネットワーク スレッドがブロックされる可能性があります。抽出を使用するダッシュボードをしばらく使用しなかった後で表示または編集する際の接続時間が遅く、Hyper ログに "asio-continuation-slow" メッセージが頻繁に表示され、Tableau ログで Hyper に対する "construct-protocol" の時間が長くなっている場合は、この値を増やします。
hyper.objectstore_validate_checksums
既定値: false
Hyper でのファイル整合性チェックを制御するブール値。true
に設定すると、Hyper は抽出ファイルに初めてアクセスしたときにその中のデータをチェックします。これにより、Hyper のクラッシュを引き起こす無兆候の破損を検出できます。一般に、非常に低速なディスクを使用するインストール (パフォーマンスの低下が生じる可能性がある) を除いて、この設定をオンにすることをお勧めします。
hyper.query_total_time_limit
既定値: 0
(無制限 (unlimited) を意味します)
Hyper の個々のクエリで使用できる合計スレッド時間の上限を設定します。秒を示すには 's'、分を示すには 'min'、時間を示すには 'h' を値に追加します。
たとえば、すべてのクエリで使用可能な合計スレッド時間を 1500 秒に制限するには、次のコマンドを実行します。
tsm configuration set -k hyper.query_total_time_limit -v 1500s
クエリが指定された制限よりも長く実行されると、クエリは失敗し、エラーが返されます。この設定を使用すると、多数のリソースを使用する可能性のあるランナウェイ クエリを自動的に制御できます。
Hyper はクエリを並列に実行します。たとえば、100 秒間実行されるクエリが 30 個のスレッドで実行されると、合計スレッド時間は 3000 秒になります。各クエリのスレッド時間は、Hyper ログの "total-time" フィールドの "query-end" ログ エントリで報告されます。
hyper.session_memory_limit
既定値: 0
(無制限 (unlimited) を意味します)
個々のクエリで使用できる最大メモリ消費量を制御します。バイト数を指定します。キロバイトを示すには 'k'、メガバイトを示すには 'm'、ギガバイトを示すには 'g'、テラバイトを示すには 't' を値に追加します。
たとえば、メモリの制限値を 900 MB に設定するには、次のコマンドを実行します。
tsm configuration set -k hyper.session_memory_limit -v 900m
または、セッション メモリの制限値を使用可能なシステム メモリ全体に対するパーセンテージで指定するには、次のコマンドを実行します。
tsm configuration set -k hyper.session_memory_limit -v 90%
あるクエリが過度の量のメモリを使用しているために他のクエリが長期間にわたって失敗する場合は、この値を減らすと役立ちます。この制限値を減らすと、単一の大きなクエリは失敗する (スプーリングがオフになっていない場合はスプーリングに移行する) ため、他のクエリに悪影響を及ぼすことがなくなります。
hyper.srm_cpu_limit_percentage
既定値 (パーセント): 75
Hyper が許可する 1 時間あたりの平均 CPU 使用率の最大値を指定します。超過した場合、データ エンジンは、コンピューター上の他のプロセスへの影響を最小限に抑えるために、自身を再起動します。
既定では、データ エンジンは、1 時間の平均 CPU 使用率が 75% を超えると、自動的に再起動します。この値は、Tableau サポートで作業している場合、または専用サーバー ノードでデータ エンジンを実行している場合を除き、変更しないでください。データ エンジンが専用ノードで実行されている場合は、この値を安全に 95% に増やして、利用可能なコンピューター ハードウェアを最大限に活用できます。専用ノードでデータ エンジンを実行する方法の詳細については、「抽出クエリの負荷が大きい環境用に最適化」を参照してください。
これを 95% に増やすには:
tsm configuration set -k hyper.srm_cpu_limit_percentage -v 95 --force-keys
tsm pending-changes apply
これをデフォルトの 75% にリセットするには:
tsm configuration set -k hyper.srm_cpu_limit_percentage -v 75 --force-keys
tsm pending-changes apply
hyper_standalone.consistent_hashing.enabled
既定値: true
クエリの抽出が既にキャッシュされている可能性が高くなります。抽出がキャッシュされたノードで追加の読み込みに対応できない場合は、新しいノードにルーティングすると、抽出が新しいノードのキャッシュに読み込まれます。これにより、必要性が正当化された負荷がある場合にのみ抽出がメモリに読み込まれるため、システム使用率が向上します。
hyper_standalone.health.enabled
既定値: true
現在の Hyper アクティビティとシステム リソースの使用状況を組み合わせて構成された正常性スコアに基づいて、ロード バランシング メトリクスをランダムな選択からデータ エンジン (Hyper) ノードの選択に切り替えます。これらの値に基づいて、ロード バランサーは抽出クエリの処理能力が最も高いノードを選択します。
hyper.temp_disk_space_limit
既定値: 100%
Hyper が一時ファイル用の領域の割り当てを停止するディスク空き容量の上限を設定します。この設定は、ハード ディスクが Hyper からの一時ファイルでいっぱいになってディスク空き容量が不足するのを防ぐのに役立ちます。ディスク空き容量がこのしきい値に達すると、管理者の介入なしに自動的に領域の解放が試行されます。
使用可能なディスク空き容量全体に対するパーセンテージで指定します。たとえば、hyper.temp_disk_space_limit="96%"
のように使用します。100% に設定すると、使用可能なすべてのディスク空き容量を使用できます。
データ エンジンを起動するには、構成されたディスク領域が使用可能でなければなりません。十分なディスク領域がない場合は、データ エンジン ログ エントリが表示され、「一時ファイルのディスク制限に達しました。デバイスのディスク領域を増やしてください。詳細については、Hyper ログを参照してください: デバイスに空き領域がありません」と表示されます。
hyper.hard_concurrent_query_thread_limit
既定値: 150%
このオプションは、Hyper がクエリの実行に使用する最大スレッド数を設定するのに使用します。CPU 使用率にハード制限を設定する場合はこれを使用してください。スレッドの数を指定するか、論理コア数に対するスレッドのパーセンテージを指定します。Hyper で使用されるリソースがこの設定の構成値を超える可能性はほとんどありませんが、Hyper のバックグラウンド スレッドやネットワーク スレッドはこの設定の影響を受けません (ただし、これらのスレッドは CPU を集中的に使用しない傾向があります)。
これを設定すると、同時に実行可能なクエリ数が制御されることを考慮に入れることが重要です。そのため、この設定を小さくすると、新しいクエリが現在実行中のクエリの完了を待機しなければならない可能性が高くなるため、ワークブックの読み込み時間に影響が出る可能性があります。
hyper.soft_concurrent_query_thread_limit
既定値: 100%
このオプションを使用すると、hard_concurrent_query_thread_limit
の設定によって十分な数のスレッドが使用可能な場合に 1 つのクエリを並列で実行できるスレッドの数を指定できます。スレッドの数を指定するか、論理コア数に対するスレッドのパーセンテージを指定します。
これを説明するため、ここで簡単な例を示します。
この値を 10 スレッドに設定するとします。つまり、クエリは最大 10 スレッドまで並列で実行できます。2 つのクエリだけを実行している場合、残りの 8 スレッドが 2 つのクエリを並列で実行するのに使用されます。
hyper. hard_concurrent_query_thread_limit オプションと hyper.soft_concurrent_query_thread_limit オプションは連係し、クエリを迅速に完了するために利用可能な CPU リソースを最大化しながら CPU 使用率を管理するいくつかのオプションが得られます。データ エンジンがマシン上で利用可能なすべての CPU を使用しないようにするには、100% 未満に変更し、お使いの環境に最適なパーセンテージにしてください。ソフト制限は CPU 使用率を制限する方法ですが、必要に応じ、ソフト制限を超過し、最大でハード制限までの使用を許可することができます。
注: Tableau Server バージョン 2018.3 以前で利用できた hyper.num_job_worker_threads オプションと hyper.num_task_worker_threads オプションは廃止され現在は利用できず、hyper.hard_concurrent_query_thread_limit オプションと hyper.soft_concurrent_query_thread_limit オプションに置き換えられました。
hyper.use_spooling_fallback
既定値: true
true
に設定すると、抽出のクエリ作成時に使用率が設定された RAM の使用率を超過した場合 (インストールされた RAM の 80%) にディスクへスプーリングできます。つまり、Hyper で RAM の使用率が設定値を超えた場合に、ディスクを使用してクエリを実行できます。
既定の設定を使用することをお勧めします。ディスク使用率に不安がある場合は、この値を false
に変更できます。この設定をオフにすると、インストールされた RAM の 80% を超過したクエリはキャンセルされます。通常、クエリのスプーリングは完了するまでにかなり時間がかかります。
スプーリングの詳細については、Tableau Server データ エンジンの「メモリと CPU 使用率」セクションを参照してください。
indexandsearchserver.vmopts
バージョン: バージョン 2022.1 で追加。
既定値: "-Xmx<default_value> -Xms<default_value>
"
既定値はシステム メモリの量に基づいており、システム RAM 全体の 3.125% です。
Index and Search Server のヒープ サイズを制御します。既定値は自動的にスケールされます。どうしても必要な場合にのみ、このオプションを使用して既定値を上書きしてください。キロバイトを示すには 'k'、メガバイトを示すには 'm'、ギガバイトを示すには 'g' を値に追加します。一般的なルールとして、ガベージ コレクションを最小化するには、初期ヒープ サイズ (-Xms
) を最大ヒープ サイズ (-Xmx
) と等しくなるように設定します。
jmx.security.enabled
バージョン: バージョン 2022.1 で追加。
既定値: false
JMX はデフォルトで無効になっているため、セキュア JMX も無効になっています。JMX を有効にする場合は、セキュア JMX を有効にすることを強くお勧めします。
tsm maintenance jmx enable
コマンドを実行し、JMX のセキュリティ機能を有効にするように求められたときに y
と回答すると、この構成は true
に設定され、SSL と基本的なユーザー名とパスワードの認証、読み取り専用アクセスでセキュア JMX が有効になります。
tsm maintenance jmx enable We do not recommend you enable JMX unsecured on a production environment. Would you like to enable security features for JMX? (y/n): y
jmx.ssl.enabled
バージョン: バージョン 2022.1 で追加。
既定値: true
JMX に SSL を適用します。このオプションは、既定で true
に設定されていますが、jmx.security.enabled
も true
に設定されていない限り、効果はありません。JMX セキュリティを有効にするには、tsm maintenance jmx enable
コマンドを実行します。プロンプトが表示されたら、「y
」と入力して SSL を有効のままにするか、「n
」と入力して SSL を無効にします。
tsm maintenance jmx enable ... Would you like to enable SSL? (y/n): n
jmx.ssl.require_client_auth
バージョン: バージョン 2022.1 で追加。
既定値: false
tsm maintenance jmx enable
コマンドを実行し、クライアント認証 (mTLS) を有効にするように求められたときに y
と回答すると、この構成は true
に設定されます。
tsm maintenance jmx enable ... Would you like to require client authentication (mTLS)? (y/n): y
構成を完了するには、クライアント証明書が必要です。クライアント証明書はクライアント コンピューターの適切な場所に配置する必要があります。
jmx.ssl.user.name
バージョン: バージョン 2022.1 で追加。
既定値: tsmjmxuser
Tableau Server をインストールまたはアップグレードするときに設定されます。
jmx.ssl.user.password
バージョン: バージョン 2022.1 で追加。
既定値: <generated>
Tableau Server をインストールまたはアップグレードするときに設定されます。
jmx.user.access
バージョン: バージョン 2022.1 で追加。
既定値: readonly
tsm maintenance jmx enable
コマンドを実行し、readwrite
アクセスを追加するように求められたときに y
と回答すると、この構成は readwrite
に変更できます。
tsm maintenance jmx enable ... JMX access is readonly by default. Would you like to add readwrite access? (y/n): y
licensing.login_based_license_management.default_requested_duration_seconds
既定値: 0
ユーザーのログインベースのライセンスが Tableau Server に接続せずにオフラインになり、ライセンス認証を再度行うように求めるメッセージが表示されるまでの時間 (秒単位) を設定します。この時間は、Tableau Desktop を使用していて Tableau Server に接続できるときに常に更新されます。
licensing.login_based_license_management.enabled
既定値: true
ログインベースのライセンス管理 を有効にするには、true に設定します。ログインベースのライセンス管理 を無効にするには、false に設定します。
注: ログインベースのライセンス管理を使用するには、ログインベースのライセンス管理 に対して有効になっているプロダクト キーをライセンス認証する必要があります。tsm licenses list
を使用して、どのプロダクト キーが ログインベースのライセンス管理 で有効になっているかを確認できます。
licensing.login_based_license_management.max_requested_duration_seconds
既定値: 7776000
ユーザーのログインベースのライセンスが Tableau Server に接続せずにオフラインになり、ライセンス認証を再度行うように求めるメッセージが表示されるまでの時間 (秒単位) の最大値を設定します。最大値は 7776000 秒 (90 日) です。この時間は、Tableau Desktop を使用していて Tableau Server に接続できるときに常に更新されます。
maestro.app_settings.sampling_max_row_limit
既定値: 1000000
Web 上の Tableau Prep を使用して、大規模なデータセットからデータをサンプリングするための最大行数を設定します。
maestro.input.allowed_paths
既定値: ""
既定では、いずれのディレクトリへのアクセスも拒否され、tflx ファイルに含まれているコンテンツの Tableau Server へのパブリッシュのみが許可されます。
フロー入力接続で許可されるネットワーク ディレクトリの一覧。Tableau Server 上で Tableau Prep Conductor がフローのスケジュールを設定できるように有効化する必要があります。詳細については、Tableau Prep Conductorを参照してください。
この設定を構成するときは、次のルールを適用し、考慮に入れる必要があります。
パスに Tableau Server からアクセスできる必要があります。これらのパスは、サーバー起動時およびフロー実行時に検証されます。
ネットワーク ディレクトリ パスは絶対パスである必要があり、ワイルドカードやパスを横断する他の記号を含めることはできません。たとえば、
\\myhost\myShare\*
または\\myhost\myShare*
は無効なパスであるため、すべてのパスが許可されません。myShare の下にあるすべてのフォルダーを許可リストに登録する正しい方法は、\\myhost\myShare or \\myhost\\myShare\
です。注:
\\myhost\myShare
構成では\\myhost\myShare1
が許可されません。これらのフォルダーを両方とも許可リストに登録するには、これらを \\myhost\myShare; \\myhost\myShare1 として許可リストに登録します。値は、ローカル ("native_api.internal_disallowed_paths" を使用して構成された一部のシステム パスを除く) を含む任意のパスを意味する
*
にするか、パスのリストを ";" で区切ったものとします。注: パスが許可されたフローのリストと internal_disasslowed リストの両方にある場合、internal_disallowed が優先されます。
重要:
このコマンドにより既存の情報が上書きされ、提供した新しい情報に取って代わります。既存のリストに新しい場所を追加する場合は、すべての場所、既存の場所、追加する新しい場所のリストを提供する必要があります。入力場所および出力場所の現在のリストを表示するには、次のコマンドを使用します。tsm configuration get -k maestro.input.allowed_paths
tsm configuration get -k maestro.output.allowed_paths
フロー入力接続およびフロー出力接続で許可されるディレクトリの構成の詳細については、「手順 4 - 入力場所と出力場所を許可リストに登録する(新しいウィンドウでリンクが開く)」を参照してください。
maestro.output.allowed_paths
既定値: ""
既定では、ディレクトリへのアクセスは拒否されます。
フロー出力接続で許可されるネットワーク ディレクトリの一覧。Tableau Server 上で Tableau Prep Conductor がフローのスケジュールを設定できるように有効化する必要があります。詳細については、Tableau Prep Conductorを参照してください。
この設定を構成するときは、次のルールを適用し、考慮に入れる必要があります。
パスに Tableau Server からアクセスできる必要があります。これらのパスは、サーバー起動時およびフロー実行時に検証されます。
ネットワーク ディレクトリ パスは絶対パスである必要があり、ワイルドカードやパスを横断する他の記号を含めることはできません。たとえば、
\\myhost\myShare\*
または\\myhost\myShare*
は無効なパスであるため、すべてのパスが許可されません。myShare の下にあるすべてのフォルダーを許可リストに登録する正しい方法は、\\myhost\myShare or \\myhost\\myShare\
です。注:
\\myhost\myShare
構成では\\myhost\myShare1
が許可されません。これらのフォルダーを両方とも許可リストに登録するには、これらを \\myhost\myShare; \\myhost\myShare1 として許可リストに登録します。値は、ローカル ("native_api.internal_disallowed_paths" を使用して構成された一部のシステム パスを除く) を含む任意のパスを意味する
*
にするか、パスのリストを ";" で区切ったものとします。注: パスが許可されたフローのリストと internal_disasslowed リストの両方にある場合、internal_disallowed が優先されます。
フロー入力接続およびフロー出力接続で許可されるディレクトリの構成の詳細については、「手順 4 - 入力場所と出力場所を許可リストに登録する(新しいウィンドウでリンクが開く)」を参照してください。
maestro.output.write_to_mssql_using_runas
バージョン: バージョン 2022.3.1 で追加。
既定値: false
有効にすると、Tableau Server にパブリッシュされたフロー出力は、実行認証資格情報を使用して、Microsoft SQL Server データベースに書き込みアクセスできるようになります。実行サービス アカウントで使用される認証資格情報には、データベースへの書き込みパーミッションが必要です。maestro.output.write_to_mssql_using_runas
設定を有効にする前に、セキュリティと展開の要件を評価してください。詳細については、「実行サービス アカウント」を参照してください。
注: このコマンドには --force-keys
オプションが必要です。たとえば、 tsm configuration set -k maestro.output.write_to_mssql_using_runas -v true --force-keys
。
maestro.sessionmanagement.maxConcurrentSessionPerUser
既定値: 4
ユーザーが一度に開くことができるフロー Web 編集セッションの最大数を設定します。
metadata.ingestor.blocklist
既定値: NULL
構成されると、Tableau Catalog で指定されたコンテンツの取り込みがブロックされます。ブロックするコンテンツを指定するには、拒否リストの値を指定する必要があります。これは、"インタラクティブでない" サーバー ログ ファイルからサイト ID、コンテンツ タイプおよびブロックするコンテンツのコンテンツ ID を組み合わせたものです。拒否リストの値は、コンマで区切る必要があります。
重要: このオプションは、Tableau サポートから指示された場合にのみ使用してください。
たとえば、tsm configuration set --force-keys -k metadata.ingestor.blocklist
を使用して、データ ソース、ワークブック、およびフローを組み合わせた取り込みをブロックするには、次のコマンドを使用します。
tsm configuration set --force-keys -k metadata.ingestor.blocklist -v "sites/1/datasources/289, sites/2/datasources/111, sites/1/workbooks/32, sites/3/workbooks/15, sites/1/flows/13, sites/1/flows/18”
ブロックされたコンテンツを検証するには、"インタラクティブでない" サーバー ログ ファイルで次のイベントを確認します。
Skipping ingestion for
Successfully updated blocklist to
例:
Skipping ingestion for contentType [Workbook], contentId [sites/1/datasources/289], siteDisabled [false], swallowEvent [false], contentBlocked [true]
Skipping ingestion for contentType [Workbook], contentId [sites/3/workbooks/15], siteDisabled [false], swallowEvent [false], contentBlocked [true]
および
Successfully updated blocklist to: [sites/1/datasources/289, sites/1/workbooks/32, sites/2/datasources/111]
metadata.ingestor.pipeline.throttleEventsEnable
既定値: false
新しいコンテンツと更新されたコンテンツのインデックス作成 (Eventing とも呼ばれる) がサーバー上のすべてのサイトで制御されるかどうかを制御します。デフォルトでは、イベント スロットルはオフになっています。イベント スロットルをオンにするには、次のコマンドを使用して、この設定を true
に変更します。
tsm configuration set -k metadata.ingestor.pipeline.throttleEventsEnable -v true --force-keys
イベント スロットルの詳細については、Tableau Catalog の有効化を参照してください。
metadata.ingestor.pipeline.throttleLimit
既定値: 20
イベント スロットルが有効な場合、指定した期間中にインデックスを作成できる、新しいコンテンツ アイテムと更新されたコンテンツ アイテムの最大数です。指定したアイテムが制限に達すると、のインデックス作成は延期されます。
既定では、制限は 20
に設定され、2
より低い値に設定することはできません。次のコマンドを使用して、制限を変更できます。
tsm configuration set -k metadata.ingestor.pipeline.throttleLimit -v 25 --force-keys
スロットル済みのイベントは、サーバーの "noninteractive" ログ ファイルで ingestor event flagged for removal by throttle filter
として識別できます。
metadata.ingestor.pipeline.throttlePeriodLength
既定値: 20
分単位の時間です。この間、イベント スロットルが有効な場合、指定された最大数の新しいコンテンツ アイテムと更新されたコンテンツ アイテムのインデックスを作成できます。指定した時間に達すると、追加の新しいコンテンツと更新されたコンテンツのインデックス作成は延期されます。
既定では、時間は 30 分に設定されています。次のコマンドを使用して、時間を変更できます。
tsm configuration set -k metadata.ingestor.pipeline.throttlePeriodLength -v PT45M --force-keys
metadata.query.limits.time
既定値: 20
これは、Catalog またはメタデータ API クエリを実行してから、タイムアウトが発生しクエリがキャンセルされるまでの最長許容時間 (秒単位) です。Tableau では、次のコマンドを使用して、タイムアウト制限を 60 秒未満で増やすことをお勧めします。
tsm configuration set -k metadata.query.limits.time –v PT30S --force-keys
重要: このオプションは、「Timeout limit and node limit exceeded (タイムアウト制限およびノード制限を超過しました)」メッセージに記載されたエラーが表示される場合にのみ変更する必要があります。タイムアウト制限を増やすと、より多くの CPU をより長く使用でき、Tableau Server 全体のタスクのパフォーマンスに影響を与える可能性があります。また、タイムアウト制限を増やすとメモリ使用率も増加する可能性があります。この場合、クエリを並列で実行するとインタラクティブなマイクロサービス コンテナで問題が発生することがあります。
metadata.query.limits.count
既定値: 20000
これは、ノードの制限を超え、クエリがキャンセルされる前に Catalog で返すことができるオブジェクトの数 (クエリ結果の数に大まかにマッピングできます) です。Tableau では、次のコマンドを使用してタイムアウト制限を 100,000 未満で段階的に増やしていくことをお勧めします。
tsm configuration set -k metadata.query.limits.count –v 3000 --force-keys
重要: このオプションは、「Timeout limit and node limit exceeded (タイムアウト制限およびノード制限を超過しました)」メッセージに記載されたエラーが表示される場合にのみ変更する必要があります。ノードの制限を増やすと、メモリ使用率が増加する可能性があります。この場合、クエリを並列で実行するとインタラクティブなマイクロサービス コンテナで問題が発生することがあります。
metadata.query.throttling.enabled
バージョン: 2023.3 で追加。
既定値: true
メタデータ API(新しいウィンドウでリンクが開く) クエリのスロットルを有効にするかどうかを制御します。メタデータ API クエリのスロットルは、サーバーの API 応答が全体的なパフォーマンスに悪影響を及ぼすのを防ぐために設計された機能です。true
(デフォルト) に設定すると、メタデータ API へのリクエストが定義済みのしきい値を超えると、RATE_EXCEEDED
エラーが返されます。
メタデータ API ユーザーに RATE_EXCEEDED
エラーが頻繁に発生する場合、管理者は metadata.query.throttling.tokenRefilledPerSecond
設定と metadata.query.throttling.queryCostCapacity
設定を使用してスロットルの調整を試みることができます。あるいは、管理者は metadata.query.throttling.enabled
の値を false
に設定することでスロットルを完全に無効にすることもできます。ただし、そうすると、この機能でパフォーマンスを保護するという利点は得られなくなります。
metadata.query.throttling.queryCostCapacity
バージョン: 2023.3 で追加。
既定値: 20000000
メタデータ API(新しいウィンドウでリンクが開く) がクエリに応答する能力を表す数値。メタデータ API への各リクエストには計算されたコストがあり、実行時にこの数値から差し引かれます (トークン バケット モデルを使用する場合、これはバケット内に入れることができるトークンの最大量になります)。
メタデータ API ユーザーに RATE_EXCEEDED
エラーが頻繁に発生する場合、管理者はスロットル設定を調整できます。metadata.query.throttling.queryCostCapacity
の調整を試みる前に、metadata.query.throttling.tokenRefilledPerSecond
を調整して結果を確認してください。あるいは、管理者は metadata.query.throttling.enabled
を false
に設定することでスロットルを完全に無効にすることもできます。ただし、そうすると、この機能でパフォーマンスを保護するという利点は得られなくなります。
metadata.query.throttling.tokenRefilledPerSecond
バージョン: 2023.3 で追加。
既定値: 5555
毎秒再生成されるメタデータ API(新しいウィンドウでリンクが開く) クエリ量を表す数値 (トークン バケット モデルを使用する場合、これは 1 秒ごとにバケットに入れられるトークンの数になります)。
メタデータ API ユーザーに RATE_EXCEEDED
エラーが頻繁に発生する場合、管理者はスロットル設定を調整できます。metadata.query.throttling.queryCostCapacity
の調整を試みる前に、metadata.query.throttling.tokenRefilledPerSecond
を調整して結果を確認してください。あるいは、管理者は metadata.query.throttling.enabled
を false
に設定することでスロットルを完全に無効にすることもできます。ただし、そうすると、この機能でパフォーマンスを保護するという利点は得られなくなります。
metricsservices.checkIntervalInMinutes
バージョン: バージョン 2024.2 で廃止。
既定値: 60
ライブ データ ソースに依存するメトリックの更新間隔を分単位で制御します。メトリクスは、サーバーがメトリックの接続ビューを介して新しいデータを確認するときに、更新されます。
metricsservices.enabled
バージョン: バージョン 2022.3 で追加。バージョン 2024.2 で廃止されました。
既定値: true
false
に設定すると、サーバー上のすべてのサイトで、メトリクス コンテンツ タイプが無効になります詳細については、「サーバーのメトリクスの無効化」を参照してください。
従来のメトリクス機能の廃止
Tableau の従来のメトリクス機能は、2024 年 2 月の Tableau Cloud および Tableau Server バージョン 2024.2 で廃止されました。2023 年 10 月に、Tableau は Tableau Cloud および Tableau Server バージョン 2023.3 に従来のメトリクスを埋め込む機能を廃止しました。Tableau Pulse では、メトリクスを追跡し、データについて質問するためのエクスペリエンスが向上しました。新しいエクスペリエンスの詳細については、「Tableau Pulse を使用したメトリクスの作成」を参照し、廃止される機能のについては、「メトリクスの作成とトラブルシューティング (廃止)」を参照してください。
metricsservices.failureCountToWarnUser
バージョン: バージョン 2024.2 で廃止。
既定値: 10
メトリクス所有者に警告が表示されるまでに発生する必要がある、連続した更新失敗の数を制御します。デフォルトの 10 に設定すると、失敗に関する通知を所有者に送信する前にメトリクスの更新が、10 回連続して失敗する必要があります。
metricsservices.maxFailedRefreshAttempts
バージョン: バージョン 2024.2 で廃止。
既定値: 175
メトリクス更新が保留されるまでに発生する必要がある、連続した更新失敗の数を制御します。
mobile.deep_linking.on_prem.enabled
既定値: true
Tableau Mobile アプリで Tableau Server へのリンクをディープ リンクとして扱うかどうかを制御します。true
に設定すると、サポートされているコンテンツ タイプへのリンクがアプリで開きます。false
に設定すると、リンクはモバイル ブラウザーで開きます。詳細については、「Tableau Mobile のディープ リンクを制御する」を参照してください。
monitoring.dataengine.connection_timeout
既定値: 30000
クラスタ コントローラーが接続のタイムアウトの発生を判断するまでデータ エンジンを待機する時間 (ミリ秒)。既定値は 30,000 ミリ秒 (30 秒) です。
native_api.allowed_paths
既定値: ""
注: 2023 年 10 月以前の Tableau Server リリース (メンテナンス リリースを含む) では、この設定は既定ですべてのパスへのアクセスを許可するように構成されていました。
この設定を使用して、Tableau またはリモート共有に保存されているファイルへのアクセスの許可リストを指定します。このシナリオでは認可された Tableau Server ユーザーに対し、サーバー上のファイル (スプレッドシートなど) をファイル ベースのデータ ソースとして使用するワークブックの作成を許可します。
この設定により、指定したディレクトリへのアクセスのみに制限できます。そのため、tableau
システム アカウントのアクセスは、データ ファイルをホストするディレクトリ パスに限定されます。
tsm configuration set -k native_api.allowed_paths -v "path"
、ここで、path は許可リストに追加するディレクトリです。指定したパスのすべてのサブディレクトリは、許可リストに追加されます。複数のパスを指定する場合は、この例のようにセミコロンで区切ります。
tsm configuration set -k native_api.allowed_paths -v "/datasources;/HR/data"
重要: この設定で指定したファイル パスが存在し、システム アカウントからアクセス可能であることを確認してください。
native_api.connection.limit.<connection class>
指定したデータ ソースに対する並列クエリ制限を設定します (接続クラス)。これにより、データ ソースのグローバル制限が上書きされます。
native_api.connection.globallimit
既定値: 16
並列クエリ用のグローバル制限。既定値は 16 です (既定値が 8 の Amazon Redshift を除く)。
native_api.ExplainDataEnabled
既定値: true
このオプションで、「データの説明を見る」をサーバーで有効にするか無効にするかを制御します。「データの説明を見る」の詳細については、Tableau ヘルプの「「データの説明を見る」を使い始める(新しいウィンドウでリンクが開く)」を参照してください。
このオプションは Tableau Server バージョン 2019.3 で追加されました。
native_api.force_alternative_federation_engine
既定値: false
単一ファイル接続と SQL 単一データベース接続からデータを結合するときに、操作制限をオーバーライドします。このオプションを True
に設定して、Tableau で、ライブ データベース接続を使用して強制的に結合を処理します。
native_api.ProtocolTransitionLegacyFormat
既定値: false
制約付き委任にレガシー名フォーマットを使用します。
名前形式がバージョン 10.1 で変更となり、クロスドメイン プロトコル トランジッション (S4U) が使用できるようになりました。これにより既存の構成に問題が発生し、クロスドメイン プロトコル トランジッションが必要ない場合は、Tableau Server を true
に設定して古い動作を使用してください。
native_api.unc_mountpoints
既定値: なし
Tableau Server on Linux からアクセスされる共有 Windows ディレクトリの UNC および FQDN パスを指定します。各パスは対応する auto.cifs ファイルで参照されている必要もあります。各パスはセミコロンで区切ってください。次に例を示します。
'//filesrv01/development;/mnt/filesrv01/development;//filesrv01.example.lan/development;/mnt/filesrv01/development'
その後、native_api.unc_mountpoints
値に対する更新を行うと、既存の値が上書きされます。したがって、Windows 共有を追加するたびに、更新された値のすべての共有を含める必要があります。
詳細については、コミュニティ ウィキ トピックの「Windows 共有ディレクトリへの接続 (英語)」(新しいウィンドウでリンクが開く)を参照してください。
native_api.InitializeQueryCacheSizeBasedOnWeights
既定値: True
クエリ キャッシュのサイズを、使用できるシステム メモリの量に基づいて自動的に初期化するかどうかを設定します。クエリ キャッシュには、論理クエリ キャッシュ、メタデータ キャッシュ、ネイティブ クエリ キャッシュがあります。既定では、この機能が有効になっています。
native_api.QueryCacheMaxAllowedMB
クエリ キャッシュの最大サイズです (メガバイト単位)。既定値は、システム メモリの量によって異なります。クエリ キャッシュには、論理クエリ キャッシュ、メタデータ キャッシュ、ネイティブ クエリ キャッシュがあります。次の表を使用して、既定値を決定します。
システム メモリ | Tableau Server のデフォルト値 | Tableau Desktop のデフォルト値 |
---|---|---|
64 GB 以上 | 3200 MB | 1600 MB |
32 GB から 64 GB まで | 2400 MB | 1200 MB |
16 GB から 32 GB まで | 1600 MB | 800 MB |
16 GB 以下 | 800 MB | 400 MB |
native_api.LogicalQueryCacheMaxAllowedWeight
既定値: 70
クエリ キャッシュの合計サイズにおける論理クエリ キャッシュ サイズの制限の重み。
native_api.MetadataQueryCachMaxAllowedWeight
既定値: 4
クエリ キャッシュの合計サイズにおけるメタデータ クエリ キャッシュ サイズの制限の重み。
native_api.NativeQueryCacheMaxAllowedWeight
既定値: 26
クエリ キャッシュの合計サイズにおけるネイティブ クエリ キャッシュ サイズの制限の重み。
native_api.QueryCacheEntryMaxAllowedInPercent
既定値: 60
クエリ キャッシュに格納できるクエリ結果の最大サイズを指定します。クエリ キャッシュの合計サイズに対する割合として設定されます。たとえば、論理クエリのキャッシュ サイズが 100 MB で native_api.QueryCacheEntryMaxAllowedInPercent
が 60% に設定されている場合、60 MB 未満のクエリ結果のみを論理クエリ キャッシュに格納できます。
native_api.UserInfoInGeneratedSQLEnabled
既定値: false
Tableau Server 上のすべてのコンテンツに対して、[クエリのタグ付け] を有効にするかどうかを決定します。true の場合、Tableau からお客様の SQL データベースに送信されるクエリには、クエリのソースに関するメタデータが含まれます。お客様のデータベースのログに記録された内容は、パフォーマンスやその他の問題のトラブルシューティングに使用することができます。
nlp.concepts_shards_count
既定値: 1
注:ほとんどの Tableau Server インストールでは、既定のシャーディング数の値で十分です。
シャードに格納されている「データに聞く」、フィールド名、フィールドの同義語、および分析用語の Concepts インデックスのデータ シャードの数を制御します。
- 2022.1 以降のバージョンのインデックスおよび検索サーバー。
- 2019.1 ~ 2021 の Elastic Server。4
シャーディング数は、検索インデックスをパーティション分割して、インデックスの合計サイズを小さくし、「データに聞く」のセマンティック パーサーのパフォーマンスを向上させます。実行している Tableau Server のバージョンに応じて、elasticserver.vmopts
または indexandsearchserver.vmopts
を使用してヒープ サイズを増やすことに加えて、シャーディング数の調整は、パフォーマンスを向上させるために講じることができるもう 1 つの方策です。
Tableau では、50 GB ごとにシャーディング数を 1 ずつ増やすことをお勧めします。シャーディング数を調整する必要がある回数を減らすには、現在のインデックスに 50% を加算して、合計インデックス サイズを計算します。たとえば、合計インデックス サイズが 50 GB 未満の場合は、1 シャーディングで十分です。実際のパフォーマンスは、サーバー、インデックスサイズが大きくなる速度、およびその他の要因によって異なります。
- 0 から 50 GB: 1
- 50 GB から 100 GB: 2
- 100 GB から 150 GB: 3
次のコマンドを使用して、Concepts インデックスのシャーディングを既定値から 2 に増やすことができます。
tsm configuration set -k nlp.concepts_shards_count -v 2
nlp.values_shards_count
既定値: 1
シャードに格納されている「データに聞く」、フィールド名、フィールドの同義語、および分析用語の Concepts インデックスのデータ シャードの数を制御します。
- 2022.1 以降のバージョンのインデックスおよび検索サーバー。
- 2019.1 ~ 2021 の Elastic Server。4
シャーディング数は、検索インデックスをパーティション分割して、インデックスの合計サイズを小さくし、「データに聞く」のセマンティック パーサーのパフォーマンスを向上させます。実行している Tableau Server のバージョンに応じて、elasticserver.vmopts
または indexandsearchserver.vmopts
を使用してヒープ サイズを増やすことに加えて、シャーディング数の調整は、パフォーマンスを向上させるために講じることができるもう 1 つの方策です。
Tableau では、50 GB ごとにシャーディング数を 1 ずつ増やすことをお勧めします。シャーディング数を調整する必要がある回数を減らすには、現在のインデックスに 50% を加算して、合計インデックス サイズを計算します。たとえば、合計インデックス サイズが 50 GB 未満の場合は、1 シャーディングで十分です。実際のパフォーマンスは、サーバー、インデックスサイズが大きくなる速度、およびその他の要因によって異なります。
- 0 から 50 GB: 1
- 50 GB から 100 GB: 2
- 100 GB から 150 GB: 3
次のコマンドを使用して、Values インデックスのシャーディング数を既定値から 2 に増やすことができます。
tsm configuration set -k nlp.values_shards_count -v 2
nlp.defaultNewSiteAskDataMode
既定値: disabled_by_default
このオプションを使用して、サイトの作成時に「データに聞く」モードの初期値を設定します。詳細については、サイトでの「データに聞く」 (Ask Data) 機能の無効化または有効化を参照してください。
有効なオプションは disabled_by_default
および disabled_always
です。
このオプションは Tableau Server バージョン 2019.4.5 および 2020.1.3 で追加されました。
noninteractive.vmopts
既定値: "-XX:+UseConcMarkSweepGC -Xmx<default_value>g -XX:+ExitOnOutOfMemoryError"
既定値は、システム メモリの量によって異なります。JVM の最大ヒープ サイズは、システム RAM 全体の 6.25% にスケールされます。
このオプションにより、Tableau Catalog の取り込みにおける JVM の最大ヒープ サイズが制御されます。既定値は自動的にスケールされます。どうしても必要な場合にのみ、このオプションで引数 -Xmx<default_value>g
を変更して既定値を上書きします。たとえば、次のコマンドを使用して、最大ヒープ サイズを 2 GB に増やすことができます。
tsm configuration set -k noninteractive.vmopts -v "-XX:+UseConcMarkSweepGC -Xmx2g -XX:+ExitOnOutOfMemoryError"
詳細については、非インタラクティブなマイクロサービス コンテナーのメモリを参照してください。
pgsql.port
既定値: 8060
PostgreSQL がリッスンするポート。
pgsql.preferred_host
優先リポジトリがインストールされているノードのコンピューター名を指定します。--preferred
または -r
オプションが tsm topology failover-repository コマンドと共に指定されている場合にはこの値が使用されます。
例:
tsm configuration set -k pgsql.preferred_host -v "<host_name>"
注: host_name
は大文字と小文字が区別され、tsm status -v
の出力に表示されるノード名と一致する必要があります。
pgsql.ssl.ciphersuite
既定値: HIGH:MEDIUM:!aNULL:!MD5:!RC4
リポジトリに対する SSL で許容される暗号アルゴリズムを指定します。
許容される値と書式要件については、Postgres Web サイトの「ssl_ciphers」(新しいウィンドウでリンクが開く)を参照してください。
pgsql.ssl.max_protocol_version
既定値: TLSv1.3
SSL でリポジトリに接続する際に使用する SSL/TLS プロトコル バージョンの最大値を設定します。
有効な値: TLSv1
、TLSv1.1
、TLSv1.2
、TLSv1.3
pgsql.ssl.min_protocol_version
既定値: TLSv1.2
SSL でリポジトリに接続する際に使用する SSL/TLS プロトコル バージョンの最小値を設定します。
有効な値: TLSv1
、TLSv1.1
、TLSv1.2
、TLSv1.3
pgsql.verify_restore.port
既定値: 8061
PostgreSQL データベースの整合性の検証に使用されるポート。詳細については、tsm maintenance backupを参照してください。
ports.blocklist
バージョン: バージョン 2021.1 で追加
既定値: 自動ポート割り当てに使用される範囲内でブロックされているポートはありません。
ポートを動的に割り当てるときに Tableau で使用しないポート割り当て範囲内のポートを指定するために使用します。この機能は、別のアプリケーションがその範囲内にあるポートを使用していることを知っている場合に役に立ちます。複数のポートをカンマで区切ります。例:
tsm configuration set -k ports.blocklist -v 8000,8089, 8090
ports.blocklist
の使用の詳細については、範囲内の特定のポートをブロックするを参照してください。
recommendations.enabled
既定値: true
データ ソースとテーブルの推奨事項 (Tableau Desktop の場合) とビューの推奨事項 (Tableau Server の場合) を提供する推奨機能を制御します。推奨事項は、コンテンツの人気度、あるいは現在のユーザーと似た別のユーザーが使用しているコンテンツに基づいて提案されます。
recommendations.vizrecs.enabled
既定値: true
Tableau Server ユーザーのビューに関する推奨事項を制御します。このオプションは recommendations.enabled
の子であり、親オプションが false に設定されている場合は無効です。親オプションが true に設定され、このオプションが false に設定されている場合でも、データ ソースとテーブルは Tableau Desktop ユーザーに推奨されますが、Tableau Server のビューに関する推奨事項は無効になります。
redis.max_memory_in_mb
既定値: 1024
キャッシュ サーバーの外部クエリ キャッシュのサイズをメガバイト単位で指定します。
refresh_token.absolute_expiry_in_seconds
既定値: 31536000
更新トークンと個人用アクセス トークン (PAT) の絶対的な有効期限の秒数を指定します。
更新トークンは、接続されたクライアント (Tableau Desktop、Tableau Prep Builder、Tableau Mobile など) が初回サインイン後に Tableau Server への認証を行うために使用されます。
制限を削除するには、値を -1
に設定します。更新トークンと PAT を無効にするには、自動クライアント認証を無効にするを参照してください。
refresh_token.idle_expiry_in_seconds
既定値: 1209600
アイドル状態の 更新トークンの有効期限が切れる秒数を指定します。更新トークンは、接続されたクライアント (Tableau Desktop、Tableau Prep Builder、Tableau Mobile など) が初回サインイン後に Tableau Server への認証を行うために使用されます。制限を削除するには、値を -1
.に設定します。
refresh_token.max_count_per_user
既定値: 24
各ユーザーに発行できる更新トークンの最大数を指定します。ユーザー セッションの最大数が十分でない場合は、この値を増やすか、-1
に設定して更新トークンの制限を完全に削除してください。
rsync.timeout
既定値: 600
ファイルの同期を完了するまでの秒単位の最大許容時間 (600 秒 = 10 分)。ファイルの同期は、高可用性の構成、またはデータ エンジンとリポジトリの移動プロセスの一部として発生します。
schedules.display_schedule_description_as_name
既定値: false
サブスクリプションまたは抽出の更新 (既定) を作成するときにスケジュール名を表示するか、スケジュールの時間と頻度を説明する "スケジュール頻度の説明" 名が表示するかを制御します。タイムゾーンを区別するスケジュールの名前を表示するよう Tableau Server を設定するには、この値を true
に設定します。
true となっている場合、"スケジュール頻度の説明" はスケジュール リスト ページのスケジュール名の後にも表示されます。
schedules.display_schedules_in_client_timezone
既定値: true
true の場合、"スケジュール頻度の説明" をユーザーのタイムゾーンで表示します (クライアント ブラウザーのタイムゾーンを使用して "スケジュール頻度の説明" )。
schedules.ignore_extract_task_priority
既定値 (ブール値): False
この設定は、ジョブをキューからプルするタイミングを定めるジョブ ランクを決定する上で、タスクの優先度を考慮するかどうかを制御します。true
に設定すると、タスクの優先度の編集が無効になり、ジョブ ランクの決定にはスケジュールの優先度のみが考慮されます。
searchserver.connection_timeout_milliseconds
バージョン: バージョン 2019.1 で追加。バージョン 2022.3 で非推奨になりました。バージョン 2023.3 で廃止されました。
既定値、ミリ秒単位: 100000
検索および参照クライアントが検索および参照サーバーへの接続を確立するまでの待機時間をミリ秒単位で指定します。
特にビジーな Tableau Server コンピューターで、またはログ エラーが表示される場合「失敗した動物園のキーパーの正常性チェック。SOLR の起動を拒否する」がこの値を大きくします。
詳細については、クライアントセッションのタイムアウトを参照してください。
searchserver.index.bulk_query_user_groups
バージョン: バージョン 2022.3 で廃止。
既定値: true
CSV ファイルでユーザーをインポートまたは削除するときに、サイト ユーザーの照会を一括で行うかどうかを指定します。true
(既定) に設定すると、インデックス作成が一括で行われます。
searchserver.javamemopts
バージョン: バージョン 2019.1 で追加。2023.3 で廃止
既定値: -Xmx512m -Xms512m -XX:+ExitOnOutOfMemoryError -XX:-UsePerfData
SOLR の JVM オプションを決定します。
構成可能なすべてのオプションの中で、検索サーバーをチューニングする際に、 -Xmx
パラメーターによって構成される最大ヒープメモリが最も重要です。ほとんどの場合、Tableau Server コンピューター上の使用可能な物理メモリに基づいて、最大 24 GB までの可能な限り高い値を設定する必要があります。最大ヒープ メモリのみを変更するには、既定の文字列全体を指定しますが、-Xmx
の値だけを変更します。
-Xmx
の有効な値は Tableau Server コンピューター上の使用可能なメモリに依存しますが、24 GB を超えることはできません。詳細については、「最大ヒープメモリの検索と参照」を参照してください。
searchserver.startup.zookeeper_healthcheck_timeout_ms
バージョン: バージョン 2020.1 で追加。バージョン 2023.3 で廃止されました。
既定値、ミリ秒単位: 300000
起動時に、Tableau Server が正常な Zookeeper ヘルスチェックを待機する時間をミリ秒単位で指定します。
特にビジーな Tableau Server コンピューターで、またはログ エラーが表示される場合「失敗した動物園のキーパーの正常性チェック。SOLR の起動を拒否する」がこの値を大きくします。
詳細については、起動時の ZooKeeper 接続のヘルスチェックのタイムアウトを参照してください。
searchserver.zookeeper_session_timeout_milliseconds
バージョン: バージョン 2022.3 で廃止。
既定値、ミリ秒単位: 100000
検索および参照クライアントが調整サービス (Zookeeper) への接続を確立するまで待機する時間をミリ秒単位で指定します。
詳細については、クライアントセッションのタイムアウトを参照してください。
ServerExportCSVMaxRowsByCols
バージョン: バージョン 2020.3 で追加。
既定値: 0
(制限なし)
ビュー データから CSV ファイルにダウンロードできるデータのセルの最大数を指定します。既定では、制限はありません。セルの数を指定します。たとえば、次のコマンドを使用して、300 万の制限を設定します。
tsm configuration set -k ServerExportCSVMaxRowsByCols -v 3000000
tsm pending-changes apply
service.jmx_enabled
既定値: false
に設定するとtrue
、必要に応じて監視とトラブルシューティング用に JMX ポートを使用できます。
service.max_procs
既定値: <number>
最大サーバー プロセス数。
service.port_remapping.enabled
既定値: true
既定または構成済みのポートが利用できない場合に、Tableau Server がポートの動的な再配置を試みるかどうかを決定します。false
に設定すると、動的なポートの再配置は無効になります。
sheet_image.enabled
既定値: true
ビューの画像を REST API で取得できるかどうかを制御します。詳細については、「REST API リファレンス」を参照してください。
ssl.ciphersuite
既定値: HIGH:MEDIUM:!EXP:!aNULL:!MD5:!RC4:!3DES:!CAMELLIA:!IDEA:!SEED
ゲートウェイに対する SSL で許容される暗号アルゴリズムを指定します。
許容される値と書式要件については、Apache Web サイトの「SSLCipherSuite」(新しいウィンドウでリンクが開く)を参照してください。
ssl.client_certificate_login.blocklisted_signature_algorithms
既定値:
バージョン 2020.4.0:
sha1withrsaencryption,
sha1withrsaバージョン 2020.4.1 以降:
sha1withrsaencryption,
sha1withrsa,
sha1withrsaandmgf1,
sha1withdsa,
sha1withecdsa
既定値は、SHA-1 署名アルゴリズムを使用した証明書をブロックします。SSL に対してブロックされるクライアント署名アルゴリズムを指定します。すべての署名アルゴリズムのブロックを無効にするには、このキーを空の引用符を付けて実行します。
このキーの詳細については、ナレッジ ベースの記事「証明書が SHA-1 で署名されている場合、アップグレード後に相互 SSL が失敗する」(新しいウィンドウでリンクが開く)を参照してください。
ssl.client_certificate_login.min_allowed.elliptic_curve_size
既定値: 256
ECDSA クライアント証明書の楕円曲線サイズに求められる最小値を指定します。この証明書で Tableau Server と相互 SSL を介して認証を行います。クライアントが提示した ECDSA クライアント証明書の曲線サイズがこの最小値を満たさない場合、認証要求は失敗します。
このオプションは Tableau Server バージョン 2021.1 で追加されました。
ssl.client_certificate_login.min_allowed.rsa_key_size
既定値: 2048
RSA クライアント証明書のキー サイズに求められる最小値を指定します。この証明書で Tableau Server と相互 SSL を介して認証を行います。クライアントが提示した RSA クライアント証明書のキー サイズがこの最小値を満たさない場合、認証要求は失敗します。
このオプションは Tableau Server バージョン 2021.1 で追加されました。
ssl.protocols
既定値: all +TLSv1.2 -SSLv2 -SSLv3 -TLSv1.3
Tableau Server がゲートウェイへの TLS 接続に対してサポートする SSL プロトコルを指定します。許容値は、Apache SSL プロトコル ディレクティブ(新しいウィンドウでリンクが開く)から導き出します。セキュリティ強化チェックリストの説明に従って、SSL プロトコルを構成することをお勧めします。
storage.monitoring.email_enabled
既定値: false
メール通知でサーバーのディスク容量の監視を有効にするかどうかを制御します。既定では、メール通知が有効になっています。ディスク容量の監視に対する通知を有効にするには、これを true
に設定します。
SMTP では、通知を送信するように設定する必要があります。詳細については、SMTP セットアップの構成を参照してください。
storage.monitoring.warning_percent
既定値: 20
合計のディスク容量に対する残りのディスク容量の割合に関する警告しきい値。ディスク容量がこのしきい値を下回ると、警告通知が送信されます。
storage.monitoring.critical_percent
既定値: 10
合計のディスク容量に対する残りのディスク容量の割合に関する重要のしきい値。ディスク容量がこのしきい値を下回ると、重要の通知が送信されます。
storage.monitoring.email_interval_min
既定値: 60
ディスク容量の監視が有効になっていて、しきい値を超えた場合にメール通知を送信する頻度 (分単位)。
storage.monitoring.record_history_enabled
既定値: true
空きディスク領域の履歴を保存し、管理ビューで表示できるようにするかどうかを決定します。監視履歴の保存を無効にするには、storage.monitoring.record_history_enabled
を false
に設定します。
subscriptions.enabled
既定値: false
サブスクリプションがシステム全体で構成可能かどうかを制御します。詳細については、サブスクリプションのサーバー設定を参照してください。
subscriptions.timeout
既定値: 1800
ビューで 1 つのワークブック サブスクリプション タスクのレンダリングがタイムアウトするまでの時間 (秒)。ビューのレンダリング中にこの制限時間に達すると、レンダリングは続行されますが、ワークブック内の後続のビューはレンダリングされず、ジョブがエラーで終了します。単一ビューのワークブックの場合、この値を指定しても、タイムアウトが原因でレンダリングが停止することはありません。
svcmonitor.notification.smtp.enabled
既定値: false
サーバー プロセス イベントに対してメール通知を有効にするかどうかを制御します。既定では通知は、プロセスがダウン、フェールオーバー、または再起動したときに送信されます。サーバー プロセスの通知を有効にするには、これを true
に設定します。
SMTP では、通知を送信するように設定する必要があります。詳細については、SMTP セットアップの構成を参照してください。
svcmonitor.notification.smtp.mime_use_multipart_mixed
バージョン: バージョン 2020.1.8、2020.2.5、2020.3.1 で追加
既定値: false
サブスクリプションの HTML MIME 添付ファイルを マルチパート/関連 (デフォルト) として送信するか、マルチパート/混合 として送信するかを制御します。
まれに、Tableau Server から送信されたメールをメール クライアントが適切に解析できない場合があります。多くの場合、この問題は、プロパティを true
に設定すると修正できます。既知のクライアントには、iOS Mail と Microsoft Outlook (Exchange S/MIME 暗号化と組み合わせた場合) が含まれます。
tabadmincontroller.auth.expiration.minutes
既定値: 120
セッション Cookie が有効な期間を制御します。既定では、120 分に設定されています。この値によって、ノード bootstrap ファイル内の埋め込みの認証資格情報がどのくらい有効であるかも決まります。詳細については、tsm topology nodes get-bootstrap-fileを参照してください。
tdsservice.log.level
バージョン: バージョン 2020.3.0 で追加。
既定値: info
データ ソース プロパティ サービスのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
tomcat.http.maxrequestsize
既定値: 16380
HTTP 要求上で Apache ゲートウェイを通じて渡すことが許可されているヘッダー コンテンツの最大サイズ (バイト)。ヘッダーがこのオプションで設定された値を超えると、ブラウザーに HTTP Error 413 (要求するエンティティが長すぎます) や認証エラーなどのエラーが表示されます。
tomcat.http.maxrequestsize
の値が小さいと、認証エラーが発生する場合があります。Active Directory (SAML および Kerberos) と統合するシングル サインオン ソリューションでは、多くの場合、HTTP ヘッダーに大きな認証トークンが必要です。本番環境に展開する前に、必ず HTTP 認証シナリオをテストしてください。
gateway.http.request_size_limit
オプションを、このオプションに設定した値と同じ値に設定することをお勧めします。
tomcat.http.proxyHost
IdP へ OpenID リクエストを行うフォワード プロキシのホスト名を指定します。OpenID Connect に対応するように Tableau Server を構成するを参照してください。
tomcat.http.ProxyPort
IdP へ OpenID リクエストを行うフォワード プロキシのポートを指定します。OpenID Connect に対応するように Tableau Server を構成するを参照してください。
tomcat.https.proxyHost
IdP へ OpenID リクエストを行うフォワード プロキシのホスト名を指定します。OpenID Connect に対応するように Tableau Server を構成するを参照してください。
tomcat.https.ProxyPort
IdP へ OpenID リクエストを行うフォワード プロキシのポートを指定します。OpenID Connect に対応するように Tableau Server を構成するを参照してください。
tomcat.https.port
既定値: 8443
Tomcat の SSL ポート (未使用)。
tomcat.server.port
既定値: 8085
Tomcat がシャットダウン メッセージをリッスンするポート。
tomcat.useSystemProxies
既定値: false
Tomcat コンポーネント (OpenID) が、ローカルの Windows オペレーティング システムのフォワード プロキシ構成にアクセスする必要があるかどうかを指定します。OpenID Connect に対応するように Tableau Server を構成するを参照してください。
tomcatcontainer.log.level
既定値: info
インタラクティブなマイクロサービス コンテナとインタラクティブでないマイクロサービス コンテナのマイクロサービスのロギング レベル。バージョン 2020.4 以降では、このロギング レベルを動的に構成できるため、この設定だけを変更する場合は Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
tsm.log.level
既定値: info
TSM サービスのロギング レベル。これらのログには、管理エージェント、管理コントローラー、クライアント ファイル サービス、クラスタ コントローラー、サービス マネージャー、ライセンス サービスなどの TSM サービスに問題が発生した場合に役立つ情報が含まれています。この構成キーによって、調整サービスやメンテナンス プロセスのロギング レベルが変わることはありません。詳細については、ロギング レベルの変更とTableau Server プロセスを参照してください。
tsm.controlapp.log.level
既定値: info
control_<app>
サービスのロギング レベル。これらのログには、TSM や Tableau Server プロセスの開始や再構成に関する問題が発生した場合に役立つ情報が含まれています。詳細については、ロギング レベルの変更を参照してください。
usernotifications.reap_after_days
既定値: 30
ユーザー通知がサーバーから削除されるまでの日数。
vizportal.adsync.update_system_user
既定値: false
Active Directory グループが Tableau Server 内で同期されている場合、ユーザーの電子メール アドレスと表示名を変更するかどうか (Active Directory で変更される場合を含む) を指定します。同期中にユーザーの電子メール アドレスと表示名が更新されていることを確認するには、vizportal.adsync.update_system_user
を true
に設定してからサーバーを再起動します。
vizportal.alwaysUseEmbeddedShareLinks
バージョン: バージョン 2021.3.0 で追加。
既定値: false
[リンクのコピー] オプションに "embed=y" パラメーターを含めるかどうかを指定します。バージョン 2019.4 以降では、このパラメーターは既定で含まれていません。この構成キーを true に設定すると、動作が変更され、"embed=y" パラメーターが含まれるようになります。[リンクのコピー] のオプションを使用して Web ページに埋め込むためのリンクを共有する方法の詳細については、Tableau Desktop および Web オーサリング ヘルプの「Web ページへのビューの埋め込み」(新しいウィンドウでリンクが開く)を参照してください。
vizportal.art_skip_list
バージョン: バージョン 2024.2 で追加。
既定値: null
アクティビティとリソースのトレース (ART) が有効になっているとき、ART を使用せずに大量の不要なデータを生成する Tableau Server 機能の側面を指定するには、この構成キーを使用します。
このキーは、アプリケーション サーバー (VizPortal) の問題のトラブルシューティングのために、vizportal.log_art_java
および vizportal.enable_art
といっしょに使用されます。[何に設定されるかについての情報をここに入力する必要があります。] に設定すると、この構成設定を使用する方法の詳細については、アプリケーション サーバーの問題のトラブルシューティングを参照してください。
vizportal.commenting.delete_enabled
既定値: true
true
に設定すると、ユーザーはビューのコメントを削除できます。コメントの作成者、コンテンツ所有者、適切なサイト ロールを持つプロジェクト リーダー、または管理者である場合、コメントを削除できます。完全なプロジェクト リーダー アクセス権を得るために必要なサイト ロールの詳細については、プロジェクト レベルの管理を参照してください。
vizportal.csv_user_mgmt.index_site_users
バージョン: バージョン 2022.3 で非推奨。バージョン 2023.3 で廃止 (完全に削除) されました。
既定値: true
CSV ファイルでユーザーをインポートまたは削除する際、サイト ユーザーのインデックス作成をユーザーごとに行うかどうかを指定します。true
(既定) に設定すると、各ユーザーが追加または削除されるときにインデックス作成が実行されます。CSV ファイル全体の処理が完了するまでサイト ユーザーのインデックス作成を遅らせるには、これを false
に設定します。
vizportal.csv_user_mgmt.bulk_index_users
バージョン: バージョン 2022.3 で非推奨。バージョン 2023.3 で廃止 (完全に削除) されました。
既定値: false
CSV ファイルでユーザーをインポートまたは削除するときに、サイト ユーザーのインデックス作成を一括で行うかどうかを指定します。false
(既定) に設定すると、インデックス作成がユーザーごとに行われます。CSV ファイルを処理した後、インデックス作成を一括で行うには、これを true
に設定します。
vizportal.enable_art
バージョン: バージョン 2024.2 で追加。
既定値: false
この設定キーは、アプリケーション サーバー (VizPortal) の問題のトラブルシューティングのために、vizportal.log_art_java
および vizportal.art_skip_list
といっしょに使用されます。true に設定すると、アプリケーション サーバーでアクティビティとリソースのトレースが有効になります。この構成設定を使用する方法の詳細については、アプリケーション サーバーの問題のトラブルシューティングを参照してください。
vizportal.log_art_java
バージョン: バージョン 2024.2 で追加。
既定値: false
この設定キーは、アプリケーション サーバー (VizPortal) の問題のトラブルシューティングのために、vizportal.enable_art
および vizportal.art_skip_list
といっしょに使用されます。true に設定すると、アプリケーション サーバーでアクティビティとリソースのトレースが有効になります。この構成設定を使用する方法の詳細については、アプリケーション サーバーの問題のトラブルシューティングを参照してください。
vizportal.log.level
既定値: info
vizportal Java コンポーネントのログ レベル。ログは /var/opt/tableau/tableau_server/data/tabsvc/logs/vizportal/*.log
に書き込まれます。
詳細については、debug
に設定してください。デバッグ設定を使用するとパフォーマンスに大きな影響を及ぼす可能性があるため、Tableau サポートにより指示される場合にしか使用しないでください。
バージョン 2020.4.0 以降では、この設定は動的に構成できるため、この設定だけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
vizportal.oauth.connected_apps.max_expiration_period_in_minutes
バージョン: バージョン 2021.4 で追加。
既定値: 10
JSON Web トークン (JWT) が有効な最大期間 (分単位)。JWT の検証時に、Tableau Server は、JWT で指定された期間がこの既定値を超えていないことを確認します。この設定は、Tableau REST API(新しいウィンドウでリンクが開く) を使用して Tableau Server で Tableau 接続アプリが構成されている場合に使用されます。
たとえば、最大期間を 5 分に変更するには、次のコマンドを実行します。
tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5
vizportal.oauth.external_authorization.enabled
バージョン: バージョン 2021.4 で追加。
既定値: false
Tableau Server 2024.2 以降では、Tableau Server に対して [接続済みアプリを有効にする] オプションがオンになっています。Tableau Server 2023.2 以前で [Enable OAuth Access for Embedding Content (コンテンツを埋め込むための OAuth アクセスを有効にする)] オプションを有効にするかどうかを指定します。
このオプションを使用して、Tableau Server で外部認証サーバー (EAS) を登録し、アプリケーション統合を有効にすることができるようにします。詳細については、OAuth 2.0 信頼を使用して接続済みアプリを設定するを参照してください。
このオプションを有効にするには、次のコマンドを実行します。
tsm configuration set -k vizportal.oauth.external_authorization.enabled -v true
vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms
バージョン: バージョン 2021.4 で追加。
既定値: ES256K
外部認証サーバー (EAS) が登録されている場合、または接続アプリが構成されている場合、このコマンドを使用して、JSON Web トークン (JWT) ヘッダーで使用される署名アルゴリズムを指定できます。詳細については、OAuth 2.0 信頼を使用して接続済みアプリを設定するまたはTableau 接続済みアプリを使用してアプリケーションを統合するを参照してください。
たとえば、必要に応じて、次のコマンドを実行してアルゴリズムを削除できます。
tsm configuration set - k vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms -v
重要: 上記のコマンド例では、安全でない署名アルゴリズムが許可されており、エラーのトラブルシューティングのみに使用する必要があります。
vizportal.oauth.external_authorization_server.issuer
バージョン: バージョン 2021.4 で追加。
既定値: null
必須。このコマンドを使用して、発行元の URL を指定します。Tableau Server で外部認証サーバー (EAS) を登録するには、発行元の URL が必要です。詳細については、OAuth 2.0 信頼を使用して接続済みアプリを設定するを参照してください。
たとえば、EAS が Okta の場合、次のようなコマンドを実行できます。
tsm configuration set -k vizportal.oauth.external_authorization_server.issuer -v "https://dev-12345678.okta.com/oauth2/abcdefg9abc8eFghi76j5"
vizportal.oauth.external_authorization_server.jwks
バージョン: バージョン 2021.4 で追加。
既定値: null
外部認証サーバー (EAS) が登録されている場合、このコマンドを使用して、JSON Web キー セット (JWKS) の URL を指定できます。ID プロバイダー (IdP) が外部認証サーバーのメタデータ エンドポイントを公開しない場合は、JWKS URL が必要です。
たとえば、IdP が Amazon Cognito の場合、次のようなコマンドを実行できます。
tsm configuration set -k vizportal.oauth.external_authorization_server.jwks -v "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_Ab129faBb/.well-known/jwks.json"
vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes
バージョン: バージョン 2021.4 で追加。
既定値: 10
JSON Web トークン (JWT) が有効な最大期間 (分単位)。JWT の検証時に、Tableau Server は、JWT で指定された期間がこの既定値を超えていないことを確認します。この設定は、Tableau Server で EAS が登録されている場合に使用されます。詳細については、OAuth 2.0 信頼を使用して接続済みアプリを設定するを参照してください。
たとえば、最大期間を 5 分に変更するには、次のコマンドを実行します。
tsm configuration set -k vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes -v 5
vizportal.openid.client_authentication
OpenID Connect のカスタム クライアント認証手法を指定します。
client_secret_post
を必要とする IdP を使用するように Tableau Server を構成するには、この値を client_secret_post
に設定します。
Salesforce IDP に接続する場合がその例で、これが必要となります。
vizportal.openid.essential_acr_values
バージョン: バージョン 2020.4 で追加。
OpenID Connect IdP を必須のクレーム要求として提示するために、認証コンテキスト クラス参照 (ACR) 値のリストを指定します。IdP は、期待される基準を満たした認証を行う責任があります。構成キー vizportal.openid.essential_acr_values
が設定されている場合、Tableau Server は証明書利用者として機能し、トークン応答で ACR クレームを検査します。Tableau Server は、期待する構成キーの値と ACR クレームが一致しない場合にのみ警告します。
このオプションを設定するには、ACR 値を優先順に入力し、二重引用符で囲みます。この例のように、複数の値はコンマとスペースで区切る必要があります。
tsm configuration set -k vizportal.openid.essential_acr_values -v "value1, value2"
vizportal.openid.full_server_request_logging_enabled
既定値: false
OpenID 動作の完全なログを記録するかどうかを指定します。
OpenID Connect の問題をトラブルシューティングするときは、これを true
に設定します。これにより詳細なログを収集でき、トラブルシューティングを役立てることができます。
ログの収集とトラブルシューティングが終了したら、ログ関連のすべての設定と同じように、このキーをデフォルト値 (false
) にリセットすることをお勧めします。これにより、ログに記録される情報量が制限され、ログ ファイルのサイズが最小限に抑えられます。
vizportal.openid.voluntary_acr_values
バージョン: バージョン 2020.4 で追加。
OpenID Connect IdP を任意のクレーム要求として提示するために、認証コンテキスト クラス参照 (ACR) 値のリストを指定します。IdP は、期待される基準を満たした認証を行う責任があります。構成キー vizportal.openid.voluntary_acr_values
が設定されている場合、Tableau Server は証明書利用者として機能し、トークン応答で ACR クレームを検査します。ACR クレームが見つからない場合、または指定したクレーム値が期待する構成キーの値と一致しない場合、認証要求は失敗します。
このオプションを設定するには、ACR 値を優先順に入力し、二重引用符で囲みます。この例のように、複数の値はコンマとスペースで区切る必要があります。
tsm configuration set -k vizportal.openid.voluntary_acr_values -v "value1, value2"
vizportal.rest_api.cors.allow_origin
vizportal.rest_api.cors.enabled
が true
に設定されている場合に、Tableau Server 上の REST API エンドポイントへのアクセスを許可するオリジン (サイト) を指定します。各エントリをコンマ (,) で区切ることで、複数のオリジンを指定できます。
tsm configuration set -k vizportal.rest_api.cors.allow_origin -v https://mysite, https://yoursite
vizportal.rest_api.cors.enabled
が false
の場合、このオプションでリストされる起点は無視されます。詳細については、「Tableau Server の CORS を有効にする」を参照してください。
注: すべてのサイトに一致するワイルド カードとしてアスタリスク文字 (*) を使用できます。サーバーに接続するすべての起点からのアクセスを許可し、セキュリティ上のリスクがあるため、アスタリスク文字の使用は推奨されません。影響とサイトへのリスクを十分に理解している場合を除き、アスタリスク文字 (*) は使用しないでください。
vizportal.rest_api.cors.enabled
既定値: false
Tableau Server がクロス オリジン リソース シェアリング (CORS) を許可するかどうかを制御します。に設定されている場合true
、サーバーは Web ブラウザーに Tableau REST API エンドポイントへのアクセスを許可します。このオプションを使用して REST API でカスタム ポータルを作成することができます。既定では、この機能は有効になっていません。どの起点 (サイト) にアクセス権を付与するかを指定するには、vizportal.rest_api.cors.allow_origin
オプションを使用します。このオプションで指定された起点のみ、Tableau Server REST API に対する要求を作成できます。詳細については、「Tableau Server の CORS を有効にする」を参照してください。
vizportal.site_user_group_count_enabled
バージョン: バージョン 2022.3.5 以降および 2023.1.0 以降で追加されました。
既定値: false
[サイト ユーザー] ページに各ユーザーのグループ数を示す列を含めるかどうかを制御します。
vizqlserver.allow_insecure_scripts
既定値: false
Tableau Desktop からサーバーへワークブックをパブリッシュし、ワークブックに安全でない可能性がある SQL または R 式 (たとえば、SQL インジェクションを許可する可能性がある SQL 式) が含まれている場合でも、サーバーからワークブックを開けるようにします。この設定が false
になっている場合 (既定)、ワークブックをパブリッシュまたはサーバーから開くとエラー メッセージが表示され、ワークブックがブロックされます。この値を true
に設定する前に、ナレッジ ベース記事の「Tableau Server での安全でないスクリプトのブロック/許可」(新しいウィンドウでリンクが開く)を確認してください。
vizqlserver.browser.render
既定値: true
vizqlserver.browser.render_threshold
または vizqlserver.browser.render_threshold_mobile
によって設定されたしきい値を下回るビューは、サーバーの代わりにクライアント Web ブラウザーによってレンダリングされます。詳細については、クライアント側レンダリングの構成を参照してください。
vizqlserver.browser.render_threshold
既定値: 100
既定値は、PC に表示されるビューの高レベルの複雑度を表します。複雑度の要因には、マーク、ヘッダー、リファレンス ライン、および注釈の数が含まれます。このレベルの複雑度を超えるビューは、PC の Web ブラウザーの代わりにサーバーによってレンダリングされます。
vizqlserver.browser.render_threshold_mobile
既定値: 60
既定値は、タブレットに表示されるビューの高レベルの複雑度を表します。複雑度の要因には、マーク、ヘッダー、リファレンス ライン、および注釈の数が含まれます。このレベルの複雑度を超えるビューは、タブレットの Web ブラウザーの代わりにサーバーによってレンダリングされます。
vizqlserver.clear_session_on_unload
既定値: false
ユーザーがブラウザーを閲覧していないときやブラウザーを閉じたときに VizQL セッションをメモリ内に保存するかどうかを決定します。既定値 (false) ではセッションをメモリ内に保存します。ブラウザーの閲覧をやめるかブラウザーを閉じて VizQL セッションを終了するには、この設定を true
にします。
vizqlserver.force_maps_to_offline
バージョン: バージョン 2020.4.0 で追加。
既定値: false
Tableau Server がマップ用にオフライン モードで実行されるかどうかを判定します。このキーは、インターネットとマップ サーバーへのアクセスが制限されている切断された環境で役立ちます。マップ用のオフライン モードを有効にするには、この値を true
に設定します。インターネットへのアクセスがない環境で Tableau Server をインストールして構成する方法の詳細については、Tableau Server を未接続の (エア ギャップ) 環境にインストールするを参照してください。
vizqlserver.geosearch_cache_size
既定値: 5
サーバー メモリに同時に読み込むことができる、異なる地理的検索ロケール/言語データ セットの最大数を設定します。メモリにないロケール/言語データ セットの地理的検索要求をサーバーが受け取ると、メモリにセットが読み込まれます。データ セットの読み込みが指定されている制限を超過する場合は、要求されたデータ セットが読み込まれるように最近使用されたロケール/言語データ セットがメモリからクリアされます。最小値は 1 です。各キャッシュは約 60 MB のメモリを消費します。したがって、これを 10 に設定すると、メモリ消費量は 600 MB (60 * 10) になります。
vizqlserver.initialsql.disabled
既定値: false
すべてのデータ ソースで初期 SQL ステートメントを無視するかどうかを指定します。これを以下のように true に設定し、初期 SQL を無視します。
tsm configuration set -k vizqlserver.initialsql.disabled -v true
vizqlserver.log.level
既定値: info
VizQL Server Java コンポーネントのロギング レベル。ログは /var/opt/tableau/tableau_server/data/tabsvc/logs/vizqlserver/*.log
に書き込まれます。
詳細については、debug
に設定してください。デバッグ設定を使用するとパフォーマンスに大きな影響を与えるため、Tableau サポートで指示された場合にのみ使用します。
バージョン 2020.3.0 以降では、この設定は動的に構成できるため、この設定だけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。
vizqlserver.NumberOfWorkbookChangesBetweenAutoSaves
既定値: 5
Web 作成の自動復元の構成。自動保存を起動するためにユーザーが行う必要のある変更の数を指定します。この値の変更は慎重に行ってください。自動復元機能は、Tableau Server での Web 作成や他の Viz に関連した操作のパフォーマンスに影響する場合があります。この値の調整は、時間をかけて増分調整することをお勧めします。
vizqlserver_<n>.port
"<n>" で指定した VizQL サーバーのインスタンスが実行されているポート。
vizqlserver.querylimit
既定値: 1800
ビューを更新するまでの最大許容時間 (秒)。1800 秒 = 30 分。この構成オプションは、VizQL Server とデータ サーバーに影響を与えます。
vizqlserver.RecoveryAttemptLimitPerSession
既定値: 3
Web 作成の自動復元の構成。同じセッションの復元の最大試行回数。この値の変更は慎重に行ってください。自動復元機能は、Tableau Server での Web 作成や他の Viz に関連した操作のパフォーマンスに影響する場合があります。この値の調整は、時間をかけて増分調整することをお勧めします。
vizqlserver.session.expiry.minimum
既定値: 5
アイドル時間を分で表した値で、この時間を過ぎると、VizQLプロセスがメモリ不足になった場合に VizQL セッションを破棄できます。
vizqlserver.session.expiry.timeout
既定値: 30
セッションが破棄されるまでのアイドル時間 (分)。
vizqlserver.sheet_image_api.max_age_floor
既定値: 1
REST API の Query View Image メソッドで生成される画像をキャッシュする時間 (分)。詳細については、REST API ヘルプの「REST API リファレンス」(新しいウィンドウでリンクが開く)を参照してください。
vizqlserver.showdownload
既定値: true
ビューでの [ダウンロード] メニューの [Tableau ワークブック] オプションの表示を制御します。false
に設定すると、[Tableau ワークブック] オプションは使用できなくなります。
注: この設定では、Web 編集モードのユーザーのオプションは削除されません。
vizqlserver.showshare
既定値: true
ビューにある [共有] オプションの表示を制御します。このオプションを非表示にするには、false に設定します。
注: ユーザーは、「showShareOptions」JavaScript または URL パラメーターを設定することにより、サーバーのデフォルト値を上書きできます。
vizqlserver.url_scheme_whitelist
ビューおよびダッシュボードの URL アクション(新しいウィンドウでリンクが開く)を使用する場合に、許可リスト (承認リスト) に 1 つまたは複数の URL スキームを指定します。既定では、http
、https
、gopher
、mailto
、news
、sms
、tel
、tsc
、および tsl
の各スキームが許可リスト (承認リスト) に登録されています。このコマンドは、次の例のように、複数のコンマとスペース区切り値を含めることができます。
tsm configuration set -k vizqlserver.url_scheme_whitelist -v scheme1, scheme2
指定した値は以前の設定を上書きします。そのため、set
コマンドをスキームの完全なリストを含める必要があります。(set
コマンドを繰り返し実行して、スキームのリストを修正することはできません。)
vizqlserver.web_page_objects_enabled
既定値: true
ダッシュボードの Web ページ オブジェクトでターゲット URL を表示できるかどうかを制御します。Web ページが表示されないようにするには、false に設定します。
vizqlserver.WorkbookTooLargeToCheckpointSizeKiB
既定値: 5120
Web 作成の自動復元の構成。自動保存するワークブックのサイズ制限 (KB)。この値より大きなワークブックは自動保存されません。この値の変更は慎重に行ってください。自動復元機能は、Tableau Server での Web 作成や他の Viz に関連した操作のパフォーマンスに影響する場合があります。この値の調整は、時間をかけて増分調整することをお勧めします。
注: 以前のバージョンのサーバーで使用していたデフォルト値: 1024
vizqlserver.workflow_objects_enabled
既定値: true
Tableau 外部アクション ワークフローのオブジェクトをダッシュボードに追加できるかどうかを決定します。
webdataconnector.refresh.enabled
非推奨です。代わりに tsm data-access web-data-connectors allow
を使用してください。
Tableau Server で Web データコネクタ (WDC) の抽出の更新を有効にするかどうかを判断します。すべての WDC で更新を無効にするには、このキーの値を以下のように false
に設定します。
tsm configuration set --key webdataconnector.refresh.enabled --value false
詳細については、「Tableau Server での Web データ コネクタ」を参照してください。
webdataconnector.whitelist.fixed
非推奨です。代わりに tsm data-access web-data-connectors add
を使用してください。
HTTP または HTTPS 経由でアクセス可能なデータ接続へのアクセスに使用できる 1 つまたは複数の Web データ コネクタ (WDC) を指定します。このコマンドは、1 つの行に JSON データとして書式設定され、バックスラッシュ (\) を使用して二重引用符 (") がすべてエスケープされます。
例として、San Francisco Film Locations の WDC を許可リストに追加します。
tsm configuration set --key webdataconnector.whitelist.fixed --value "'{\"https://tableau.data.world:443\": {\"properties\": { \"secondary_whitelist\": [\"(https://data.world/)(.*)\"] } } }'"
詳細については、「Tableau Server での Web データ コネクタ」を参照してください。
webdataconnector.enabled
非推奨です。代わりに tsm data-access web-data-connectors allow
を使用してください。
既定値: true
true
に設定すると、tsm
コマンドを使用してサーバー上でWeb データ コネクタを管理できます。
webdataconnector.whitelist.mode
既定値: mixed
Tableau Server での Web データ コネクタの実行方法を決定します。サポートされるモードは次の通りです。
mixed
。ユーザーは URL の許可リスト (承認リスト) にあるコネクタを実行できます。このモードでは、当初、インポートされた WDC を実行することもできました。WDC のインポートはサポートされなくなりました。fixed
。ユーザーは URL の許可リスト (承認リスト) にあるコネクタを実行できます。insecure
。ユーザーは任意のコネクターを実行できます。
重要: insecure
オプションは、開発やテストでのみ使用してください。コネクターはカスタム コードを実行するため、吟味されていないコネクターを実行すると、セキュリティの脅威に晒される可能性があります。
wgserver.audit_history_expiration_days
既定値: 183
履歴イベントのレコードが PostgreSQL データベース (Tableau Server のデータベース) から削除されるまでの日数を指定します。
wgserver.authentication.legacy_identity_mode.enabled
バージョン: 2022.1 で追加されました
既定値: Tableau Server 2022.1 以降では false
2022.1 以降にアップグレードされた 2022.1 より前の Tableau Server の導入では、既定値は true
.です。
アイデンティティ プールを有効にするには、false
に設定します。
詳細については、「ID プールのトラブルシューティング」を参照してください。
wgserver.authentication.identity_pools.default_pool_description
バージョン: バージョン 2023.1 で追加されました
既定値: Null
オプションとして、初期プール (TSM 設定) の説明を Tableau Server のランディング ページに追加し、すべてのユーザーに表示することができます。少なくとも 1 つの ID プールを作成すると、この説明はプライマリ サインイン オプションに追加され、初期プール (TSM 設定) に属するユーザーを正しいサインイン オプションに誘導するために使用できます。
たとえば、「正社員のサインインはこちら」 (Regular employees sign in here) という説明を追加するには、次のコマンドを使用します。
tsm configuration set -k wgserver.authentication.identity_pools.default_pool_description -v “Regular employees sign in here"
注: 初期プール (TSM 設定) の説明は、サインインのカスタマイズ の注記とは異なります。サインインのカスタマイズに関する注記は、Tableau Server ランディング ページですべてのサインイン オプションの下、および初期プール (TSM 設定) ユーザーがユーザー名とパスワードを入力するページに表示されます。
wgserver.change_owner.enabled
既定値: true
ワークブック、データ ソース、またはプロジェクトの所有権が変更可能かどうかを制御します。その他の選択肢には false
および adminonly
があります。
wgserver.clickjack_defense.enabled
既定値: true
に設定するとtrue
、悪意のある人物によるTableau Server ユーザーへの "クリックジャッキング" Tableau Server ユーザー。クリックジャック攻撃では、ターゲット ページが 2 ページ目の上に透明に表示され、攻撃者はユーザーに 2 ページ目で操作をしていると思わせておいて、ターゲット ページをクリックさせたり、情報を入力させたりします。
詳細については、クリックジャック保護を参照してください。
wgserver.domain.accept_list
バージョン: この設定は、バージョン 2020.4.0 で追加されました。wgserver.domain.whitelist
を置き換えるものです。
既定値: NULL
Tableau Server からセカンダリ アクティブ ディレクトリ ドメインへの接続を許可します。セカンダリ ドメインはユーザーが同期するときに Tableau Server が接続するドメインですが、Tableau Server はインストールされていません。Tableau Server は、ユーザーとグループの同期のためにセカンダリ ドメインへの接続を試みます。場合によっては、Tableau Server がセカンダリ ドメインに接続できないことがあり、その結果、「Domain not in accept list (ドメインが許可リストにありません) (errorCode=101015)」というエラーが発生します。
wgserver.domain.accept_list
オプションの設定は、セキュリティの脆弱性に対する修正プログラムで必要です。「[重要] ADV-2020-003: Tableau Server の強制認証」(新しいウィンドウでリンクが開く)を参照してください。2020 年 2 月現在、この脆弱性に対する修正プログラムは、Tableau Server のすべての最新バージョンおよびメンテナンス リリースに含まれています。
このオプションを設定するには、二重引用符で囲まれたセカンダリドメインを入力します。複数のドメインは、コンマとスペースで区切る必要があります。たとえば、tsm configuration set -k wgserver.domain.accept_list -v "example.org, domain.com"
と入力します。
ワイルドカード機能はサポートされていません。たとえば、Tableau がsub1.example.org
と sub2.example.org
とに接続する場合は、両方のドメインを追加する必要があります。
wgserver.domain.accept_list
オプションを更新すると、既存の値が上書きされます。したがって、値に格納されている既存のドメインセットに新しいドメインを追加する場合は、オプションを設定する際に、新しいドメインを持つ既存のドメインをすべて含めます。tsm configuration get –k wgserver.domain.accept_list
を実行すると、既存のドメインの一覧を取得できます。
wgserver.domain.ldap.domain_custom_ports
既定値: NULL
子ドメインとその LDAP ポートをマッピングできます。ドメインとポートはコロン (:) で区切られ、ドメインとポートのペア間は FQDN1:port,FQDN2:port
の形式のようにコンマ (,) で区切られます。
例: tsm configuration set -k wgserver.domain.ldap.domain_custom_ports -v childdomain1.lan:3269,childdomain2.lan:3269,childdomain3.lan:389
wgserver.domain.password
既定値: Null
LDAP 接続に使用するユーザー アカウントのパスワードを指定します。外部のアイデンティティ ストアの構成リファレンスを参照してください。
wgserver.domain.whitelist
重要: このキーはバージョン 2020.4.0 で非推奨になりました代わりに wgserver.domain.accept_list
を使用してください。
既定値: NULL
Tableau Server からセカンダリ アクティブ ディレクトリ ドメインへの接続を許可します。セカンダリ ドメインはユーザーが同期するときに Tableau Server が接続するドメインですが、Tableau Server はインストールされていません。Tableau Server は、ユーザーとグループの同期のためにセカンダリ ドメインへの接続を試みます。場合によっては、Tableau Server がセカンダリ ドメインに接続できない場合があり、その結果、「ドメインが許可リストにない (エラーコード=101015)」というエラーが発生することがあります。
wgserver.extended_trusted_ip_checking
既定値: false
信頼できるチケットの要求に対して IP クライアント照合を実施します。
wgserver.ignore_domain_in_username_for_matching
バージョン: バージョン 2021.4.21、2022.1.17、2022.3.9、2023.1.5 で追加
既定値: false
SAML を有効にすると、ID プロバイダー (IdP) のユーザー名と Tableau Server のユーザー アカウントを照合するときに、SAML ユーザー名属性のドメイン部分を無視するように Tableau Server を構成できます。ユーザー名属性のプレフィックス部分に一致するが、ユーザー名属性のドメイン部分には一致しないユーザーを Tableau Server ですでに定義していれば、ユーザー名属性のドメイン部分を無視できる場合があります。詳細については、SAML 要件のトピックのセクション「SAML ユーザー名属性を照合するときにドメインを無視する」を参照してください。
たとえば、SAML ユーザー名属性のドメイン名を無視するには、次のコマンドを実行します。
tsm configuration set -k wgserver.ignore_domain_in_username_for_matching -v true
重要:
- ドメイン名を無視する際は、細心の注意を払ってください。特に、IdP で作成した構成済みドメイン全体で、ユーザー名が一意であることを確認してください。
- このコマンドは、
legacy-identity-mode
になっている Tableau Server 展開か、アイデンティティの移行(新しいウィンドウでリンクが開く)を通じて更新されていない (アイデンティティ サービスを使用しない) Tableau Server 展開のみで機能します。
wgserver.restrict_options_method
既定値: true
Tableau Server が HTTP OPTIONS 要求を受け入れるかどうかを制御します。このオプションが true
に設定されている場合、サーバーは HTTP OPTIONS 要求に対して HTTP 405 (許可されていないメソッド) を返します。
wgserver.saml.blocklisted_digest_algorithms
バージョン: バージョン 2021.1 で追加。
既定値: SHA1
SAML 証明書の署名や、SAML アサーションのダイジェスト メソッドまたは署名メソッドで、使用が認められないハッシュ アルゴリズムを指定します。拒否リストに登録されたアルゴリズムで署名およびハッシュされた証明書やアサーションは、この設定を行うと拒否され失敗します。
Tableau 側と IdP 側の両方で SHA-1 が使用される可能性のある場面は複数あります。例:
- Tableau Server が IdP に送信される要求に署名するために使用する、TSM でアップロードされた証明書。
- 証明書の公開鍵を使用して IdP から受信した AuthnResponse (署名) の検証に使用する IdP メタデータの証明書。
- SHA-1 で署名およびハッシュされた着信アサーション (DigestMethod を SHA-1 に設定し、SignatureMethod を SHA-1 に設定)。
デフォルト値は Tableau Server 2021.2 で SHA1
に変更されました。SAML を構成している 2021.2 へのアップグレードの詳細については、ナレッジベースの記事「Tableau Server 2021.2 へのアップグレード後、SAML 認証を使用した Tableau Server の起動に失敗するかログインが拒否される」を参照してください。
wgserver.saml.forceauthn
バージョン: バージョン 2019.3 で追加。
既定値: false
true
に設定した場合、Tableau ユーザー セッションの有効期限が切れると、Tableau Server は IdP を使用してユーザーを再認証します。また、このオプションを使用して、ユーザーがアクティブな IdP セッションを持っている場合でも、ユーザーに再認証を求めるよう IdP に要求することができます。
wgserver.saml.idpattribute.username
SAML IdP がユーザー名を保存する属性の名前を指定します。既定では username
に設定されています。IdP が使用する属性名にスペースが含まれている場合は、引用符で囲ってください。詳細については、サーバー全体の SAML の構成あるいはサイト固有の SAML の構成を参照してください。
wgserver.saml.iframed_idp.enabled
既定値: false
false の既定は、埋め込みビュー上でユーザーがサインイン ボタンを選択したときに、IdP のサインイン フォームがポップアップ ウィンドウで開くことを意味します。
true に設定し、既にサインインしているサーバー SAML ユーザーが埋め込みビューのある Web ページに移動すると、ユーザーはビューを見るためにサインインする必要がありません。
IdP が iframe 内のサインインをサポートする場合にのみ、これを true に設定できます。この iframe オプションはポップアップを使用するよりも安全性が低くなるため、すべての IdP でサポートされているわけではありません。IdP のサインイン ページでクリックジャック攻撃防止機能を使用している場合 (ほとんどの場合で使用しています)、サインイン ページが iframe に表示されず、ユーザーはサインインできません。
お使いの IdP が iframe 経由でのサインインをサポートしていない場合、明示的に有効化する必要が生じることがあります。ただし、このオプションを使用できる場合でも、Tableau Server の SAML に対するクリックジャック攻撃防止機能が無効になるため、セキュリティ リスクが生じるおそれがあります。
wgserver.saml.maxassertiontime
既定値: 3000
作成から SAML アサーションが利用可能な最大秒数を指定します。
wgserver.saml.min_allowed.elliptic_curve_size
既定値: 256
バージョン: バージョン 2021.1 で追加されましたが、デフォルト値は含まれていませんでした。デフォルト値は 2021.2 で 256
に設定されました。
このオプションは、SAML 認証に使用する証明書の ECDSA 曲線の最小許容サイズを指定します。ECDSA 曲線サイズが 256 未満の証明書をアップロードした場合、変更を適用すると TSM のログにエラーが記録されます。
SAML 証明書が 256 未満のサイズの ECDSA 曲線を使用している場合、Tableau Server 2021.2 以降にアップグレードしても、Tableau Server はアップグレード後に起動しません。アップグレードする前に、ECDSA 曲線のサイズが 256 またはそれ以上の新しい証明書をアップロードすることをお勧めします。代替策として、このコマンドを実行して、アップグレードする前に、Tableau Server の古いバージョン (2021.1より前) でサイズがより短い ECDSA 曲線を設定することもできます。2021.1 より前のバージョンでこのコマンドを実行する場合は、--force-keys
オプションをコマンドに含める必要があります。SAML を構成している 2021.2 へのアップグレードの詳細については、ナレッジベースの記事「Tableau Server 2021.2 へのアップグレード後、SAML 認証を使用した Tableau Server の起動に失敗するかログインが拒否される」を参照してください。
wgserver.saml.min_allowed.rsa_key_size
既定値: 2048
バージョン: バージョン 2021.1 で追加されましたが、デフォルト値は含まれていませんでした。デフォルト値は 2021.2 で 2048
に設定されました。
このオプションは、SAML 認証に使用する証明書の RSA キーの最小許容長を指定します。RSA キーの長さが 2048 未満の証明書をアップロードした場合、変更を適用すると TSM のログにエラーが記録されます。
RSA キーの長さが 1024 の SAML 認証を実行するには (非推奨)、この値を 1024
に設定します。
SAML 証明書が 2048 未満の長さのキーを使用している場合、Tableau Server 2021.2以降にアップグレードしても、Tableau Server はアップグレード後に起動しません。アップグレードする前に、キーの長さが 2048 またはそれ以上の新しい証明書をアップロードすることをお勧めします。代替策として、このコマンドを実行して、アップグレードする前に、Tableau Server の古いバージョン (2021.1より前) で強度がより弱いキーを設定することもできます。2021.1 より前のバージョンでこのコマンドを実行する場合は、--force-keys
オプションをコマンドに含める必要があります。SAML を構成している 2021.2 へのアップグレードの詳細については、ナレッジベースの記事「Tableau Server 2021.2 へのアップグレード後、SAML 認証を使用した Tableau Server の起動に失敗するかログインが拒否される」を参照してください。
wgserver.saml.responseskew
既定値: 180
Tableau Server の時刻と、依然としてメッセージを処理できるアサーション作成 (IdP サーバーの時刻に基づく) 時間の最大秒数の差を設定します。
wgserver.saml.sha256
既定値: true
true
に設定すると、Tableau Server は SAML アサーションで SHA-256 を使用し、メッセージの署名と要約を IdP にハッシュします。IdP が SHA-256 ハッシュコンテンツを含むアサーションを拒否した場合にのみ、このオプションを false
に設定します。
wgserver.session.apply_lifetime_limit
既定値: false
サーバー セッションのセッション存続期間があるかどうかを制御します。サーバー セッションの存続期間を構成するには、これを true
に設定します。
wgserver.session.idle_limit
既定値: 240
Web アプリケーションへのサインインがタイムアウトになるまでのアイドル時間 (分)。
wgserver.session.lifetime_limit
既定値: 1440
セッションの存続期間が設定されている場合は、サーバー セッションを持続する分数。既定値は 1440 分 (24 時間) です。wgserver.session.apply_lifetime_limit
が false
の場合 (デフォルト)、この設定は無視されます。
wgserver.unrestricted_ticket
既定値: false
信頼できるチケットによるユーザー認証に対し、サーバー リソースへアクセスを拡張するかどうかを指定します。既定の動作では、ユーザーにビューへのアクセスのみを許可します。これを true
に設定すると、有効な信頼できるチケットを持つユーザーに対し、認証資格情報を使用してサインインしている場合のように、サーバー リソース (プロジェクト、ワークブックなど) へのアクセスを許可します。
workerX.gateway.port
既定値: 80
(SSL の場合は 443
)
Apache が workerX ("worker" は、クラスタの後続のサーバー ノードで使用する用語) でリッスンする外部ポート。worker0.gateway.port は Tableau Server の外部ポートです。分散環境では、worker0 が Tableau Server の初期ノードです。
workerX.vizqlserver.procs
既定値: <number>
VizQL サーバー数。
zookeeper.config.snapCount
調整サービスでログのスナップショットが作成されるために必要なトランザクションの数を指定します。既定では、この値は 100,000 トランザクションです。調整サービスでスナップショットの作成に十分な数のトランザクションが書き込まれていない場合、5 日を超えたスナップショットの自動クリーンアップは実行されず、トランザクション ログによってディスク空き容量が失われる可能性があります。既定では、トランザクション ログとスナップショットは Tableau のデータ ディレクトリで作成されます。