Объект script

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

Скрипт

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

Property Type Description
scriptid ID ID скрипта.

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

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

Допустимые значения, если scope установлен в "action operation":
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

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

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

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

Допустимые значения:
1 - action operation;
2 - manual host action;
4 - manual event action.

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

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

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

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

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

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

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

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

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

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

Property behavior:
- поддерживается, если type установлен в "SSH" или "TELNET"
groupid ID ID группы узлов сети, на которых можно запускать скрипт.

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

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

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

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

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

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

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

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

Допустимые значения: 1-60s.

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

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

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

Property behavior:
- обязательно, если type установлен в "URL"
new_window integer Открывать URL в новом окне.

Допустимые значения:
0 - Нет;
1 - (по умолчанию) Да.

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

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

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

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

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

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

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

Property behavior:
- поддерживается, если 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 Сообщение журнала.