script.getscriptsbyevents

説明

object script.getscriptsbyevents(object parameters)

このメソッドは、指定されたイベントで利用可能なすべてのスクリプト、またはスクリプトIDが指定されている場合は特定のスクリプトを取得します。manualinputが指定されている場合は、{MANUALINPUT}マクロを指定された値に置き換えます。

このメソッドは、あらゆるタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくは、ユーザーの役割 をご覧ください。

パラメータ

(オブジェクト/配列) メソッドは、以下のパラメータを持つオブジェクトまたはオブジェクトの配列を受け入れます。

パラメータ タイプ 説明
eventid ID スクリプトを返すイベントのID
一意である必要があります。

パラメータの動作:
- 必須
scriptid ID 返すスクリプトのID
manualinput 文字列 ユーザーが指定した {MANUALINPUT} マクロの値

戻り値

(object) は、イベントIDをプロパティとして、利用可能なスクリプトの配列を値として持つオブジェクトを返します。スクリプトIDが指定されている場合、関連付けられた値は特定のスクリプトを含む配列です。

このメソッドは、confirmation テキスト、manualinput prompt テキスト、および url 内のマクロを自動的に展開します。

manualinput パラメータが指定されている場合、{MANUALINPUT} マクロは指定された値に解決されます。

Retrieve scripts by event IDs

"632" と"614"のイベントIDで利用可能なすべてのスクリプトを取得します。

リクエスト:

{  "jsonrpc": "2.0",  "method": "script.getscriptsbyevents",  "params": [  {  "eventid": "632"  },  {  "eventid": "614"  }  ],  "id": 1 }

Response:

{  "jsonrpc": "2.0",  "result": {  "632": [  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "0",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  },  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "0",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  },  {  "scriptid": "4",  "name": "Open Zabbix page",  "command": "",  "host_access": "2",  "usrgrpid": "0",  "groupid": "0",  "description": "",  "confirmation": "Are you sure you want to open page *UNKNOWN*?",  "type": "6",  "execute_on": "2",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "http://localhost/ui/zabbix.php?action=*UNKNOWN*",  "new_window": "1",  "manualinput": "1",  "manualinput_prompt": "Zabbix page to open:",  "manualinput_validator_type": "1",  "manualinput_validator": "dashboard.view,discovery.view",  "manualinput_default_value": "",  "parameters": []  },  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "0",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  }  ],  "614": [  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "1",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  },  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "0",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  },  {  "scriptid": "4",  "name": "Open Zabbix page",  "command": "",  "host_access": "2",  "usrgrpid": "0",  "groupid": "0",  "description": "",  "confirmation": "Are you sure you want to open page *UNKNOWN*?",  "type": "6",  "execute_on": "2",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "http://localhost/ui/zabbix.php?action=*UNKNOWN*",  "new_window": "1",  "manualinput": "1",  "manualinput_prompt": "Zabbix page to open:",  "manualinput_validator_type": "1",  "manualinput_validator": "dashboard.view,discovery.view",  "manualinput_default_value": "",  "parameters": []  },  {  "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",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "",  "new_window": "1",  "manualinput": "0",  "manualinput_prompt": "",  "manualinput_validator_type": "0",  "manualinput_validator": "",  "manualinput_default_value": "",  "parameters": []  }  ]  },  "id": 1 }

manualinput 値を持つ特定のスクリプトを取得します。

manualinput 値 "dashboard.view" を持つイベント "632" の ID "4" のスクリプトを取得します。

リクエスト:

{  "jsonrpc": "2.0",  "method": "script.getscriptsbyevents",  "params": [  {  "eventid": "632",  "scriptid": "4",  "manualinput": "dashboard.view"  }  ],  "id": 1 }

Response:

{  "jsonrpc": "2.0",  "result": {  "632": [  {  "scriptid": "4",  "name": "Open Zabbix page",  "command": "",  "host_access": "2",  "usrgrpid": "0",  "groupid": "0",  "description": "",  "confirmation": "Are you sure you want to open page dashboard.view?",  "type": "6",  "execute_on": "2",  "timeout": "30s",  "scope": "4",  "port": "",  "authtype": "0",  "username": "",  "password": "",  "publickey": "",  "privatekey": "",  "menu_path": "",  "url": "http://localhost/ui/zabbix.php?action=dashboard.view",  "new_window": "1",  "manualinput": "1",  "manualinput_prompt": "Zabbix page to open:",  "manualinput_validator_type": "1",  "manualinput_validator": "dashboard.view,discovery.view",  "manualinput_default_value": "",  "parameters": []  }  ]  },  "id": 1 }

ソース

CScript::getScriptsByEvents() in ui/include/classes/api/services/CScript.php.