> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/keeperpam/jp/endpoint-privilege-manager/reference/plugin-and-task-settings.md).

# プラグインとタスクの設定

<figure><img src="/files/gElykWGOqdY9EBwHNJJ4" alt=""><figcaption></figcaption></figure>

**対象:** 個別のKEPMプラグインの設定を行う必要があるIT管理者、または特定のジョブタスクに影響する設定を把握したい方。本ページでは各設定の**用途**、**型**、**デフォルト**、**適切な値**を示します。

設定はプラグインJSONファイル (`Plugins/{PluginName}.json`) または統合ストレージに保存できます。実行時は、Revertで元に戻すまで統合ストレージの値がプラグインJSONより優先されます。

## 設定の適用方法

* **プラグインJSON:** 各プラグインには `Plugins/` 以下にJSONファイルがあります (例: `Plugins/KeeperPolicy.json`)。設定はルートまたは `metadata` 配下に置けます。ファイルを編集しプラグインを再起動すると反映されます。
* **統合ストレージ:** エージェントはプラグイン設定を統合ストレージに保存できます。Revert (例: `POST /api/PluginSettings/{pluginName}/revert` または `revert-all`) を実行するまで、これらの値がプラグインJSONより優先されます。
* **SettingsUpdateポリシー:** `SettingsUpdate` 構成ポリシーでプラグインJSON全体をディスクに書き込めます。Configuration Policy Processor の実行後、実行時ストレージを新しいファイルに合わせたい場合は Revert を使い、必要ならプラグインを再起動します。
* **API:** `GET /api/PluginSettings/{pluginName}` または `GET /api/PluginSettings/{pluginName}/{settingName}` で設定を読み取り、`PUT /api/PluginSettings/{pluginName}/{settingName}` で個別キーを更新できます。値の形式はJSONです (文字列、数値、真偽値など)。

統合担当者向けのプラグイン設定の概要 (ジョブタスクのバイナリが実行時にこのAPIでブローカー構成を読み取る方法を含む) については、[ジョブとプラグイン: 設定キー](/keeperpam/jp/endpoint-privilege-manager/reference/job-and-plugin-settings-keys.md)および[HTTPリファレンス](/keeperpam/jp/endpoint-privilege-manager/integrations/http-reference-guide.md)をご参照ください。

## グローバル設定 (`appsettings.json`)

これらの設定は、エージェントサービス実行ファイル横の `appsettings.json` の `Settings` セクションにあり、サービス全体に適用されます。変更を反映するにはサービスの再起動が必要です。

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="198.85186767578125">設定</th><th width="91.036865234375">型</th><th width="105.0369873046875">デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>KestrelHttpPort</code></td><td>integer</td><td><code>6888</code></td><td>ローカル管理API用HTTPポート (ループバックのみ)</td><td>1024–65535。マシン上で空いているポート</td></tr><tr><td><code>KestrelHttpsPort</code></td><td>integer</td><td><code>6889</code></td><td>ローカル管理API用HTTPSポート (ループバックのみ)</td><td>1024–65535。空いているポート</td></tr><tr><td><code>system.logging.level</code></td><td>string</td><td><code>"Warning"</code></td><td>メインサービスおよびKeeperLoggerフォールバックの最低ログレベル</td><td><code>"Critical"</code>、<code>"Error"</code>、<code>"Warning"</code>、<code>"Information"</code>、<code>"Debug"</code>、<code>"Trace"</code>。本番: <code>"Warning"</code> または <code>"Information"</code>。トラブルシュート: <code>"Debug"</code></td></tr><tr><td><code>RepositoryPath</code></td><td>string</td><td><code>"KeeperStorage"</code></td><td>システム構成の保存先ディレクトリ</td><td>有効なパス。<code>{approot}/KeeperStorage</code> などのパス変数可</td></tr><tr><td><code>PluginPath</code></td><td>string</td><td><code>"Plugins"</code></td><td>プラグインJSONファイルと実行ファイルを含むディレクトリ</td><td>有効なパス。パス変数可</td></tr><tr><td><code>ServiceName</code></td><td>string</td><td><code>"KeeperPrivilegeManager"</code></td><td>Windowsサービスの表示名</td><td>空でない任意の文字列</td></tr><tr><td><code>MaintainKeeperAccount</code></td><td>boolean</td><td><code>false</code></td><td><code>true</code> のとき (Windows)、一時的な KeeperUserSession アカウントをサービス再起動後も維持 (ハイブリッド Azure AD + Intune 向け)</td><td><code>true</code> または <code>false</code></td></tr></tbody></table>

