On this page
tower_project - create, update, or destroy Ansible Tower projects
New in version 2.3.
Synopsis
- Create, update, or destroy Ansible Tower projects. See https://www.ansible.com/tower for an overview.
Requirements
The below requirements are needed on the host that executes this module.
- ansible-tower-cli >= 3.0.2
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
description | Default:
None
|
Description to use for the project.
|
local_path | Default:
None
|
The server playbook directory for manual projects.
|
name
required
|
Default:
None
|
Name to use for the project.
|
organization | Default:
None
|
Primary key of organization for project.
|
scm_branch | Default:
None
|
The branch to use for the scm resource.
|
scm_clean | Default:
no
|
Remove local modifications before updating.
|
scm_credential | Default:
None
|
Name of the credential to use with this scm resource.
|
scm_delete_on_update | Default:
no
|
Remove the repository completely before updating.
|
scm_type |
|
Type of scm resource.
|
scm_update_on_launch | Default:
no
|
Before an update to the local repository before launching a job with this project.
|
scm_url | Default:
None
|
URL of scm resource.
|
state |
|
Desired state of the resource.
|
tower_config_file | Default:
None
|
Path to the Tower config file. See notes.
|
tower_host | Default:
None
|
URL to your Tower instance.
|
tower_password | Default:
None
|
Password for your Tower instance.
|
tower_username | Default:
None
|
Username for your Tower instance.
|
tower_verify_ssl | Default:
yes
|
Dis/allow insecure connections to Tower. If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
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"
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Wayne Witzel III (@wwitzel3)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/tower_project_module.html