Модуль telekom_mms.icinga_director.icinga_host — управление хостами в Icinga2

Примечание

Этот модуль входит в коллекцию telekom_mms.icinga_director (версия 2.5.1).

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

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

Чтобы использовать её в плейбуке, укажите: telekom_mms.icinga_director.icinga_host.

Добавлено в telekom_mms.icinga_director 1.0.0

Краткое описание
Параметры
Примечания
Примеры

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

Добавление или удаление хоста в Icinga2 через API Director.

Параметры

Параметр	Комментарии
accept_config логический добавлено в telekom_mms.icinga_director 1.9.0	Настроен ли агент на принятие конфигурации. Варианты: `false` `true`
address строка	Адрес хоста. Обычно это адрес IPv4, но может быть адресом любого типа, с которым может работать ваш плагин проверки.
address6 строка добавлено в telekom_mms.icinga_director 1.4.0	Адрес хоста IPv6. Обычно это адрес IPv6, но может быть адресом любого типа, с которым может работать ваш плагин проверки.
api_timeout целое число	Время ожидания завершения транзакции по умолчанию, в секундах. По умолчанию: `10`
append логический добавлено в telekom_mms.icinga_director 1.25.0	Не перезаписывать весь объект, а добавить указанные свойства. Примечание — невозможно добавить данные к существующим vars, imports или любому другому списку/словарю. Необходимо перезаписать весь список/словарь. Примечание — будут также применены переменные, заданные по умолчанию, даже если они не указаны. Варианты: `false` `true`
check_command строка	Имя команды проверки. Хотя в Director не обязательно задавать это значение, в хосте или шаблоне хоста всё равно необходимо указать check_command.
check_interval строка	Интервал регулярных проверок.
check_period строка	Имя временного периода, определяющего, когда следует отслеживать этот объект. По умолчанию ограничений нет.
check_timeout строка	Тайм-аут команды проверки в секундах. Переопределяет атрибут timeout объекта CheckCommand.
client_cert путь	Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён в файл, параметр `client_key` не требуется.
client_key путь	Файл в формате PEM с закрытым ключом для аутентификации SSL-клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
command_endpoint строка	Конечная точка, на которой выполняются команды.
disabled логический	Отключённые объекты не развёртываются. Варианты: `false` ← (по умолчанию) `true`
display_name строка	Альтернативное имя этого хоста. Это может быть псевдоним хоста или любая строка, помогающая пользователям идентифицировать этот хост.
enable_active_checks логический	Выполнять ли активные проверки этого объекта. Варианты: `false` `true`
enable_event_handler логический	Включить ли обработчики событий для этого объекта. Варианты: `false` `true`
enable_flapping логический	Включено ли обнаружение нестабильного состояния для этого объекта. Варианты: `false` `true`
enable_notifications логический	Отправлять ли уведомления для этого объекта. Варианты: `false` `true`
enable_passive_checks логический	Принимать ли результаты пассивных проверок для этого объекта. Варианты: `false` `true`
enable_perfdata логический	Обрабатывать ли данные о производительности, предоставленные этим объектом. Варианты: `false` `true`
event_command строка	Команда события для хоста, вызываемая при каждом выполнении проверки, если выполняется одно из следующих условий: Хост находится в мягком состоянии. Состояние хоста переходит в жёсткое состояние. Состояние хоста восстанавливается из мягкого или жёсткого состояния до OK/Up.
flapping_threshold_high строка	Верхний порог нестабильности в процентах, при превышении которого служба считается нестабильной.
flapping_threshold_low строка	Нижний порог нестабильности в процентах, ниже которого служба считается стабильной.
force логический	Если `yes`, не получать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth логический	Передавать ли учётные данные, указанные с помощью `url_username` и `url_password`, в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
groups список / элементы=строка	Группы хостов, которые следует назначить этому узлу напрямую. Группы хостов могут быть полезны по разным причинам. Можно назначать проверки служб на основе назначенных групп хостов. Они также часто используются для настройки ограниченного доступа к представлениям в Icinga Web 2. Группы хостов можно назначать отдельным хостам или шаблонам хостов напрямую. Также можно назначать группы хостов с помощью правил apply. По умолчанию: `[]`
has_agent логический добавлено в telekom_mms.icinga_director 1.9.0	Установлен ли на этом хосте агент Icinga 2. Варианты: `false` `true`
http_agent строка	Значение заголовка идентификации; обычно оно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
icon_image строка	URL-адрес значка для этого объекта. Для значков из каталога public/img/icons используйте, например, «tux.png», а для значков из шрифта значков Icinga — «cloud» (без расширения).
icon_image_alt строка	Альтернативный текст, который отображается, если указанный выше значок отсутствует.
imports список / элементы=строка	Выберите шаблон хоста. Обязательный параметр, если state имеет значение `present`. Обязательный параметр, если state имеет значение `present`.
master_should_connect логический добавлено в telekom_mms.icinga_director 1.9.0	Должен ли родительский узел (master) активно пытаться подключиться к этому агенту. Варианты: `false` `true`
max_check_attempts строка	Определяет, после какого количества попыток проверки устанавливается новое жёсткое состояние.
notes строка добавлено в telekom_mms.icinga_director 1.8.0	Дополнительные примечания для этого объекта.
notes_url строка добавлено в telekom_mms.icinga_director 1.8.0	URL-адрес дополнительных примечаний для этого объекта. Несколько URL-адресов разделяйте следующим образом: «’http://url1’ ‘http://url2’». Максимальная длина — 255 символов.
object_name псевдонимы: name строка / обязательный	Имя объекта Icinga для этого хоста. Обычно это полное доменное имя хоста, но в принципе это может быть строка любого вида. Чтобы упростить работу пользователей, настоятельно рекомендуем использовать для шаблонов понятные имена. Например, «generic-host» — неудачное имя, а «Standard Linux Server» проще понять.
retry_interval строка	Интервал повторной проверки, применяемый после смены состояния, пока не будет достигнуто следующее жёсткое состояние.
state строка	Применить состояние функции. Варианты: `"present"` ← (по умолчанию) `"absent"`
url строка / обязательный	URL-адрес HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
url_password строка	Пароль для базовой аутентификации HTTP. Если параметр `url_username` не указан, параметр `url_password` использоваться не будет.
url_username строка	Имя пользователя для базовой аутентификации HTTP. Этот параметр можно использовать без `url_password` для сайтов, допускающих пустые пароли.
use_gssapi логический добавлено в ansible-core 2.11	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python gssapi. Учётные данные для GSSAPI можно указать с помощью `url_username`/`url_password` или переменной среды GSSAPI `KRB5CCNAME`, задающей пользовательский кэш учётных данных Kerberos. Аутентификация NTLM не поддерживается, даже если установлен механизм GSSAPI для NTLM. Варианты: `false` ← (по умолчанию) `true`
use_proxy логический	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды целевых хостов. Варианты: `false` `true` ← (по умолчанию)
validate_certs логический	Если `no`, сертификаты SSL проверяться не будут. Этот параметр следует использовать только на сайтах под личным контролем, где применяются самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vars словарь	Пользовательские свойства хоста.
volatile логический	Является ли эта проверка нестабильной. Варианты: `false` `true`
zone строка	Задать зону.

