Spec-Zone.ru › Ansible

Модуль telekom_mms.icinga_director.icinga_service_apply — управление правилами применения сервисов в 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_apply.

Добавлено в 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

apply_for

string

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

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

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

assign_filter

string

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

check_command

string

добавлено в telekom_mms.icinga_director 1.7.0

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

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 содержит и сертификат, и ключ, этот параметр не требуется.

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 ← (по умолчанию)
  • true

force_basic_auth

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

groups

list / elements=string

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

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

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

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

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

http_agent

string

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

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

imports

list / elements=string

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

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

max_check_attempts

string

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

notes

string

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

notes_url

string

URL-адрес со ссылкой на дополнительные примечания для этого объекта.

Несколько URL-адресов указываются следующим образом: «’http://url1’ ‘http://url2’».

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

object_name

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

string / обязательный

Имя правила применения сервиса Icinga.

retry_interval

string

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

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_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

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

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

Примечания

Примечание

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

Примеры

- 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–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_apply_module.html

Spec-Zone.ru

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