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 | Retourneer alleen detectieregels die de opgegeven ontdekte hosts hebben gemaakt. |
| druleids | string/array | Retourneer alleen detectieregels met de opgegeven ID's. |
| dserviceids | string/array | Retourneert alleen detectieregels die de opgegeven gedetecteerde services hebben gemaakt. |
| selectDChecks | query | Retourneer een eigenschap dchecks met de detectiecontroles die worden gebruikt door de detectieregel. Ondersteunt count. |
| selectDHosts | query | Retourneer een eigenschap dhosts met de gedetecteerde hosts die zijn gemaakt door de ontdekkingsregel. Ondersteunt count. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: selectDChecks - resultaten worden gesorteerd op dcheckid;selectDHosts - resultaten wordt gesorteerd op dhostsid. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: druleid en name. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| filter | object | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Alle ontdekkingsregels ophalen
Haal alle geconfigureerde detectieregels op en de detectiecontroles die ze gebruiken.
Verzoek:
{
"jsonrpc": "2.0",
"methode": "drule.get",
"parameters": {
"uitvoer": "verlengen",
"selectDChecks": "verlengen"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"resultaat": [
{
"druleid": "2",
"proxy_hostid": "0",
"naam": "Lokaal netwerk",
"iprange": "192.168.3.1-255",
"vertraging": "5s",
"volgende controle": "1348754327",
"status": "0",
"dchecks": [
{
"dcheckid": "7",
"druleid": "2",
"type": "3",
"sleutel_": "",
"snmp_community": "",
"poorten": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniek": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
},
{
"dcheckid": "8",
"druleid": "2",
"type": "4",
"sleutel_": "",
"snmp_community": "",
"poorten": "80",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniek": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
}
]
},
{
"druleid": "6",
"proxy_hostid": "0",
"name": "Zabbix-agent ontdekking",
"iprange": "192.168.1.1-255",
"vertraging": "1u",
"volgende controle": "0",
"status": "0",
"dchecks": [
{
"dcheckid": "10",
"druleid": "6",
"type": "9",
"key_": "systeem.uname",
"snmp_community": "",
"poorten": "10050",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniek": "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.