Модуль telekom_mms.icinga_director.icinga_command_template — Управление шаблонами команд в 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_command_template.

Новый в telekom_mms.icinga_director 1.1.0

Описание
Параметры
Примечания
Примеры

Описание

Добавление или удаление шаблона команды в Icinga2 через API директора.

Параметры

Параметр	Комментарии
append boolean добавлено в telekom_mms.icinga_director 1.25.0	Не перезаписывать весь объект, а добавлять определённые свойства. Примечание - Добавление к существующим переменным, импортам или любым другим спискам/словарям невозможно. Вы должны перезаписать весь список/словарь. Примечание - Переменные, установленные по умолчанию, также будут применены, даже если не установлены. Варианты: `false` `true`
arguments словарь	Аргументы шаблона команды. Каждый аргумент может быть строкой, JSON или словарем. При использовании словаря в качестве значения аргумента поддерживаются следующие свойства. `skip_key`, `repeat_key`, `required`, `order`, `description`), `set_if`, `value`. Свойство `value` может быть строкой, JSON или словарем. При использовании в качестве словаря, вы можете определить его `type` как `Function` и установить его свойство `body` как фрагмент конфигурации Icinga DSL.
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для аутентификации клиента SSL. Этот файл также может содержать ключ, и если ключ включён, `client_key` не требуется.
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации клиента SSL. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
command строка	Команда, которую должен выполнить Icinga. Абсолютные пути принимаются как предоставленные, относительные пути префиксруются «PluginDir +», допускаются аналогичные константные префиксы. Пробелы приведут к разделению пути к команде и самостоятельных аргументов. Обратите внимание, что в настоящее время мы не поддерживаем пробелы в именах и путях плагинов.
disabled boolean	Отключенные объекты не будут развернуты. Варианты: `false` ← (по умолчанию) `true`
force boolean	Если `yes`, не получать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	Указанные с `url_username` и `url_password` учетные данные должны передаваться в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
http_agent строка	Заголовок для идентификации, обычно отображается в логах веб-сервера. По умолчанию: `"ansible-httpget"`
imports список / элементы=строка	Импортируемые шаблоны, добавляйте столько, сколько нужно. Обратите внимание, что порядок имеет значение при импорте свойств из нескольких шаблонов — последний имеет приоритет. По умолчанию: `[]`
methods_execute псевдонимы: command_type строка	Команды проверки плагинов необходимы для выполнения проверок вашей инфраструктуры. Команды уведомлений используются для уведомления ваших пользователей. Команды событий позволяют запускать определённые действия при возникновении проблем. Некоторые люди используют их для механизмов автоматического исправления, таких как перезапуск служб или перезагрузка систем при определённых порогах. Варианты: `"PluginCheck"` ← (по умолчанию) `"PluginNotification"` `"PluginEvent"`
object_name псевдонимы: name строка / обязательно	Имя шаблона команды.
state строка	Состояние применяемой функции. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout строка	Необязательный таймаут команды. Допустимые значения: секунды или временные интервалы с указанным суффиксом единицы (например, 1м или 3м 30с).
url строка / обязательно	URL HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[пользователь[:пароль]]@хост.домен[:порт]/путь
url_password строка	Пароль для использования в аутентификации 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	Пользовательские свойства шаблона команды. По умолчанию: `{}`
zone string	Зона кластера Icinga. Позволяет вручную переопределить решения Директора о том, куда развернуть вашу конфигурацию. Вам следует воздержаться от этого, пока вы не получите глубокого понимания, как работает стек кластера Icinga.

Примечания

Примечание

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

Примеры

- name: Create command template
  telekom_mms.icinga_director.icinga_command_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    arguments:
      '--authpassphrase':
        value: $snmpv3_priv_key$
      '--authprotocol':
        value: $snmpv3_auth_protocol$
      '--critical':
        value: $centreon_critical$
      '--filter':
        value: $centreon_filter$
      '--hostname':
        value: $snmp_address$
      '--maxrepetitions':
        value: $centreon_maxrepetitions$
      '--mode':
        value: $centreon_mode$
      '--plugin':
        value: $centreon_plugin$
      '--privpassphrase':
        value: $snmpv3_auth_key$
      '--privprotocol':
        value: $snmpv3_priv_protocol$
      '--snmp-community':
        value: $snmp_community$
      '--snmp-timeout':
        value: $snmp_timeout$
      '--snmp-username':
        value: $snmpv3_user$
      '--snmp-version':
        value: $snmp_version$
      '--subsetleef':
        value: $centreon_subsetleef$
      '--verbose':
        set_if: $centreon_verbose$
      '--warning':
        value: $centreon_warning$
      '--dummy-arg':
        description: "dummy arg using Icinga DSL code"
        value:
          type: "Function"
          body: 'return macro("$dummy_var$")'
    command: "/opt/centreon-plugins/centreon_plugins.pl"
    command_type: "PluginCheck"
    object_name: centreon-plugins-template
    disabled: false
    vars:
      centreon_maxrepetitions: 20
      centreon_subsetleef: 20
      centreon_verbose: false
      snmp_address: $address$
      snmp_timeout: 60
      snmp_version: '2'
      snmpv3_auth_key: authkey
      snmpv3_priv_key: privkey
      snmpv3_user: user

- name: Update command template
  telekom_mms.icinga_director.icinga_command_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: centreon-plugins-template
    timeout: "2m"
    append: true

Авторы

Lars Krahl (@mmslkr)

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

© 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_command_template_module.html