модуль theforeman.foreman.discovery_rule — управление правилами обнаружения узлов

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.discovery_rule.

Добавлено в theforeman.foreman 3.5.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Управление правилами обнаружения узлов

Требования

Следующие требования должны быть выполнены на узле, где запускается этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат ЦС для проверки. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_CA_PATH`.
enabled boolean	Включить или отключить правило Варианты: `false` `true`
hostgroup string	Группа узлов, которой будут назначены узлы Обязательно, если state=present
hostname string	Имя узла, назначаемое обнаруженным узлам При совпадении с несколькими узлами необходимо указать уникальное имя для каждого обнаруженного узла
locations list / elements=string	Список местоположений, которым следует назначить сущность
max_count integer	Максимальное количество узлов, которые можно подготовить с помощью правила 0 означает отсутствие ограничения
name string / обязательно	Имя правила обнаружения
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / elements=string	Список организаций, которым следует назначить сущность
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_PASSWORD`.
priority integer	Приоритет правила
search string	Выражение для сопоставления с вновь обнаруженными узлами Обязательно, если state=present
server_url string / обязательно	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это требуется для Kerberos или Kerberos через аутентификацию Negotiate. Необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния без изменения сущности
diff_mode	Поддержка: full	В режиме 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 dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: success
discovery_rules list / elements=dictionary	Список правил обнаружения. Возвращается: success

Авторы

Jeffrey van Pelt (@Thulium-Drake)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/discovery_rule_module.html