Documentation

tower_project - create, update, or destroy Ansible Tower projects

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • ansible-tower-cli >= 3.0.3

Options

parameter required default choices comments
description
 no
Description to use for the project.
local_path
 no
The server playbook directory for manual projects.
name
 yes
Name to use for the project.
organization
 no
Primary key of organization for project.
scm_branch
 no
The branch to use for the scm resource.
scm_clean
 no
Remove local modifications before updating.
scm_credential
 no
Name of the credential to use with this scm resource.
scm_delete_on_update
 no
Remove the repository completely before updating.
scm_type
 no manual
  • manual
  • git
  • hg
  • svn
Type of scm resource.
scm_update_on_launch
 no
Before an update to the local repository before launching a job with this project.
scm_url
 no
URL of scm resource.
state
 no present
  • present
  • absent
Desired state of the resource.
tower_config_file
 no
Path to the Tower config file. See notes.
tower_host
 no
URL to your Tower instance.
tower_password
 no
Password for your Tower instance.
tower_username
 no
Username for your Tower instance.
tower_verify_ssl
 no True
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.

Examples

- name: Add tower project
  tower_project:
    name: "Foo"
    description: "Foo bar project"
    organization: "test"
    state: present
    tower_config_file: "~/tower_cli.cfg"

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.