community.general.omapi_host модуль — Настройка хостов OMAPI

Примечание

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

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

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

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

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

Описание

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

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

pypureomapi

Параметры

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

Атрибуты

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

Примеры

- 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

END_OF_DOCUMENT_MARKER

Значения возврата

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

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

Авторы

Лоик Бло (@nerzhul)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/omapi_host_module.html