インベントリ・スクリプトに必要なインベントリ・グループおよびホスト・データの生成。
/api/v2/inventories/{id}/script/
インベントリ・スクリプトの詳細は、Dynamic Inventoryを参照してください。
レスポンスのリスト
問合せパラメータを指定せずにこのリソースに対してGETリクエストを行うと、各グループのホスト、子および変数を含む、グループを含むJSONオブジェクトが取得されます。 レスポンス・データは、--list引数をインベントリ・スクリプトに渡すことで返されるデータと同じです。
前述のJSONオブジェクト(すべてのホスト変数を含む)を取得するには、問合せ文字列?hostvars=1を指定します。 レスポンスの['_meta']['hostvars']オブジェクトには、各ホストのエントリとその変数が含まれます。 このレスポンス形式をAnsible 1.3以降で使用すると、ホストごとに個別のAPIリクエストを行うことを回避できます。 この機能の詳細は、Tuning the External Inventory Scriptを参照してください。
デフォルトでは、インベントリ・スクリプトは、インベントリで有効になっているホストのみを返します。 この機能により、無効になっているホストは、インベントリから削除せずにジョブを実行するときにスキップできます。 すべてのホスト(無効になっているホストを含む)を返すには、問合せ文字列?all=1を指定します。
有効状態およびデータベースIDを指定する各ホストのhostvarsに変数を追加するには、問合せ文字列?towervars=1を指定します。
ジョブ・スライスのルールに従ってホストの数が制限されているインベントリを生成するには、問合せ文字列?subset=slice2of5を指定します。
複数の問合せ文字列を適用するには、?hostvars=1&all=1のように&文字で結合します。
ホストのレスポンス
指定されたホストのホスト変数を含むJSONオブジェクトを取得するには、?host=HOSTNAMEのような問合せ文字列を指定してこのリソースに対してGETリクエストを実行します。 レスポンス・データは、--host HOSTNAME引数をインベントリ・スクリプトに渡すことで返されるデータと同じです。
リクエスト
- application/json
レスポンス
- application/json
200レスポンス
{
"all":{
"hosts":[
"first_host",
"second_host"
]
}
}