Sidebar

dservice.get

Description

integer/array dservice.get(object parameters)

La méthode permet de récupérer des services découverts en fonction des paramètres donnés.

Cette méthode est disponible pour tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
dserviceids string/array Renvoie uniquement les services découverts avec les ID donnés.
dhostids string/array Renvoie uniquement les services découverts appartenant aux hôtes découverts donnés.
dcheckids string/array Renvoie uniquement les services découverts qui ont été détectés par les tests de découverte donnés.
druleids string/array Renvoie uniquement les services découverts créés par les règles de découverte données.
selectDRules query Renvoie une propriété drules avec un tableau des règles de découverte qui ont détecté le service.
selectDHosts query Renvoie une propriété dhosts avec un tableau les hôtes découverts auxquels le service appartient.
selectHosts query Renvoie une propriété hosts avec les hôtes avec la même adresse IP et le même proxy que le service.

Prend en charge count.
limitSelects integer Limite le nombre d'enregistrements renvoyés par les sous-requêtes.

S'applique aux sous-sélections suivantes :
selectHosts - les résultats seront triés par hostid.
sortfield string/array Trie le résultat par les propriétés données.

Les valeurs possibles sont: dserviceid, dhostid et ip.
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 countOutput a été utilisé.

Exemples

Récupération des services découverts sur un hôte

Récupérer tous les services découverts détectés sur l'hôte découvert "11".

Requête :

{
           "jsonrpc": "2.0",
           "method": "dservice.get",
           "params": {
               "output": "extend",
               "dhostids": "11"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dserviceid": "12",
                   "dhostid": "11",
                   "value": "",
                   "port": "80",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650607",
                   "dcheckid": "5",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               },
               {
                   "dserviceid": "13",
                   "dhostid": "11",
                   "value": "",
                   "port": "21",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650610",
                   "dcheckid": "6",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               }
           ],
           "id": 1
       }

Voir également

Source

CDService::get() dans ui/include/classes/api/services/CDService.php.