Объект script

Следующие объекты напрямую связаны с API script.

Скрипт

Объект скрипта имеет следующие свойства.

Свойство Тип Описание
scriptid ID Идентификатор скрипта.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
name string Имя скрипта.

Поведение свойства:
- обязательно для операций создания
type integer Тип скрипта.

Возможные значения, если scope имеет значение "action operation":
0 - скрипт;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - вебхук.

Возможные значения, если scope имеет значение "manual host action" или "manual event action":
6 - URL.

Поведение свойства:
- обязательно для операций создания
command string Команда для выполнения.

Поведение свойства:
- обязательно, если type имеет значение "Script", "IPMI", "SSH", "TELNET" или "Webhook"
scope integer Область действия скрипта.

Возможные значения:
1 - операция действия;
2 - ручное действие над узлом сети;
4 - ручное действие над событием.

Поведение свойства:
- обязательно для операций создания
execute_on integer Где выполнять скрипт.

Возможные значения:
0 - выполнять на агенте Zabbix;
1 - выполнять на сервере Zabbix. Поддерживается только если на сервере Zabbix включено выполнение глобальных скриптов;
2 - (по умолчанию) выполнять на сервере Zabbix или прокси.

Поведение свойства:
- поддерживается, если type имеет значение "Script"
menu_path string Папки, разделенные косой чертой, образующие навигацию в виде меню в веб-интерфейсе при нажатии на узел сети или событие.

Поведение свойства:
- поддерживается, если scope имеет значение "manual host action" или "manual event action"
authtype integer Метод аутентификации, используемый для скриптов типа SSH.

Возможные значения:
0 - пароль;
1 - открытый ключ.

Поведение свойства:
- поддерживается, если type имеет значение "SSH"
username string Имя пользователя, используемое для аутентификации.

Поведение свойства:
- обязательно, если type имеет значение "SSH" или "TELNET"
password string Пароль, используемый для скриптов SSH с аутентификацией по паролю и для скриптов TELNET.

Поведение свойства:
- поддерживается, если type имеет значение "SSH", а authtype имеет значение "password", или если type имеет значение "TELNET"
publickey string Имя файла открытого ключа, используемого для скриптов SSH с аутентификацией по открытому ключу.

Поведение свойства:
- обязательно, если type имеет значение "SSH", а authtype имеет значение "public key"
privatekey string Имя файла закрытого ключа, используемого для скриптов SSH с аутентификацией по открытому ключу.

Поведение свойства:
- обязательно, если type имеет значение "SSH", а authtype имеет значение "public key"
port string Номер порта, используемый для скриптов SSH и TELNET.

Поведение свойства:
- поддерживается, если type имеет значение "SSH" или "TELNET"
groupid ID Идентификатор группы узлов сети, в которой можно выполнять скрипт.

Если задано значение "0", скрипт будет доступен во всех группах узлов сети.

По умолчанию: 0.
usrgrpid ID Идентификатор группы пользователей, которой будет разрешено выполнять скрипт.

Если задано значение "0", скрипт будет доступен всем группам пользователей.

По умолчанию: 0.

Поведение свойства:
- поддерживается, если scope имеет значение "manual host action" или "manual event action"
host_access integer Права доступа к узлу сети, необходимые для выполнения скрипта.

Возможные значения:
2 - (по умолчанию) чтение;
3 - запись.

Поведение свойства:
- поддерживается, если scope имеет значение "manual host action" или "manual event action"
confirmation string Текст всплывающего окна подтверждения.
Всплывающее окно появится при попытке выполнить скрипт из веб-интерфейса Zabbix.

Поведение свойства:
- поддерживается, если scope имеет значение "manual host action" или "manual event action"
timeout string Тайм-аут выполнения скрипта вебхука в секундах. Поддерживаются суффиксы времени (например, 30s, 1m).

Возможные значения: 1-60 с.

По умолчанию: 30 с.

Поведение свойства:
- обязательно, если type имеет значение "Webhook"
parameters array Массив входных параметров вебхука.

Поведение свойства:
- поддерживается, если type имеет значение "Webhook"
description string Описание скрипта.
url string URL, заданный пользователем.

Поведение свойства:
- обязательно, если type имеет значение "URL"
new_window integer Открывать URL в новом окне.

Возможные значения:
0 - нет;
1 - (по умолчанию) да.

Поведение свойства:
- поддерживается, если type имеет значение "URL"
manualinput integer Указывает, принимает ли скрипт ввод, предоставленный пользователем.

Возможные значения:
0 - (по умолчанию) отключено;
1 - включено;

Поведение свойства:
- поддерживается, если scope имеет значение "manual host action" или "manual event action"
manualinput_prompt string Текст запроса ручного ввода.

Поведение свойства:
- обязательно, если manualinput имеет значение "Enabled"
manualinput_validator string Строковое поле, используемое для проверки ввода, предоставленного пользователем. Строка содержит регулярное выражение или набор значений, разделенных запятыми.

Поведение свойства:
- обязательно, если manualinput имеет значение "Enabled"
manualinput_validator_type integer Определяет ожидаемый тип пользовательского ввода.

Возможные значения:
0 - (по умолчанию) строка. Указывает, что manualinput_validator следует рассматривать как регулярное выражение;
1 - список. Указывает, что manualinput_validator следует рассматривать как список возможных значений, разделенных запятыми.

Поведение свойства:
- поддерживается, если manualinput имеет значение "Enabled"
manualinput_default_value string Значение по умолчанию для автоматического заполнения пользовательского ввода.

Поведение свойства:
- поддерживается, если manualinput_validator_type имеет значение "String"

Параметры вебхука

Параметры, передаваемые в скрипт вебхука при его вызове, имеют следующие свойства.

Property Type Description
name string Имя параметра.

Поведение свойства:
- required
value string Значение параметра. Поддерживает макросы.

Отладка

Отладочная информация о выполненном скрипте вебхука. Объект debug имеет следующие свойства.

Property Type Description
logs array Массив записей журнала.
ms string Длительность выполнения скрипта в миллисекундах.

Запись журнала

Объект записи журнала имеет следующие свойства.

Property Type Description
level integer Уровень журнала.
ms string Время, прошедшее в миллисекундах с момента запуска скрипта до добавления записи журнала.
message string Сообщение журнала.