Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

インベントリのリスト

get

/api/v2/constructed_inventories/

このリソースに対してGETリクエストを行って、インベントリのリストを取得します。

結果のデータ構造には次が含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、対象となる問合せで見つかったインベントリの合計数を示します。nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。resultsリストには、0個以上のインベントリ・レコードが含まれます。

結果

それぞれのインベントリ・データ構造には次のフィールドが含まれます。

id: このインベントリのデータベースID。(整数)
type: このインベントリのデータ型。(選択)
url: このインベントリのURL。(文字列)
related: 関連リソースのURLを含むデータ構造。(オブジェクト)
summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
created: このインベントリが作成されたときのタイムスタンプ。(日時)
modified: このインベントリが最後に変更されたときのタイムスタンプ。(日時)
name: このインベントリの名前。(文字列)
description: このインベントリのオプションの説明。(文字列)
organization: このインベントリを含む組織。(id)
kind: 表されているインベントリの種類。(選択)
- "": ホストに、このインベントリへの直接リンクがあります。
- smart: host_filterプロパティを使用して生成されたインベントリのホスト。
- constructed: 構築済インベントリのプラグインを備えたソース・インベントリの解析リスト。
variables: JSONまたはYAML形式のインベントリ変数。(json)
has_active_failures: このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのホストが失敗したかどうかを示すフラグ。(ブール)
total_hosts: このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのホストの合計数。(整数)
hosts_with_active_failures: このフィールドは非推奨であり、今後のリリースで削除される予定です。アクティブなエラーのあるこのインベントリのホスト数。(整数)
total_groups: このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのグループの合計数。(整数)
has_inventory_sources: このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリに外部のインベントリ・ソースがあるかどうかを示すフラグ。(ブール)
total_inventory_sources: このインベントリ内に構成されている外部のインベントリ・ソースの合計数。(整数)
inventory_sources_with_failures: エラーのあるこのインベントリの外部のインベントリ・ソースの数。(整数)
pending_deletion: インベントリが削除中であることを示すフラグ。(ブール)
prevent_instance_group_fallback: 有効な場合、インベントリは関連するジョブ・テンプレートを実行するための優先インスタンス・グループのリストに、組織のインスタンス・グループを追加できなくします。この設定を有効にし、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール)
source_vars: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースのsource_vars。(文字列)
update_cache_timeout: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースのキャッシュ・タイムアウト(整数)
limit: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースの返されるホストを制限する上限値。(文字列)
verbosity: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースの詳細レベル(整数)

ソート

インベントリが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=name

フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。

?order_by=-name

フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。

?order_by=name,some_other_field

ページ区切り

リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。

?page_size=100&page=2

結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

検索

モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。

?search=findme

