ansible.builtin.tower_project (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Create, update, or destroy Ansible Tower projects. See U(https://www.ansible.com/tower) for an overview.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
name:
    description:
    - Name to use for the project.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the resource.

scm_url:
    description:
    - URL of SCM resource.

scm_type:
    choices:
    - manual
    - git
    - hg
    - svn
    default: manual
    description:
    - Type of SCM resource.

scm_clean:
    default: 'no'
    description:
    - Remove local modifications before updating.
    type: bool

local_path:
    description:
    - The server playbook directory for manual projects.

scm_branch:
    description:
    - The branch to use for the SCM resource.

description:
    description:
    - Description to use for the project.

job_timeout:
    default: 0
    description:
    - The amount of time (in seconds) to run before the SCM Update is canceled. A value
      of 0 means no timeout.
    version_added: '2.8'
    version_added_collection: ansible.builtin

organization:
    description:
    - Primary key of organization for project.

scm_credential:
    description:
    - Name of the credential to use with this SCM resource.

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to AWX.
    - If C(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 C(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_HOST) and then config
      files
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

custom_virtualenv:
    description:
    - Local absolute file path containing a custom Python virtualenv to use
    version_added: '2.8'
    version_added_collection: ansible.builtin

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

scm_delete_on_update:
    default: 'no'
    description:
    - Remove the repository completely before updating.
    type: bool

scm_update_on_launch:
    default: 'no'
    description:
    - Before an update to the local repository before launching a job with this project.
    type: bool

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - 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 C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: awx.awx

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path

scm_update_cache_timeout:
    default: 0
    description:
    - 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.
    version_added: '2.8'
    version_added_collection: ansible.builtin