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

インベントリの更新

patch

/api/v2/inventories/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このインベントリを更新します。次のフィールドを変更できます。

name: このインベントリの名前。(文字列、必須)
description: このインベントリのオプションの説明。(文字列、デフォルト="")
organization: このインベントリを含む組織。(id、必須)
kind: 表されているインベントリの種類。(選択)
- "": ホストに、このインベントリへの直接リンクがあります。(デフォルト)
- smart: host_filterプロパティを使用して生成されたインベントリのホスト。
- constructed: 構築済インベントリのプラグインを備えたソース・インベントリの解析リスト。
host_filter: このインベントリのホストに適用されるフィルタ。(文字列、デフォルト="")
variables: JSONまたはYAML形式のインベントリ変数。(json、デフォルト=``)
prevent_instance_group_fallback: 有効な場合、インベントリは関連するジョブ・テンプレートを実行するための優先インスタンス・グループのリストに、組織のインスタンス・グループを追加できなくします。この設定を有効にし、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール、デフォルト=False)

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

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

application/json

パス・パラメータ

id(必須): 文字列

ルート・スキーマ : Inventory

型: object

ソースを表示

created: 文字列

タイトル: Created

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

タイトル: Description
has_active_failures: ブール

タイトル: Has active failures

読取り専用: true

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

タイトル: Has inventory sources

読取り専用: true

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

タイトル: Host filter

このインベントリのホストに適用されるフィルタ。
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

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

表されているインベントリの種類。
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
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
url: 文字列

タイトル: Url

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

タイトル: 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"
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : Inventory

型: object

ソースを表示

created: 文字列

タイトル: Created

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

タイトル: Description
has_active_failures: ブール

タイトル: Has active failures

読取り専用: true

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

タイトル: Has inventory sources

読取り専用: true

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

タイトル: Host filter

このインベントリのホストに適用されるフィルタ。
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

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

表されているインベントリの種類。
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
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
url: 文字列

タイトル: Url

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

タイトル: 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"
}

先頭に戻る