awx.awx.job_list module – List Automation Platform Controller jobs.

Note

This module is part of the awx.awx collection (version 21.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.job_list.

Synopsis

Parameters

Parameter

Comments

all_pages

boolean

Fetch all the pages and return a single result.

Choices:

  • no ← (default)

  • yes

controller_config_file

aliases: tower_config_file

path

Path to the controller config file.

If provided, the other locations for config files will not be considered.

controller_host

aliases: tower_host

string

URL to your Automation Platform Controller instance.

If value not set, will try environment variable CONTROLLER_HOST and then config files

If value not specified by any means, the value of 127.0.0.1 will be used

controller_oauthtoken

aliases: tower_oauthtoken

raw

added in 3.7.0 of awx.awx

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 CONTROLLER_OAUTH_TOKEN and then config files

controller_password

aliases: tower_password

string

Password for your controller instance.

If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

controller_username

aliases: tower_username

string

Username for your controller instance.

If value not set, will try environment variable CONTROLLER_USERNAME and then config files

page

integer

Page number of the results to fetch.

query

dictionary

Query used to further filter the list of jobs. {"foo":"bar"} will be passed at ?foo=bar

status

string

Only list jobs with this status.

Choices:

  • pending

  • waiting

  • running

  • error

  • failed

  • canceled

  • successful

validate_certs

aliases: tower_verify_ssl

boolean

Whether to allow insecure connections to AWX.

If 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 CONTROLLER_VERIFY_SSL and then config files

Choices:

  • no

  • yes

Notes

Note

  • If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.

  • config_file should be in the following format host=hostname username=username password=password

Examples

- name: List running jobs for the testing.yml playbook
  job_list:
    status: running
    query: {"playbook": "testing.yml"}
    controller_config_file: "~/tower_cli.cfg"
  register: testing_jobs

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

count

integer

Total count of objects return

Returned: success

Sample: 51

next

integer

next page available for the listing

Returned: success

Sample: 3

previous

integer

previous page available for the listing

Returned: success

Sample: 1

results

list / elements=string

a list of job objects represented as dictionaries

Returned: success

Sample: [{“allow_simultaneous”: false, “artifacts”: {}, “ask_credential_on_launch”: false, “ask_inventory_on_launch”: false, “ask_job_type_on_launch”: false, “failed”: false, “finished”: “2017-02-22T15:09:05.633942Z”, “force_handlers”: false, “forks”: 0, “id”: 2, “inventory”: 1, “job_explanation”: “”, “job_tags”: “”, “job_template”: 5, “job_type”: “run”}, “…”]

Authors

  • Wayne Witzel III (@wwitzel3)