dservice.get

Description

integer/array dservice.get(object parameters)

Cette méthode permet de récupérer les services découverts selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les permissions pour appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir User roles 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 ID/array Retourner uniquement les services découverts avec les ID indiqués.
dhostids ID/array Retourner uniquement les services découverts qui appartiennent aux hôtes découverts indiqués.
dcheckids ID/array Retourner uniquement les services découverts qui ont été détectés par les vérifications de découverte indiquées.
druleids ID/array Retourner uniquement les services découverts qui ont été détectés par les règles de découverte indiquées.
selectDRules query Retourner une propriété drules contenant un tableau des règles de découverte qui ont détecté le service.
selectDHosts query Retourner une propriété dhosts contenant un tableau des hôtes découverts auxquels le service appartient.
selectHosts query Retourner une propriété hosts contenant les hôtes ayant 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-sélections.

S’applique aux sous-sélections suivantes :
selectHosts - le résultat sera trié par hostid.
sortfield string/array Trier le résultat selon les propriétés indiquées.

Valeurs possibles : dserviceid, dhostid, ip.
countOutput boolean Ces paramètres sont décrits dans le commentaire 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érer les services découverts sur un hôte

Récupérez 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"
    },
    "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.