awx.awx.tower_project_update – Update a Project in Ansible Tower

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_project_update.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Update a Ansible Tower Project. 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.
name string / required		The name or id of the project to update. aliases: project
organization string		Organization the project exists in. Used to help lookup the object, cannot be modified using this module. If not provided, will lookup by name only, which does not work with duplicates.
timeout integer		If waiting for the project to update 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	Choices: 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	Choices: no yes ←	Wait for the project to update.

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: Launch a project with a timeout of 10 seconds
  tower_project_update:
    project: "Networking Project"
    timeout: 10

- name: Launch a Project with extra_vars without waiting
  tower_project_update:
    project: "Networking Project"
    wait: False

Return Values

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

Key	Returned	Description
id integer	success	project id of the updated project Sample: 86
status string	success	status of the updated project Sample: pending

Authors

Sean Sullivan (@sean-m-sullivan)

© 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_project_update_module.html