Модуль community.general.omapi_host — настройка узлов OMAPI

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.omapi_host.

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

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

Управление узлами OMAPI на совместимых DHCPd-серверах.

Требования

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

pypureomapi

Параметры

Параметр	Комментарии
ddns логический	Включить динамические обновления DNS для этого узла. Варианты: `false` ← (по умолчанию) `true`
host строка	Задаёт узел сервера OMAPI для взаимодействия. По умолчанию: `"localhost"`
hostname псевдонимы: name строка	Задаёт имя узла для аренды (обязательно, если `state=present`).
ip строка	Задаёт IP-адрес узла для аренды.
key строка / обязательный	Задаёт содержимое ключа TSIG для аутентификации на сервере OMAPI.
key_name строка / обязательный	Задаёт имя ключа TSIG для аутентификации на сервере OMAPI.
macaddr строка / обязательный	Задаёт MAC-адрес узла для аренды.
port целое число	Задаёт порт сервера OMAPI для взаимодействия. По умолчанию: `7911`
state строка / обязательный	Создать или удалить узел OMAPI. Варианты: `"absent"` `"present"`
statements список / элементы=строка	Добавляет список инструкций DHCP OMAPI к аренде узла (без завершающей точки с запятой). По умолчанию: `[]`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может выполняться в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого узла.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примеры

- name: Add a host using OMAPI
  community.general.omapi_host:
    key_name: defomapi
    key: +bFQtBCta6j2vWkjPkNFtgA==
    host: 10.98.4.55
    macaddr: 44:dd:ab:dd:11:44
    name: server01
    ip: 192.168.88.99
    ddns: true
    statements:
      - filename "pxelinux.0"
      - next-server 1.1.1.1
    state: present

- name: Remove a host using OMAPI
  community.general.omapi_host:
    key_name: defomapi
    key: +bFQtBCta6j2vWkjPkNFtgA==
    host: 10.1.1.1
    macaddr: 00:66:ab:dd:11:44
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
lease словарь	Словарь, содержащий сведения об узле. Возвращается: при успешном выполнении
hardware-address строка	MAC-адрес. Возвращается: при успешном выполнении Пример: `"00:11:22:33:44:55"`
hardware-type целое число	Тип оборудования, обычно `1`. Возвращается: при успешном выполнении Пример: `1`
ip-address строка	IP-адрес, если он задан. Возвращается: при успешном выполнении Пример: `"192.168.1.5"`
name строка	Имя узла. Возвращается: при успешном выполнении Пример: `"mydesktop"`

Авторы

Loic Blot (@nerzhul)

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

© 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/community/general/omapi_host_module.html