Documentation
Table of Contents
dhost.get
Description
integer/array dhost.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des h?tes d¨¦couverts en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du r?le utilisateur. Voir les r?les utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| dhostids | string/array | Renvoie uniquement les h?tes d¨¦couverts avec les ID donn¨¦s. |
| druleids | string/array | Renvoie uniquement les h?tes d¨¦couverts cr¨¦¨¦s par les r¨¨gles de d¨¦couverte donn¨¦es. |
| dserviceids | string/array | Renvoie uniquement les h?tes d¨¦couverts qui ex¨¦cutent les services donn¨¦s. |
| selectDRules | query | Renvoie une propri¨¦t¨¦ drules contenant un tableau des r¨¨gles de d¨¦couverte qui ont d¨¦tect¨¦ l'h?te. |
| selectDServices | query | Renvoie une propri¨¦t¨¦ dservices contenant les services d¨¦couverts ex¨¦cut¨¦s sur l'h?te. Supporte count. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoy¨¦s par les sous-requ¨ºtes. S'applique aux sous-s¨¦lections suivantes : selectDServices - les r¨¦sultats seront tri¨¦s par dserviceid. |
| sortfield | string/array | Trie le r¨¦sultat par les propri¨¦t¨¦s donn¨¦es. Les valeurs possibles sont : dhostid and druleid. |
| countOutput | boolean | Ces param¨¨tres, communs ¨¤ toutes les m¨¦thodes get, sont d¨¦crits dans les commentaires de r¨¦f¨¦rence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retourn¨¦es
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemple
R¨¦cup¨¦ration des h?tes d¨¦couverts par r¨¨gle de d¨¦couverte
R¨¦cup¨¦rer tous les h?tes et les services d¨¦couverts qu'ils ex¨¦cutent, d¨¦tect¨¦s par la r¨¨gle de d¨¦couverte "4".
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "dhost.get",
"params": {
"output": "extend",
"selectDServices": "extend",
"druleids": "4"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"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
}Voir ¨¦galement
Source
CDHost::get() dans ui/include/classes/api/services/CDHost.php.