**MQTTブローカー**設定は `appsettings.json` の `MqttBrokerSettings` にあります。

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="121.5926513671875">設定</th><th width="81.926025390625">型</th><th width="131.370361328125">デフォルト</th><th width="171.9259033203125">用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>IpAddress</code></td><td>string</td><td><code>"127.0.0.1"</code></td><td>MQTTブローカーのバインドアドレス</td><td><code>"127.0.0.1"</code> または <code>"localhost"</code>。セキュリティのためループバックのままにする</td></tr><tr><td><code>Port</code></td><td>integer</td><td><code>8675</code></td><td>MQTTブローカーのポート</td><td>1024–65535。空いているポート</td></tr></tbody></table>

## KeeperPolicyプラグイン

**構成ファイル:** `Plugins/KeeperPolicy.json`

設定はプラグイン起動時に読み込まれ、MQTT接続、API呼び出し、ポリシー評価の挙動を制御します。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th width="93.4444580078125">型</th><th width="149.6666259765625">デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>broker.host</code></td><td>string</td><td><code>"127.0.0.1"</code></td><td>プラグインが接続するMQTTブローカーのホスト名</td><td>ローカルMQTTブローカーのホスト名またはIP (通常 <code>127.0.0.1</code>)</td></tr><tr><td><code>broker.port</code></td><td>integer</td><td><code>8675</code></td><td>MQTTブローカーのポート</td><td>1024–65535。<code>MqttBrokerSettings.Port</code> と一致必須</td></tr><tr><td><code>subscription.topic</code></td><td>string</td><td><code>"KeeperPolicy"</code></td><td>ポリシーリクエスト用にプラグインがサブスクライブする主MQTTトピック</td><td>空でないトピック名</td></tr><tr><td><code>subscription.topics</code></td><td>string</td><td>可変</td><td>追加でサブスクライブするMQTTトピックのカンマ区切り一覧</td><td>カンマ区切りのトピック名</td></tr><tr><td><code>system.service.https_port</code></td><td>integer</td><td><code>6889</code></td><td>カスタムフィルタやジョブトリガーなど、ローカルAPI呼び出し用HTTPSポート</td><td><code>KestrelHttpsPort</code> と同じ</td></tr><tr><td><code>customfilter.timeout_seconds</code></td><td>integer</td><td><code>30</code></td><td>カスタムフィルタジョブへのHTTP呼び出しタイムアウト (秒)</td><td>正の整数。通常 15–60</td></tr><tr><td><code>ratelimit.max_requests_per_minute</code></td><td>integer</td><td><code>100</code></td><td>ソースあたり1分間のポリシー評価リクエスト上限</td><td>正の整数。正当なトラフィックが抑制される場合は増やす</td></tr><tr><td><code>metadata.admin.enforce_policies_for_administrators</code></td><td>boolean</td><td><code>false</code></td><td>ポリシー非一致の特権昇格リクエストで、要求ユーザーが管理者の場合: <code>false</code> は許可 (OSデフォルト)、<code>true</code> は拒否</td><td><code>false</code>: 管理者はポリシー非一致時も拒否対象外。<code>true</code>: 管理者も標準ユーザーと同様に拒否</td></tr></tbody></table>

## KeeperAPIプラグイン

**構成ファイル:** `Plugins/KeeperApi.json`

