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

インベントリのリスト

get

/api/v2/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: 構築されたインベントリ・プラグインでソース在庫のリストを解析します。
host_filter: このインベントリのホストに適用されるフィルタ。(文字列)
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: 有効にすると、在庫管理では、関連付けられたジョブ・テンプレートを実行するために、組織インスタンス・グループを優先インスタンス・グループのリストに追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール)

ソート

インベントリが特定の順序で返されるように指定するには、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: integer

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

ページごとに返す結果の数。
search: string

検索条件。

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : schema

型: object

ソースを表示

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array 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/Inventory"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object Inventory

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

ネストされたスキーマ : インベントリ

型: object

ソースを表示

created: string

タイトル: Created

読取り専用: true
description: string

タイトル: Description
has_active_failures: boolean

タイトル: Has active failures

読取り専用: true

このフィールドは非推奨であり、将来のリリースで削除されます。このインベントリ内のホストに障害が発生したかどうかを示すフラグ。
has_inventory_sources: boolean

タイトル: Has inventory sources

読取り専用: true

このフィールドは非推奨であり、将来のリリースで削除されます。この在庫に外部在庫ソースがあるかどうかを示すフラグ。
host_filter: string

タイトル: Host filter

このインベントリのホストに適用されるフィルタ。
hosts_with_active_failures: integer

タイトル: Hosts with active failures

読取り専用: true

最小値: 0

このフィールドは非推奨であり、将来のリリースで削除されます。アクティブな障害があるこのインベントリ内のホストの数。
id: integer

タイトル: ID

読取り専用: true
inventory_sources_with_failures: integer

タイトル: Inventory sources with failures

読取り専用: true

最小値: 0

失敗があるこのインベントリ内の外部インベントリ・ソースの数。
親切な: string

タイトル: Kind

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

表される在庫の種類。
modified: string

タイトル: Modified

読取り専用: true
name(required): string

タイトル: Name

最小長: 1

最大長: 512
organization(required): integer

タイトル: Organization

この在庫を含む組織。
pending_deletion: boolean

タイトル: Pending deletion

読取り専用: true

在庫が削除されることを示すフラグ。
prevent_instance_group_fallback: boolean

タイトル: Prevent instance group fallback

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

タイトル: Related

読取り専用: true
summary_fields: string

タイトル: Summary fields

読取り専用: true
total_groups: integer

タイトル: Total groups

読取り専用: true

最小値: 0

このフィールドは非推奨であり、将来のリリースで削除されます。この在庫のグループの合計数。
total_hosts: integer

タイトル: Total hosts

読取り専用: true

最小値: 0

このフィールドは非推奨であり、将来のリリースで削除されます。このインベントリ内のホストの合計数。
total_inventory_sources: integer

タイトル: Total inventory sources

読取り専用: true

最小値: 0

この在庫内に構成された外部在庫ソースの合計数。
type: string

タイトル: Type

読取り専用: true
url: string

タイトル: Url

読取り専用: true
variables: string

タイトル: Variables

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

{
    "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"
        },
        "host_filter":{
            "description":"Filter that will be applied to the hosts of this inventory.",
            "title":"Host filter",
            "type":"string",
            "x-nullable":true
        },
        "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"
            ],
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "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"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "variables":{
            "description":"Inventory variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "organization"
    ],
    "type":"object"
}

先頭に戻る