Documentation
Table of Contents
drule.get
Beschrijving
integer/array drule.get(objectparameters)
De methode maakt het mogelijk om detectieregels op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| dhostids | string/array | Geef alleen ontdekkingsregels terug die de opgegeven ontdekte hosts hebben aangemaakt. |
| druleids | string/array | Geef alleen ontdekkingsregels terug met de opgegeven IDs. |
| dserviceids | string/array | Geef alleen ontdekkingsregels terug die de opgegeven ontdekte services hebben aangemaakt. |
| selectDChecks | query | Geef een eigenschap dchecks terug met de ontdekkingscontroles die door de ontdekkingsregel zijn gebruikt. Ondersteunt count. |
| selectDHosts | query | Geef een eigenschap dhosts terug met de ontdekte hosts die door de ontdekkingsregel zijn aangemaakt. Ondersteunt count. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: selectDChecks - de resultaten worden gesorteerd op dcheckid;selectDHosts - de resultaten worden gesorteerd op dhostsid. |
| sortfield | string/array | Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden: druleid, name. |
| countOutput | boolean | Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Alle ontdekkingsregels ophalen
Haal alle geconfigureerde ontdekkingsregels op en de ontdekkingscontroles die ze gebruiken.
{
"jsonrpc": "2.0",
"method": "drule.get",
"params": {
"output": "extend",
"selectDChecks": "extend"
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"druleid": "2",
"proxy_hostid": "0",
"name": "Lokaal netwerk",
"iprange": "192.168.3.1-255",
"delay": "5s",
"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": "Zabbix-agentontdekking",
"iprange": "192.168.1.1-255",
"delay": "1u",
"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
}Zie ook
Bron
CDRule::get() in ui/include/classes/api/services/CDRule.php.