1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. グループ

グループのインベントリ・ソースのリスト

get

/api/v2/groups/{id}/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: 実行時の追加のグループとホスト変数用のテンプレート
    • 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 Automation Platform
    • insights: Red Hat Insights
  • source_path: (文字列)
  • source_vars: YAMLまたはJSON形式のインベントリ・ソース変数。(文字列)
  • scm_branch: インベントリ・ソースのSCMブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列)
  • 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"}を使用すると、ホストが有効とマークされます。power_stateがpowered_on以外の値である場合、インポートされるときにホストは無効になります。キーが見つからない場合、ホストは有効になります(文字列)
  • 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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

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

200レスポンス

本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ : results
型: array
ソースを表示
ネストされたスキーマ : InventorySource
型: object
ソースを表示
  • タイトル: Created
    読取り専用: true
  • タイトル: Credential
    最小値: 1
    インベントリ更新に使用するクラウド資格証明。
  • タイトル: Custom virtualenv
    読取り専用: true
    最小長: 1
    使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス
  • タイトル: Description
  • タイトル: 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"}を使用すると、ホストが有効とマークされます。power_stateがpowered_on以外の値である場合、インポートされるときにホストは無効になります。キーが見つからない場合、ホストは有効になります
  • タイトル: Enabled var
    対象となるホスト変数の辞書から有効状態を取得します。有効化された変数は「foo.bar」のように指定でき、この場合は、ネストされた辞書を横断してルックアップが行われ、from_dict.get("foo", {}).get("bar", default)と同等になります
  • タイトル: Execution environment
    実行に使用されるコンテナ・イメージ。
  • タイトル: Host filter
    このフィールドは非推奨であり、今後のリリースで削除される予定です。一致するホストのみがインポートされる正規表現。
  • タイトル: ID
    読取り専用: true
  • タイトル: Inventory
  • タイトル: Last job failed
    読取り専用: true
  • タイトル: Last job run
    読取り専用: true
  • タイトル: Last update failed
    読取り専用: true
  • タイトル: Last updated
    読取り専用: true
  • タイトル: Limit
    ホスト、グループまたはパターン一致を入力します
  • タイトル: Modified
    読取り専用: true
  • タイトル: Name
    最小長: 1
    最大長: 512
  • タイトル: Next job run
    読取り専用: true
  • タイトル: Overwrite
    リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。
  • タイトル: Overwrite vars
    リモート・インベントリ・ソースからローカル変数を上書きします。
  • タイトル: Scm branch
    最大長: 1024
    インベントリ・ソースのSCMブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。
  • タイトル: Source
    指定できる値: [ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
  • タイトル: Source path
    最大長: 1024
  • タイトル: Source project
    ソースとして使用されるインベントリ・ファイルを含むプロジェクト。
  • タイトル: Source vars
    YAMLまたはJSON形式のインベントリ・ソース変数。
  • タイトル: Status
    読取り専用: true
    指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ]
  • タイトル: Summary fields
    読取り専用: true
  • タイトル: Timeout
    タスクが取り消されるまでの実行時間(秒)。
  • タイトル: Type
    読取り専用: true
  • タイトル: Update cache timeout
    最小値: 0
  • タイトル: Update on launch
  • タイトル: Url
    読取り専用: true
  • タイトル: Verbosity
    デフォルト値: 1
    指定できる値: [ "0", "1", "2" ]
先頭に戻る