Tableau Server on Linux ヘルプ

tsm コマンドは、第一ノード (TSM がインストールされているノード)、またはクラスター内の任意の追加ノードで実行できます。

tsm コマンドを実行するには、コマンド プロンプトを開く必要があります。

1. クラスター内のノード上で、tsmadmin グループのメンバー アカウントを使用してコマンド プロンプトを開きます。

2. 必要なコマンドを実行します。第一ノード以外のノードからコマンドを実行する場合は、-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

backgrounder.failure_threshold_for_run_prevention

既定値: 5

サブスクリプション、抽出、またはフロー実行ジョブを連続して失敗するとジョブが一時停止される回数。連続して失敗した後にジョブを一時停止することで、他のジョブのバックグラウンダー リソースを保持するのに役立ちます。失敗したバックグラウンド タスクの一時停止を無効にするには、これを -1 に設定します。

backgrounder.log.level

バージョン: バージョン 2020.3.0 で追加。

既定値: info

バックグラウンダー プロセスのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。

backgrounder.restrict_serial_collections_to_site_level

既定値: false

Tableau Server では、定期的に実行する抽出更新、サブスクリプション、フローなどをユーザーがスケジューリングできます。これらのスケジュールされた項目はタスクと呼ばれます。バックグラウンダー プロセスは、これらのタスクの固有のインスタンスを開始して、スケジュールされた時刻に実行します。結果として開始されたタスクの固有インスタンスは、ジョブと呼ばれます。

この設定は、順番に実行するように構成されているスケジュールに影響します。デフォルトでは、スケジュールを順番に実行するように設定している場合、そのスケジュールを使用するすべてのジョブは順番に実行されます。これを true に設定すると、異なるサイトで実行するジョブは並行して実行できるようになります。同じサイトでスケジュールされたタスクのジョブは、引き続き順番に実行されます。

以下の例は、次のシナリオを示したものです。

毎日午前 7 時にジョブを実行する「毎日」という名前のスケジュールが Tableau Server にあります。「毎日」スケジュールは、順番に実行するように設定されています。「人事」サイトと「給与」サイトにはそれぞれ、「毎日」スケジュールを使用する複数のタスクがスケジュールされています。この設定が true に設定されている場合、「人事」サイトのこれらのスケジュールされたタスクのジョブは、「給与」サイトのジョブと並行して実行できますが、同じサイト上のジョブは引き続き順番に実行されます。

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 を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。

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 を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。

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.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

バージョン: バージョン 2024.2 で廃止。バージョン 2024.2 以降では、vizportal.password_reset を使用します。

既定値: 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 が既定になりました。Tableau Server 2024.2 で非推奨になりました。

既定値: true

ユーザーが .tde 形式のファイルをアップロードできるかどうかを指定します。この形式は、Tableau Server のバージョン 10.5 から .hyper 形式に置き換えられましたが、アップロードはブロックされていません。バージョン 2024.3 以降、.tde 形式のファイルは使用できなくなりました。いくつかあるアクションのいずれかが実行されると、ファイルは自動的に .hyper 形式に変換されました。詳細については、「.hyper 形式への抽出のアップグレード」を参照してください。

filestore.log.level

バージョン: バージョン 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.hsts

既定値: false

HTTP Strict Transport Security (HSTS) ヘッダーによって、有効になっているドメインの 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.log.level

バージョン: バージョン 2020.3.0 で追加。

既定値: info

ゲートウェイのロギング レベル。このロギング レベルは動的に構成できるため、ロギング レベルだけを変更する場合は、Tableau Server を再起動する必要はありません。詳細については、ロギング レベルの変更を参照してください。

hyper.log_queries

既定値: true

true に設定すると、クエリ情報がログに記録されます。

既定では、クエリ情報がログに記録されます。ただし、ログ ファイルが使用可能なディスク容量に対して大きすぎると判明した場合は、これを false に設定してクエリ情報のログへの記録を無効にできます。Tableau では、この設定を true のままにしておくことをお勧めします。

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

