theforeman.foreman.bookmark 模块 – 管理书签
注意
此模块是 theforeman.foreman 集合(版本 4.2.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install theforeman.foreman
。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。
要在 playbook 中使用它,请指定:theforeman.foreman.bookmark
。
theforeman.foreman 1.0.0 中的新增功能
概要
管理书签实体
别名:foreman_bookmark
要求
在执行此模块的主机上需要以下要求。
requests
参数
参数 |
注释 |
---|---|
书签的控制器 |
|
书签的名称 |
|
访问 Foreman 服务器的用户的密码。 如果未在任务中指定该值,则将改用环境变量 |
|
使书签对所有用户可用 选项
|
|
书签的查询 |
|
Foreman 服务器的 URL。 如果未在任务中指定该值,则将改用环境变量 |
|
实体的状态
选项
|
|
访问 Foreman 服务器的用户名。 如果未在任务中指定该值,则将改用环境变量 |
|
是否验证 Foreman 服务器的 TLS 证书。 如果未在任务中指定该值,则将改用环境变量 选项
|
属性
属性 |
支持 |
描述 |
---|---|---|
支持: 完全 |
可以在 check_mode 中运行并返回更改的状态预测,而无需修改实体 |
|
支持: 完全 |
在 diff 模式下,将返回有关已更改(或可能需要在 check_mode 中更改)的详细信息 |
示例
- name: "Create a Bookmark"
theforeman.foreman.bookmark:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "recent"
controller: "job_invocations"
query: "started_at > '24 hours ago'"
state: present_with_defaults
- name: "Update a Bookmark"
theforeman.foreman.bookmark:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "recent"
controller: "job_invocations"
query: "started_at > '12 hours ago'"
state: present
- name: "Delete a Bookmark"
theforeman.foreman.bookmark:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "recent"
controller: "job_invocations"
state: absent
返回值
常见返回值在此处有文档记录,以下是此模块特有的字段
键 |
描述 |
---|---|
受影响的实体按其类型分组的最终状态。 返回: 成功 |
|
书签列表。 返回: 成功 |
|
控制器,执行查询的位置。 返回: 成功 |
|
书签的数据库 ID。 返回: 成功 |
|
书签的名称。 返回: 成功 |
|
所有者实体的数据库 ID。 返回: 成功 |
|
所有者实体的类。 返回: 成功 |
|
书签的公开性。 返回: 成功 |
|
要在控制器上执行的查询。 返回: 成功 |