Модуль community.zabbix.zabbix_script – Создание/обновление/удаление скриптов Zabbix

Примечание

Этот модуль входит в коллекцию community.zabbix (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в книге задач укажите: community.zabbix.zabbix_script.

Новая в community.zabbix 1.7.0

Описание
Требования
Параметры
Примеры

Описание

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

Требования

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

python >= 3.9

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
authtype строка	Метод аутентификации, используемый для сценариев типа SSH. Используется, если тип равен `ssh`. Варианты: `"password"` `"public_key"`
command строка	Команда для выполнения. Требуется, когда состояние равно ‘present’
confirmation строка	Текст всплывающего окна подтверждения. Всплывающее окно появится при попытке запустить сценарий из веб-интерфейса Zabbix. Используется, если область действия равна `manual_host_action` или `manual_event_action`.
description строка	Описание сценария.
execute_on строка	Место выполнения сценария. Используется, если тип равен `script`. Варианты: `"zabbix_agent"` `"zabbix_server"` `"zabbix_server_proxy"` ← (по умолчанию)
host_access строка	Права доступа к хосту, необходимые для выполнения сценария. Используется, если область действия равна `manual_host_action` или `manual_event_action`. Варианты: `"read"` ← (по умолчанию) `"write"`
host_group строка	Имя группы хостов, на которых можно выполнить сценарий. Если установлено значение “all”, сценарий будет доступен на всех группах хостов. По умолчанию: `"all"`
http_login_password строка	Пароль для базовой аутентификации.
http_login_user строка	Логин для базовой аутентификации.
menu_path строка	Папки, разделенные слешем, которые формируют навигацию по меню в интерфейсе при нажатии на хост или событие. Используется, если область действия равна `manual_host_action` или `manual_event_action`.
name строка / обязательно	Имя сценария.
parameters список / элементы=словарь	Массив параметров ввода веб-хука. Используется, если тип равен `webhook`.
name строка	Имя параметра. Требуется, когда для сценария ‘веб-хук’ указаны ‘параметры’.
value строка	Значение параметра. Поддерживает макросы. По умолчанию: `""`
password строка	Пароль, используемый для сценариев SSH с аутентификацией по паролю и сценариев Telnet. Используется, если тип равен `ssh` и authtype равен `password` или тип равен `telnet`.
port строка	Номер порта, используемый для сценариев SSH и Telnet. Используется, если тип равен `ssh` или `telnet`.
privatekey строка	Имя файла закрытого ключа, используемого для сценариев SSH с аутентификацией по открытому ключу. Используется, если тип равен `ssh` и authtype равен `public_key`.
publickey строка	Имя файла открытого ключа, используемого для сценариев SSH с аутентификацией по открытому ключу. Используется, если тип равен `ssh` и authtype равен `public_key`.
scope строка	Область действия сценария. Варианты: `"action_operation"` ← (по умолчанию) `"manual_host_action"` `"manual_event_action"`
script_timeout строка	Таймаут выполнения сценария веб-хука в секундах. Поддерживаются суффиксы времени, например, 30с, 1м. Требуется, если тип равен `webhook`. Возможные значения: 1-60с. По умолчанию: `"30s"`
script_type строка	Тип сценария. Требуется, когда состояние равно ‘present’. Варианты: `"script"` `"ipmi"` `"ssh"` `"telnet"` `"webhook"`

state string	Состояние скрипта. Выбор: `"present"` ← (по умолчанию) `"absent"`
user_group string	Имя группы пользователей, которой разрешено выполнять скрипт. Если установлено значение «all», скрипт будет доступен для всех групп пользователей. Используется, если область действия равна `manual_host_action` или `manual_event_action`. По умолчанию: `"all"`
username string	Имя пользователя, используемое для аутентификации. Используется, если тип равен `ssh` или `telnet`

Примеры

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

- name: test - Create new action operation script to execute webhook
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: "zabbixeu"  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_script:
    name: Test action operation script
    scope: action_operation
    script_type: webhook
    command: "return 0"
    description: "Test action operation script"
    state: present

Авторы

Евгеній Юрченко (@BGmot)

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

© 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/community/zabbix/zabbix_script_module.html