infra.aap_configuration.ad_hoc_command_cancel

Description

An Ansible Role to cancel a list of ad hoc commands 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_ad_hoc_commands_cancel see below yes Data structure describing your ad hoc jobs to cancel Described below.  

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 ad hoc commands cancel task does not include sensitive information. controller_configuration_ad_hoc_command_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_ad_hoc_command_cancel_secure_logging false no Whether or not to include the sensitive ad_hoc_command_cancel 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.

Data Structure

Ad Hoc Command Cancel Variables

Variable Name Default Value Required Type Description
id ”” yes int ID of the command to cancel Recommended to be in a separate list of ID’s see example, defaults to output of ad_hoc_command_role of controller_ad_hoc_commands_output.
fail_if_not_running false no bool Fail loudly if the I(command_id) can not be canceled.
interval 1 no int The interval in seconds, to request an update from.
timeout 0 no int Maximum time in seconds to wait for a job to finish, 0 means wait until it is finished regardless.

Standard Ad Hoc Command Cancel Data Structure

Yaml Example

controller_ad_hoc_commands_cancel:
  - id: 10
    fail_if_not_running: false
    interval: 1
    timeout: 10
  - id: 12
    fail_if_not_running: false
    interval: 1
    timeout: 10

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.ad_hoc_command_cancel, when: controller_ad_hoc_commands is defined}

License

GPL-3.0

Author

Sean Sullivan