awx.awx.tower_project – create, update, or destroy Ansible Tower projects

Note

This plugin is part of the awx.awx collection.

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

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

Synopsis

Parameters

Parameter Choices/Defaults Comments
allow_override
boolean
    Choices:
  • no
  • yes
Allow changing the SCM branch or revision in a job template that uses this project.

aliases: scm_allow_override
custom_virtualenv
string
Default:
""
Local absolute file path containing a custom Python virtualenv to use
description
string
Description to use for the project.
job_timeout
integer
Default:
0
The amount of time (in seconds) to run before the SCM Update is canceled. A value of 0 means no timeout.
local_path
string
The server playbook directory for manual projects.
name
string / required
Name to use for the project.
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 / required
Name of organization for project.
scm_branch
string
Default:
""
The branch to use for the SCM resource.
scm_clean
boolean
    Choices:
  • no ←
  • yes
Remove local modifications before updating.
scm_credential
string
Name of the credential to use with this SCM resource.
scm_delete_on_update
boolean
    Choices:
  • no ←
  • yes
Remove the repository completely before updating.
scm_refspec
string
Default:
""
The refspec to use for the SCM resource.
scm_type
string
    Choices:
  • manual ←
  • git
  • hg
  • svn
  • insights
Type of SCM resource.
scm_update_cache_timeout
integer
Default:
0
Cache Timeout to cache prior project syncs for a certain number of seconds. Only valid if scm_update_on_launch is to True, otherwise ignored.
scm_update_on_launch
boolean
    Choices:
  • no ←
  • yes
Before an update to the local repository before launching a job with this project.
scm_url
string
URL of SCM resource.
state
string
    Choices:
  • present ←
  • absent
Desired state of the resource.
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 ←
Provides option (True by default) to wait for completed project sync before returning
Can assure playbook files are populated so that job templates that rely on the project may be successfully created

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: Add tower project
  tower_project:
    name: "Foo"
    description: "Foo bar project"
    organization: "test"
    state: present
    tower_config_file: "~/tower_cli.cfg"

- name: Add Tower Project with cache timeout and custom virtualenv
  tower_project:
    name: "Foo"
    description: "Foo bar project"
    organization: "test"
    scm_update_on_launch: True
    scm_update_cache_timeout: 60
    custom_virtualenv: "/var/lib/awx/venv/ansible-2.2"
    state: present
    tower_config_file: "~/tower_cli.cfg"

Authors

  • Wayne Witzel III (@wwitzel3)