Keeperバックエンドとの通信 (登録、ポリシー同期、監査) に使います。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th>型</th><th>デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>broker.host</code></td><td>string</td><td><code>"127.0.0.1"</code></td><td>MQTTブローカーのホスト名</td><td><code>127.0.0.1</code> または <code>localhost</code></td></tr><tr><td><code>broker.port</code></td><td>integer</td><td><code>8675</code></td><td>MQTTブローカーのポート</td><td><code>MqttBrokerSettings.Port</code> と一致</td></tr><tr><td><code>api.base_url</code></td><td>string</td><td>環境から取得</td><td>KeeperバックエンドAPIのベースURL</td><td>完全なHTTPS URL (例: <code>https://api.keepersecurity.com</code>)</td></tr><tr><td><code>sync.interval_minutes</code></td><td>integer</td><td>可変</td><td>バックエンドからのポリシー/設定同期の間隔 (分)</td><td>正の整数。通常 15–60</td></tr></tbody></table>

## KeeperLoggerプラグイン

**構成ファイル:** `Plugins/KeeperLogger.json`

ログメッセージの出力先と方法 (ファイル、HTTPエンドポイント、保持期間、ローテーション) を制御します。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th>型</th><th>デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>logToFile</code></td><td>boolean</td><td><code>true</code></td><td><code>true</code> のとき、ログをファイルに書き込む</td><td><code>true</code> または <code>false</code></td></tr><tr><td><code>logFileName</code></td><td>string</td><td><code>"Log/KeeperLogger.log"</code></td><td>ログファイルのパス (プラグイン作業ディレクトリからの相対または絶対)。パス変数可</td><td>有効なパス (例: <code>{approot}/Log/KeeperLogger.log</code>)</td></tr><tr><td><code>maxFileSizeMB</code></td><td>number</td><td><code>100</code></td><td>ローテーション前のログファイル最大サイズ (MB)</td><td>正の数。通常 50–500</td></tr><tr><td><code>logRetentionDays</code></td><td>integer</td><td><code>15</code></td><td>削除前にローテーション済みログを保持する日数</td><td>正の整数。通常 7–90</td></tr><tr><td><code>logToHttpEndpoint</code></td><td>boolean</td><td><code>false</code></td><td><code>true</code> のとき、ログをHTTPエンドポイントにも送る</td><td><code>true</code> または <code>false</code></td></tr><tr><td><code>loggingHttpEndpoint</code></td><td>string</td><td><code>""</code></td><td><code>logToHttpEndpoint</code> が <code>true</code> のときログをPOSTするURL</td><td>完全なHTTP/HTTPS URL、または空</td></tr><tr><td><code>log.level</code></td><td>string</td><td>可変</td><td>ファイルまたはHTTPへ書き込むメッセージの最低レベル</td><td><code>"Critical"</code>、<code>"Error"</code>、<code>"Warning"</code>、<code>"Information"</code>、<code>"Debug"</code>、<code>"Trace"</code>。本番: <code>"Warning"</code> または <code>"Information"</code>。トラブルシュート: <code>"Debug"</code></td></tr></tbody></table>

## RedirectEvaluatorプラグイン

**構成ファイル:** `Plugins/RedirectEvaluator.json`

リダイレクト設定は、ルール一致時に `LaunchPrivilegeElevation` ジョブが別の実行ファイルに差し替えるかどうかを制御します (例: `ncpa.cpl` → Keeper管理のネットワーク接続UI)。全体の流れについては、[リダイレクト機能](/keeperpam/jp/endpoint-privilege-manager/reference/redirect-capability.md)をご参照ください。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th>型</th><th>デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>metadata.redirect.enabled</code></td><td>boolean</td><td>構成により可変</td><td><code>true</code> のとき、<code>LaunchPrivilegeElevation</code> ジョブは check-redirect タスクを実行しルールを評価する。ルール一致時は元の要求を拒否し <code>targetExe</code> を昇格付きで起動。<code>false</code> のとき check-redirect をスキップ</td><td>リダイレクト有効: <code>true</code>。通常の昇格起動のみ: <code>false</code></td></tr><tr><td><code>metadata.redirect.rules</code></td><td>array</td><td><code>[]</code></td><td>リダイレクトルールのリスト。最初に一致したルールが適用</td><td>ルールオブジェクトの配列 (下記参照)。不要なら <code>[]</code></td></tr><tr><td><code>metadata.redirect.rulesPath</code></td><td>string</td><td>任意</td><td>インライン <code>rules</code> の代わりにリダイレクトルールを格納したファイルへのパス</td><td>有効なファイルパス、または空</td></tr></tbody></table>

**リダイレクトルールのフィールド** (`metadata.redirect.rules` 内の各オブジェクト):

<table data-header-hidden="false" data-header-sticky><thead><tr><th>フィールド</th><th>型</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>sourceExePattern</code></td><td>string (regex)</td><td>昇格リクエストの実行ファイル名にマッチ。大文字小文字を区別しない</td><td>正規表現。リテラルのドットは <code>\\.</code> (例: <code>"rundll32\\.exe"</code>)</td></tr><tr><td><code>commandLinePattern</code></td><td>string (regex)</td><td>完全なコマンドラインにマッチ。大文字小文字を区別しない</td><td>正規表現 (例: <code>"ncpa\\.cpl"</code>)</td></tr><tr><td><code>elevationOnly</code></td><td>boolean</td><td><code>true</code> のとき、特権昇格イベントにのみルールを適用</td><td>一般的なリダイレクトでは <code>true</code></td></tr><tr><td><code>nonAdminOnly</code></td><td>boolean</td><td><code>true</code> のとき、要求ユーザーが管理者でない場合のみルールを適用</td><td>標準ユーザーのみ: <code>true</code>。管理者にも適用: <code>false</code></td></tr><tr><td><code>targetExe</code></td><td>string</td><td>差し替え先のプラグインIDまたは実行ファイル名 (<code>Jobs/bin</code> または <code>Plugins/bin</code> から解決)</td><td>例: <code>"Keeper.NetworkConnections"</code>。エンドポイントにデプロイ済みであること</td></tr><tr><td><code>targetArguments</code></td><td>string</td><td>差し替え先実行ファイルのコマンドライン引数</td><td>任意の文字列。多くは <code>""</code></td></tr></tbody></table>

## KeeperClientプラグイン

**構成ファイル:** `Plugins/KeeperClient.json`

システムトレイクライアント (通知、メニュー、ヘルスチェック)。多くのオプションは `metadata` にあります。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th>型</th><th>デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>broker.host</code></td><td>string</td><td><code>"127.0.0.1"</code></td><td>MQTTブローカーのホスト名</td><td><code>127.0.0.1</code></td></tr><tr><td><code>broker.port</code></td><td>integer</td><td><code>8675</code></td><td>MQTTブローカーのポート</td><td>ブローカーと同じ</td></tr><tr><td><code>metadata.menu.refreshIntervalMinutes</code></td><td>integer</td><td><code>5</code></td><td>トレイメニューをAPIから再取得する間隔 (分)</td><td>正の整数。通常 1–30</td></tr><tr><td><code>metadata.menu.autoRefresh</code></td><td>boolean</td><td><code>true</code></td><td>タイマーによるメニューの自動更新の有無</td><td><code>true</code> または <code>false</code></td></tr><tr><td><code>metadata.LanguageOverride</code></td><td>string</td><td><code>"DEFAULT"</code></td><td>UI表示言語の上書き</td><td><code>"DEFAULT"</code> または有効なカルチャコード (例: <code>"en-US"</code>)</td></tr><tr><td><code>metadata.showInTray</code></td><td>boolean</td><td><code>true</code></td><td>システムトレイにアイコンを表示するか</td><td><code>true</code> または <code>false</code></td></tr></tbody></table>

## keeperAgentプラグイン

**構成ファイル:** `Plugins/keeperAgent.json`

特権昇格およびファイルアクセス要求 (承認、履歴、失効) を管理するスタンドアロンUI。

<table data-header-hidden="false" data-header-sticky><thead><tr><th>設定</th><th>型</th><th>デフォルト</th><th>用途</th><th>適切な値</th></tr></thead><tbody><tr><td><code>approvalExpirationHours</code></td><td>integer</td><td><code>72</code></td><td>保留中の承認要求が期限切れになるまでの時間 (時間)</td><td>正の整数。通常 24–168</td></tr><tr><td><code>approvedRequestExpirationHours</code></td><td>integer</td><td><code>24</code></td><td>承認済み要求が期限切れとなり起動できなくなるまでの時間 (時間)</td><td>正の整数。通常 1–72</td></tr><tr><td><code>historyRetentionDays</code></td><td>integer</td><td><code>30</code></td><td>UIに履歴項目を保持する日数</td><td>正の整数。通常 7–90</td></tr><tr><td><code>maxPayloadSizeBytes</code></td><td>integer</td><td><code>1048576</code></td><td>メッセージの最大ペイロードサイズ (1 MB)</td><td>正の整数</td></tr><tr><td><code>maxRequestItems</code></td><td>integer</td><td><code>20</code></td><td>表示する保留要求の最大件数</td><td>正の整数</td></tr><tr><td><code>maxHistoryItems</code></td><td>integer</td><td><code>20</code></td><td>表示する履歴の最大件数</td><td>正の整数</td></tr><tr><td><code>maxExceptionMessageLength</code></td><td>integer</td><td><code>500</code></td><td>表示する例外メッセージの最大長</td><td>正の整数</td></tr></tbody></table>

## プラグイン設定を参照するタスク

一部のジョブタスクは、動作判断のためにプラグイン設定を読みます。タスクの挙動が想定と異なる場合に、どの設定を確認すべきかを示します。

| ジョブ                        | タスク              | 設定                                             | 用途                                                                                |
| -------------------------- | ---------------- | ---------------------------------------------- | --------------------------------------------------------------------------------- |
| `LaunchPrivilegeElevation` | `check-redirect` | `RedirectEvaluator: metadata.redirect.enabled` | `true` のとき、RedirectEvaluatorを実行してリダイレクトルールを評価。`false` のときタスクをスキップし、通常の昇格起動でジョブを続行 |

`privilege-elevation-policy-controls` や `default-policy-controls` など、その他のポリシー制御ジョブは `KeeperMfa`、`KeeperJustification`、`KeeperApproval` をタスク実行ファイルとして使います。挙動はジョブパラメータとポリシーで決まり、プラグイン設定表には含まれません。

### 設定場所

<table data-header-hidden="false" data-header-sticky><thead><tr><th>対象</th><th>場所</th><th>メモ</th></tr></thead><tbody><tr><td>グローバル設定 (ポート、パス、ログレベル)</td><td><code>appsettings.json</code> → <code>Settings</code> および <code>MqttBrokerSettings</code></td><td>ポート/パス変更後はサービス再起動が必要</td></tr><tr><td>KeeperPolicy (ブローカー、管理者フォールバック、レート制限)</td><td><code>Plugins/KeeperPolicy.json</code> または <code>PUT /api/PluginSettings/KeeperPolicy/{key}</code></td><td>変更後はKeeperPolicyを再起動</td></tr><tr><td>KeeperAPI (ブローカー、API URL、同期間隔)</td><td><code>Plugins/KeeperApi.json</code> またはPlugin Settings API</td><td>変更後はKeeperAPIを再起動</td></tr><tr><td>KeeperLogger (ファイルパス、保持、ログレベル)</td><td><code>Plugins/KeeperLogger.json</code> またはPlugin Settings API</td><td>変更後はKeeperLoggerを再起動</td></tr><tr><td>リダイレクト (有効フラグ、ルール)</td><td><code>Plugins/RedirectEvaluator.json</code> またはPlugin Settings API</td><td>ルール変更は次回評価から反映。再起動は不要</td></tr><tr><td>KeeperClient (メニュー、トレイ)</td><td><code>Plugins/KeeperClient.json</code></td><td>反映にはKeeperClientの再起動</td></tr><tr><td>keeperAgent (期限、上限)</td><td><code>Plugins/keeperAgent.json</code></td><td>反映にはkeeperAgentの再起動</td></tr></tbody></table>

ディスク上のプラグインJSONを編集したあとは、`POST /api/PluginSettings/{pluginName}/revert` (または `revert-all`) でファイルから統合ストレージへ再読み込みし、その後プラグインを再起動して新しい値を読み込ませます。`autoRestart: true` が設定されている場合、プラグインを停止すると自動的に再起動します。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/keeperpam/jp/endpoint-privilege-manager/reference/plugin-and-task-settings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.