awx.awx.job_list 模块 – 列出自动化平台控制器作业。

注意

此模块是 awx.awx 集合(版本 24.6.1)的一部分。

如果您正在使用 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install awx.awx

要在 Playbook 中使用它,请指定:awx.awx.job_list

概要

别名:tower_job_list

参数

参数

注释

all_pages

布尔值

获取所有页面并返回单个结果。

选择

  • false ←(默认)

  • true

controller_config_file

别名:tower_config_file

路径

控制器配置文件的路径。

如果提供,则不会考虑其他配置文件的位置。

controller_host

别名:tower_host

字符串

指向自动化平台控制器实例的 URL。

如果未设置该值,将尝试环境变量 CONTROLLER_HOST,然后尝试配置文件

如果未通过任何方式指定该值,则将使用 127.0.0.1 的值

controller_oauthtoken

别名:tower_oauthtoken

任何

在 awx.awx 3.7.0 中添加

要使用的 OAuth 令牌。

此值可以采用两种格式之一。

一个字符串,它是令牌本身。(即 bqV5txm97wqJqtkxlMkhQz0pKhRMMX)

一个由令牌模块返回的字典结构。

如果未设置该值,将尝试环境变量 CONTROLLER_OAUTH_TOKEN,然后尝试配置文件

controller_password

别名:tower_password

字符串

控制器实例的密码。

如果未设置该值,将尝试环境变量 CONTROLLER_PASSWORD,然后尝试配置文件

controller_username

别名:tower_username

字符串

控制器实例的用户名。

如果未设置该值,将尝试环境变量 CONTROLLER_USERNAME,然后尝试配置文件

page

整数

要获取的结果的页码。

query

字典

用于进一步筛选作业列表的查询。{"foo":"bar"} 将在 ?foo=bar 处传递

request_timeout

浮点数

指定 Ansible 在向控制器主机发送请求时应使用的超时。

默认为 10 秒,但这由共享的 module_utils 代码处理

status

字符串

仅列出具有此状态的作业。

选择

  • “待定”

  • “等待”

  • “运行中”

  • “错误”

  • “失败”

  • “已取消”

  • “成功”

validate_certs

别名:tower_verify_ssl

布尔值

是否允许与 AWX 的不安全连接。

如果为 no,则不会验证 SSL 证书。

这应仅在个人控制的站点上使用自签名证书。

如果未设置该值,将尝试环境变量 CONTROLLER_VERIFY_SSL,然后尝试配置文件

选择

  • false

  • true

备注

注意

  • 如果未提供 config_file,我们将尝试使用 tower-cli 库的默认设置来查找您的主机信息。

  • config_file 的格式应为 host=hostname username=username password=password

示例

- 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

返回值

常见的返回值记录在 此处,以下是此模块特有的字段

描述

count

整数

返回的对象总数

已返回:成功

示例: 51

next

整数

列表的下一页

已返回:成功

示例: 3

上一页

整数

列表的上一页

已返回:成功

示例: 1

结果

列表 / 元素=字符串

以字典形式表示的作业对象列表

已返回:成功

示例: [{"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"}, "..."]

作者

  • Wayne Witzel III (@wwitzel3)