Try Spottercreate, update, or destroy Automation Platform Controller projects
Authors: Wayne Witzel III (@wwitzel3)
preview | supported by community
Install with ansible-galaxy collection install shanemcd.awx:==20.0.14
collections:
- name: shanemcd.awx
version: 20.0.14Create, update, or destroy Automation Platform Controller projects. See U(https://www.ansible.com/tower) for an overview.
- name: Add project
project:
name: "Foo"
description: "Foo bar project"
organization: "test"
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Add Project with cache timeout
project:
name: "Foo"
description: "Foo bar project"
organization: "test"
scm_update_on_launch: True
scm_update_cache_timeout: 60
state: present
controller_config_file: "~/tower_cli.cfg"
- name: Copy project
project:
name: copy
copy_from: test
description: Foo copy project
organization: Foo
state: present
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
timeout:
aliases:
- 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.
- If waiting for the project to update this will abort after this amount of seconds
type: int
interval:
default: 1
description:
- The interval to request an update from the controller.
- Requires wait.
required: false
type: float
new_name:
description:
- Setting this option will change the existing name (looked up via the name field.
type: str
scm_type:
choices:
- manual
- git
- svn
- insights
default: manual
description:
- Type of SCM resource.
type: str
copy_from:
description:
- Name or id to copy the project from.
- This will copy an existing project and change any parameters supplied.
- The new project name will be the one provided in the name parameter.
- The organization parameter is not used in this, to facilitate copy from one organization
to another.
- Provide the id or use the lookup plugin to provide the id if multiple projects share
the same name.
type: str
scm_clean:
default: 'no'
description:
- Remove local modifications before updating.
type: bool
credential:
aliases:
- scm_credential
description:
- Name of the credential to use with this SCM resource.
type: str
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
description:
description:
- Description to use for the project.
type: str
scm_refspec:
default: ''
description:
- The refspec to use for the SCM resource.
type: str
organization:
description:
- Name of organization for project.
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
update_project:
default: false
description:
- Force project to update after changes.
- Used in conjunction with wait, interval, and timeout.
type: bool
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.
- Only compatible with older versions of AWX/Tower
- Deprecated, will be removed in the future
type: str
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
default_environment:
description:
- Default Execution Environment to use for jobs relating to the project.
type: str
scm_delete_on_update:
default: 'no'
description:
- Remove the repository completely before updating.
type: bool
scm_track_submodules:
default: 'no'
description:
- Track submodules latest commit on specified branch.
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: shanemcd.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.
type: int
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