Скрипты
Обзор
В разделе Alerts > Scripts можно настраивать и поддерживать пользовательские глобальные скрипты.
Это меню доступно только пользователям типа SuperAdmin.
Глобальные скрипты, в зависимости от настроенной области применения, а также прав пользователя, доступны для выполнения:
- Из меню узла сети в различных разделах веб-интерфейса (Dashboard, Problems, Latest data, Maps и т. д.).
- Из меню события.
- Могут запускаться как операция действия.
Скрипты выполняются на агенте Zabbix, сервере Zabbix (прокси) или только на сервере Zabbix См. также Command execution.
И на агенте Zabbix, и на прокси Zabbix удаленные скрипты по умолчанию отключены. Их можно включить следующим образом:
- Для удаленных команд, выполняемых на агенте Zabbix:
- добавьте параметр
AllowKey=system.run[<command>,*]для каждой разрешенной команды в конфигурации агента;*означает режим ожидания и без ожидания;
- добавьте параметр
- Для удаленных команд, выполняемых на прокси Zabbix:
- Внимание: нет необходимости включать удаленные команды на прокси Zabbix, если удаленные команды выполняются на агенте Zabbix, который контролируется прокси Zabbix. Однако, если требуется выполнять удаленные команды на прокси Zabbix, установите параметр EnableRemoteCommands в значение '1' в конфигурации прокси.
Выполнение глобальных скриптов на сервере Zabbix можно отключить, установив EnableGlobalScripts=0 в конфигурации сервера.
Для новых установок, начиная с Zabbix 7.0, выполнение глобальных скриптов на сервере Zabbix по умолчанию отключено.
Отображается список существующих скриптов с их подробностями.
Отображаемые данные:
| Column | Description |
|---|---|
| Name | Имя скрипта. При нажатии на имя скрипта открывается форма настройки. |
| Scope | Область применения скрипта - операция действия, ручное действие для узла сети или ручное действие для события. Этот параметр определяет, где доступен скрипт - в удаленных командах операций действия, из меню узла сети или из меню события соответственно. |
| Used in actions | Отображаются все действия, в которых используется скрипт, с указанием общего числа этих действий. При нажатии на имя действия открывается форма настройки действия. Если у пользователя нет прав на действие, имя не является ссылкой. |
| Type | Отображается тип скрипта - команда URL, Webhook, Script, SSH, Telnet или IPMI. |
| Execute on | Показывает, будет ли скрипт выполняться на агенте Zabbix, прокси Zabbix или сервере, либо только на сервере Zabbix. |
| Commands | Отображаются все команды, которые будут выполнены в рамках скрипта. Для вебхуков здесь ничего не отображается. |
| User group | Отображается группа пользователей, для которой доступен скрипт (или All для всех групп пользователей). |
| Host group | Отображается группа узлов сети, для которой доступен скрипт (или All для всех групп узлов сети). |
| Host access | Отображается уровень прав для группы узлов сети - Read или Write. Доступ к выполнению скрипта будут иметь только пользователи с требуемым уровнем прав. |
Чтобы настроить новый скрипт, нажмите кнопку Create script в правом верхнем углу.
Параметры массового редактирования
Кнопка под списком предлагает один вариант массового редактирования:
- Удалить - удалить скрипты
Чтобы использовать этот вариант, отметьте флажки перед соответствующими скриптами и нажмите Удалить.
Использование фильтра
Вы можете использовать фильтр, чтобы отображать только те скрипты, которые вас интересуют. Для повышения производительности поиска данные ищутся с неразрешенными макросами.
Ссылка Filter доступна над списком скриптов. Если вы нажмете ее, станет доступен фильтр, с помощью которого можно фильтровать скрипты по имени и области применения.
Настройка глобального скрипта
Рекомендуется использовать функции макросов вместо обычных макросов в глобальных скриптах для повышения безопасности, так как макросы не экранируются автоматически.
Атрибуты скрипта:
| Parameter | Description | |
|---|---|---|
| Name | Уникальное имя скрипта. Например, Clear /tmp filesystem |
|
| Scope | Область применения скрипта - операция действия, ручное действие для узла сети или ручное действие для события. Этот параметр определяет, где можно использовать скрипт - в удаленных командах операций, из меню узла сети или из меню события соответственно. Если установить область применения в значение 'Action operation', скрипт будет доступен всем пользователям с доступом к Alerts > Actions. Если скрипт фактически используется в действии, изменить его область применения с 'action operation' нельзя. Поддержка макросов Область применения влияет на набор доступных макросов. Например, макросы, связанные с пользователем ( {USER.*}), поддерживаются в скриптах, чтобы можно было передавать информацию о пользователе, запустившем скрипт. Однако они не поддерживаются, если область применения скрипта - operation action, так как операции действия выполняются автоматически.Макрос {MANUALINPUT} позволяет указать ввод вручную во время выполнения скрипта. Он поддерживается для скриптов ручного действия для узла сети и ручного действия для события. Чтобы узнать, какие еще макросы поддерживаются, выполните поиск по строкам 'Trigger-based notifications and commands/Trigger-based commands', 'Manual host action scripts' и 'Manual event action scripts' в таблице supported macro. Обратите внимание: если макрос может быть преобразован в значение с пробелами (например, имя узла сети), не забудьте при необходимости заключить его в кавычки. |
|
| Menu path | Требуемый путь меню к скрипту. Например, Default или Default/ отобразит скрипт в соответствующем каталоге. Меню могут быть вложенными, например, Main menu/Sub menu1/Sub menu2. При доступе к скриптам через меню узла сети/события в разделах мониторинга они будут организованы в соответствии с указанными каталогами.Это поле отображается только если в качестве Scope выбрано 'Manual host action' или 'Manual event action'. |
|
| Type | Нажмите соответствующую кнопку, чтобы выбрать тип скрипта: URL, Webhook, Script, SSH, Telnet или команду IPMI. Тип URL доступен только если в качестве Scope выбрано 'Manual host action' или 'Manual event action'. |
|
| Script type: URL | ||
| URL | Укажите URL для быстрого доступа из меню узла сети или меню события. Поддерживаются макросы и пользовательские макросы пользователя. Поддержка макросов зависит от области применения скрипта (см. Scope выше). Используйте макрос {MANUALINPUT} в этом поле, чтобы можно было указать ввод вручную во время выполнения скрипта, например: http://{MANUALINPUT}/zabbix/zabbix.php?action=dashboard.viewЗначения макросов не должны быть URL-кодированы. |
|
| Open in new window | Определяет, следует ли открывать URL в новой вкладке браузера или в той же. | |
| Script type: Webhook | ||
| Parameters | Укажите переменные вебхука в виде пар атрибут-значение. См. также: конфигурация медиа-типа Webhook. В значениях параметров поддерживаются макросы и пользовательские макросы пользователя. Поддержка макросов зависит от области применения скрипта (см. Scope выше). |
|
| Script | Введите код JavaScript в модальном редакторе, который открывается при щелчке в поле параметра или по значку карандаша рядом с ним. Поддержка макросов зависит от области применения скрипта (см. Scope выше). См. также: конфигурация медиа-типа Webhook, Additional Javascript objects. |
|
| Timeout | Тайм-аут выполнения JavaScript (1-60 с, по умолчанию 30 с). Поддерживаются суффиксы времени, например 30s, 1m. |
|
| Script type: Script | ||
| Execute on | Нажмите соответствующую кнопку, чтобы выполнить shell-скрипт на: Zabbix agent - скрипт будет выполнен Zabbix agent (если элемент данных system.run разрешен) на узле сети Zabbix proxy or server - скрипт будет выполнен Zabbix proxy или server - в зависимости от того, контролируется ли узел сети через proxy или server. Он будет выполнен на proxy, если это включено параметром EnableRemoteCommands. Он будет выполнен на server, если глобальные скрипты включены параметром сервера EnableGlobalScripts. Zabbix server - скрипт будет выполнен только Zabbix server. Этот параметр будет недоступен, если глобальные скрипты отключены параметром сервера EnableGlobalScripts. |
|
| Commands | Введите полный путь к командам, которые будут выполняться в скрипте. Поддержка макросов зависит от области применения скрипта (см. Scope выше). Поддерживаются пользовательские макросы пользователя. |
|
| Script type: SSH | ||
| Authentication method | Выберите метод аутентификации - пароль или публичный ключ. | |
| Username | Введите имя пользователя. | |
| Password | Введите пароль. Это поле доступно, если в качестве метода аутентификации выбран 'Password'. |
|
| Public key file | Введите путь к файлу публичного ключа. Это поле доступно, если в качестве метода аутентификации выбран 'Public key'. |
|
| Private key file | Введите путь к файлу закрытого ключа. Это поле доступно, если в качестве метода аутентификации выбран 'Public key'. |
|
| Passphrase | Введите парольную фразу. Это поле доступно, если в качестве метода аутентификации выбран 'Public key'. |
|
| Port | Введите порт удаленной службы SSH на целевом узле сети, к которому Zabbix будет подключаться. | |
| Commands | Введите команды. Поддержка макросов зависит от области применения скрипта (см. Scope выше). Поддерживаются пользовательские макросы пользователя. |
|
| Script type: Telnet | ||
| Username | Введите имя пользователя. | |
| Password | Введите пароль. | |
| Port | Введите порт удаленной службы Telnet на целевом узле сети, к которому Zabbix будет подключаться. | |
| Commands | Введите команды. Поддержка макросов зависит от области применения скрипта (см. Scope выше). Поддерживаются пользовательские макросы пользователя. |
|
| Script type: IPMI | ||
| Command | Введите команду IPMI. Поддержка макросов зависит от области применения скрипта (см. Scope выше). Поддерживаются пользовательские макросы пользователя. |
|
| Description | Введите описание скрипта. | |
| Host group | Выберите группу узлов сети, для которой будет доступен скрипт (или All для всех групп узлов сети). | |
| User group | Выберите группу пользователей, для которой будет доступен скрипт (или All для всех групп пользователей). Это поле отображается только если в качестве Scope выбрано 'Manual host action' или 'Manual event action'. |
|
| Required host permissions | Выберите уровень прав для группы узлов сети - Read или Write. Только пользователи с требуемым уровнем прав смогут выполнять скрипт. Это поле отображается только если в качестве Scope выбрано 'Manual host action' или 'Manual event action'. |
|
| Advanced configuration | Нажмите заголовок Advanced configuration, чтобы отобразить параметры advanced configuration. Это поле отображается только если в качестве Scope выбрано 'Manual host action' или 'Manual event action'. |
|
Расширенная настройка
Параметры расширенной настройки доступны в сворачиваемом разделе Расширенная настройка:
| Parameter | Description |
|---|---|
| Enable user input | Отметьте флажок, чтобы включить ручной ввод пользователя перед выполнением скрипта. Ручной ввод пользователя заменит значение макроса {MANUALINPUT} в скрипте. См. также: Ручной ввод пользователя. |
| Input prompt | Введите собственный текст-подсказку для пользовательского ввода. Этот текст будет отображаться над полем ввода во всплывающем окне Ручной ввод. Чтобы увидеть предварительный просмотр всплывающего окна Ручной ввод, нажмите Test user input. Предварительный просмотр также позволяет проверить, соответствует ли строка ввода правилу проверки ввода (см. параметры ниже). Поддержка макросов и пользовательских макросов зависит от области действия скрипта (см. Scope в общих параметрах настройки скрипта). |
| Input type | Выберите тип ручного ввода: String - одна строка; Dropdown - значение выбирается из нескольких вариантов в раскрывающемся списке. |
| Dropdown options | Введите уникальные значения для раскрывающегося списка пользовательского ввода в виде списка, разделенного запятыми. Чтобы включить пустой вариант в раскрывающемся списке, добавьте дополнительную запятую в начале, середине или конце списка. Это поле отображается только если в качестве Input type выбрано 'Dropdown'. |
| Default input string | Введите строку по умолчанию для пользовательского ввода (или оставьте пустым). Это поле будет проверяться по регулярному выражению, указанному в поле Input validation rule. Введенное здесь значение будет по умолчанию отображаться во всплывающем окне Ручной ввод. Это поле отображается только если в качестве Input type выбрано 'String'. |
| Input validation rule | Введите регулярное выражение для проверки строки пользовательского ввода. Поддерживаются глобальные регулярные выражения. Это поле отображается только если в качестве Input type выбрано 'String'. |
| Enable confirmation | Отметьте флажок, чтобы отображать сообщение подтверждения перед выполнением скрипта. Эта функция может быть особенно полезна для потенциально опасных операций (например, скрипта перезагрузки) или операций, которые могут занять много времени. |
| Confirmation text | Введите собственный текст подтверждения для всплывающего окна подтверждения, включаемого флажком выше (например, Remote system will be rebooted. Are you sure?). Чтобы увидеть, как будет выглядеть текст, нажмите Test confirmation рядом с полем. Поддерживаются макросы и пользовательские user macros. Примечание: макросы не будут развернуты при тестировании сообщения подтверждения. |
Если настроены и ручной ввод пользователя, и сообщение подтверждения, они будут отображаться в последовательных всплывающих окнах.
Ручной ввод пользователем
Ручной ввод пользователем позволяет задавать пользовательский параметр при каждом выполнении скрипта. Это избавляет от необходимости создавать несколько похожих пользовательских скриптов, отличающихся только одним параметром.
Например, во время выполнения скрипта вы можете задать другое целое число или другой URL-адрес.
Чтобы включить ручной ввод пользователем:
- используйте макрос {MANUALINPUT} в скрипте (команды, скрипт, параметр скрипта), где это требуется; либо в поле URL для URL-скриптов;
- в расширенной конфигурации скрипта включите ручной ввод пользователем и настройте параметры ввода.
Если ввод пользователем включен, перед выполнением скрипта пользователю будет показано всплывающее окно Ручной ввод, в котором будет предложено указать пользовательское значение. Указанное значение заменит {MANUALINPUT} в скрипте.
В зависимости от конфигурации пользователю будет предложено ввести строковое значение:
Или выбрать значение из раскрывающегося списка заранее определенных вариантов:
Ручной ввод пользователем доступен только для скриптов, для которых область действия — 'Manual host action' или 'Manual event action'.
Выполнение скрипта и результат
Скрипты, запускаемые сервером Zabbix, выполняются в порядке, описанном на странице выполнения команд.
Результат скрипта отображается во всплывающем окне, которое появляется после выполнения скрипта. Возвращаемое значение скрипта — это стандартный вывод:
- Если скрипт завершается успешно (код выхода
0), возвращаемое значение ограничено 16 МБ (включая завершающие пробелы, которые обрезаются). - Если скрипт завершается с ошибкой (ненулевой код выхода), возвращаемое значение стандартной ошибки ограничено 2 КБ.
По умолчанию Zabbix не сохраняет расширенный вывод скрипта. Чтобы сохранить полные сведения о выводе, вы можете реализовать ведение журнала непосредственно в самом скрипте (например, перенаправить вывод в локальный файл журнала).
Обратите внимание, что для скриптов, выполняемых либо на сервере Zabbix, либо на прокси Zabbix, также применяются ограничения базы данных.
Ниже приведен пример скрипта и окна результата:
uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"
В результате выполнения скрипта сам скрипт не отображается.
Тайм-аут скрипта в агенте Zabbix
Вы можете столкнуться с ситуацией, когда при выполнении скрипта происходит тайм-аут.
Ниже приведен пример выполнения скрипта на агенте Zabbix и окно с результатом:
sleep 5
df -h
В этом случае сообщение об ошибке будет следующим:
Timeout while executing a shell script.Чтобы избежать таких ситуаций, рекомендуется оптимизировать сам скрипт (в приведенном выше примере — "5"), а не изменять параметр Timeout в конфигурации агента Zabbix и конфигурации сервера Zabbix.
Если параметр Timeout был изменен в конфигурации агента Zabbix, появится следующее сообщение об ошибке:
Get value from agent failed: ZBX_TCP_READ() timed out.Это означает, что изменение было внесено в конфигурации агента Zabbix, но также требуется изменить параметр Timeout в конфигурации сервера Zabbix.
Тайм-аут скрипта на активных агентах
Возможно выполнение скриптов на агентах, работающих только в активном режиме. После того как выполнение скрипта будет инициировано операцией действия или ручным запуском скрипта, команда включается в конфигурацию активных проверок и выполняется, когда активный агент получает ее.
Ручные скрипты отправляются активному агенту вместе с тайм-аутом сервера/прокси для выполнения скрипта. Увеличьте значение тайм-аута по умолчанию для сервера/прокси для выполнения скрипта. Тайм-аут должен быть больше, чем частота обновления активных проверок, иначе тайм-аут будет превышен до того, как активный агент получит скрипт и сможет вернуть результат.
Тайм-аут скрипта на сервере/прокси Zabbix
Ниже приведен пример выполнения скрипта на сервере Zabbix и окно с результатом:
sleep 11
df -h
Также рекомендуется оптимизировать сам скрипт (вместо настройки параметра TrapperTimeout на соответствующее значение (в нашем случае, > 11) путем изменения конфигурации сервера Zabbix).