theforeman.foreman.hostgroup_info 模块 – 获取关于主机组的信息

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：theforeman.foreman.hostgroup_info。

theforeman.foreman 3.9.0 版本新增

概要 

获取关于主机组的信息

要求 

执行此模块的主机需要满足以下要求。

requests

参数 

参数	说明
location 字符串	用于限定搜索范围的位置标签。
name 字符串	要获取其信息的资源的名称。与 search 互斥。
organization 字符串	用于限定搜索范围的组织名称。
password 字符串 / 必需	用于访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
search 字符串	要使用的搜索查询如果为 None，且未设置 name，则返回所有资源。与 name 互斥。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
username 字符串 / 必需	用于访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持: 完全	可以在 check_mode 中运行，并返回更改状态预测，而无需修改实体
diff_mode	支持: 完全	在 diff 模式下运行时，将返回已更改的内容（或在 check_mode 中可能需要更改的内容）的详细信息

示例 

- name: "Show a hostgroup"
  theforeman.foreman.hostgroup_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Default Hostgroup"

- name: "Show all hostgroups with 'name ~ Default'"
  theforeman.foreman.hostgroup_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "name ~ Default"

返回值 

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

键	描述
hostgroup 字典	关于找到的主机组的详细信息返回: 成功且传递了 name
hostgroups 列表 / 元素=字典	所有找到的主机组及其详细信息的列表返回: 成功且传递了 search

作者

Louis Tiches (@TheRedGreek)