Примечания

Примечание

Этот модуль поддерживает режим проверки.

Примеры

- name: Create a host in icinga
  telekom_mms.icinga_director.icinga_host:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    accept_config: true
    address: "127.0.0.1"
    address6: "::1"
    check_command: hostalive
    check_interval: 90s
    check_timeout: 60
    command_endpoint: fooendpoint
    disabled: false
    display_name: "foohost"
    enable_active_checks: true
    enable_event_handler: false
    enable_flapping: false
    enable_notifications: true
    enable_passive_checks: false
    enable_perfdata: false
    flapping_threshold_high: "30.0"
    flapping_threshold_low: "25.0"
    has_agent: true
    icon_image_alt: "alt text"
    icon_image: "http://url1"
    master_should_connect: true
    max_check_attempts: 3
    object_name: "foohost"
    retry_interval: "1m"
    volatile: false
    groups:
      - "foohostgroup"
    imports:
      - "foohosttemplate"
    vars:
      dnscheck: "no"

- name: update a host in icinga
  telekom_mms.icinga_director.icinga_host:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "foohost"
    notes: "example note"
    notes_url: "'http://url1' 'http://url2'"
    append: true

Авторы

Sebastian Gumprich (@rndmh3ro)

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

© 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/telekom_mms/icinga_director/icinga_host_module.html