Documentation
Table of Contents
drule.get
§°§á§Ú§ã
integer/array drule.get(object parameters)
§®§Ö§ä§à§Õ §Õ§à§Ù§Ó§à§Ý§ñ? §à§ä§â§Ú§Þ§Ñ§ä§Ú §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ §Ù§Ñ §Ù§Ñ§Õ§Ñ§ß§Ú§Þ§Ú §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ñ§Þ§Ú.
§¸§Ö§Û §ã§á§à§ã?§Ò §Õ§à§ã§ä§å§á§ß§Ú§Û §Ü§à§â§Ú§ã§ä§å§Ó§Ñ§é§Ñ§Þ §Ò§å§Õ§î-§ñ§Ü§à§Ô§à §ä§Ú§á§å. §¥§à§Ù§Ó§à§Ý§Ú §ß§Ñ §Ó§Ú§Ü§Ý§Ú§Ü §Þ§Ö§ä§à§Õ§å §Þ§à§Ø§ß§Ñ §ã§Ü§Ñ§ã§å§Ó§Ñ§ä§Ú §Ó §ß§Ñ§Ý§Ñ§ê§ä§å§Ó§Ñ§ß§ß§ñ§ç §â§à§Ý? §Ü§à§â§Ú§ã§ä§å§Ó§Ñ§é§Ñ. §¥§Ú§Ó. §²§à§Ý? §Ü§à§â§Ú§ã§ä§å§Ó§Ñ§é§Ñ §Õ§Ý§ñ §à§ä§â§Ú§Þ§Ñ§ß§ß§ñ §Õ§à§Õ§Ñ§ä§Ü§à§Ó§à? ?§ß§æ§à§â§Þ§Ñ§è??.
§±§Ñ§â§Ñ§Þ§Ö§ä§â§Ú
(object) §±§Ñ§â§Ñ§Þ§Ö§ä§â§Ú, §ë§à §Ó§Ú§Ù§ß§Ñ§é§Ñ§ð§ä§î §Ò§Ñ§Ø§Ñ§ß§Ú§Û §â§Ö§Ù§å§Ý§î§ä§Ñ§ä.
§®§Ö§ä§à§Õ §á?§Õ§ä§â§Ú§Þ§å? §ä§Ñ§Ü? §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ú.
| §±§Ñ§â§Ñ§Þ§Ö§ä§â | §´§Ú§á | §°§á§Ú§ã |
|---|---|---|
| dhostids | §â§ñ§Õ§à§Ü/§Þ§Ñ§ã§Ú§Ó | §±§à§Ó§Ö§â§ä§Ñ§ä§Ú §Ý§Ú§ê§Ö §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ, §ñ§Ü? §ã§ä§Ó§à§â§Ú§Ý§Ú §Õ§Ñ§ß? §Ó§Ú§ñ§Ó§Ý§Ö§ß? §ç§à§ã§ä§Ú. |
| druleids | §â§ñ§Õ§à§Ü/§Þ§Ñ§ã§Ú§Ó | §±§à§Ó§Ö§â§ä§Ñ§ä§Ú §Ý§Ú§ê§Ö §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ §Ù §å§Ü§Ñ§Ù§Ñ§ß§Ú§Þ§Ú ?§Õ§Ö§ß§ä§Ú§æ?§Ü§Ñ§ä§à§â§Ñ§Þ§Ú. |
| dserviceids | §â§ñ§Õ§à§Ü/§Þ§Ñ§ã§Ú§Ó | §±§à§Ó§Ö§â§ä§Ñ§ä§Ú §Ý§Ú§ê§Ö §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ, §ñ§Ü? §ã§ä§Ó§à§â§Ú§Ý§Ú §Õ§Ñ§ß? §Ó§Ú§ñ§Ó§Ý§Ö§ß? §ã§Ý§å§Ø§Ò§Ú. |
| selectDChecks | §Ù§Ñ§á§Ú§ä | §±§à§Ó§Ö§â§ä§Ñ? §Ó§Ý§Ñ§ã§ä§Ú§Ó?§ã§ä§î dchecks ?§Ù §á§Ö§â§Ö§Ó?§â§Ü§Ñ§Þ§Ú §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ, §ñ§Ü? §Ó§Ú§Ü§à§â§Ú§ã§ä§à§Ó§å§ð§ä§î§ã§ñ §á§â§Ñ§Ó§Ú§Ý§à§Þ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ. §±?§Õ§ä§â§Ú§Þ§å? count. |
| selectDHosts | §Ù§Ñ§á§Ú§ä | §±§à§Ó§Ö§â§ä§Ñ? §Ó§Ý§Ñ§ã§ä§Ú§Ó?§ã§ä§î dhosts ?§Ù §Ó§Ú§ñ§Ó§Ý§Ö§ß§Ú§Þ§Ú §ç§à§ã§ä§Ñ§Þ§Ú, §ã§ä§Ó§à§â§Ö§ß§Ú§Þ§Ú §Ù§Ñ §á§â§Ñ§Ó§Ú§Ý§à§Þ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ. §±?§Õ§ä§â§Ú§Þ§å? count. |
| limitSelects | §è?§Ý§Ö §é§Ú§ã§Ý§à | §°§Ò§Þ§Ö§Ø§å? §Ü?§Ý§î§Ü?§ã§ä§î §Ù§Ñ§á§Ú§ã?§Ó, §ë§à §á§à§Ó§Ö§â§ä§Ñ§ð§ä§î§ã§ñ §á?§Õ§Ó§Ú§Ò§à§â§Ñ§Þ§Ú. §©§Ñ§ã§ä§à§ã§à§Ó§å?§ä§î§ã§ñ §Õ§à §ß§Ñ§ã§ä§å§á§ß§Ú§ç §á?§Õ§Ó§Ú§Ò§à§â?§Ó: selectDChecks - §â§Ö§Ù§å§Ý§î§ä§Ñ§ä§Ú §Ò§å§Õ§å§ä§î §Ó?§Õ§ã§à§â§ä§à§Ó§Ñ§ß? §Ù§Ñ dcheckid;selectDHosts - §â§Ö§Ù§å§Ý§î§ä§Ñ§ä§Ú §Ò§å§Õ§Ö §Ó?§Õ§ã§à§â§ä§à§Ó§Ñ§ß§à §Ù§Ñ dhostsid. |
| sortfield | §â§ñ§Õ§à§Ü/§Þ§Ñ§ã§Ú§Ó | §£?§Õ§ã§à§â§ä§å§Û§ä§Ö §â§Ö§Ù§å§Ý§î§ä§Ñ§ä §Ù§Ñ §Ù§Ñ§Õ§Ñ§ß§Ú§Þ§Ú §Ó§Ý§Ñ§ã§ä§Ú§Ó§à§ã§ä§ñ§Þ§Ú. §®§à§Ø§Ý§Ú§Ó? §Ù§ß§Ñ§é§Ö§ß§ß§ñ: druleid ? name. |
| countOutput | boolean | §¸? §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ú, §ñ§Ü? ? §ã§á?§Ý§î§ß§Ú§Þ§Ú §Õ§Ý§ñ §Ó§ã?§ç §Þ§Ö§ä§à§Õ?§Ó get, §Õ§Ö§ä§Ñ§Ý§î§ß§à §à§á§Ú§ã§Ñ§ß? §Ó §Õ§à§Ó?§Õ§Ü§à§Ó§à§Þ§å §Ü§à§Þ§Ö§ß§ä§Ñ§â?. |
| §â§Ö§Õ§Ñ§Ô§à§Ó§Ñ§ß§Ú§Û | §Ý§à§Ô?§é§ß§Ú§Û | |
| excludeSearch | boolean | |
| §æ?§Ý§î§ä§â | §à§Ò'?§Ü§ä | |
| §Ý?§Þ?§ä | §è?§Ý§Ö | |
| §Ó§Ú§Ó?§Õ | §Ù§Ñ§á§Ú§ä | |
| preservekeys | boolean | |
| §á§à§ê§å§Ü | §à§Ò'?§Ü§ä | |
| searchByAny | §Ý§à§Ô?§é§ß§Ú§Û | |
| §å§Ó?§Þ§Ü§ß§Ö§ß§à §Ù§ß§Ñ§Ü§Ú §á?§Õ§ã§ä§Ñ§ß§à§Ó§Ü§Ú | §Ý§à§Ô?§é§ß§Ú§Û | |
| §á§à§â§ñ§Õ§à§Ü §ã§à§â§ä§å§Ó§Ñ§ß§ß§ñ | §â§ñ§Õ§à§Ü/§Þ§Ñ§ã§Ú§Ó | |
| §á§à§é§Ñ§ä§Ú §á§à§ê§å§Ü | §Ý§à§Ô?§é§ß§Ú§Û |
§±§à§Ó§Ö§â§ß§å§ä? §Ù§ß§Ñ§é§Ö§ß§ß§ñ
(integer/array) §±§à§Ó§Ö§â§ä§Ñ? §Ñ§Ò§à:
- §Þ§Ñ§ã§Ú§Ó §à§Ò'?§Ü§ä?§Ó;
- §Ü?§Ý§î§Ü?§ã§ä§î §à§ä§â§Ú§Þ§Ñ§ß§Ú§ç §à§Ò'?§Ü§ä?§Ó, §ñ§Ü§ë§à §Ó§Ú§Ü§à§â§Ú§ã§ä§à§Ó§å§Ó§Ñ§Ó§ã§ñ §á§Ñ§â§Ñ§Þ§Ö§ä§â
countOutput.
§±§â§Ú§Ü§Ý§Ñ§Õ§Ú
§°§ä§â§Ú§Þ§Ñ§ä§Ú §Ó§ã? §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ
§°§ä§â§Ú§Þ§Ñ§ä§Ú §Ó§ã? §ß§Ñ§Ý§Ñ§ê§ä§à§Ó§Ñ§ß? §á§â§Ñ§Ó§Ú§Ý§Ñ §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ §ä§Ñ §á§Ö§â§Ö§Ó?§â§Ü§Ú §Ó§Ú§ñ§Ó§Ý§Ö§ß§ß§ñ, §ñ§Ü? §Ó§à§ß§Ú §Ó§Ú§Ü§à§â§Ú§ã§ä§à§Ó§å§ð§ä§î.
§©§Ñ§á§Ú§ä:
{
"jsonrpc": "2.0",
"method": "drule.get",
"params": {
"output": "extend",
"selectDChecks": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}§£?§Õ§á§à§Ó?§Õ§î:
{
"jsonrpc": "2.0",
"result": [
{
"druleid": "2",
"proxy_hostid": "0",
"name": "Local network",
"iprange": "192.168.3.1-255",
"delay": "5s",
"nextcheck": "1348754327",
"status": "0",
"dchecks": [
{
"dcheckid": "7",
"druleid": "2",
"type": "3",
"key_": "",
"snmp_community": "",
"ports": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
},
{
"dcheckid": "8",
"druleid": "2",
"type": "4",
"key_": "",
"snmp_community": "",
"ports": "80",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
}
]
},
{
"druleid": "6",
"proxy_hostid": "0",
"name": "Áú»¢¶Ä²© agent discovery",
"iprange": "192.168.1.1-255",
"delay": "1h",
"nextcheck": "0",
"status": "0",
"dchecks": [
{
"dcheckid": "10",
"druleid": "6",
"type": "9",
"key_": "system.uname",
"snmp_community": "",
"ports": "10050",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "2",
"name_source": "3"
}
]
}
],
"id": 1
}§¥§Ú§Ó§Ú§ã§î §ä§Ñ§Ü§à§Ø
§¥§Ø§Ö§â§Ö§Ý§à
CDRule::get() §å ui/include/classes/api/services/CDRule.php.