Spec-Zone.ru › Ansible

telekom_mms.icinga_director.icinga_service_apply модуль – Управление правилами применения сервисов в Icinga2

Примечание

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

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

Для установки используйте: ansible-galaxy collection install telekom_mms.icinga_director.

Для использования в плейбуке укажите: telekom_mms.icinga_director.icinga_service_apply.

Введено в telekom_mms.icinga_director 1.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры

Обзор

  • Добавить или удалить правило применения сервиса в Icinga2 через API директора.

Параметры

Параметр

Комментарии

append

boolean

added in telekom_mms.icinga_director 1.25.0

Не перезаписывать весь объект, а добавлять определенные свойства.

Примечание - Добавление к существующим переменным, импортам или любому другому списку/словарю невозможно. Вы должны перезаписать полный список/словарь.

Примечание - Переменные, установленные по умолчанию, также будут применены, даже если не установлены.

Варианты:

  • false
  • true

apply_for

string

Вычисляет правило применения для всех объектов с указанным пользовательским атрибутом.

Например, выбор «host.vars.custom_attr» создаст «for (config in host.vars.array_var)», где «config» будет доступен через «$config$».

Примечание - подходят только пользовательские переменные типа «Массив».

assign_filter

string

Фильтр, в котором будет действовать правило применения сервиса.

check_command

string

added in telekom_mms.icinga_director 1.7.0

Определение команды проверки.

check_interval

string

Ваш регулярный интервал проверки.

check_period

string

Имя временного периода, определяющего, когда этот объект должен контролироваться. По умолчанию не ограничено.

check_timeout

string

Время ожидания команды проверки в секундах. Перезаписывает атрибут времени ожидания CheckCommand.

client_cert

path

Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL.

Этот файл может также включать ключ, и если ключ включен, client_key не требуется.

client_key

path

Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL.

Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется.

command_endpoint

string

Хост, на котором должен выполняться сервис.

display_name

string

Альтернативное отображаемое имя правила применения сервиса.

enable_active_checks

boolean

Следует ли активно проверять этот объект.

Варианты:

  • false
  • true

enable_event_handler

boolean

Следует ли включать обработчики событий для этого объекта.

Варианты:

  • false
  • true

enable_notifications

boolean

Следует ли отправлять уведомления для этого объекта.

Варианты:

  • false
  • true

enable_passive_checks

boolean

Следует ли принимать результаты пассивной проверки для этого объекта.

Варианты:

  • false
  • true

enable_perfdata

boolean

Следует ли обрабатывать данные производительности, предоставляемые этим объектом.

Варианты:

  • false
  • true

event_command

string

Команда события для сервиса, которая вызывается при каждом выполнении проверки, если одно из этих условий совпадает

Сервис находится в мягком состоянии

Состояние сервиса меняется на жесткое состояние

Состояние сервиса восстанавливается из мягкого или жесткого состояния в OK/Up

force

boolean

Если yes не получают кэшированную копию.

Варианты:

  • false ← (default)
  • true

force_basic_auth

boolean

Учетные данные, указанные с помощью url_username и url_password, должны передаваться в заголовке HTTP.

Варианты:

  • false ← (default)
  • true

groups

список / элементы=строка

Группы служб, которые должны быть напрямую назначены этой службе.

Группы служб могут быть полезны по различным причинам.

Они полезны для предоставления специфичных для типа служб представлений в Icinga Web 2, как для пользовательских панелей мониторинга, так и для ограничения доступа.

Группы служб могут быть напрямую назначены отдельным службам или шаблонам служб.

По умолчанию: []

http_agent

строка

Заголовок для идентификации, обычно отображается в журналах веб-сервера.

По умолчанию: "ansible-httpget"

imports

список / элементы=строка

Импортируемые шаблоны, добавьте столько, сколько вам нужно.

Обратите внимание, что порядок имеет значение при импорте свойств из нескольких шаблонов — последняя версия имеет приоритет.

max_check_attempts

строка

Определяет, после скольки попыток проверки достигается новое жёсткое состояние.

notes

строка

Дополнительные заметки для этого объекта.

notes_url

строка

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

Разделяйте несколько URL таким образом: “’http://url1’ ‘http://url2’”.

Максимальная длина — 255 символов.

object_name

псевдонимы: имя

строка / обязательно

Имя правила применения Icinga службы.

retry_interval

строка

Интервал повторных попыток, применяется после изменения состояния, если не достигнуто новое жёсткое состояние.

state

строка

Состояние функции применения.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

url

строка / обязательно

URL HTTP, HTTPS или FTP в формате (http|https|ftp)://[пользователь[:пароль]]@хост.домен[:порт]/путь

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

словарь

Пользовательские свойства правила применения службы.

По умолчанию: {}

Примечания

Примечание

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

Примеры

- name: Add service apply rule to icinga
  telekom_mms.icinga_director.icinga_service_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "SERVICE_dummy"
    assign_filter: 'host.name="foohost"'
    check_command: hostalive
    display_name: "dummy process"
    check_interval: "10m"
    check_period: "24/7"
    check_timeout: "1m"
    enable_active_checks: true
    enable_event_handler: true
    enable_notifications: true
    enable_passive_checks: false
    enable_perfdata: false
    event_command: restart_httpd
    max_check_attempts: "5"
    retry_interval: "3m"
    imports:
      - fooservicetemplate
    groups:
      - fooservicegroup
    vars:
      http_address: "$address$"
      http_port: "9080"
      http_uri: "/ready"
      http_string: "Ready"
      http_expect: "Yes"

- name: Add service apply rule with command_endpoint
  telekom_mms.icinga_director.icinga_service_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "SERVICE_dummy"
    assign_filter: 'host.name="foohost"'
    check_command: hostalive
    display_name: "dummy process"
    check_interval: "10m"
    check_period: "24/7"
    check_timeout: "1m"
    enable_active_checks: true
    enable_event_handler: true
    enable_notifications: true
    enable_passive_checks: false
    event_command: restart_httpd
    max_check_attempts: "5"
    retry_interval: "3m"
    command_endpoint: "fooendpoint"
    imports:
      - fooservicetemplate
    groups:
      - fooservicegroup

- name: Update service apply rule with command_endpoint
  telekom_mms.icinga_director.icinga_service_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "SERVICE_dummy"
    enable_perfdata: true
    append: true

Авторы

  • Sebastian Gumprich (@rndmh3ro)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API