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

インベントリの作成

post

/api/v2/constructed_inventories/

次のインベントリ・フィールドを指定してこのリソースに対してPOSTリクエストを行って、新しいインベントリを作成します。

name: このインベントリの名前。(文字列、必須)
description: このインベントリのオプションの説明。(文字列、デフォルト="")
organization: このインベントリを含む組織。(id、必須)
variables: JSONまたはYAML形式のインベントリ変数。(json、デフォルト=``)
prevent_instance_group_fallback: 有効な場合、インベントリは関連するジョブ・テンプレートを実行するための優先インスタンス・グループのリストに、組織のインスタンス・グループを追加できなくします。この設定を有効にし、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール、デフォルト=False)
source_vars: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースのsource_vars。(文字列、デフォルト="")
update_cache_timeout: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースのキャッシュ・タイムアウト(整数、デフォルト=None)
limit: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースの返されるホストを制限する上限値。(文字列、デフォルト="")
verbosity: 構築済インベントリに特有の、関連する自動作成インベントリ・ソースの詳細レベル(整数、デフォルト=None)

リクエスト

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

application/json

ルート・スキーマ : 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"
}

先頭に戻る

レスポンス

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

application/json

201レスポンス

ルート・スキーマ : 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"
}

先頭に戻る