Модуль community.general.kea_command — отправляет произвольную команду серверу ISC KEA на целевом узле

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

Добавлено в community.general 12.0.0

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

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

Отправляет команду в JSON API сервера ISC KEA, работающего на целевом узле, и получает результат.
Этот модуль поддерживает отправку произвольных команд и возвращает ответ сервера без проверки; хотя можно было бы создавать отдельные модули для конкретных команд служб KEA, такой подход не масштабируется, поскольку только хуки FOSS предоставляют десятки команд.
Между отправкой команды и разбором статуса результата changed регистрируется как true, чтобы действовать наверняка в случае ошибки.

Параметры

Параметр	Комментарии
arguments словарь	Аргументы, отправляемые вместе с командой, если они есть. Используйте `{}`, чтобы отправить пустой словарь/объект аргументов вместо того, чтобы опустить его.
command строка / обязательный	Имя отправляемой команды, например `status-get`.
rv_changed список / элементы=целое число	Список кодов `result`, указывающих на успешное выполнение и изменение состояния системы. Для большинства команд получения не указывайте это значение. Задайте значение `[0]` для `command=lease4-del` и подобных команд, которые таким образом сообщают об изменении состояния системы. Любые коды `result`, не указанные ни в `rv_unchanged`, ни в `rv_changed`, интерпретируются как результат с ошибкой. Если код результата входит в оба списка, `rv_unchanged` имеет приоритет над `rv_changed`. По умолчанию: `[]`
rv_unchanged список / элементы=целое число	Список кодов `result`, указывающих на успешное выполнение без изменения состояния системы. Для большинства команд получения задайте значение `[0]`. Используйте `[3]` для `command=lease4-del` и подобных команд, для которых предусмотрен отдельный код такого результата. Любые коды `result`, не указанные ни в `rv_unchanged`, ни в `rv_changed`, интерпретируются как результат с ошибкой. Если код результата входит в оба списка, `rv_unchanged` имеет приоритет над `rv_changed`. По умолчанию: `[]`
socket путь	Полный путь к сокету домена Unix, к которому необходимо подключиться. Значение по умолчанию подходит для `kea-dhcp4-server` в Debian trixie. Этот модуль напрямую взаимодействует через UDS; HTTP-обёртки не поддерживаются. По умолчанию: `"/run/kea/kea4-ctrl-socket"`

Атрибуты

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

Примеры

vars:
  ipaddr: "192.168.123.45"
  hwaddr: "00:00:5E:00:53:00"
tasks:

  # an example for a request acquiring information
  - name: Get KEA DHCP6 status
    kea_command:
      command: status-get
      rv_unchanged: [0]
      socket: /run/kea/kea6-ctrl-socket
    register: kea6_status
  - name: Display registered status result
    ansible.builtin.debug:
      msg: KEA DHCP6 running on PID {{ kea6_status.response.arguments.pid }}

  # an example for requests modifying state
  - name: Remove existing leases for {{ ipaddr }}, if any
    kea_command:
      command: lease4-del
      arguments:
        ip-address: "{{ ipaddr }}"
      rv_changed: [0]
      rv_unchanged: [3]
  - name: Add DHCP lease for {{ ipaddr }}
    kea_command:
      command: lease4-add
      arguments:
        ip-address: "{{ ipaddr }}"
        hw-address: "{{ hwaddr }}"
      rv_changed: [0]

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

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

Ключ	Описание
response словарь	Ответ сервера в формате JSON. Возвращается: если доступно

Авторы

Thorsten Glaser (@mirabilos)

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

© 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/kea_command_module.html