ansible.builtin.tower_job_list (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

List Ansible Tower 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: List running jobs for the testing.yml playbook
  tower_job_list:
    status: running
    query: {"playbook": "testing.yml"}
    tower_config_file: "~/tower_cli.cfg"
  register: testing_jobs

Inputs

    
page:
    description:
    - Page number of the results to fetch.

query:
    description:
    - Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at
      C(?foo=bar)

status:
    choices:
    - pending
    - waiting
    - running
    - error
    - failed
    - canceled
    - successful
    description:
    - Only list jobs with this status.

all_pages:
    default: 'no'
    description:
    - Fetch all the pages and return a single result.
    type: bool

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

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: awx.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

count:
  description: Total count of objects return
  returned: success
  sample: 51
  type: int
next:
  description: next page available for the listing
  returned: success
  sample: 3
  type: int
previous:
  description: previous page available for the listing
  returned: success
  sample: 1
  type: int
results:
  description: 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
  - '...'
  type: list