这是原厂英文文档的翻译页面. 欢迎帮助我们 完善文档.

获取

描述

integer/array script.get(object parameters)

此方法允许检索符合所给参数的脚本。

参数

(object) 定义所需输出的参数。

此方法支持以下参数。

Parameter Type Description
groupids string/array 仅能运行在所给主机组的脚本。
hostids string/array 仅能运行在所给主机的脚本。
scriptids string/array 仅返回所给ID的脚本。
usrgrpids string/array 仅返回所给用户组可以运行的脚本。
selectGroups query 返回可以在groups属性中运行脚本的主机组。
selectHosts query 返回可以在hosts属性中运行脚本的主机组。
sortfield string/array 根据所给参数对参数进行排序

可能的值:scriptidname
countOutput boolean 这些参数对于所有“get”方法都是通用的,在reference commentary 中有详细描述。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) Returns either:

  • 一个数组对象。
  • 检索到对象的数目,如果countOutput参数被使用。

示例如下

检索所有脚本

检索所有的已确认的脚本

Request:

{
           "jsonrpc": "2.0",
           "method": "script.get",
           "params": {
               "output": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [    
               {
                   "scriptid": "1",
                   "name": "Ping",
                   "command": "/bin/ping -c 3 {HOST.CONN} 2>&1",
                   "host_access": "2",
                   "usrgrpid": "0",
                   "groupid": "0",
                   "description": "",
                   "confirmation": "",
                   "type": "0",
                   "execute_on": "1"
               },
               {
                   "scriptid": "2",
                   "name": "Traceroute",
                   "command": "/usr/bin/traceroute {HOST.CONN} 2>&1",
                   "host_access": "2",
                   "usrgrpid": "0",
                   "groupid": "0",
                   "description": "",
                   "confirmation": "",
                   "type": "0",
                   "execute_on": "1"
               },
               {
                   "scriptid": "3",
                   "name": "Detect operating system",
                   "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1",
                   "host_access": "2",
                   "usrgrpid": "7",
                   "groupid": "0",
                   "description": "",
                   "confirmation": "",
                   "type": "0",
                   "execute_on": "1"
               }
           ],
           "id": 1
       }

猜你想看

CScript::get() in frontends/php/include/classes/api/services/CScript.php.