telekom_mms.icinga_director.icinga_service module – Управление службами в 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_service.

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

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

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

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

Параметры

Параметр	Комментарии
api_timeout integer	Время ожидания завершения транзакции по умолчанию, в секундах. По умолчанию: `10`
append boolean добавлено в telekom_mms.icinga_director 1.25.0	Не перезаписывать объект целиком, а добавлять заданные свойства. Примечание — Добавлять элементы в существующие vars, imports или любые другие списки/словари невозможно. Необходимо перезаписать список/словарь целиком. Примечание — Также будут применены переменные, заданные по умолчанию, даже если они не указаны. Варианты: `false` `true`
check_command string	Определение команды проверки.
check_interval string	Регулярный интервал проверки.
check_period string	Название временного периода, определяющего, когда следует отслеживать этот объект. По умолчанию ограничений нет.
check_timeout string	Время ожидания выполнения команды проверки в секундах. Переопределяет атрибут timeout объекта CheckCommand.
client_cert path	Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён в файл, параметр `client_key` не требуется.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
disabled boolean	Отключённые объекты не будут развёрнуты. Варианты: `false` ← (по умолчанию) `true`
display_name string	Альтернативное название службы.
enable_active_checks boolean	Следует ли активно проверять этот объект. Варианты: `false` `true`
enable_event_handler boolean	Следует ли включить обработчики событий для этого объекта. Варианты: `false` `true`
enable_flapping boolean	Включено ли для этого объекта обнаружение нестабильного состояния. Варианты: `false` `true`
enable_notifications boolean	Следует ли отправлять уведомления об этом объекте. Варианты: `false` `true`
enable_passive_checks boolean	Следует ли принимать результаты пассивных проверок для этого объекта. Варианты: `false` `true`
enable_perfdata boolean	Следует ли обрабатывать данные о производительности, предоставленные этим объектом. Варианты: `false` `true`
event_command string	Команда обработки события для службы, вызываемая при каждом выполнении проверки, если выполняется одно из следующих условий Служба находится в мягком состоянии Состояние службы меняется на жёсткое Служба восстанавливается из мягкого или жёсткого состояния до OK/Up
flapping_threshold_high string	Верхний порог нестабильности в процентах, при превышении которого служба считается нестабильной
flapping_threshold_low string	Нижний порог нестабильности в процентах, ниже которого служба считается стабильной
force boolean	Если `yes`, не получать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	Передавать учётные данные, указанные в `url_username` и `url_password`, в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
groups list / elements=string	Группы служб, которые следует напрямую назначить этой службе. Группы служб могут быть полезны по разным причинам. Они позволяют создавать в Icinga Web 2 представления для определённых типов служб — например, для пользовательских панелей мониторинга или для настройки ограничений доступа. Группы служб можно напрямую назначать отдельным службам или шаблонам служб. По умолчанию: `[]`
host string	Выберите узел, которому следует назначить эту отдельную службу. Это поле обязательно, если параметр `service_set` не задан.
http_agent string	Значение заголовка для идентификации; обычно оно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
icon_image string	URL-адрес значка для этого объекта. Для значков из public/img/icons укажите, например, «tux.png», а для значков из шрифта значков Icinga — «cloud» (без расширения).
icon_image_alt string	Альтернативный текст, отображаемый, если указанный выше значок отсутствует.
imports list / elements=string	Импортируемые шаблоны; можно указать любое их количество. Обратите внимание: при импорте свойств из нескольких шаблонов важен порядок — последнее значение имеет приоритет. По умолчанию: `[]`
max_check_attempts string	Определяет, после какого количества попыток проверки будет установлено новое жёсткое состояние.
notes string добавлено в telekom_mms.icinga_director 1.8.0	Дополнительные примечания к этому объекту.
notes_url string добавлено в telekom_mms.icinga_director 1.8.0	URL-адрес дополнительных примечаний к этому объекту. Несколько URL-адресов указываются следующим образом: «’http://url1’ ‘http://url2’». Максимальная длина — 255 символов.
object_name псевдонимы: name string / обязательный	Название службы.
retry_interval string	Интервал повторной проверки, применяемый после изменения состояния, если ещё не достигнуто следующее жёсткое состояние.
service_set string добавлено в telekom_mms.icinga_director 1.29.0	Выберите название набора служб, которому следует назначить эту отдельную службу. Это поле обязательно, если параметр `host` не задан.
state string	Применить состояние функции. Варианты: `"present"` ← (по умолчанию) `"absent"`
url string / обязательный	URL-адрес HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
url_password string	Пароль для базовой аутентификации HTTP. Если параметр `url_username` не указан, параметр `url_password` использоваться не будет.
url_username string	Имя пользователя для базовой аутентификации HTTP. Этот параметр можно использовать без `url_password` для сайтов, допускающих пустые пароли.
use_agent boolean	Следует ли выполнять команду проверки этой службы на агенте Icinga. Варианты: `false` `true`
use_gssapi boolean добавлено в 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 boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `no`, SSL-сертификаты проверяться не будут. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)
vars dictionary	Пользовательские свойства службы. По умолчанию: `{}`
volatile boolean	Является ли эта проверка волатильной. Варианты: `false` `true`

Примечания

Примечание

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

Примеры

- name: Create service
  tags: service
  telekom_mms.icinga_director.icinga_service:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "foo service"
    display_name: "foo service"
    check_command: hostalive
    use_agent: false
    host: foohost
    vars:
      procs_argument: consul
      procs_critical: '1:'
      procs_warning: '1:'

- name: Update service
  tags: service
  telekom_mms.icinga_director.icinga_service:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "foo service"
    display_name: "foo service"
    host: foohost
    notes: "example note"
    notes_url: "'http://url1' 'http://url2'"
    append: true

- name: Create serviceset service
  telekom_mms.icinga_director.icinga_service:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "foo service serviceset"
    service_set: "foo_serviceset"

Авторы

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_service_module.html