Documentation
Table of Contents
dhost.get
Beschrijving
integer/array dhost.get(object parameters)
Deze methode maakt het mogelijk om ontdekte hosts op te halen op basis van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen 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 ontdekte hosts terug met de opgegeven IDs. |
| druleids | string/array | Geef alleen ontdekte hosts terug die zijn aangemaakt door de opgegeven ontdekkingsregels. |
| dserviceids | string/array | Geef alleen ontdekte hosts terug die de opgegeven services uitvoeren. |
| selectDRules | query | Geef een eigenschap drules terug met een reeks ontdekkingsregels die de host hebben gedetecteerd. |
| selectDServices | query | Geef een eigenschap dservices terug met de ontdekte services die op de host worden uitgevoerd. Ondersteunt count. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Geldt voor de volgende subselecties: selectDServices - resultaten worden gesorteerd op dserviceid. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: dhostid, druleid. |
| countOutput | boolean | Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in de referentie-toelichting. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Teruggegeven waarden
(integer/array) Geeft ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputis gebruikt.
Voorbeelden
Opvragen van ontdekte hosts via ontdekkingsregel
Haal alle hosts en de ontdekte services die ze uitvoeren op die zijn gedetecteerd door ontdekkingsregel "4".
{
"jsonrpc": "2.0",
"method": "dhost.get",
"params": {
"output": "extend",
"selectDServices": "extend",
"druleids": "4"
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"dservices": [
{
"dserviceid": "1",
"dhostid": "1",
"type": "4",
"key_": "",
"value": "",
"port": "80",
"status": "0",
"lastup": "1337697227",
"lastdown": "0",
"dcheckid": "5",
"ip": "192.168.1.1",
"dns": "station.company.lan"
}
],
"dhostid": "1",
"druleid": "4",
"status": "0",
"lastup": "1337697227",
"lastdown": "0"
},
{
"dservices": [
{
"dserviceid": "2",
"dhostid": "2",
"type": "4",
"key_": "",
"value": "",
"port": "80",
"status": "0",
"lastup": "1337697234",
"lastdown": "0",
"dcheckid": "5",
"ip": "192.168.1.4",
"dns": "john.company.lan"
}
],
"dhostid": "2",
"druleid": "4",
"status": "0",
"lastup": "1337697234",
"lastdown": "0"
},
{
"dservices": [
{
"dserviceid": "3",
"dhostid": "3",
"type": "4",
"key_": "",
"value": "",
"port": "80",
"status": "0",
"lastup": "1337697234",
"lastdown": "0",
"dcheckid": "5",
"ip": "192.168.1.26",
"dns": "printer.company.lan"
}
],
"dhostid": "3",
"druleid": "4",
"status": "0",
"lastup": "1337697234",
"lastdown": "0"
},
{
"dservices": [
{
"dserviceid": "4",
"dhostid": "4",
"type": "4",
"key_": "",
"value": "",
"port": "80",
"status": "0",
"lastup": "1337697234",
"lastdown": "0",
"dcheckid": "5",
"ip": "192.168.1.7",
"dns": "mail.company.lan"
}
],
"dhostid": "4",
"druleid": "4",
"status": "0",
"lastup": "1337697234",
"lastdown": "0"
}
],
"id": 1
}Zie ook
Bron
CDHost::get() in ui/include/classes/api/services/CDHost.php.