Объект script

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

Скрипт

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

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

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

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

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

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

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

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

Возможные значения:
1 - action operation;
2 - manual host action;
4 - manual event action.

Поведение свойства:
- обязательно для операций создания
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 ID группы узлов сети, на которой можно запускать скрипт.

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

По умолчанию: 0.
usrgrpid ID 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-60s.

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

Поведение свойства:
- обязательно, если 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"

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

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

Свойство Тип Описание
name string Имя параметра.

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

Отладка

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

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

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

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

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