Table of Contents
dhost.get
Beschrijving
integer/array dhost.get(objectparameters)
De methode maakt het mogelijk om ontdekte hosts op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kunnen 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 ontdekte hosts met de opgegeven ID's.| |druleids|string/array|Retourneer alleen ontdekte hosts die zijn gemaakt door de gegeven ontdekkingsregels.| |dserviceids|string/array|Retourneer alleen ontdekte hosts die de opgegeven services uitvoeren.| |selectDRules|query|Retourneer een eigenschap drules met een array van de detectieregels die de host hebben gedetecteerd.| |selectDServices|query|Retourneer een eigenschap dservices waarbij de gedetecteerde services op de host worden uitgevoerd.
Ondersteunt count.| |limitSelects|integer|Beperkt het aantal records dat wordt geretourneerd door subselecties.
Van toepassing op de volgende subselecties:selectDServices - resultaten worden gesorteerd op dserviceid.| |sortfield|string/array|Sorteer het resultaat op de gegeven eigenschappen.
Mogelijke waarden zijn: dhostid en druleid.| |countOutput|boolean|Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar.| |editable|booleaans|^| |excludeSearch|boolean|^| |filter|object|^| |limit|geheel getal|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|booleaans|^|
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputis gebruikt.
Voorbeelden
Ontdekte hosts ophalen volgens ontdekkingsregel
Haal alle hosts en ontdekte services op die ontdekt zijn door ontdekkingsregel "4".
Verzoek:
{
"jsonrpc": "2.0",
"method": "dhost.get",
"params": {
"output": "extend",
"selectDServices": "extend",
"druleids": "4"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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.