zabbix_action – Создание/удаление/обновление действий Zabbix

Новая версия с 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Этот модуль позволяет создавать, изменять и удалять действия Zabbix.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

zabbix-api

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
acknowledge_default_message -			Текст сообщения операции обновления (известной как "Acknowledge operation" до Zabbix 4.0). Работает только с >= Zabbix 3.4
acknowledge_default_subject -			Тема сообщения операции обновления (известной как "Acknowledge operation" до Zabbix 4.0). Работает только с >= Zabbix 3.4
acknowledge_operations список			Список операций подтверждения. `Suboptions` аналогичны тем, что для operations. Работает только с >= Zabbix 3.4
conditions список			Список словарей условий для оценки. Дополнительную информацию о подвариантах этого параметра можно найти в документации API Zabbix по адресу https://www.zabbix.com/documentation/3.4/manual/api/reference/action/object#action_filter_condition
	formulaid -		Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Обязательно для фильтров пользовательских выражений.
	operator -	Варианты: = <> like not like in >= <= not in	Оператор условия. Когда type установлен на `time_period`, варианты - `in`, `not in`.
	type -	Варианты: группа_хостов хост триггер имя_триггера серьёзность_триггера временной_период шаблон_хоста приложение статус_обслуживания тег_события значение_тега_события IP_хоста тип_обнаруженной_службы порт_обнаруженной_службы статус_обнаружения длительность_простоя_или_рабочего_времени полученное_значение правило_обнаружения проверка_обнаружения прокси объект_обнаружения прокси имя_хоста метаданные_хоста группа_хостов хост шаблон_хоста приложение тип_события	Тип (метка) условия.
	value -		Значение для сравнения. Когда type установлен на `discovery_status`, варианты - `up`, `down`, `discovered`, `lost`. Когда type установлен на `discovery_object`, варианты - `host`, `service`. Когда type установлен на `event_type`, варианты - `item in not supported state`, `item in normal state`, `LLD rule in not supported state`, `LLD rule in normal state`, `trigger in unknown state`, `trigger in normal state`. Когда type установлен на `trigger_severity`, варианты (регистронезависимые) - `not classified`, `information`, `warning`, `average`, `high`, `disaster`, независимо от изменения отображаемых пользователю имен в Zabbix. По умолчанию `not classified`, если опущено. Помимо вышеперечисленного, обычно это имя объекта или строка для сравнения.
default_message -			Текст сообщения по умолчанию для проблемы.
default_subject -			Тема сообщения по умолчанию для проблемы.
esc_period -		По умолчанию: "60"	Продолжительность шага по умолчанию. Должно быть больше 60 секунд. Принимает секунды, единицы измерения времени с суффиксом и пользовательские макросы.
eval_type -		Варианты: andor and or custom_expression	Метод оценки условия фильтра. По умолчанию `andor` если условий меньше 2 или formula не указан. По умолчанию `custom_expression` если formula указан.
event_source - / обязательно		Варианты: триггер обнаружение авторегистрация внутренний	Тип событий, которые будет обрабатывать действие.
formula -			Пользовательское выражение, используемое для оценки условий фильтров с пользовательским выражением. Выражение должно содержать идентификаторы, которые ссылаются на конкретные условия фильтра по его formulaid. Идентификаторы, используемые в выражении, должны точно соответствовать тем, которые определены в условиях фильтра. Ни одно условие не может остаться неиспользуемым или опущенным. Обязательно для фильтров пользовательских выражений.
http_login_password строка добавлено в 2.1			Пароль Basic Auth.
http_login_user строка / обязательно добавлено в 2.1			Логин Basic Auth.
login_password строка / обязательно			Пароль пользователя Zabbix.
login_user строка / обязательно			Имя пользователя Zabbix.
name - / обязательно			Имя действия
operations список			Список операций действия.
	command -		Команда для выполнения. Обязательно, когда type=remote_command и command_type!=global_script.
	command_type -	Варианты: custom_script ipmi ssh telnet global_script	Тип команды операции. Обязательно, когда type=remote_command.
	esc_period -	По умолчанию: "0s"	Продолжительность шага эскалации в секундах. Должно быть больше 60 секунд. Принимает секунды, единицы измерения времени с суффиксом и пользовательские макросы. Если установлено 0 или 0s, будет использоваться период эскалации действия по умолчанию.
	esc_step_from -	По умолчанию: 1	Шаг для начала эскалации.
	esc_step_to -	По умолчанию: 1	Шаг для завершения эскалации.
	execute_on -	Варианты: агент сервер прокси	Целевой объект, на котором будет выполнена команда пользовательского скрипта. Обязательно, когда type=remote_command и command_type=custom_script.
	host_groups список		Список групп хостов, к которым должен быть добавлен хост. Обязательно, когда type=add_to_host_group или type=remove_from_host_group.
	inventory -		Режим инвентаризации хостов. Обязательно, когда type=set_host_inventory_mode.
	media_type -	По умолчанию: "all"	Тип носителя, который будет использоваться для отправки сообщения. Установлено в `all` для всех типов носителей.
	message -		Текст сообщения операции. Будет проверять «сообщение по умолчанию» и использовать текст из default_message, если это и default_subject не указаны.

	operation_condition строка	Варианты: acknowledged not_acknowledged	Объект условия действия операции определяет условие, которое должно быть выполнено для выполнения текущей операции.
	password -		Пароль, используемый для аутентификации. Требуется, когда type=remote_command и command_type в [ssh, telnet].
	port -		Номер порта, используемый для аутентификации. Требуется, когда type=remote_command и command_type в [ssh, telnet].
	run_on_groups -		Группы хостов, на которых необходимо выполнить удалённые команды. Требуется, когда type=remote_command, если run_on_hosts не задано.
	run_on_hosts -		Хосты, на которых необходимо выполнить удалённые команды. Требуется, когда type=remote_command, если run_on_groups не задано. Если задано значение 0, команда будет выполнена на текущем хосте.
	script_name -		Имя скрипта, используемого для глобальных команд скрипта. Требуется, когда type=remote_command и command_type=global_script.
	send_to_groups список		Группы пользователей, которым нужно отправить сообщения.
	send_to_users список		Пользователи (имена пользователей или псевдонимы) для отправки сообщений.
	ssh_auth_type -	Варианты: password public_key	Метод аутентификации, используемый для команд SSH. Требуется, когда type=remote_command и command_type=ssh.
	ssh_privatekey_file -		Имя файла закрытого ключа, используемого для команд SSH с аутентификацией с помощью открытого ключа. Требуется, когда type=remote_command и command_type=ssh.
	ssh_publickey_file -		Имя файла открытого ключа, используемого для команд SSH с аутентификацией с помощью открытого ключа. Требуется, когда type=remote_command и command_type=ssh.
	subject -		Тема сообщения об операции. Будет проверять «сообщение по умолчанию» и использовать текст из default_subject, если это и default_subject не указаны
	templates список		Список шаблонов, к которым должен быть привязан хост. Требуется, когда type=link_to_template или type=unlink_from_template.
	type -	Варианты: send_message remote_command add_host remove_host add_to_host_group remove_from_host_group link_to_template unlink_from_template enable_host disable_host set_host_inventory_mode	Тип операции.
	username -		Имя пользователя, используемое для аутентификации. Требуется, когда type=remote_command и command_type в [ssh, telnet].
