infra.aap_configuration.schedules
Description
An Ansible Role to create/update/remove Schedules on Ansible Controller.
Requirements
ansible-galaxy collection install -r tests/collections/requirements.yml to be installed Currently: awx.awx or ansible.controller
Variables
| Variable Name | Default Value | Required | Description | Example |
platform_state | “present” | no | The state all objects will take unless overridden by object default | ‘absent’ |
aap_hostname | ”” | yes | URL to the Ansible Automation Platform Server. | 127.0.0.1 |
aap_validate_certs | true | no | Whether or not to validate the Ansible Automation Platform Server’s SSL certificate. | |
aap_username | ”” | no | Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified. | |
aap_password | ”” | no | Platform Admin User’s password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook. | |
aap_token | ”” | no | Controller Admin User’s token on the Ansible Automation Platform Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified. | |
aap_request_timeout | 10 | no | Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host. | |
controller_schedules | see below | yes | Data structure describing your schedule or schedules Described below. Alias: schedules |
Enforcing defaults
The following Variables compliment each other. If Both variables are not set, enforcing default values is not done. Enabling these variables enforce default values on options that are optional in the controller API. This should be enabled to enforce configuration and prevent configuration drift. It is recomended to be enabled, however it is not enforced by default.
Enabling this will enforce configurtion without specifying every option in the configuration files.
‘controller_configuration_schedules_enforce_defaults’ defaults to the value of ‘aap_configuration_enforce_defaults’ if it is not explicitly called. This allows for enforced defaults to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.
| Variable Name | Default Value | Required | Description |
controller_configuration_schedules_enforce_defaults | false | no | Whether or not to enforce default option values on only the applications role |
aap_configuration_enforce_defaults | false | no | This variable enables enforced default values as well, but is shared across multiple roles, see above. |
Secure Logging Variables
The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to false as normally the add schedules task does not include sensitive information. controller_configuration_schedules_secure_logging defaults to the value of aap_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.
| Variable Name | Default Value | Required | Description |
controller_configuration_schedules_secure_logging | false | no | Whether or not to include the sensitive Schedules role tasks in the log. Set this value to true if you will be providing your sensitive values from elsewhere. |
aap_configuration_secure_logging | false | no | This variable enables secure logging as well, but is shared across multiple roles, see above. |
Asynchronous Retry Variables
The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.
| Variable Name | Default Value | Required | Description |
aap_configuration_async_retries | 30 | no | This variable sets the number of retries to attempt for the role globally. |
controller_configuration_schedules_async_retries | `` | no | This variable sets the number of retries to attempt for the role. |
aap_configuration_async_delay | 1 | no | This sets the delay between retries for the role globally. |
controller_configuration_schedules_async_delay | aap_configuration_async_delay | no | This sets the delay between retries for the role. |
aap_configuration_loop_delay | 0 | no | This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded. |
controller_configuration_schedules_loop_delay | aap_configuration_loop_delay | no | This sets the pause between each item in the loop for the role. To help when API is getting overloaded. |
aap_configuration_async_dir | null | no | Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/. |
Data Structure
Schedule Variables
| Variable Name | Default Value | Required | Type | Description |
name | ”” | yes | str | Name of Job Template |
new_name | ”” | str | no | Setting this option will change the existing name (looked up via the name field). |
description | false | no | str | Description to use for the job template. |
rrule | ”” | yes | str | A value representing the schedules iCal recurrence rule. See the awx.awx.schedule plugin for help constructing this value |
extra_data | {} | no | dict | Extra vars for the job template. Only allowed if prompt on launch |
inventory | ”” | no | str | Inventory applied to job template, assuming the job template prompts for an inventory. |
credentials | ”” | no | list | List of credentials applied as a prompt, assuming job template prompts for credentials |
scm_branch | Project default | no | str | Branch to use in the job run. Project default used if not set. Only allowed if allow_override set to true on project |
execution_environment | Job Template default | no | str | Execution Environment applied as a prompt. Job Template default used if not set. Only allowed if ask_execution_environment_on_launch set to true on Job Template |
forks | Job Template default | no | str | Forks applied as a prompt. Job Template default used if not set. Only allowed if ask_forks_on_launch set to true on Job Template |
instance_groups | Job Template default | no | str | List of Instance Groups applied as a prompt. Job Template default used if not set. Only allowed if ask_instance_groups_on_launch set to true on Job Template |
job_slice_count | Job Template default | no | str | Job Slice Count to use in the job run. Job Template default used if not set. Only allowed if ask_job_slice_count_on_launch set to true on Job Template |
labels | Job Template default | no | list | List of labels to use in the job run. Job Template default used if not set. Only allowed if ask_labels_on_launch set to true on Job Template |
timeout | Job Template default | no | str | Timeout to use in the job run. Job Template default used if not set. Only allowed if ask_timeout_on_launch set to true on Job Template |
job_type | Job template default | no | str | The job type used for the job template. |
job_tags | ”” | no | str | Comma separated list of tags to apply to the job |
skip_tags | ”” | no | str | Comma separated list of tags to skip for the job |
limit | ”” | no | str | A host pattern to constrain the list of hosts managed or affected by the playbook |
diff_mode | Job template default | no | bool | Enable diff mode for the job template |
verbosity | Job template default | no | int | Level of verbosity for the job. Only allowed if configured to prompt on launch |
unified_job_template | ”” | no | string | The name of object that is being targeted by the schedule. Example objects include projects, inventory sources, and templates. Required if state=’present. |
organization | ”” | no | str | The organization the unified job template exists in. Used for looking up the unified job template, not a direct model field. |
enabled | true | no | bool | Enabled processing of this job template |
state | present | no | str | Desired state of the resource. |
Standard Schedule Data Structure
Json Example
"controller_schedules": [
{
"name": "Demo Schedule",
"description": "A demonstration",
"unified_job_template": "Demo Job Template",
"rrule": "DTSTART:20191219T130551Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1",
"extra_data": {
"scheduled": true
},
"verbosity": 1
}
]
Yaml Example
controller_schedules:
- name: Simple Example Schedule
description: A demonstration without any additional options
unified_job_template: Demo Job Template
rrule: "DTSTART:20191219T130551Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
- name: Demo Schedule with extra options
description: A demonstration
unified_job_template: Demo Job Template
rrule: "DTSTART:20191219T130551Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
# Note that this example requires the relevant ask_*_on_launch to be true
extra_data:
scheduled: true
verbosity: 1
Playbook Examples
Standard Role Usage
- name: Playbook to configure ansible controller post installation
hosts: localhost
connection: local
# Define following vars here, or in platform_configs/controller_auth.yml
# aap_hostname: ansible-controller-web-svc-test-project.example.com
# aap_username: admin
# aap_password: changeme
pre_tasks:
- name: Include vars from platform_configs directory
ansible.builtin.include_vars:
dir: ./yaml
ignore_files: [controller_config.yml.template]
extensions: ["yml"]
roles:
- {role: infra.aap_configuration.schedules, when: controller_schedules is defined}