Table of Contents
以下objects与scriptAPI直接相关。
脚本
脚本 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| scriptid | string | (只读) 脚本的ID。 |
| name (required) |
string | 脚本的名称。 |
| type (required) |
integer | 脚本类型。 可能的值： 0 - 脚本； 1 - IPMI； 2 - SSH； 3 - Telnet； 5 - (默认) Webhook。 |
| command (required) |
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脚本的公钥文件名。 当类型为 2 且 authtype 为 1 时必填。 |
| privatekey | string | 用于公钥认证的SSH脚本的私钥文件名。 当类型为 2 且 authtype 为 1 时必填。 |
| port | string | 用于SSH和Telnet脚本的端口号。 当类型为 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输入参数 的 array。 当 type 为 5 时使用。 |
| description | string | 脚本的描述。 |
请注意，某些方法（更新、删除）所需的/可选的参数组合有所不同。
Webhook 参数
当调用Webhook脚本时传递的参数具有以下属性。
调试
已执行的Webhook脚本调试信息。该调试object具有以下属性。
日志条目
日志条目 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| level | integer | 日志级别。 |
| ms | string | 自脚本运行到添加日志条目所经过的毫秒数。 |
| message | string | 日志消息。 |