クエリの抽出が既にキャッシュされている可能性が高くなります。抽出がキャッシュされたノードで追加の読み込みに対応できない場合は、新しいノードにルーティングすると、抽出が新しいノードのキャッシュに読み込まれます。これにより、必要性が正当化された負荷がある場合にのみ抽出がメモリに読み込まれるため、システム使用率が向上します。

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 に接続できるときに常に更新されます。

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 に設定することでスロットルを完全に無効にすることもできます。ただし、そうすると、この機能でパフォーマンスを保護するという利点は得られなくなります。

native_api.allowed_paths

既定値: ""

注: 2023 年 10 月以前の Tableau Server リリース (メンテナンス リリースを含む) では、この設定は既定ですべてのパスへのアクセスを許可するように構成されていました。

この設定を使用して、Tableau またはリモート共有に保存されているファイルへのアクセスの許可リストを指定します。このシナリオでは認可された Tableau Server ユーザーに対し、サーバー上のファイル (スプレッドシートなど) をファイル ベースのデータ ソースとして使用するワークブックの作成を許可します。

この設定により、指定したディレクトリへのアクセスのみに制限できます。そのため、tableau システム アカウントのアクセスは、データ ファイルをホストするディレクトリ パスに限定されます。

重要: この設定で指定したファイル パスが存在し、システム アカウントからアクセス可能であることを確認してください。

native_api.ExplainDataEnabled

既定値: true

このオプションで、「データの説明を見る」をサーバーで有効にするか無効にするかを制御します。「データの説明を見る」の詳細については、Tableau ヘルプの「「データの説明を見る」を使い始める(新しいウィンドウでリンクが開く)」を参照してください。

このオプションは Tableau Server バージョン 2019.3 で追加されました。

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 共有ディレクトリへの接続 (英語)」(新しいウィンドウでリンクが開く)を参照してください。

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

pgsql.port

既定値: 8060

PostgreSQL がリッスンするポート。

pgsql.preferred_host

優先リポジトリがインストールされているノードのコンピューター名を指定します。--preferred または -r オプションが tsm topology failover-repository コマンドと共に指定されている場合にはこの値が使用されます。

例:

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 の場合) を提供する推奨機能を制御します。推奨事項は、コンテンツの人気度、あるいは現在のユーザーと似た別のユーザーが使用しているコンテンツに基づいて提案されます。

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

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 に設定します。

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.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.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.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.full_server_request_logging_enabled

既定値: false

OpenID 動作の完全なログを記録するかどうかを指定します。

OpenID Connect の問題をトラブルシューティングするときは、これを true に設定します。これにより詳細なログを収集でき、トラブルシューティングを役立てることができます。

ログの収集とトラブルシューティングが終了したら、ログ関連のすべての設定と同じように、このキーをデフォルト値 (false) にリセットすることをお勧めします。これにより、ログに記録される情報量が制限され、ログ ファイルのサイズが最小限に抑えられます。

vizportal.password_reset

バージョン: バージョン 2024.2 で features.PasswordReset から置き換えられました。

既定値: false

ローカル認証を使用するサーバーにのみ適用されます。この値を true に設定し、ユーザーがサインイン ページの [パスワードを忘れましたか] オプションでパスワードをリセットできるようにします。

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.force_maps_to_offline

バージョン: バージョン 2020.4.0 で追加。

既定値: false

Tableau Server がマップ用にオフライン モードで実行されるかどうかを判定します。このキーは、インターネットとマップ サーバーへのアクセスが制限されている切断された環境で役立ちます。マップ用のオフライン モードを有効にするには、この値を true に設定します。インターネットへのアクセスがない環境で Tableau Server をインストールして構成する方法の詳細については、Tableau Server を未接続の (エア ギャップ) 環境にインストールするを参照してください。

wgserver.authentication.legacy_identity_mode.enabled

バージョン: 2022.1 で追加されました

既定値: Tableau Server 2022.1 以降では false2022.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.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.username

既定値: 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.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.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.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 の起動に失敗するかログインが拒否される」を参照してください。