theforeman.foreman.host_collection 模块 – 管理主机集合

注意

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

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，请参阅需求获取详细信息。

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

theforeman.foreman 1.0.0 中的新增功能

概要 

创建和管理主机集合

别名：katello_host_collection

需求 

在执行此模块的主机上需要以下需求。

requests

参数 

参数	注释
description 字符串	主机集合的描述
name 字符串 / 必需	主机集合的名称
organization 字符串 / 必需	实体所属的组织
password 字符串 / 必需	访问 Foreman 服务器的用户密码。如果任务中未指定值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果任务中未指定值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
updated_name 字符串	主机集合的新名称。设置此参数后，模块将不是幂等的。
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果任务中未指定值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: "Create Foo host collection"
  theforeman.foreman.host_collection:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Foo"
    description: "Foo host collection for Foo servers"
    organization: "My Cool new Organization"
    state: present

返回值 

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

键	描述
entity 字典	按类型分组的受影响实体的最终状态。返回：成功
host_collections 列表 / 元素=字典	主机集合列表。返回：成功

作者

Maxim Burgerhout (@wzzrd)
Christoffer Reijer (@ephracis)