shanemcd.awx.job_launch (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

Launch an Automation Platform Controller jobs. 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: Launch a job
  job_launch:
    job_template: "My Job Template"
  register: job

Scanned by Steampunk Spotter

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

- name: Launch a job template with extra_vars on remote controller instance
  job_launch:
    job_template: "My Job Template"
    extra_vars:
      var1: "My First Variable"
      var2: "My Second Variable"
      var3: "My Third Variable"
    job_type: run

Scanned by Steampunk Spotter

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

- name: Launch a job with inventory and credential
  job_launch:
    job_template: "My Job Template"
    inventory: "My Inventory"
    credential: "My Credential"
  register: job

Scanned by Steampunk Spotter

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

- name: Wait for job max 120s
  job_wait:
    job_id: "{{ job.id }}"
    timeout: 120

Inputs

    
name:
    aliases:
    - job_template
    description:
    - Name of the job template to use.
    required: true
    type: str

tags:
    description:
    - Specific tags to use for from playbook.
    elements: str
    type: list

wait:
    default: false
    description:
    - Wait for the job to complete.
    type: bool

limit:
    description:
    - Limit to use for the I(job_template).
    type: str

timeout:
    description:
    - If waiting for the job to complete this will abort after this amount of seconds
    type: int

interval:
    default: 1
    description:
    - The interval to request an update from the controller.
    required: false
    type: float

job_type:
    choices:
    - run
    - check
    description:
    - Job_type to use for the job, only used if prompt for job_type is set.
    type: str

diff_mode:
    description:
    - Show the changes made by Ansible tasks where supported
    type: bool

inventory:
    description:
    - Inventory to use for the job, only used if prompt for inventory is set.
    type: str

skip_tags:
    description:
    - Specific tags to skip from the playbook.
    elements: str
    type: list

verbosity:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    description:
    - Verbosity level for this job run
    type: int

extra_vars:
    description:
    - extra_vars to use for the Job Template.
    - ask_extra_vars needs to be set to True via job_template module when creating the
      Job Template.
    type: dict

scm_branch:
    description:
    - A specific of the SCM project to run the template on.
    - This is only applicable if your project allows for branch override.
    type: str

credentials:
    aliases:
    - credential
    description:
    - Credential to use for job, only used if prompt for credential is set.
    elements: str
    type: list

organization:
    description:
    - Organization the job template exists in.
    - Used to help lookup the object, cannot be modified using this module.
    - If not provided, will lookup by name only, which does not work with duplicates.
    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

credential_passwords:
    description:
    - Passwords for credentials which are set to prompt on launch
    type: dict

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

Outputs

id:
  description: job id of the newly launched job
  returned: success
  sample: 86
  type: int
status:
  description: status of newly launched job
  returned: success
  sample: pending
  type: str