BigFix Explorer の使用
データストア・エンジンを利用することで、BigFix Explorer は、収集されたデータをセッション関連度を使用して照会するように設計された REST API インターフェースを提供します。また、一連の API を使用して、Explorer インスタンスを監視および管理できます。
BigFix Explorer REST API
セッション関連度を評価するための BigFix Explorer REST API (/api/relevance)
BES Explorer が提供するこの API は、入力されたセッション関連度を評価します。
- キー
- セッション関連度を評価し、返される応答のフィールドの名前と構成を変更します。
- filters
- セッション関連度を評価し、指定した条件を満たすさまざまな BigFix オブジェクト・タイプをフィルタリングします。このオプションは、BigFix バージョン 11.0.3 から使用可能になりました。
この API の使用方法について詳しくは、セッション関連度を参照してください。
BES Explorer インスタンスの現在のステータスを取得する BigFix Explorer REST API (/api/status)
BES Explorer によって提供されるこの API は、BES Explorer インスタンスの現在のステータスを返します。この API の使用方法について詳しくは、ステータスを参照してください。
BigFix サーバー REST API
セッション関連度の API (/api/query)
BigFix ルート・サーバーの REST API である /api/query は、入力されたセッション関連度要求を BigFix Explorer インスタンスに転送できます (存在する場合)。Explorer インスタンスが存在しない場合、BigFix ルート・サーバーは要求を Web レポート・インスタンスに転送します。
ユーザーは、既存の REST API である /api/query/ を使用して BigFix Explorer に対して照会を実行できます。照会で説明されている api/query は、セッション関連度を評価するための新しい入力パラメーターをサポートし、現在の仕様との互換性を維持します。
BigFix ルート・サーバーは、優先度が最も高い利用可能な BigFix Explorer への転送を最初に試みます。その後、その優先度に応じて存在する Web レポート・サーバーに対して転送を試行します。
新しいパラメーターにより、/api/query は /api/relevance の機能を利用して、JSON 形式で要求を送信し、カスタマイズされた構造化 JSON オブジェクトとして BigFix Explorer からデータを取得できます。詳しくは、照会を参照してください。
BigFix Explorer インスタンスは、優先度および BigFix ルート・サーバーへの初回接続時刻によってターゲットに設定されます。優先度は、登録時に BigFix ルート・サーバーによって割り当てられます。ユーザーは API を使用してインスタンスの優先度を変更できます。複数の Explorer インスタンスが同じ優先度で使用可能な場合、BigFix ルート・サーバーは最初に登録されたインスタンスに転送します。マスター・オペレーターとマスター以外のオペレーターの両方が、この REST API に要求を発行できます。応答の内容は、環境におけるオペレーターの可視性に基づいています。BigFix のマスター以外のオペレーターには、「REST API を使用可能」特権が必要です。
BES Explorer インスタンスの詳細を取得し管理するための新しい BigFix Server REST API
BigFix ルート・サーバーによって提供されるこの REST API のグループは、ユーザー が BigFix ルート・サーバーに登録された BES Explorer インスタンスに関するデータを取得し、それらのインスタンスを操作して各インスタンスの優先度を設定することを可能にします。
この API グループの使用方法について詳しくは、Explorer を参照してください。