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_PASSWORD 的值。

公共

布尔值

使书签对所有用户可用

选择

  • false

  • true ← (默认)

查询

字符串

书签的查询

服务器网址

字符串 / 必需

Foreman 服务器的 URL。

如果未在任务中指定该值,则将使用环境变量 FOREMAN_SERVER_URL 的值。

状态

字符串

实体的状态

present_with_defaults 将确保实体存在,但不会更新现有实体

选择

  • "present" ← (默认)

  • "present_with_defaults"

  • "absent"

用户名

字符串 / 必需

访问 Foreman 服务器的用户名。

如果未在任务中指定该值,则将使用环境变量 FOREMAN_USERNAME 的值。

验证证书

布尔值

是否验证 Foreman 服务器的 TLS 证书。

如果未在任务中指定该值,则将使用环境变量 FOREMAN_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 下运行,并返回更改状态预测,而无需修改实体

diff_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。

返回: 成功

名称

字符串

书签的名称。

返回: 成功

所有者_id

整数

所有者实体的数据库 ID。

返回: 成功

所有者_类型

字符串

所有者实体的类。

返回: 成功

公共

布尔值

书签的公开性。

返回: 成功

查询

字符串

要在控制器上执行的查询。

返回: 成功

作者

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Christoffer Reijer (@ephracis) Basalt AB