Sommaire
dcheck.get
Description
integer/array dcheck.get(object parameters)
La méthode permet de récupérer les vérifications de découverte selon les 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 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 |
|---|---|---|
| dcheckids | ID/array | Retourner uniquement les vérifications de découverte avec les ID donnés. |
| druleids | ID/array | Retourner uniquement les vérifications de découverte qui appartiennent aux règles de découverte données. |
| dserviceids | ID/array | Retourner uniquement les vérifications de découverte qui ont détecté les services découverts donnés. |
| selectDRules | query | Retourner les règles de découverte liées aux vérifications de découverte. |
| sortfield | string/array | Trier le résultat selon les propriétés données. Valeurs possibles : dcheckid, druleid. |
| 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
countOutputa été utilisé.
Exemples
Récupérer les vérifications de découverte pour une règle de découverte
Récupérez toutes les vérifications de découverte utilisées par la règle de découverte « 6 ».
Requête :
{
"jsonrpc": "2.0",
"method": "dcheck.get",
"params": {
"output": "extend",
"dcheckids": "6"
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"dcheckid": "6",
"druleid": "4",
"type": "3",
"key_": "",
"snmp_community": "",
"ports": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"snmpv3_contextname": "",
"host_source": "1",
"name_source": "0",
"allow_redirect": "0"
}
],
"id": 1
}
Source
CDCheck::get() dans ui/include/classes/api/services/CDCheck.php.