awx.awx.project_update module – Update a Project in Automation Platform Controller
Note
This module is part of the awx.awx collection (version 24.6.1).
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.project_update
.
Synopsis
Update a Automation Platform Controller Project. See https://www.ansible.com/tower for an overview.
Aliases: tower_project_update
Parameters
Parameter |
Comments |
---|---|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
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 |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
The interval to request an update from the controller. Default: |
|
The name or id of the project to update. |
|
Organization name, ID, or named URL 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. |
|
Specify the timeout Ansible should use in requests to the controller host. Defaults to 10s, but this is handled by the shared module_utils code |
|
If waiting for the project to update this will abort after this amount of seconds |
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
|
Wait for the project to update. If scm revision has not changed module will return not changed. Choices:
|
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: Launch a project with a timeout of 10 seconds
project_update:
project: "Networking Project"
timeout: 10
- name: Launch a Project with extra_vars without waiting
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 |
Description |
---|---|
project id of the updated project Returned: success Sample: |
|
status of the updated project Returned: success Sample: |