機械翻訳について

移動先

• リクエスト
• レスポンス

インベントリ・ソースの更新

put

/api/v2/inventory_sources/{id}/

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

• name: このインベントリ・ソースの名前。(文字列、必須)
• description: このインベントリ・ソースのオプションの説明。(文字列、デフォルト="")
• source: (選択)
  • file: ファイル、ディレクトリまたはスクリプト
  • 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形式のインベントリ・ソース変数。(文字列、デフォルト="")
• credential: インベントリの更新に使用するクラウド資格証明。(整数、デフォルト=None)
• 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: リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。(ブール、デフォルト=False)

• overwrite_vars: リモート・インベントリ・ソースからローカル変数を上書きします。(ブール、デフォルト=False)

• timeout: タスクが取り消されるまでの実行時間(秒)。(整数、デフォルト=0)

• verbosity: (選択)

  • 0: 0 (警告)
  • 1: 1 (情報) (デフォルト)
  • 2: 2 (デバッグ)

• execution_environment: 実行に使用されるコンテナ・イメージ。(id、デフォルト=``)

• inventory: (id、必須)
• update_on_launch: (ブール、デフォルト=False)
• update_cache_timeout: (整数、デフォルト=0)
• source_project: ソースとして使用されるインベントリ・ファイルを含むプロジェクト。(id、デフォルト=``)
• update_on_project_update: (ブール、デフォルト=False)

PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。

リクエスト

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

• application/json

パス・パラメータ

• id: 文字列

問合せパラメータ

• search(オプション): 文字列
  検索条件。

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• credential(オプション): 整数
  インベントリ更新に使用するクラウド資格証明。
• 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"}を使用すると、ホストが有効とマークされます。 powered_on以外の値がpower_stateの場合、インポート時にホストは無効になります。 キーが見つからない場合、ホストは有効になります
• enabled_var(オプション): 文字列
  対象となるホスト変数の辞書から有効状態を取得します。 有効化された変数は「foo.bar」のように指定でき、この場合は、ネストされた辞書を横断してルックアップが行われ、from_dict.get("foo", {}).get("bar", default)と同等になります
• execution_environment(オプション): 整数
  実行に使用するコンテナ・イメージ。
• host_filter(オプション): 文字列
  一致するホストのみがインポートされる正規表現。
• inventory: 整数
• name: 文字列
• overwrite(オプション): ブール
  リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。
• overwrite_vars(オプション): ブール
  リモート・インベントリ・ソースからローカル変数を上書きします。
• source(オプション): 文字列
• source_path(オプション): 文字列
• source_project(オプション): 文字列
  ソースとして使用されるインベントリ・ファイルを含むプロジェクト。
• source_vars(オプション): 文字列
  YAMLまたはJSON形式のインベントリ・ソース変数。
• timeout(オプション): 整数
  タスクが取り消されるまでの実行時間(秒)。
• update_cache_timeout(オプション): 整数
• update_on_launch(オプション): ブール
• update_on_project_update(オプション): ブール
• verbosity(オプション): 文字列

{
    "properties":{
        "credential":{
            "description":"Cloud credential to use for inventory updates.",
            "type":"integer"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "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",
            "type":"string"
        },
        "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)",
            "type":"string"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "type":"integer"
        },
        "host_filter":{
            "description":"Regex where only matching hosts will be imported.",
            "type":"string"
        },
        "inventory":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "overwrite":{
            "description":"Overwrite local groups and hosts from remote inventory source.",
            "type":"boolean"
        },
        "overwrite_vars":{
            "description":"Overwrite local variables from remote inventory source.",
            "type":"boolean"
        },
        "source":{
            "description":"",
            "type":"string"
        },
        "source_path":{
            "description":"",
            "type":"string"
        },
        "source_project":{
            "description":"Project containing inventory file used as source.",
            "type":"string"
        },
        "source_vars":{
            "description":"Inventory source variables in YAML or JSON format.",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "type":"integer"
        },
        "update_cache_timeout":{
            "description":"",
            "type":"integer"
        },
        "update_on_launch":{
            "description":"",
            "type":"boolean"
        },
        "update_on_project_update":{
            "description":"",
            "type":"boolean"
        },
        "verbosity":{
            "description":"",
            "type":"string"
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

200レスポンス

先頭に戻る