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

プロジェクトのインベントリ・ソースのリスト

get

/api/v2/projects/{id}/scm_inventory_sources/

このリソースに対して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: このインベントリ・ソースのオプションの説明。(文字列)
source: (選択)
- file: ファイル、ディレクトリまたはスクリプト
- constructed: 実行時に追加のグループおよびhostvarsをテンプレート化します
- scm: プロジェクトからのソーシング
- ec2: Amazon EC2
- gce: Google Compute Engine
- azure_rm: Microsoft Azure Resource Manager
- vmware: VMware vCenter
- satellite6: Red Hat Satellite 6
- openstack: OpenStack
- rhv: Red Hat Virtualization
- controller: Red Hat Ansible自動化プラットフォーム
- insights: Red Hat Insights
source_path: (文字列)
source_vars: YAMLまたはJSON形式のインベントリ・ソース変数。(文字列)
scm_branch: 在庫ソースSCMブランチ。空白の場合に使用されるプロジェクト・デフォルト。プロジェクトallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(string)
credential: インベントリの更新に使用するクラウド資格証明。(整数)
enabled_var: 対象となるホスト変数のディクショナリから有効状態を取得します。有効化された変数は「foo.bar」のように指定でき、この場合は、ネストされた辞書を横断してルックアップが行われ、from_dict.get("foo", {}).get("bar", default)と同等になります(文字列)
enabled_value: enabled_varが設定されている場合にのみ使用されます。ホストが有効とみなされるときの値。たとえば、enabled_var="status.power_state"およびenabled_value="powered_on"でホスト変数{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}を使用すると、ホストが有効とマークされます。 powered_on以外の値がpower_stateの場合、インポート時にホストは無効になります。キーが見つからない場合、ホストは有効になります(文字列)
host_filter: このフィールドは非推奨であり、将来のリリースで削除されます。一致するホストのみがインポートされる正規表現。(文字列)
overwrite: リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。(ブール)
overwrite_vars: リモート・インベントリ・ソースからローカル変数を上書きします。(ブール)
custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列)
timeout: タスクが取り消されるまでの実行時間(秒)。(整数)
verbosity: (選択)
- 0: 0 (警告)
- 1: 1 (情報)
- 2: 2 (デバッグ)
limit: ホスト、グループまたはパターン一致の入力(文字列)
last_job_run: (日時)
last_job_failed: (ブール)
next_job_run: (日時)
status: (選択)
- new: 新規
- pending: 保留中
- waiting: 待機中
- running: 実行中
- successful: 成功
- failed: 失敗
- error: エラー
- canceled: 取消し済
- never updated: 更新なし
- none: 外部ソースなし
execution_environment: 実行に使用されるコンテナ・イメージ。(id)
inventory: (id)
update_on_launch: (ブール)
update_cache_timeout: (整数)
source_project: ソースとして使用されるインベントリ・ファイルを含むプロジェクト。(id)
last_update_failed: (ブール)
last_updated: (日時)

ソート

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

パス・パラメータ

id(required): string

問合せパラメータ

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/InventorySource"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object InventorySource

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

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

型: object

ソースを表示

created: string

タイトル: Created

読取り専用: true
credential: integer

タイトル: Credential

最小値: 1

インベントリ更新に使用するクラウド資格証明。
custom_virtualenv: string

タイトル: Custom virtualenv

読取り専用: true

最小長: 1

使用するカスタムPython virtualenvを含むローカル絶対ファイル・パス
description: string

タイトル: Description
enabled_value: string

タイトル: Enabled value

enabled_varが設定されている場合にのみ使用されます。ホストが有効とみなされるときの値。たとえば、enabled_var="status.power_state"およびenabled_value="powered_on"でホスト変数{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}を使用すると、ホストが有効とマークされます。 powered_on以外の値がpower_stateの場合、インポート時にホストは無効になります。キーが見つからない場合、ホストは有効になります
enabled_var: string

タイトル: Enabled var

ホスト変数の指定された日付から有効な状態を取得します。有効な変数は、"foo.bar"と指定できます。その場合、参照はネスト・ディクトに走査されます: from_dict.get("foo", {}).get("bar", default)
execution_environment: integer

タイトル: Execution environment

実行に使用するコンテナ・イメージ。
host_filter: string