pause_in_maintenance булево		Варианты: no да ←	Остановить эскалацию во время периодов технического обслуживания или нет. Можно использовать при event_source=trigger.
recovery_default_message -			Текст сообщения о восстановлении. Работает только с >= Zabbix 3.2
recovery_default_subject -			Тема сообщения о восстановлении. Работает только с >= Zabbix 3.2
recovery_operations список			Список операций восстановления. `Suboptions` такие же, как для operations. Работает только с >= Zabbix 3.2
server_url строка / обязательно			URL сервера Zabbix с протоколом (http или https). `url` — псевдоним для `server_url`. псевдонимы: url
state -		Варианты: present ← absent	Состояние действия. При `present`, будет создано действие, если оно не существует, или будет обновлено действие, если связанные данные отличаются. При `absent`, действие будет удалено, если оно существует.
status -		Варианты: enabled ← disabled	Статус действия.
timeout целое число		По умолчанию: 10	Таймаут запроса API (секунды).
validate_certs булево добавлен в 2.5		Варианты: no да ←	Если установлено значение False, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяемые сертификаты.

Примечания

Примечание

Поддерживается только Zabbix >= 3.0.

Примеры

# Trigger action with only one condition
- name: Deploy trigger action
  zabbix_action:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: Admin
    login_password: secret
    name: "Send alerts to Admin"
    event_source: 'trigger'
    state: present
    status: enabled
    conditions:
      - type: 'trigger_severity'
        operator: '>='
        value: 'Information'
    operations:
      - type: send_message
        subject: "Something bad is happening"
        message: "Come on, guys do something"
        media_type: 'Email'
        send_to_users:
          - 'Admin'

# Trigger action with multiple conditions and operations
- name: Deploy trigger action
  zabbix_action:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: Admin
    login_password: secret
    name: "Send alerts to Admin"
    event_source: 'trigger'
    state: present
    status: enabled
    conditions:
      - type: 'trigger_name'
        operator: 'like'
        value: 'Zabbix agent is unreachable'
        formulaid: A
      - type: 'trigger_severity'
        operator: '>='
        value: 'disaster'
        formulaid: B
    formula: A or B
    operations:
      - type: send_message
        media_type: 'Email'
        send_to_users:
          - 'Admin'
      - type: remote_command
        command: 'systemctl restart zabbix-agent'
        run_on_hosts:
          - 0

# Trigger action with recovery and acknowledge operations
- name: Deploy trigger action
  zabbix_action:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: Admin
    login_password: secret
    name: "Send alerts to Admin"
    event_source: 'trigger'
    state: present
    status: enabled
    conditions:
      - type: 'trigger_severity'
        operator: '>='
        value: 'Information'
    operations:
      - type: send_message
        subject: "Something bad is happening"
        message: "Come on, guys do something"
        media_type: 'Email'
        send_to_users:
          - 'Admin'
    recovery_operations:
      - type: send_message
        subject: "Host is down"
        message: "Come on, guys do something"
        media_type: 'Email'
        send_to_users:
          - 'Admin'
    acknowledge_operations:
      - type: send_message
        media_type: 'Email'
        send_to_users:
          - 'Admin'

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое	Описание
msg строка	success	Результат операции Пример: Действие удалено: Регистрация web-серверов, ID: 0001

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ruben Tsirunyan (@rubentsirunyan)
Ruben Harutyunov (@K-DOT)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/zabbix_action_module.html