awx.awx.inventory_source – create, update, or destroy Automation Platform Controller inventory source.

Note

This plugin is part of the awx.awx collection (version 19.2.2).

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.inventory_source.

Synopsis

Parameters

Parameter Choices/Defaults Comments
controller_config_file
path
Path to the controller config file.
If provided, the other locations for config files will not be considered.

aliases: tower_config_file
controller_host
string
URL to your Automation Platform Controller instance.
If value not set, will try environment variable CONTROLLER_HOST and then config files
If value not specified by any means, the value of 127.0.0.1 will be used

aliases: tower_host
controller_oauthtoken
raw
added in 3.7.0 of awx.awx
The OAuth token to use.
This value can be in one of two formats.
A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
A dictionary structure as returned by the token module.
If value not set, will try environment variable CONTROLLER_OAUTH_TOKEN and then config files

aliases: tower_oauthtoken
controller_password
string
Password for your controller instance.
If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

aliases: tower_password
controller_username
string
Username for your controller instance.
If value not set, will try environment variable CONTROLLER_USERNAME and then config files

aliases: tower_username
credential
string
Credential to use for the source.
custom_virtualenv
string
Local absolute file path containing a custom Python virtualenv to use.
Only compatible with older versions of AWX/Controller
Deprecated, will be removed in the future
description
string
The description to use for the inventory source.
enabled_value
string
Value when the host is considered enabled, e.g., "powered_on"
enabled_var
string
The variable to use to determine enabled state e.g., "status.power_state"
execution_environment
string
Execution Environment to use for the source.
host_filter
string
If specified, AWX will only import hosts that match this regular expression.
inventory
string / required
Inventory the group should be made a member of.
name
string / required
The name to use for the inventory source.
new_name
string
A new name for this assets (will rename the asset)
notification_templates_error
list / elements=string
list of notifications to send on error
notification_templates_started
list / elements=string
list of notifications to send on start
notification_templates_success
list / elements=string
list of notifications to send on success
organization
string
Name of the inventory source's inventory's organization.
overwrite
boolean
    Choices:
  • no
  • yes
Delete child groups and hosts not found in source.
overwrite_vars
boolean
    Choices:
  • no
  • yes
Override vars in child groups and hosts with those from external source.
source
string
    Choices:
  • scm
  • ec2
  • gce
  • azure_rm
  • vmware
  • satellite6
  • openstack
  • rhv
  • controller
  • insights
The source to use for this group.
source_path
string
For an SCM based inventory source, the source path points to the file within the repo to use as an inventory.
source_project
string
Project to use as source with scm option
source_vars
dictionary
The variables or environment fields to apply to this source type.
state
string
    Choices:
  • present ←
  • absent
Desired state of the resource.
timeout
integer
The amount of time (in seconds) to run before the task is canceled.
update_cache_timeout
integer
Time in seconds to consider an inventory sync to be current.
update_on_launch
boolean
    Choices:
  • no
  • yes
Refresh inventory data from its source each time a job is run.
update_on_project_update
boolean
    Choices:
  • no
  • yes
Update this source when the related project updates if source is scm
validate_certs
boolean
    Choices:
  • no
  • yes
Whether to allow insecure connections to AWX.
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.
If value not set, will try environment variable CONTROLLER_VERIFY_SSL and then config files

aliases: tower_verify_ssl
verbosity
integer
    Choices:
  • 0
  • 1
  • 2
The verbosity level to run this inventory source under.

Notes

Note

  • If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.

  • config_file should be in the following format host=hostname username=username password=password

Examples

- name: Add an inventory source
  inventory_source:
    name: "source-inventory"
    description: Source for inventory
    inventory: previously-created-inventory
    credential: previously-created-credential
    overwrite: True
    update_on_launch: True
    organization: Default
    source_vars:
      private: false

Authors

  • Adrien Fleury (@fleu42)