This is a translation of the original English documentation page. Help us make it better.

dcheck.get

Description

integer/array dcheck.get(object parameters)

La méthode permet de récupérer des vérifications de découverte 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.

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 string/array Renvoie uniquement les vérifications de découverte avec les ID donnés.
druleids string/array Renvoie uniquement les vérifications de découverte appartenant aux règles de découverte données.
dserviceids string/array Renvoie uniquement les vérifications de découverte qui ont détecté les services découverts donnés.
sortfield string/array Trie le résultat par les propriétés données.

Les valeurs possibles sont : dcheckid et 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
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 de tests de découverte d'une règle de découverte

Récupérer toutes les vérifications de découverte utilisés par la règle de découverte "6".

Requête :

{
           "jsonrpc": "2.0",
           "method": "dcheck.get",
           "params": {
               "output": "extend",
               "dcheckids": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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",
                   "host_source": "1",
                   "name_source": "0"            
               }
           ],
           "id": 1
       }

Source

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