theforeman.foreman.discovery_rule module – Manage Host Discovery Rules
Note
This module is part of the theforeman.foreman collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install theforeman.foreman
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: theforeman.foreman.discovery_rule
.
New in theforeman.foreman 3.5.0
Synopsis
Manage Host Discovery Rules
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Enable or disable the rule Choices:
|
|
Hostgroup to assign hosts to Required if state=present |
|
Hostname to assign to discovered host(s) When matching multiple hosts, must provide unique hostnames for each of the discovered hosts |
|
List of locations the entity should be assigned to |
|
Maximum amount of hosts to provision with the rule 0 means no limit |
|
Name of the Discovery Rule |
|
List of organizations the entity should be assigned to |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Priority of the rule |
|
Expression to match newly discovered hosts with Required if state=present |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying the entity |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
Examples
- 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'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of discovery rules. Returned: success |