統合のJSONテンプレート

本節では、Keeperエンドポイント特権マネージャーのジョブおよびプラグイン統合でよくあるシナリオを、すぐに使えるJSONテンプレートとしてまとめています。各サブページでは1シナリオずつ、デプロイ可能なJSONと、例の要点・利用場面を説明しています。

各テンプレートはファイル内の説明だけで意図がわかるようになっています。各ファイルの description フィールドは SCENARIO: で始まるため、ファイル全体を読まなくてもテンプレートの目的を把握できます。本番へデプロイする前に、プレースホルダのパス、ID、トピック名を実際の値に置き換えてください。

ジョブの例

ジョブファイルはエージェント上の Jobs/{id}.json に配置します。以下では、サポート対象の各OSで一般的なトリガーとスケジュールのパターンを取り上げます。

例

内容

ジョブ: 最小構成 (Windows)	Windows上の最もシンプルな有効なジョブ。インターバルスケジュール、サービスタスクの実行、KeeperLoggerへの出力。Windows向けテンプレートの出発点として利用可能
ジョブ: 最小構成 (macOS)	同じ最小構成をmacOS向けに合わせた例。バイナリの正しいパスと osFilter の設定例
ジョブ: 最小構成 (Linux)	同じ最小構成をLinux向けに合わせた例。バイナリの正しいパスと osFilter の設定例
スケジュールと起動時実行のジョブ	起動直後に1回実行したうえで、一定間隔の繰り返し実行。スキャナー型の統合で推奨されるパターン
イベントトピック付きジョブ	MQTTのカスタム eventTopic へ進捗をパブリッシュする例。 eventTopic と mqttTopics.allowedPublications の対応づけ

プラグインの例

プラグインファイルはエージェント上の Plugins/{id}.json に配置します。以下では、プラグイン登録と通信でよく使うパターンを取り上げます。

例

内容

最小構成のプラグイン (Windows)	Windows上の最もシンプルな有効な管理プラグイン。 autoStart 、メインのMQTT Subscription 、KeeperLoggerへの出力。Windows向けテンプレートの出発点として利用可能
最小構成のプラグイン (macOS)	同じ最小構成をmacOS向けに合わせた例。バイナリの正しいパスとプラットフォーム向けの設定
最小構成のプラグイン (Linux)	同じ最小構成をLinux向けに合わせた例。バイナリの正しいパスとプラットフォーム向けの設定
MQTT経由のコマンド/レスポンス付きプラグイン	コマンド/レスポンスのトピックパターン (Commands/+、Responses/+、Status) の例。MQTTで指示を受け取り応答するケース向け
手動起動のプラグイン	autoStart: false を指定した登録。エージェント起動時の自動起動なし。オンデマンドまたは条件付き起動向け

始める前に

• いずれの例をデプロイする前に、カスタムジョブ統合ガイドおよびカスタムプラグイン統合ガイドをご参照ください。バイナリの配置、署名要件、MQTTトピックの権限モデルを把握したうえでデプロイしてください。

• より多くのフィールドが記入されたWindows向けジョブのサンプルが必要な場合は、親の統合バンドル内の secrets-scanner-sample-job.json をご参照ください。

• エンドポイントへ配布する前に、ジョブJSONは POST /api/Jobs/validate で検証できます。