alancoding.awx.tower_project (11.2.0) — module

Install collection

Install with ansible-galaxy collection install alancoding.awx:==11.2.0

Add to requirements.yml

  collections:
    - name: alancoding.awx
      version: 11.2.0

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
    type: str

wait:
    default: true
    description:
    - 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
    type: bool

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

scm_url:
    description:
    - URL of SCM resource.
    type: str

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

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

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

scm_branch:
    default: ''
    description:
    - The branch to use for the SCM resource.
    type: str

tower_host:
    description:
    - URL to your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_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

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

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.
    type: int
    version_added: '2.8'
    version_added_collection: alancoding.awx

scm_refspec:
    default: ''
    description:
    - The refspec to use for the SCM resource.
    type: str
    version_added: '3.7'
    version_added_collection: alancoding.awx

organization:
    description:
    - Name of organization for project.
    required: true
    type: str

allow_override:
    aliases:
    - scm_allow_override
    description:
    - Allow changing the SCM branch or revision in a job template that uses this project.
    type: bool
    version_added: '3.7'
    version_added_collection: alancoding.awx

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

tower_password:
    description:
    - Password for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_PASSWORD) and then config
      files
    type: str

tower_username:
    description:
    - Username for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_USERNAME) and then config
      files
    type: str

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to Tower or 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(TOWER_VERIFY_SSL) and then config
      files
    type: bool

tower_oauthtoken:
    description:
    - The Tower OAuth token to use.
    - If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config
      files
    type: str
    version_added: '3.7'
    version_added_collection: alancoding.awx

custom_virtualenv:
    default: ''
    description:
    - Local absolute file path containing a custom Python virtualenv to use
    type: str
    version_added: '2.8'
    version_added_collection: alancoding.awx

tower_config_file:
    description:
    - Path to the Tower or AWX config file.
    type: path

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

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.
    type: int
    version_added: '2.8'
    version_added_collection: alancoding.awx

notification_templates_error:
    description:
    - list of notifications to send on error
    elements: str
    type: list

notification_templates_started:
    description:
    - list of notifications to send on start
    elements: str
    type: list

notification_templates_success:
    description:
    - list of notifications to send on success
    elements: str
    type: list