Update an Inventory Source
put
/api/v2/inventory_sources/{id}/
Make a PUT or PATCH request to this resource to update this inventory source. The following fields may be modified:
name
: Name of this inventory source. (string, required)description
: Optional description of this inventory source. (string, default=""
)source
: (choice)file
: File, Directory or Scriptconstructed
: Template additional groups and hostvars at runtimescm
: Sourced from a Projectec2
: Amazon EC2gce
: Google Compute Engineazure_rm
: Microsoft Azure Resource Managervmware
: VMware vCentersatellite6
: Red Hat Satellite 6openstack
: OpenStackrhv
: Red Hat Virtualizationcontroller
: Red Hat Ansible Automation Platforminsights
: Red Hat Insights
source_path
: (string, default=""
)source_vars
: Inventory source variables in YAML or JSON format. (string, default=""
)scm_branch
: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=""
)credential
: Cloud credential to use for inventory updates. (integer, default=None
)enabled_var
: 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) (string, default=""
)enabled_value
: 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 (string, default=""
)host_filter
: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=""
)overwrite
: Overwrite local groups and hosts from remote inventory source. (boolean, default=False
)-
overwrite_vars
: Overwrite local variables from remote inventory source. (boolean, default=False
) -
timeout
: The amount of time (in seconds) to run before the task is canceled. (integer, default=0
) verbosity
: (choice)0
: 0 (WARNING)1
: 1 (INFO) (default)2
: 2 (DEBUG)
-
limit
: Enter host, group or pattern match (string, default=""
) -
execution_environment
: The container image to be used for execution. (id, default=``) inventory
: (id, required)update_on_launch
: (boolean, default=False
)update_cache_timeout
: (integer, default=0
)source_project
: Project containing inventory file used as source. (id, default=``)
For a PUT request, include all fields in the request.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : InventorySource
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
Minimum Value:1
Cloud credential to use for inventory updates. -
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
description:
string
Title:
Description
-
enabled_value:
string
Title:
Enabled value
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 -
enabled_var:
string
Title:
Enabled var
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) -
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
host_filter:
string
Title:
Host filter
This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. -
id:
integer
Title:
ID
Read Only:true
-
inventory(required):
integer
Title:
Inventory
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
last_update_failed:
boolean
Title:
Last update failed
Read Only:true
-
last_updated:
string(date-time)
Title:
Last updated
Read Only:true
-
limit:
string
Title:
Limit
Enter host, group or pattern match -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
overwrite:
boolean
Title:
Overwrite
Overwrite local groups and hosts from remote inventory source. -
overwrite_vars:
boolean
Title:
Overwrite vars
Overwrite local variables from remote inventory source. - related: string
-
scm_branch:
string
Title:
Scm branch
Maximum Length:1024
Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. -
source:
string
Title:
Source
Allowed Values:[ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
-
source_path:
string
Title:
Source path
Maximum Length:1024
-
source_project:
string
Title:
Source project
Project containing inventory file used as source. -
source_vars:
string
Title:
Source vars
Inventory source variables in YAML or JSON format. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) to run before the task is canceled. -
type:
string
Title:
Type
Read Only:true
-
update_cache_timeout:
integer
Title:
Update cache timeout
Minimum Value:0
-
update_on_launch:
boolean
Title:
Update on launch
-
url:
string
Title:
Url
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Default Value:1
Allowed Values:[ "0", "1", "2" ]
Response
Supported Media Types
- application/json
200 Response
Root Schema : InventorySource
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
Minimum Value:1
Cloud credential to use for inventory updates. -
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
description:
string
Title:
Description
-
enabled_value:
string
Title:
Enabled value
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 -
enabled_var:
string
Title:
Enabled var
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) -
execution_environment:
integer
Title:
Execution environment
The container image to be used for execution. -
host_filter:
string
Title:
Host filter
This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. -
id:
integer
Title:
ID
Read Only:true
-
inventory(required):
integer
Title:
Inventory
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
last_update_failed:
boolean
Title:
Last update failed
Read Only:true
-
last_updated:
string(date-time)
Title:
Last updated
Read Only:true
-
limit:
string
Title:
Limit
Enter host, group or pattern match -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
overwrite:
boolean
Title:
Overwrite
Overwrite local groups and hosts from remote inventory source. -
overwrite_vars:
boolean
Title:
Overwrite vars
Overwrite local variables from remote inventory source. - related: string
-
scm_branch:
string
Title:
Scm branch
Maximum Length:1024
Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. -
source:
string
Title:
Source
Allowed Values:[ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
-
source_path:
string
Title:
Source path
Maximum Length:1024
-
source_project:
string
Title:
Source project
Project containing inventory file used as source. -
source_vars:
string
Title:
Source vars
Inventory source variables in YAML or JSON format. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) to run before the task is canceled. -
type:
string
Title:
Type
Read Only:true
-
update_cache_timeout:
integer
Title:
Update cache timeout
Minimum Value:0
-
update_on_launch:
boolean
Title:
Update on launch
-
url:
string
Title:
Url
Read Only:true
-
verbosity:
integer
Title:
Verbosity
Default Value:1
Allowed Values:[ "0", "1", "2" ]