インベントリ・ソースの更新
put
/api/v2/inventory_sources/{id}/
このリソースに対してPUTまたはPATCHリクエストを行って、このインベントリ・ソースを更新します。 次のフィールドを変更できます。
name
: このインベントリ・ソースの名前。(文字列、必須)description
: このインベントリ・ソースのオプションの説明。(文字列、デフォルト=""
)source
: (選択)file
: ファイル、ディレクトリまたはスクリプトscm
: プロジェクトからのソーシングec2
: Amazon EC2gce
: Google Compute Engineazure_rm
: Microsoft Azure Resource Managervmware
: VMware vCentersatellite6
: Red Hat Satellite 6openstack
: OpenStackrhv
: Red Hat Virtualizationcontroller
: 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
パス・パラメータ
問合せパラメータ
- 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(オプション): 文字列