awx.awx.tower_inventory_source_update – Update inventory source(s).

Note

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

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

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

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Update Ansible Tower inventory source(s). See https://www.ansible.com/tower for an overview.

Parameters

Parameter	Choices/Defaults	Comments
interval float	Default: 1	The interval to request an update from Tower.
inventory string / required		Name or id of the inventory that contains the inventory source(s) to update.
name string / required		The name or id of the inventory source to update. aliases: inventory_source
organization string		Name of the inventory source's inventory's organization.
timeout integer		If waiting for the job to complete this will abort after this amount of seconds
tower_config_file path		Path to the Tower or AWX config file. If provided, the other locations for config files will not be considered.
tower_host string		URL to your Tower or AWX instance. If value not set, will try environment variable `TOWER_HOST` and then config files If value not specified by any means, the value of `127.0.0.1` will be used
tower_oauthtoken raw added in 3.7 of awx.awx		The Tower 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 tower_token module. If value not set, will try environment variable `TOWER_OAUTH_TOKEN` and then config files
tower_password string		Password for your Tower or AWX instance. If value not set, will try environment variable `TOWER_PASSWORD` and then config files
tower_username string		Username for your Tower or AWX instance. If value not set, will try environment variable `TOWER_USERNAME` and then config files
validate_certs boolean	no yes	Whether to allow insecure connections to Tower or 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 `TOWER_VERIFY_SSL` and then config files aliases: tower_verify_ssl
wait boolean	no ← yes	Wait for the job to complete.

Notes

Note

If no config_file is provided we will attempt to use the tower-cli library defaults to find your Tower host information.
config_file should contain Tower configuration in the following format host=hostname username=username password=password

Examples

- name: Update a single inventory source
  tower_inventory_source_update:
    name: "Example Inventory Source"
    inventory: "My Inventory"
    organization: Default

- name: Update all inventory sources
  tower_inventory_source_update:
    name: "{{ item }}"
    inventory: "My Other Inventory"
  loop: "{{ query('awx.awx.tower_api', 'inventory_sources', query_params={ 'inventory': 30 }, return_ids=True ) }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
id integer	success	id of the inventory update Sample: 86
status string	success	status of the inventory update Sample: pending

Authors

Bianca Henderson (@beeankha)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/awx/awx/tower_inventory_source_update_module.html