タイトル: Host filter

このフィールドは非推奨であり、将来のリリースで削除されます。一致するホストのみがインポートされる正規表現。
id: integer

タイトル: ID

読取り専用: true
inventory(required): integer

タイトル: Inventory
last_job_failed: boolean

タイトル: Last job failed

読取り専用: true
last_job_run: string(date-time)

タイトル: Last job run

読取り専用: true
last_update_failed: boolean

タイトル: Last update failed

読取り専用: true
last_updated: string(date-time)

タイトル: Last updated

読取り専用: true
limit: string

タイトル: Limit

ホスト、グループまたはパターン一致の入力
modified: string

タイトル: Modified

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

タイトル: Name

最小長: 1

最大長: 512
next_job_run: string(date-time)

タイトル: Next job run

読取り専用: true
overwrite: ブール

タイトル: Overwrite

リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。
overwrite_vars: boolean

タイトル: Overwrite vars

リモート・インベントリ・ソースからローカル変数を上書きします。
related: string

タイトル: Related

読取り専用: true
scm_branch: string

タイトル: Scm branch

最大長: 1024

在庫ソースSCMブランチ。空白の場合に使用されるプロジェクト・デフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。
source: string

タイトル: Source

指定できる値: [ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
source_path: string

タイトル: Source path

最大長: 1024
source_project: string

タイトル: Source project

ソースとして使用されるインベントリ・ファイルを含むプロジェクト。
source_vars: string

タイトル: Source vars

YAMLまたはJSON形式のインベントリ・ソース変数。
status: string

タイトル: Status

読取り専用: true

指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ]
summary_fields: string

タイトル: Summary fields

読取り専用: true
timeout: integer

タイトル: Timeout

タスクが取り消されるまでに実行される時間(秒)。
type: string

タイトル: Type

読取り専用: true
update_cache_timeout: integer

タイトル: Update cache timeout

最小値: 0
update_on_launch: boolean

タイトル: Update on launch
url: string

タイトル: Url

読取り専用: true
verbosity: integer

タイトル: Verbosity

デフォルト値: 1

指定できる値: [ "0", "1", "2" ]

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "description":"Cloud credential to use for inventory updates.",
            "minimum":"1",
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "enabled_value":{
            "description":"Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{   \"status\": {     \"power_state\": \"powered_on\",     \"created\": \"2018-02-01T08:00:00.000000Z:00\",     \"healthy\": true    },    \"name\": \"foobar\",    \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled",
            "title":"Enabled value",
            "type":"string",
            "x-nullable":true
        },
        "enabled_var":{
            "description":"Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)",
            "title":"Enabled var",
            "type":"string",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "host_filter":{
            "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.",
            "title":"Host filter",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "last_update_failed":{
            "readOnly":true,
            "title":"Last update failed",
            "type":"boolean"
        },
        "last_updated":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last updated",
            "type":"string"
        },
        "limit":{
            "description":"Enter host, group or pattern match",
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "overwrite":{
            "description":"Overwrite local groups and hosts from remote inventory source.",
            "title":"Overwrite",
            "type":"boolean",
            "x-nullable":true
        },
        "overwrite_vars":{
            "description":"Overwrite local variables from remote inventory source.",
            "title":"Overwrite vars",
            "type":"boolean",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "source":{
            "enum":[
                "file",
                "constructed",
                "scm",
                "ec2",
                "gce",
                "azure_rm",
                "vmware",
                "satellite6",
                "openstack",
                "rhv",
                "controller",
                "insights"
            ],
            "title":"Source",
            "type":"string",
            "x-nullable":true
        },
        "source_path":{
            "maxLength":"1024",
            "title":"Source path",
            "type":"string",
            "x-nullable":true
        },
        "source_project":{
            "description":"Project containing inventory file used as source.",
            "title":"Source project",
            "type":"string",
            "x-nullable":true
        },
        "source_vars":{
            "description":"Inventory source variables in YAML or JSON format.",
            "title":"Source vars",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "none"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "update_cache_timeout":{
            "minimum":"0",
            "title":"Update cache timeout",
            "type":"integer"
        },
        "update_on_launch":{
            "title":"Update on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "default":"1",
            "enum":[
                "0",
                "1",
                "2"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}

先頭に戻る