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
。
概要
列出自动化平台控制器作业。有关概述,请参阅 https://ansible.org.cn/tower。
别名:tower_job_list
参数
参数 |
注释 |
---|---|
获取所有页面并返回单个结果。 选择
|
|
控制器配置文件的路径。 如果提供,则不会考虑其他配置文件的位置。 |
|
指向自动化平台控制器实例的 URL。 如果未设置该值,将尝试环境变量 如果未通过任何方式指定该值,则将使用 |
|
要使用的 OAuth 令牌。 此值可以采用两种格式之一。 一个字符串,它是令牌本身。(即 bqV5txm97wqJqtkxlMkhQz0pKhRMMX) 一个由令牌模块返回的字典结构。 如果未设置该值,将尝试环境变量 |
|
控制器实例的密码。 如果未设置该值,将尝试环境变量 |
|
控制器实例的用户名。 如果未设置该值,将尝试环境变量 |
|
要获取的结果的页码。 |
|
用于进一步筛选作业列表的查询。 |
|
指定 Ansible 在向控制器主机发送请求时应使用的超时。 默认为 10 秒,但这由共享的 module_utils 代码处理 |
|
仅列出具有此状态的作业。 选择
|
|
是否允许与 AWX 的不安全连接。 如果为 这应仅在个人控制的站点上使用自签名证书。 如果未设置该值,将尝试环境变量 选择
|
备注
注意
如果未提供 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
返回值
常见的返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
返回的对象总数 已返回:成功 示例: |
|
列表的下一页 已返回:成功 示例: |
|
列表的上一页 已返回:成功 示例: |
|
以字典形式表示的作业对象列表 已返回:成功 示例: |