rmtadmin コマンド ライン ユーティリティ
Resource Monitoring Tool には、コマンド ライン インターフェイス、rmtadmin.cmd がインストール フォルダーに含まれています。デフォルトのインストール フォルダーは次の通りです。
- RMT サーバー:
%PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\Master - エージェント:
%PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent
注: これらのコマンドを正常に実行するには、管理者としてコマンド プロンプトを実行する必要があります。
rmtadminは RMT サーバーとエージェントの両方のインストールに含まれています。コマンドの中には、RMT サーバーまたはエージェントのどちらのrmtadminコマンド ライン ユーティリティを使用しているかによって変わるものもあります。たとえば、usersコマンドは RMT サーバーのみで使用できます。ziplogsコマンドはどこでも使用できますが、コマンドを実行しているアプリケーションのログ ファイルのみを含めます。
rmtadmin コマンド ラインで使用できるコマンドは、次のとおりです。
注: rmtadmin コマンドは、位置パラメーターとオプションの両方を使用します。
位置パラメーターは、値のみを使用して指定する必要があります。実際のキーワードを指定する必要はありません。オプションのキーワードと値は、等号を使用して指定する必要があります。
例: rmtadmin <command> <positional parameter value> --<option keyword>=<value>
- rmtadmin agents
- rmtadmin bootstrap-file
- rmtadmin cleanup
- rmtadmin create-admin-user
- rmtadmin create-env
- rmtadmin delete-env
- rmtadmin data-access
- rmtadmin delete-env-data
- rmtadmin delete-server
- rmtadmin delete-server-data
- rmtadmin deregister-agent
- rmtadmin environments
- rmtadmin get
- rmtadmin help
- rmtadmin master-setup
- rmtadmin passwd
- rmtadmin query
- rmtadmin register
- rmtadmin restart
- rmtadmin rotate-mq-certificate
- rmtadmin rotate-mq-certificates
- rmtadmin-servers
- rmtadmin-service-setup
- rmtadmin set
- rmtadmin start
- rmtadmin stop
- rmtadmin status
- rmtadmin test-env
- rmtadmin update-baseline
- rmtadmin update-env
- rmtadmin users
- rmtadmin version
- rmtadmin ziplogs
当社の企業価値である「平等」に合致させるため、包括的ではない用語を可能な限り変更しました。場面に応じて用語を変更すると重大な影響につながる可能性があるため、既存の用語を維持します。そのため、CLI コマンドとオプション、インストール フォルダー、構成ファイル、その他のインスタンスには、これらの用語が引き続き使用されます、詳細については、「Tableau ヘルプについて」(新しいウィンドウでリンクが開く)を参照してください。
rmtadmin agents
注: バージョン 2021.2 で追加
すべての環境の Tableau Server ノードに登録されているすべてのエージェントを一覧表示します。
Resource Monitoring Tool エージェントがインストールされている Tableau Server の場所を確認するのに役立ちます。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin agents [options][global option]
オプション
--env
任意の項目です。このオプションを使用すると、特定の環境のエージェントを一覧表示できます。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
--keys
任意の項目です。出力にエージェント キーを含めます。
例:rmtadmin agents --env=<myenvironmentidentifier> --keys
rmtadmin bootstrap-file
注: バージョン 2021.2 で追加
Tableau Server ノードにエージェントを登録するために使用する、bootstrap ファイルを作成して保存します。
bootstrap ファイルが作成され、指定された絶対パスまたは相対パスに保存されます。相対パスは、現在の作業ディレクトリに対して解決されます。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin bootstrap-file [options][global option]
オプション
--env
必須。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
Tableau Serverノード上のエージェントは、一度に 1 つの環境にのみ登録できます。--filename
任意の項目です。ファイル名を含む絶対パスまたは相対パス。相対パスは、現在の作業ディレクトリに対して解決されます。指定しない場合、デフォルトの出力ファイル名が使用されます。
--force
任意の項目です。同じ名前の既存のファイルを上書きします。
例:rmtadmin bootstrap-file --env=<myenvironmentidentifier>
rmtadmin cleanup
注: バージョン 2021.2 で追加
特定の日数より古いログファイルを削除します。デフォルトでは、31 日より古いログファイルが削除されます。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
注: Resource Monitoring Tool プロセスが実行されている場合、アクティブなログ ファイルはこのコマンドによってクリーンアップされません。すべてのファイルが確実に削除されるようにするには、rmtadmin_stop コマンドを使用して RMT を停止してから、次のコマンド rmtadmin cleanup --log-files-retention=0 を使用してクリーンアップを実行する必要があります。次に rmtadmin_start コマンドを使用してプロセスを再起動します。
シノプシス
rmtadmin cleanup [option][global option]
オプション
--log-files-retention
任意の項目です。指定した日数より古いログ ファイルを削除します。
例:rmtadmin cleanup --log-files-retention=<number of days>
rmtadmin create-admin-user
バージョン: 2022.1 で追加されました
他のユーザーが存在しない場合は、初期管理ユーザーを作成します。
注: バージョン 2023.1 以降では、複数の管理ユーザーを作成することができます。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin create-admin-user [options][global option]
オプション
--username
オプション。管理者ユーザー アカウントのユーザー名。指定しない場合は既定で "admin" に設定されます。
--password
必須。管理者ユーザー アカウントのパスワード。
--password-file
オプション。管理者ユーザー アカウントのパスワードを含むファイル パス。これは、パスワードを直接入力せずにアクセス可能なファイルにパスワードを保存する場合に使用できます。
例:rmtadmin create-admin-user --username<admin user name> --password <password for the admin user account>
rmtadmin create-env
注: バージョン 2021.2 で追加
新しい環境を作成します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin create-env [options][global option]
オプション
| オプション | 必須か? | 既定 | 説明 |
|---|---|---|---|
| --name | はい | N/A | 環境 の名前。 |
| --gateway-url | はい
| N/A | Tableau Server ゲートウェイへのアクセスに使用される URL。 |
| --version | はい | N/A | この環境が監視する Tableau Server のバージョン。 |
| --non-interactive | いいえ | インタラクティブなプロンプトはデフォルトで有効になっています。 | すべてのインタラクティブなプロンプトを無効にします。 |
| --no-test | いいえ | API とリポジトリの接続テストはデフォルトで有効になっています。 | API とリポジトリの接続テストを無効にします。 |
| --api-username | いいえ | Null | Tableau Server API への接続に使用されるアカウントのユーザー名。ユーザー アカウントは、すべての Tableau Server サイトにアクセスできる Tableau Server 管理者である必要があります。 |
| --api-password | いいえ (Tableau API ユーザー名を指定する場合は、パスワードを指定するか、ファイル パスとパスワードを含むファイルを指定します) | Null | Tableau Server API への接続に使用される Tableau Server API ユーザー アカウントのパスワード。 |
| --api-password-file | いいえ | Null | ファイルへのパスと、Tableau Server API ユーザー アカウントのパスワードを含むファイルの名前。 |
| --repository-server | はい | Null | Tableau Server と共にインストールされている PostgreSQL データベースのサーバー名。 |
| --repository-database | 可 | Null | Tableau Server と共にインストールされている PostgreSQL データベースの名前。 |
| --repository-port | 可 | Null | Tableau Server リポジトリデータベースのポート番号。 |
| --repository-username | 可 | Null | Tableau Server リポジトリと共にインストールされている PostgreSQL データベースへの接続に使用するユーザー名。 Resource Monitoring Tool は、パフォーマンス上の理由から Tableau Server リポジトリ データベースに直接アクセスします。これが動作するには、読み取り専用データベース ユーザーのパスワード セットを使用してリポジトリへのアクセスを有効にする必要があります。詳細については、Tableau Server リポジトリへのアクセスを有効にするを参照してください。 |
| --repository-password | 可 | Null | Tableau Server と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー アカウント のパスワード。 Resource Monitoring Tool は、パフォーマンス上の理由から Tableau Server リポジトリ データベースに直接アクセスします。これが動作するには、読み取り専用データベース ユーザーのパスワード セットを使用してリポジトリへのアクセスを有効にする必要があります。詳細については、Tableau Server リポジトリへのアクセスを有効にするを参照してください。 |
| --repository-password-file | いいえ。ただし、コマンド プロンプトまたはスクリプトで直接パスワードを入力しない場合は必要です。 | Null | Tableau Server と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー アカウントのパスワードが保存されているファイル名を含むパス。 |
| --repository-ssl-mode | いいえ | Prefer | Tableau Server リポジトリ SSL モード。 Prefer は SSL を優先して、Require は SSL を必須として、Tableau リポジトリへの SSL接続を構成します。 Disable は SSL を使用せずに、Tableau Server リポジトリへの接続を行います。 |
| --repository-ssl-thumbprint | いいえ | Null | 直接接続を許可するように Tableau Server PostgreSQL を構成する場合、Tableau Server は証明書とキーを作成します。Tableau Server によって生成された証明書の指紋を指定するか、server.crt ファイルを Resource Monitoring Tool のサーバー マシンにコピーするかを選択できます。証明書ファイルをコピーする場合は、指紋を指定する必要はありません。詳細については、クライアントからの直接接続を許可するよう Postgres SSL を構成するを参照してください。 |
例:rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account> --gateway-url <Tableau Server Gateway URL> --version <Tableau Server version>
rmtadmin data-access
注: バージョン 2022.3 で追加
PostgreSQL データベースへのアクセスを有効化または無効化します。注: Resource Monitoring Tool が Tableau Server からすべての監視データを収集できるようにするために、バージョン 2022.3 以降では、PostgreSQL データベースにアクセスする必要があります。
このコマンドは RMT サーバーのみで機能します。
注: この構成を有効にするには、PostgreSQL データベースを再起動する必要があります。
シノプシス
rmtadmin data-access [positional parameter][options] [global option]
位置パラメーター
モード
必須。PostgreSQL データベースへのリモート データ アクセスに使用する必要があるモード。値は、None、ReadOnly、Admin のいずれかにする必要があります。None に設定すると、データ アクセスが無効になります。ReadOnly と Admin の場合、データベースへのアクセスに使用するユーザー アカウントを指定します。
オプション
--
例:
rmtadmin data-access ReadOnly
rmtadmin restart --db
rmtadmin delete-env
注: バージョン 2021.2 で追加
特定の環境と、その環境用に収集されたすべてのデータを削除します。その環境が監視している Tableau Server に関する接続およびトポロジ情報も削除し、すべての Resource Monitoring Tool エージェントの登録を解除します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin delete-env [positional parameter][options] [global option]
位置パラメーター
env
必須。これは、システムで生成された識別子です。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
オプション
--confirm
任意の項目です。環境を削除することを確認します。このオプションを指定しない場合、確認を要求するプロンプトが表示されます。
--skip-agent-disconnect
任意の項目です。エージェントの切断をスキップし、エージェントの登録解除を続行します。エージェントがアクセスできないと考えられる場合に、このオプションを使用します。たとえば、Tableau Server ノードが削除されている場合、またはエージェントがそのノードでアンインストールされている場合などです。
例:rmtadmin delete-env <myenvironmentidentifier>
rmtadmin delete-env-data
指定した環境で収集されたすべての Tableau Server 関連のデータが完全に削除されます。環境構成、Tableau Server 情報、エージェント登録は削除されません。
これは、環境自体を削除せずに環境内のすべての既存データをクリアする場合に便利です。既存のデータを削除した後も、エージェントによって送信された新規データは引き続き処理されます。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin delete-env-data [positional parameter][option][global option]
位置パラメーター
env
データを削除する必要がある環境の識別子。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
オプション
--confirm
任意の項目です。環境データを削除することを確認します。このオプションを指定しない場合、確認を要求するプロンプトが表示されます。
例:rmtadmin delete-env-data <myenvironmentidentifier>
rmtadmin delete-server
注: バージョン 2021.2 で追加
Tableau Server ノードの構成情報を環境から削除し、そのノードのエージェントの登録を解除し、そのノードに固有に収集されたすべての監視データを削除します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin delete-server [options][global option]
オプション
--env
必須。Tableau Server ノードが接続されている環境の識別子。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
--hostname
環境に接続されている 1 つ以上の情報を削除するために必要。-all が指定されていない場合も必要。
Tableau Server ノードのマシン名です。複数のホスト名を指定する場合は、コンマを使用して複数の値を区切ります。
--all
オプションですが、--hostname が指定されていない場合は必須です。
環境に接続されているすべての Tableau Server ノードの情報を削除します。
--skip-agent-disconnect
任意の項目です。エージェントの切断をスキップし、エージェントの登録解除を続行します。エージェントにアクセスできない場合、このオプションを使用します。たとえば、ノードが Tableau Server から削除されている場合、またはエージェントがそのノードでアンインストールされている場合です。
--confirm
Tableau Server ノードに関するすべての情報を削除することを確認します。このオプションを指定しない場合、確認を要求するプロンプトが表示されます。
例:rmtadmin delete-server --hostname=<machine name of the Tableau Server node>
rmtadmin delete-server-data
注: バージョン 2021.2 で追加
1 つ以上の Tableau Server ノードから収集されたデータを削除します。指定したノードのみから収集されたデータを削除します。all を指定すると、すべてのノードから収集されたすべてのデータが削除されます。環境構成、Tableau Server 情報、エージェント登録は削除されません。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin delete-server-data [options][global option]
オプション
--env
必須。Tableau Server ノードが接続されている環境の識別子。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
--hostname
環境に接続されている 1 つ以上の情報を削除するために必要。-all が指定されていない場合も必要。
Tableau Server ノードのマシン名です。複数のホスト名を指定する場合は、コンマを使用して複数の値を区切ります。
--all
オプションですが、--hostname が指定されていない場合は必須です。
環境に接続されているすべての Tableau Server ノードの監視データを削除します。
--confirm
Tableau Server ノードからすべての監視データを削除することを確認します。このオプションを指定しない場合、確認を要求するプロンプトが表示されます。
例:rmtadmin delete-server-data --all
rmtadmin の登録解除
注: バージョン 2021.2 で追加
環境からエージェントの登録を解除します。このノードからの監視データは収集されなくなります。既存のデータは残り、削除されません。
このコマンドは RMT エージェントでのみ機能します。登録を解除したいエージェント上でこれを実行します。
シノプシス
rmtadmin deregister [options]
オプション
--confirm
任意の項目です。エージェントの登録を解除することを確認します。これにより、確認プロンプトが省略されます。
--ignore-master-errors
任意の項目です。このプロセス中に RTM サーバーとの通信で発生するエラーは無視されます。
例: rmtadmin deregister --confirm
rmtadmin deregister-agent
注: バージョン 2021.2 で追加
指定されたエージェントの登録を環境から解除します。このノードからの監視データは収集されなくなります。既存のデータは残り、削除されません。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin deregister-agent [options][global option]
オプション
--env
--key が指定されていない場合は必須です。
エージェントが現在登録されている環境の識別子です。これは、システムで生成された識別子です。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
--key
--env が指定されている場合は省略可能です。
エージェント キーです。複数の値を区切るには、コンマを使用します。rmtadmin agents コマンドを実行すると、キー値を取得できます。
--hostname
任意の項目です。エージェントがインストールされている Tableau Server ノードのマシン名。複数の値を区切るには、コンマを使用します。
--all
任意の項目です。このオプションを使用して、すべてのノードのエージェントの登録を解除します。
--ignore-agent-errors
任意の項目です。このプロセス中にエージェントに接続できない場合に発生するエラーを無視します。
--skip-agent-disconnect
任意の項目です。エージェントの切断をスキップし、エージェントの登録解除を続行します。エージェントにアクセスできないと思われる場合は、このオプションを使用します。たとえば、ノードが Tableau Server から削除されている場合、またはエージェントがそのノードでアンインストールされている場合などです。
--confirm
任意の項目です。エージェントの登録を解除することを確認します。このオプションを指定しない場合、確認を要求するプロンプトが表示されます。
例:rmtadmin deregister-agent --env=<myenvironmentidentifier> --all
rmtadmin environments
注: バージョン 2021.2 で追加
Resource Monitoring Tool サーバー上のすべての環境を一覧表示します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin environments [global option]
rmtadmin get
指定した構成キーの値を取得します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin get <config.key> [global option]
位置パラメーター
key
構成キーの名前。
例: rmtadmin get db:database
サポートされる構成キー
| キー | データ型 | 適用先 | デフォルト | 説明 |
|---|---|---|---|---|
db:database | 文字列 | RMT サーバー | tabrmtdb | RMT が使用する PostgreSQL データベースの名前。 |
db:readOnlyUsername | 文字列 | RMT サーバー | リードオンリー | RMT データへの読み取り専用アクセスのみを持つ PostgreSQL ユーザー アカウントのユーザー名。 |
db:readOnlyPassword | 文字列 | RMT サーバー | インストーラー プログラムによって生成されます。 | PostgreSQL 読み取り専用ユーザーのパスワード。 |
mq:tls:certificateHostName | 文字列 | RMT サーバーとエージェント | N/A | TLS 経由で RabbitMQ に接続するときに使用する証明書のホスト名。 |
mq:tls:enabled | ブール値 | RMT サーバーとエージェント | 無効 | RabbitMQ への TLS 接続を有効または無効にします。 |
mq:port | 整数 | RMT サーバーとエージェント | 5672 | RabbitMQ ホストのポート番号。 |
mq:virtualHost | 文字列 | RMT サーバーとエージェント | tabrmt | RMT サーバーまたはエージェントへの接続。エージェントの場合、ブートストラップ ファイルにエージェントを登録することで、この設定を変更できます。RMT サーバーの場合、値はインストーラーによって管理されます。 |
server.web.run | ブール値 | エージェント | 有効 | エージェントの Web インターフェイスを有効または無効にします。 |
set コマンドを使用して、現在の構成値を変更します。
rmtadmin help
コマンド ライン インターフェイスと使用可能なコマンドに関する一般的なヘルプを示します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin help
特定のコマンドのヘルプおよび使用状況情報を表示する場合:
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
rmtadmin help [command]
rmtadmin master-setup
指定したオプションを使用して RMT サーバーを構成します。インストール時とインストール後の両方の構成で使用します。
シノプシス
rmtadmin master-setup [options][global option]
構成オプションは以下のとおりです。
| オプション | 必須か? | 既定 | 説明 |
|---|---|---|---|
| --admin-password | はい (初回インストールでのみ必要) パスワードは、コマンド ラインで指定するか、使用するパスワードをファイルに含めて指定できます。いずれかの方法で指定しなければ、パスワードの入力が求められます。 | N/A | 管理者ユーザーのパスワード |
| --admin-password-file | はい (初回インストールでのみ必要) パスワードは、コマンド ラインで指定するか、使用するパスワードをファイルに含めて指定できます。いずれかの方法で指定しなければ、パスワードの入力が求められます。 | N/A | 管理者ユーザーのパスワード |
| --admin-username | いいえ | admin | 管理者ユーザーのユーザー名 |
| --skip-admin-creation 追加: バージョン 2020.4.0 廃止: バージョン 2022.3.0 | なし このオプションは、インストール後に構成を更新する場合にのみ使用する必要があります。 このオプションが有効なバージョン (2020.4.0 - 2022.2.x) では、インストール後の構成の更新中にこのオプションを使用しない場合、そのコマンドは失敗し、更新は行われなくなります。 バージョン 2022.3.0 以降では、このコマンドは必要に応じて管理者を作成します。 | False | 管理者ユーザーとパスワードの作成をスキップします。 |
| --http-port | いいえ | 80 | |
| --require-https | いいえ | False | HTTP トラフィックを HTTPS にリダイレクトします。 |
| --https-certificate-mode | いいえ | ‘既定' 使用可能なオプション:
| HTTPS 証明書に対して実行する証明書検索のタイプ 既定: このモードでは、インストーラーによって提供される既定の自己署名証明書が使用されます。 ストア: このモードでは、Windows 証明書ストアに証明書の指紋を入力できます。 ローカル: このモードでは、config フォルダーにあるファイルベースの証明書を指定できます。 |
| --https-certificate-store-thumbprint | いいえ | Null | HTTPS 証明書のハッシュ/指紋を使用して 'ストア' 証明書モードで検索する |
| --https-certificate-local-name | いいえ | Null 注: 指定しない場合、Resource Monitoring Tool は自己署名証明書と共にインストールされ、HTTPS 通信にその証明書を使用します。 | HTTPS 証明書ファイルの名前 |
| --https-certificate-local-password | いいえ | Null | HTTPS 証明書に使用するパスワード |
| --https-certificate-local-password-file | いいえ | Null | HTTPS 証明書に使用するパスワードを含むファイルへのパス |
| --confirm | いいえ | 確認のプロンプトを表示します。 | RMT サーバーの再起動を確認します。 |
| --host | いいえ 注: この値を変更することは推奨しません。 | 現在の構成値またはマシン名 | Resource Monitoring Tool サーバーにアクセスするための優先 URL。サーバは、ホスト名に関係なくすべての IP をリッスンします。 |
| --db-config=external | いいえ | なし。 このオプションは、リポジトリが RMT サーバーの外部で構成されている場合にのみ使用されます。 | このオプションを使って、外部リポジトリを使用するように RMT サーバーを構成します。PostgreSQL データベースをローカルでインストールする場合は、このオプションを指定する必要はありません。 |
| --db-server | いいえ | 現在の構成値またはインストーラーのデフォルト値 | Resource Monitoring Tool と共にインストールされている PostgreSQL データベースのサーバー名。 AWS RDS でホストされている外部リポジトリを使用している場合、この名前は RDS のインスタンス名である必要があります。 |
--db-ssl-mode バージョン: バージョン 2023.1.0 で追加されました。 | いいえ | Prefer | Resource Monitoring Tool と共にインストールされてた PostgreSQL データベースへの接続の SSL/TLS 暗号化が決定されます。 オプションは、 |
| --db-port | いいえ | 現在の構成値またはインストーラーのデフォルト値 | データベース サーバーのポート番号 |
| --db-username | いいえ | 現在の構成値またはインストーラーのデフォルト値 | Resource Monitoring Tool と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー名。 AWS RDS でホストされている外部リポジトリを使用している場合、この名前は"postgres" である必要があります。 |
| --db-password | いいえ | 現在の構成値またはインストーラーのデフォルト値 | Resource Monitoring Tool と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー アカウント のパスワード。 AWS RDS でホストされている外部リポジトリを使用している場合、このパスワードは、RDS インスタンスを作成するときに設定したユーザー パスワードです。 |
| --mq-config=external | いいえ | なし このオプションは、メッセージング サービスが RMT サーバーの外部で構成されている場合にのみ指定されます。 | このオプションを使って、外部 Rabbit MQ メッセージング サービスを使用するように RMT サーバーを構成します。 |
| --mq-server | いいえ | 現在の構成値またはインストーラーのデフォルト値 | メッセージ キュー サーバーの名前。 |
| --mq-port | いいえ | 現在の構成値またはインストーラーのデフォルト値 | メッセージ キューのポート。 |
| --mq-vhost | いいえ | 現在の構成値またはインストーラーのデフォルト値 | メッセージ キューの仮想ホスト。 |
| --mq-username | いいえ | 現在の構成値またはインストーラーのデフォルト値 | メッセージ キューへの接続に使用するユーザー名。 |
| --mq-password | いいえ | 現在の構成値またはインストーラーのデフォルト値 | メッセージ キューへの接続に使用するユーザー アカウントのパスワード。 |
| --mq-enable-tls | いいえ | 現在の構成値または false。 | メッセージ キューに接続するには TLS 接続が必要です。 |
| --mq-tls-certificate-host | いいえ | 現在の構成値または null。 | メッセージ キュー サーバーの正規名。証明書の名前と一致している必要があります。 |
| --password-salt | いいえ | ランダム値 | パスワードのハッシュ化に使用するグローバル ソルト。 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --password-min-length | いいえ | 現在の構成値または 10。 | パスワードの最小長。 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --password-min-numeric | いいえ | 現在の構成値または 1。 | パスワードに必要な数字の最小個数。 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --password-min-special | いいえ | 現在の構成値または 1。 | パスワードに必要な最小特殊文字数 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --password-min-latin | いいえ | 現在の構成値または 5。 | パスワードに必要な英字の最小個数。 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --password-require-mixed-case | いいえ | 現在の構成値または true。 | パスワードに大文字と小文字を混在させることが必要。 これは Resource Monitoring Tool で作成したローカル ユーザー アカウントに適用されます。 |
| --auth-timeout-minutes | なし | 現在の構成値または 240。 | セッションのユーザー認証が期限切れになるまでの時間 (分)。 |
| --auth-sliding-expiration | なし | 現在の構成値または true。 | ユーザー アクティビティで認証タイムアウト期間をリセットする、またはリセットしない。 |
例:
管理者パスワードを指定するには、次を実行します。rmtadmin master-setup --admin-password=<password> --skip-admin-creation
インストール後にポートを更新するには、次を実行します。 rmtadmin master-setup --http-port=8000 --skip-admin-creation
rmtadmin passwd
特定の Resource Monitoring Tool ユーザー アカウントのパスワードをリセットします。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin passwd [positional parameter][global option]
位置パラメーター
username
パスワードを変更するユーザーの名前。
例: rmtadmin passwd <username>
rmtadmin query
Resource Monitoring Tool データベースに対して未加工の SQL クエリを実行し、結果を出力ファイルに保存します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin query [positional parameter][options] [global option]
位置パラメーター
sql
実行する SQL コマンドのテキスト。複数の SQL コマンドを指定できます。SQL コマンドでファイルを使用するには、ファイル名の頭に @ を付けます。
オプション
--outfile=VALUE
--force
既存のファイルを上書きします。
--timeout=VALUE
クエリのタイムアウト値です。秒単位で指定します。
--commit
SQL コマンドによって行われた変更をデータベースにコミットします。デフォルトでは、SQL コマンドはトランザクションとして実行されますが、完了時にロールバックされます。
クエリ結果を出力する zip ファイルの名前。デフォルトは queryresults.zip です。
例: rmtadmin query <SQLCommand> --outfile=<path and the output file name>
rmtadmin register
注: バージョン 2020.2 で追加
ブートストラップ ファイルを使用してエージェントを登録します。bootstrap ファイルは、rmtadmin bootstrap-file コマンドを使用してダウンロードできます。
このコマンドはエージェントでのみ使用でき、エージェントをインストールするマシンで実行する必要があります。
シノプシス
rmtadmin register [options][positional parameter] [global option]
位置パラメーター
bootstrap
ブートストラップ ファイルの名前を含むファイル パス。
オプション
--username
必須。RMT サーバーのインストール中に作成された管理者ユーザーの名前。
--password
必須。ユーザー アカウントのパスワード。
--password-file
パスワード情報を含むファイル名が含まれたパス。パスワードは、コマンド ラインで指定するか、使用するパスワードをファイルに含めて指定できます。いずれかの方法で指定しなければ、パスワードの入力が求められます。
--server-name
エージェントがインストールされているノードの名前。名前が指定されていない場合は、デフォルトでマシン名が使用されます。
--server-description
サーバーに関する自由な説明。
例: rmtadmin register <bootstrap file name and path> --server-name=<server name>
rmtadmin restart
Resource Monitoring Tool アプリケーションを再起動します。RMT サーバーがインストールされているマシンから実行すると、RMT サーバー アプリケーションが再起動します。エージェントがインストールされているノードで実行すると、その特定のノードでエージェント アプリケーションのみが再起動します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin restart [options] [global option]
オプション
少なくとも 1 つのオプションを指定する必要があります。
RMT サーバー:
--all
すべてのサービスを再起動します。
--master
RMT サーバーを再起動します。
--mq
メッセージ キュー サービスを再起動します。
--db
データベース サービスを再起動します。
エージェント:
--agent
マシンで実行されているエージェント サービスを再起動します。
例: rmtadmin restart --db
rmtadmin rotate-mq-certificate
エージェント マシンで、エージェント メッセージ キューのクライアント証明書をローテーションします。Server マシンで rmtadmin rotate-mq-certificate を実行した後に、このコマンドを実行します。
このコマンドは、RMT エージェントから実行する必要があります。
シノプシス
rmtadmin rotate-mq-certificate [options] [positional parameter]
位置パラメーター
bootstrap
ブートストラップ ファイルの名前を含むファイル パス。
オプション
--username
必須。マスター サーバーのユーザー名
--password
必須。マスター サーバーのユーザー アカウントのパスワード。
--password-file
マスター サーバーのパスワード情報を含むファイル名が含まれたパス。パスワードは、コマンド ラインで指定するか、使用するパスワードをファイルに含めて指定できます。いずれかの方法で指定しなければ、パスワードの入力が求められます。
--confirm-restart
サービスの再起動を確認し、確認プロンプトをバイパスします。
rmtadmin rotate-mq-certificates
Server マシンで、メッセージ キューのサーバー証明書とクライアント証明書をローテーションします。
このコマンドは、RMT サーバーから実行する必要があります。
シノプシス
rmtadmin rotate-mq-certificates [options]
オプション
--confirm-restart
サービスの再起動を確認し、確認プロンプトをバイパスします。
rmtadmin servers
注: バージョン 2021.2 で追加
すべての環境または特定の環境にあるすべての Tableau Server ノードを一覧表示します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin servers [positional parameter][global option]
位置パラメーター
env
任意の項目です。環境の識別子を指定して、その環境に登録されている Tableau Server ノードのリストを取得します。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
rmtadmin service-setup
注: バージョン 2021.4 で追加。RMT サーバー、エージェント、Rabbit MQ、PostgreSQL データベースなどの Resource Monitoring Tool サービスのユーザー認証資格情報をインストールまたは更新するために使用されます。このコマンドは、インストール後にサービス情報を更新するのに役立ちます。
このコマンドは、RMT サーバーとエージェントの両方で機能します。
シノプシス
rmtadmin service-setup [positional parameter][options][global option]
位置パラメーター
次のうち少なくとも 1 つの値を指定する必要があります。
すべて
利用可能なすべてのサービスを更新します。RMT とエージェントの両方で実行できます。Tableau Server ノードで実行すると、そのノードのエージェントが更新されます。
マスター
RMT サーバーを更新します。
エージェント
エージェントを更新します。エージェント (Tableau Server ノード) でのみ実行できます。
db
データベース サービスを更新します。RMT サーバーでのみ実行できます。
mq
メッセージ キュー サービスを更新します。RMT サーバーでのみ実行できます。
オプション
--confirm
任意の項目です。更新することを確認します。RMT とエージェントの両方で実行できます。Tableau Server ノードで実行すると、そのノードのエージェントが更新されます。
--user-type
RMT サーバーとエージェントに対して必要です。RMT サーバーまたはエージェントの実行に使用されるアカウントのタイプ許可される値は次のとおりです。
- 仮想アカウント (RMT サーバーのみ)
- ネットワークサービス
- local-system
- local-service
- username (ローカル ユーザーまたはドメイン ユーザーのアカウント名)
--username
アカウントのユーザー名を指定します。ローカル ユーザーまたはドメイン ユーザーのアカウントを使用する場合に必要です。
--password
アカウントのパスワードを指定します。ローカル ユーザーまたはドメイン ユーザーのアカウントを使用する場合に必要です。
--password-file
オプション。パスワード情報が保存されているファイル名を含むファイルの場所へのパス
--append-permissions
オプション。新しいパーミッションを追加します。このコマンドは、既存のパーミッションを上書きしたくない場合に使用します。
rmtadmin set
指定した構成キーの値を設定します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin set [positional parameter] [global option]
位置パラメーター
key
値を変更する構成キー。
値
使用する新しい値。
例: rmtadmin set mq:port <port number> mq:port がキーで、<port number> が値です。
サポートされる構成キー
| キー | データ型 | 適用先 | デフォルト | 説明 |
|---|---|---|---|---|
mq:tls:certificateHostName | 文字列 | RMT サーバーとエージェント | N/A | TLS 経由で RabbitMQ に接続するときに使用する証明書のホスト名 |
mq:tls:enabled | ブール値 | RMT サーバーとエージェント | 無効 | RabbitMQ への TLS 接続を有効または無効にします。 |
mq:port | 整数 | RMT サーバーとエージェント | 5672 | RabbitMQ ホストのポート番号。 |
server.web.run | ブール値 | エージェント | 有効 | エージェントの Web インターフェイスを有効または無効にします。 |
オプション
--backup
変更を行う前に、構成ファイルのバックアップを作成します。
get コマンドを使用して、現在の構成値を表示します。
rmtadmin start
Resource Monitoring Tool サービスを開始します。RMT サーバー上で実行すると、RMT サーバーのみが起動します。エージェント上で実行すると、コマンドを実行しているマシン上でエージェントが起動します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin start [options] [global option]
オプション
少なくとも 1 つのオプションを指定する必要があります。
RMT サーバー:
--all
すべてのサービスを開始します。
--master
RMT サーバーを起動します。
--mq
メッセージ キュー サービスを開始します。
--db
データベース サービスを開始します。
エージェント:
--agent
マシン上で実行されているエージェント サービスを開始します。
例: rmtadmin start --all
rmtadmin status
このコマンドを実行しているマシン上で、アプリケーションおよび実行中のサービスの状態を確認します。RMT サーバーの場合、ステータス レポートで、RMT サーバーがデータベースとメッセージ キューに接続されていることを確認します。エージェントの場合、ステータス レポートで、エージェントが RMT サーバーに接続されていることを確認します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
このコマンドは次を返します。
- アプリケーションの状態 (実行中かどうか)
- ライセンスのステータス
- MQ 接続
- キューの詳細
- 使用されているメモリ
- 使用されているディスク スペース
- マシン上の Tableau Server のバージョン
- エージェント構成ファイルに格納されている Tableau Server のプロセス トポロジ。
バージョン 2024.2.0 以降では、RMT サーバーでコマンドを実行すると、次が返されます。
ローカル データベース内のメッセージング テーブルが警告しきい値 (4 GB) を超える領域を使用している場合、ディスク領域使用量の警告が表示されます。詳細については、メッセージング テーブルのディスク使用量の警告のトラブルシューティングを参照してください。
シノプシス
rmtadmin status [global option]
rmtadmin stop
Resource Monitoring Tool サービスを停止します。このコマンドを RMT サーバー上で実行すると、RMT サーバーのみを停止します。エージェントがインストールされているマシン上で実行すると、そのマシン上のエージェントのみを停止します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin stop [options] [global option]
オプション
少なくとも 1 つのオプションを指定する必要があります。
RMT サーバー:
--all
すべてのサービスを停止します。
--master
RMT サーバーを停止します。
--mq
メッセージ キュー サービスを停止します。
--db
データベース サービスを停止します。
エージェント:
--agent
マシン上で実行されているエージェント サービスを停止します。
例: rmtadmin stop --db
rmtadmin test-env
注: バージョン 2021.2 で追加
Resource Monitoring Tool および Tableau Server 間のさまざまな接続ポイントをテストします。Tableau Server リポジトリ接続、Tableau Server API 接続、Advanced Management 機能などのテストが含まれます。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin test-env [positional parameter][global option]
位置パラメーター
--env
オプション。Resource Monitoring Tool が監視している環境の識別子。これはシステムで生成された識別子です。これを確認するには、Admin > Environments >
--force
任意の項目です。このオプションを使用すると、十分なデータを使用できない場合でも、ベースラインをすぐに更新できます。既定では、このコマンドは 50 回のロードが正常に終了してベースラインが計算されるまで待機します
rmtadmin update-baseline
注 バージョン 2021.4 で追加
すべてのビューの読み込みのベースラインを更新します。ベースラインは、ビューの 50 回の正常な初期ロード時間の 95 パーセンタイルです。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin update-baseline [options][global option]
オプション
env
必須。これは、システムで生成された識別子です。これを確認するには、Admin > Environments >
rmtadmin update-env
注: バージョン 2021.2 で追加
環境設定を更新します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin update-env [options][global option]
オプション
| オプション | 必須か? | 説明 |
|---|---|---|
| --non-interactive | いいえ | すべてのインタラクティブなプロンプトを無効にします。 |
| --no-test | いいえ | API とリポジトリの接続テストを無効にします。 |
| --name | はい | 環境 の名前。 |
| --id | いいえ | Web インターフェイスの URL で使用される環境の識別子。 これは、システムで生成された識別子です。これを確認するには、Admin > Environments > |
| --gateway-url | いいえ
| Tableau Server ゲートウェイへのアクセスに使用される URL。 |
| --version | いいえ | この環境が監視する Tableau Server のバージョン。 |
| --api-username | いいえ | Tableau Server API への接続に使用されるアカウントのユーザー名。ユーザー アカウントは、すべての Tableau Server サイトにアクセスできる Tableau Server 管理者である必要があります。 |
| --api-password | いいえ | Tableau Server API への接続に使用される Tableau Server API ユーザー アカウントのパスワード。 |
| --api-password-file | いいえ | Tableau Server API ユーザー アカウントのパスワードを含むファイルの名前。 |
| --repository-server | いいえ | Resource Monitoring Tool と共にインストールされている PostgreSQL データベースのサーバー名。 |
| --repository-port | いいえ | Tableau Server リポジトリデータベースのポート番号。 |
| --repository-username | いいえ | Tableau Server リポジトリと共にインストールされている PostgreSQL データベースへの接続に使用するユーザー名。 Resource Monitoring Tool は、パフォーマンス上の理由から Tableau Server リポジトリ データベースに直接アクセスします。これが動作するには、読み取り専用データベース ユーザーのパスワード セットを使用してリポジトリへのアクセスを有効にする必要があります。詳細については、Tableau Server リポジトリへのアクセスを有効にするを参照してください。 |
| --repository-password | いいえ | Tableau Server と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー アカウント のパスワード。 Resource Monitoring Tool は、パフォーマンス上の理由から Tableau Server リポジトリ データベースに直接アクセスします。これが動作するには、読み取り専用データベース ユーザーのパスワード セットを使用してリポジトリへのアクセスを有効にする必要があります。詳細については、Tableau Server リポジトリへのアクセスを有効にするを参照してください。 |
| --repository-password | いいえ | Tableau Server と共にインストールされている PostgreSQL データベースへの接続に使用するユーザー アカウントのパスワードが保存されているファイル名を含むパス。 |
| --repository-ssl-mode | いいえ | Tableau Server リポジトリ SSL モード。 Prefer は SSL を優先して、Require は SSL を必須として、Tableau リポジトリへの SSL接続を構成します。 Disable は SSL を使用せずに、Tableau Server リポジトリへの接続を行います。 |
| --repository-ssl-thumbprint | いいえ | 直接接続を許可するように Tableau Server PostgreSQL を構成する場合、Tableau Server は証明書とキーを作成します。Tableau Server によって生成された証明書の指紋を指定するか、server.crt ファイルを Resource Monitoring Tool のサーバー マシンにコピーするかを選択できます。証明書ファイルをコピーする場合は、指紋を指定する必要はありません。詳細については、クライアントからの直接接続を許可するよう Postgres SSL を構成するを参照してください。 |
例:rmtadmin update-env --name=<new name>
rmtadmin users
Resource Monitoring Tool ユーザー アカウントのリストを表示します。
このコマンドは RMT サーバーでのみ機能します。
シノプシス
rmtadmin users
rmtadmin version
RMT サーバー マシンで実行すると、RMT サーバーの現在のバージョン情報を表示します。エージェントがインストールされているマシン上で実行すると、エージェントの現在のバージョン情報を表示します。
このコマンドは、RMT サーバーとエージェントの両方で使用できます。
シノプシス
rmtadmin version
rmtadmin ziplogs
Resource Monitoring Tool ログ ファイルを含む ZIP 形式のアーカイブ ファイルを作成します。
このコマンドは、RMT サーバーとエージェントの両方で使用できますが、コマンドが実行されるアプリケーションのログ ファイルのみが含まれます。
シノプシス
rmtadmin ziplogs [positional parameter] [option] [global option]
位置パラメーター
filename
出力 zip ファイルの名前。名前が指定されていない場合は、デフォルトで log.zip が使用されます。
オプション
--force
既存のファイルを上書きします。
例: rmtadmin ziplogs <zip file name> --force
グローバル オプション
コマンドのヘルプを表示します。
--help