shanemcd.awx.schedule (20.0.14) — module

Install collection

Install with ansible-galaxy collection install shanemcd.awx:==20.0.14

Add to requirements.yml

  collections:
    - name: shanemcd.awx
      version: 20.0.14

Description

Create, update, or destroy Automation Platform Controller schedules. 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: Build a schedule for Demo Job Template
  schedule:
    name: "{{ sched1 }}"
    state: present
    unified_job_template: "Demo Job Template"
    rrule: "DTSTART:20191219T130551Z RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=1"
  register: result

Scanned by Steampunk Spotter

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

- name: Build the same schedule using the rrule plugin
  schedule:
    name: "{{ sched1 }}"
    state: present
    unified_job_template: "Demo Job Template"
    rrule: "{{ query('awx.awx.schedule_rrule', 'week', start_date='2019-12-19 13:05:51') }}"
  register: result

Inputs

    
name:
    description:
    - Name of this schedule.
    required: true
    type: str

limit:
    description:
    - A host pattern to further constrain the list of hosts managed or affected by the
      playbook
    required: false
    type: str

rrule:
    description:
    - A value representing the schedules iCal recurrence rule.
    - See rrule plugin for help constructing this value
    required: false
    type: str

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

enabled:
    description:
    - Enables processing of this schedule.
    required: false
    type: bool

job_tags:
    description:
    - Comma separated list of the tags to use for the job template.
    required: false
    type: str

job_type:
    choices:
    - run
    - check
    description:
    - The job type to use for the job template.
    required: false
    type: str

new_name:
    description:
    - Setting this option will change the existing name (looked up via the name field.
    required: false
    type: str

diff_mode:
    description:
    - Enable diff mode for the job template.
    required: false
    type: bool

inventory:
    description:
    - Inventory applied as a prompt, assuming job template prompts for inventory
    required: false
    type: str

skip_tags:
    description:
    - Comma separated list of the tags to skip for the job template.
    required: false
    type: str

verbosity:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    description:
    - Control the output level Ansible produces as the playbook runs. 0 - Normal, 1 -
      Verbose, 2 - More Verbose, 3 - Debug, 4 - Connection Debug.
    required: false
    type: int

extra_data:
    default: {}
    description:
    - Specify C(extra_vars) for the template.
    required: false
    type: dict

scm_branch:
    description:
    - Branch to use in job run. Project default used if blank. Only allowed if project
      allow_override field is set to true.
    required: false
    type: str

credentials:
    description:
    - List of credentials applied as a prompt, assuming job template prompts for credentials
    elements: str
    type: list

description:
    description:
    - Optional description of this schedule.
    required: false
    type: str

organization:
    description:
    - The organization the unified job template exists in.
    - Used for looking up the unified job template, not a direct model field.
    type: str

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

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

unified_job_template:
    description:
    - Name of unified job template to schedule.
    required: false
    type: str

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