theforeman.foreman.discovery_rule 模块 – 管理主机发现规则

注意

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

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

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

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

theforeman.foreman 3.5.0 中的新增功能

摘要 

管理主机发现规则

需求 

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

requests

参数 

参数	注释
enabled 布尔值	启用或禁用规则选项 `false` `true`
hostgroup 字符串	要将主机分配到的主机组如果 state=present，则为必填
hostname 字符串	要分配给已发现主机的主机名当匹配多个主机时，必须为每个已发现的主机提供唯一的主机名
locations 列表 / 元素=字符串	应将实体分配到的位置列表
max_count 整数	使用此规则配置的主机的最大数量 0 表示无限制
name 字符串 / 必填	发现规则的名称
organizations 列表 / 元素=字符串	应将实体分配到的组织列表
password 字符串 / 必填	访问 Foreman 服务器的用户密码。如果任务中未指定此值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
priority 整数	规则的优先级
search 字符串	用于匹配新发现主机的表达式如果 state=present，则为必填
server_url 字符串 / 必填	Foreman 服务器的 URL。如果任务中未指定此值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
username 字符串 / 必填	访问 Foreman 服务器的用户名。如果任务中未指定此值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定此值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: 'Ensure Discovery Rule'
  theforeman.foreman.discovery_rule:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'my-first-disco'
    search: 'mac = bb:bb:bb:bb:bb:bb'
    hostgroup: 'RedHat7-Base'
    hostname: 'servera'
    max_count: 1
    organizations:
      - 'MyOrg'
    locations:
      - 'DC1'

- name: 'Remove Discovery Rule'
  theforeman.foreman.discovery_rule:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'my-first-disco'
    state: 'absent'

返回值 

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

键	描述
entity 字典	按其类型分组的受影响实体的最终状态。返回：成功
discovery_rules 列表 / 元素=字典	发现规则列表。返回：成功

作者

Jeffrey van Pelt (@Thulium-Drake)