Table of Contents
script.create
描述
object script.create(object/array scripts)
此方法允许create新脚本.
此方法仅适用于超级管理员用户类型. 调用该方法的权限可以在用户角色设置中撤销. 参见 User roles 获取更多信息.
参数
(object/array) 脚本用于 create.
该方法接受带有 脚本 的脚本.
返回值
(object) 返回一个包含所创建脚本ID的object，这些ID位于scriptids属性下。返回的ID顺序与传入的脚本顺序一致。
示例
创建 webhook 脚本
创建一个向外部服务发送HTTP请求的webhook脚本。
执行请求:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Webhook script",
"command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}",
"type": 5,
"timeout": "40s",
"parameters": [
{
"name": "token",
"value": "{$WEBHOOK.TOKEN}"
},
{
"name": "host",
"value": "{HOST.HOST}"
},
{
"name": "v",
"value": "2.2"
}
]
},
"id": 1
}响应:
创建 SSH 脚本
创建一个支持公钥认证的SSH脚本，该脚本可在一个主机上执行并包含上下文菜单。
执行请求:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "SSH script",
"command": "my script command",
"type": 2,
"authtype": 1,
"username": "John",
"publickey": "pub.key",
"privatekey": "priv.key",
"password": "secret",
"port": "12345",
"scope": 2,
"menu_path": "All scripts/SSH",
"usrgrpid": "7",
"groupid": "4"
},
"id": 1
}响应:
创建自定义脚本
创建一个用于重启服务器的自定义脚本。该脚本需要 对主机具有写入权限，并将提示用户进行 手动输入。成功提交输入后，脚本将在前端显示 确认消息。
执行请求:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Reboot server",
"command": "reboot server {MANUALINPUT}",
"type": 0,
"scope": 2,
"confirmation": "Are you sure you would like to reboot the server {MANUALINPUT}?",
"manualinput": 1,
"manualinput_prompt": "Which server you want to reboot?",
"manualinput_validator": "[1-9]",
"manualinput_validator_type": 0,
"manualinput_default_value": "1"
},
"id": 1
}响应:
创建 URL 类型脚本
为主机作用域创建一个URL类型脚本，该脚本保留在同一窗口并具有确认文本。
执行请求:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "URL script",
"type": 6,
"scope": 2,
"url": "http://zabbix/ui/zabbix.php?action=host.edit&hostid={HOST.ID}",
"confirmation": "Edit host {HOST.NAME}?",
"new_window": 0
},
"id": 1
}响应:
创建一个URL类型脚本并手动输入
创建一个用于事件范围的新窗口URL类型脚本，需手动输入。
执行请求:
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "URL script with manual input",
"type": 6,
"scope": 4,
"url": "http://zabbix/ui/zabbix.php?action={MANUALINPUT}",
"new_window": 1,
"manualinput": 1,
"manualinput_prompt": "Select a page to open:",
"manualinput_validator": "dashboard.view,script.list,actionlog.list",
"manualinput_validator_type": 1
},
"id": 1
}响应:
来源
CScript::create() 位于 ui/include/classes/api/services/CScript.php 文件中。