Documentation
Table of Contents
drule.get
Description
integer/array drule.get(object parameters)
La méthode permet de récupérer des règles de découverte en fonction des paramètres donnés.
Cette méthode est disponible à 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 |
|---|---|---|
| dhostids | string/array | Renvoie uniquement les règles de découverte qui ont créé les hôtes découverts donnés. |
| druleids | string/array | Renvoie uniquement les règles de découverte avec les ID donnés. |
| dserviceids | string/array | Renvoie uniquement les règles de découverte qui ont créé les services découverts donnés. |
| selectDChecks | query | Retourne une propriété dchecks contenant les tests de découverte utilisés par la règle de découverte . Supporte count. |
| selectDHosts | query | Retourne une propriété dhosts contenant les hôtes découverts créés par la règle de découverte. Supporte count. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-requêtes suivantes : selectDChecks - les résultats seront triés par dcheckid ;selectDHosts - les résultats seront triés par dhostsid. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : druleid et name. |
| 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
(entier/tableau) Renvoie soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération de toutes les règles de découverte
Récupérer toutes les règles de découverte configurées et les vérifications de découverte qu'elles utilisent.
Requête :
{
"jsonrpc": "2.0",
"method": "drule.get",
"params": {
"output": "extend",
"selectDChecks": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"druleid": "2",
"proxy_hostid": "0",
"name": "Local network",
"iprange": "192.168.3.1-255",
"delay": "5s",
"nextcheck": "1348754327",
"status": "0",
"dchecks": [
{
"dcheckid": "7",
"druleid": "2",
"type": "3",
"key_": "",
"snmp_community": "",
"ports": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
},
{
"dcheckid": "8",
"druleid": "2",
"type": "4",
"key_": "",
"snmp_community": "",
"ports": "80",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
}
]
},
{
"druleid": "6",
"proxy_hostid": "0",
"name": "Zabbix agent discovery",
"iprange": "192.168.1.1-255",
"delay": "1h",
"nextcheck": "0",
"status": "0",
"dchecks": [
{
"dcheckid": "10",
"druleid": "6",
"type": "9",
"key_": "system.uname",
"snmp_community": "",
"ports": "10050",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "2",
"name_source": "3"
}
]
}
],
"id": 1
}Voir également
Source
CDRule::get() dans ui/include/classes/api/services/CDRule.php.