Note
This plugin is part of the awx.awx collection (version 19.4.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.inventory_source_update
.
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 filesIf value not specified by any means, the value of 127.0.0.1 will be usedaliases: 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 filesaliases: tower_oauthtoken | |
controller_password string | Password for your controller instance. If value not set, will try environment variable CONTROLLER_PASSWORD and then config filesaliases: tower_password | |
controller_username string | Username for your controller instance. If value not set, will try environment variable CONTROLLER_USERNAME and then config filesaliases: tower_username | |
interval float | Default: 1 | The interval to request an update from the controller. |
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 | |
validate_certs boolean |
| 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 filesaliases: tower_verify_ssl |
wait boolean |
| Wait for the job to complete. |
Note
- name: Update a single inventory source inventory_source_update: name: "Example Inventory Source" inventory: "My Inventory" organization: Default - name: Update all inventory sources inventory_source_update: name: "{{ item }}" inventory: "My Other Inventory" loop: "{{ query('awx.awx.controller_api', 'inventory_sources', query_params={ 'inventory': 30 }, return_ids=True ) }}"
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/inventory_source_update_module.html