(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

サポートされているメディア・タイプ

application/json

問合せパラメータ

page: 整数

ページ区切りが設定された結果セット内のページ番号。
page_size: 整数

ページごとに返す結果の数。
search: 文字列

検索条件。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

ルート・スキーマ: schema

型: object

ソースを表示

count(必須): 整数
next: 文字列(uri)
previous: 文字列(uri)
results(必須): 配列 results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/ConstructedInventory"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ : results

型: array

ソースを表示

配列: オブジェクト ConstructedInventory

{
    "items":{
        "$ref":"#/definitions/ConstructedInventory"
    },
    "type":"array"
}

ネストされたスキーマ : ConstructedInventory

型: object

ソースを表示

created: 文字列

タイトル: Created

読取り専用: true
description: 文字列

タイトル: Description
has_active_failures: ブール

タイトル: Has active failures

読取り専用: true

このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのホストが失敗したかどうかを示すフラグ。
has_inventory_sources: ブール

タイトル: Has inventory sources

読取り専用: true

このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリに外部のインベントリ・ソースがあるかどうかを示すフラグ。
hosts_with_active_failures: 整数

タイトル: Hosts with active failures

読取り専用: true

最小値: 0

このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのうち、アクティブなエラーのあるホストの数。
id: 整数

タイトル: ID

読取り専用: true
inventory_sources_with_failures: 整数

タイトル: Inventory sources with failures

読取り専用: true

最小値: 0

このインベントリのうち、エラーのある外部インベントリ・ソースの数。
kind: 文字列

タイトル: Kind

読取り専用: true

指定できる値: [ "", "smart", "constructed" ]

表されているインベントリの種類。
limit: 文字列

タイトル: Limit

構築済インベントリに特有の、関連する自動作成インベントリ・ソースの返されるホストを制限する上限値。
modified: 文字列

タイトル: Modified

読取り専用: true
name(必須): 文字列

タイトル: Name

最小長: 1

最大長: 512
organization(必須): 整数

タイトル: Organization

このインベントリを含む組織。
pending_deletion: ブール

タイトル: Pending deletion

読取り専用: true

インベントリが削除されることを示すフラグ。
prevent_instance_group_fallback: ブール

タイトル: Prevent instance group fallback

有効な場合、インベントリは関連するジョブ・テンプレートを実行するための優先インスタンス・グループのリストに、組織のインスタンス・グループを追加できなくします。この設定を有効にし、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。
related: 文字列

タイトル: Related

読取り専用: true
source_vars: 文字列

タイトル: Source vars

構築済インベントリに特有の、関連する自動作成インベントリ・ソースのsource_vars。
summary_fields: 文字列

タイトル: Summary fields

読取り専用: true
total_groups: 整数

タイトル: Total groups

読取り専用: true

最小値: 0

このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのグループの合計数。
total_hosts: 整数

タイトル: Total hosts

読取り専用: true

最小値: 0

このフィールドは非推奨であり、今後のリリースで削除される予定です。このインベントリのホストの合計数。
total_inventory_sources: 整数

タイトル: Total inventory sources

読取り専用: true

最小値: 0

このインベントリ内に構成された外部インベントリ・ソースの合計数。
type: 文字列

タイトル: Type

読取り専用: true
update_cache_timeout: 整数

タイトル: Update cache timeout

最小値: 0

構築済インベントリに特有の、関連する自動作成インベントリ・ソースのキャッシュ・タイムアウト
url: 文字列

タイトル: Url

読取り専用: true
variables: 文字列

タイトル: Variables

JSONまたはYAML形式のインベントリ変数。
verbosity: 整数

タイトル: Verbosity

最小値: 0

最大値: 2

構築済インベントリに特有の、関連する自動作成インベントリ・ソースの詳細レベル

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "has_active_failures":{
            "description":"This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.",
            "readOnly":true,
            "title":"Has active failures",
            "type":"boolean"
        },
        "has_inventory_sources":{
            "description":"This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.",
            "readOnly":true,
            "title":"Has inventory sources",
            "type":"boolean"
        },
        "hosts_with_active_failures":{
            "description":"This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.",
            "minimum":"0",
            "readOnly":true,
            "title":"Hosts with active failures",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory_sources_with_failures":{
            "description":"Number of external inventory sources in this inventory with failures.",
            "minimum":"0",
            "readOnly":true,
            "title":"Inventory sources with failures",
            "type":"integer"
        },
        "kind":{
            "description":"Kind of inventory being represented.",
            "enum":[
                "",
                "smart",
                "constructed"
            ],
            "readOnly":true,
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "description":"The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.",
            "title":"Limit",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Organization containing this inventory.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pending_deletion":{
            "description":"Flag indicating the inventory is being deleted.",
            "readOnly":true,
            "title":"Pending deletion",
            "type":"boolean"
        },
        "prevent_instance_group_fallback":{
            "description":"If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.",
            "title":"Prevent instance group fallback",
            "type":"boolean",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "source_vars":{
            "description":"The source_vars for the related auto-created inventory source, special to constructed inventory.",
            "title":"Source vars",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "total_groups":{
            "description":"This field is deprecated and will be removed in a future release. Total number of groups in this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total groups",
            "type":"integer"
        },
        "total_hosts":{
            "description":"This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total hosts",
            "type":"integer"
        },
        "total_inventory_sources":{
            "description":"Total number of external inventory sources configured within this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total inventory sources",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "update_cache_timeout":{
            "description":"The cache timeout for the related auto-created inventory source, special to constructed inventory",
            "minimum":"0",
            "title":"Update cache timeout",
            "type":"integer",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "variables":{
            "description":"Inventory variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        },
        "verbosity":{
            "description":"The verbosity level for the related auto-created inventory source, special to constructed inventory",
            "maximum":"2",
            "minimum":"0",
            "title":"Verbosity",
            "type":"integer",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "organization"
    ],
    "type":"object"
}

先頭に戻る