Documentation
> 脚本对象
以下对象与 脚本 API直接相关。
脚本
脚本对象有以下参数。
| 属性 | 类型 | 描述 |
|---|---|---|
| scriptid | string | (只读) 脚本ID。 |
| name (必需) |
string | 脚本名称。 |
| type (必需) |
integer | 脚本类型。 可能的值： 0 - 脚本； 1 - IPMI； 2 - SSH； 3 - Telnet； 5 - (默认) Webhook。 |
| command (必需) |
string | 运行的命令。 |
| scope | integer | 脚本范围。 可能的值： 1 - 默认 动作操作； 2 - 手动主机动作； 4 - 手动事件动作。 |
| execute_on | integer | 在哪里运行脚本。 当 type 为 0时使用 （脚本）。可能的值： 0 - 在 Zabbix agent上运行； 1 - 在 Zabbix server上运行; 2 - (默认) 在 Zabbix server (proxy)上运行。 |
| menu_path | string | 当点击主机或事件时，由斜杠分隔的文件夹所组成的类似于前端导航的菜单。 当 scope 为 2 或 4时使用。 |
| authtype | integer | SSH脚本类型使用的身份验证方法。 当 type 为 2时使用。可能的值： 0 - 密码； 1 - 公钥。 |
| username | string | 身份验证使用的用户名 当 type 为 2 或 3时需要。 |
| password | string | 通过密码进行身份验证的SSH脚本和Telnet脚本使用的密码。 当 type 为 2 且 authtype 为 0 或 type 为 3时使用。 |
| publickey | string | 通过公钥进行身份验证的SSH脚本使用的公钥文件名。 当 type 为 2 且 authtype 为 1时需要。 |
| privatekey | string | 通过公钥进行身份验证的SSH脚本使用的私钥文件名。 当 type 为 2 且 authtype 为 1时需要。 |
| port | string | SSH 和 Telnet 脚本使用的端口号。 当 type 为 2 或 3时使用。 |
| groupid | string | 可以运行脚本的主机群组ID。如果设置为 0， 脚本将可以在所有主机群组运行。 默认值： 0。 |
| usrgrpid | string | 允许运行脚本的用户群组ID。如果设置为 0, 脚本将可以在所有用户群组运行。 当 scope 为 2 或 4时使用。默认值: 0. |
| host_access | integer | 运行脚本所需的主机权限。 当 scope为 2 或 4时使用。可能的值： 2 - (默认) 读; 3 - 写. |
| confirmation | string | 弹出窗口的确认文本。如果尝试在zabbix前端运行脚本，将会弹出窗口。 当 scope 为 2 或 4时使用。 |
| timeout | string | Webhook脚本执行超时秒数。 支持时间后缀, 例如 30s，1m。 当 type 为 5时需要。可能的值： 1-60s 默认值： 30s |
| parameters | array | webhook入参数组. 当 type 为 5时使用。 |
| description | string | 脚本描述。 |
注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。
Webhook参数
webhook脚本运行时被传入的参数有如下属性。 |属性|类型|描述| |--------|---------------------------------------------------|-----------| |name
(必需)|string|参数名称。| |value|string|参数值。 支持宏。|
调试
运行的webhook脚本的调试信息。调试对象有如下属性。 |属性|类型|描述| |--------|---------------------------------------------------|-----------| |logs|array|日志条目数组(/manual/api/reference/script/object#日志条目)。| |ms|string|脚本运行毫秒数。|
日志条目
日志条目对象有如下属性。 |属性|类型|描述| |--------|---------------------------------------------------|-----------| |level|integer|日志等级。| |ms|string|从脚本开始运行到添加日志条目前经过时间（毫秒）。| |message|string|日志信息。|