discoveryruleprototype.get

Description

integer/array discoveryruleprototype.get(object parameters)

La méthode permet de récupérer les prototypes de règles LLD selon les paramètres fournis.

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 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
discoveryids ID/array Retourner uniquement les prototypes de règle LLD qui appartiennent aux règles LLD ou aux prototypes de règle LLD donnés.
itemids ID/array Retourner uniquement les prototypes de règle LLD avec les ID donnés.
groupids ID/array Retourner uniquement les prototypes de règle LLD qui appartiennent aux hôtes des groupes donnés.
hostids ID/array Retourner uniquement les prototypes de règle LLD qui appartiennent aux hôtes donnés.
inherited boolean Si défini sur true, retourner uniquement les prototypes de règle LLD hérités d’un modèle.
interfaceids ID/array Retourner uniquement les prototypes de règle LLD qui utilisent les interfaces d’hôte données.
monitored boolean Si défini sur true, retourner uniquement les prototypes de règle LLD activés qui appartiennent à des hôtes surveillés.
templated boolean Si défini sur true, retourner uniquement les prototypes de règle LLD qui appartiennent à des modèles.
templateids ID/array Retourner uniquement les prototypes de règle LLD qui appartiennent aux modèles donnés.
selectDiscoveryRule query Retourner une propriété discoveryRule avec la règle LLD parente du prototype de règle LLD.
Retournera une réponse vide si le parent est un prototype de règle de découverte.
selectDiscoveryRulePrototype query Retourner une propriété discoveryRulePrototype avec le prototype de règle LLD parent du prototype de règle LLD.
Retournera une réponse vide si le parent est une règle de découverte (et non un prototype).
selectDiscoveryRulePrototypes query Retourner une propriété discoveryRulePrototypes avec les prototypes de règle LLD enfants qui appartiennent au prototype de règle LLD.

Prend en charge count.
selectFilter query Retourner une propriété filter avec les données du filtre utilisé par le prototype de règle LLD.
selectGraphs query Retourner une propriété graphs avec les prototypes de graphique qui appartiennent au prototype de règle LLD.

Prend en charge count.
selectHostPrototypes query Retourner une propriété hostPrototypes avec les prototypes d’hôte qui appartiennent au prototype de règle LLD.

Prend en charge count.
selectHosts query Retourner une propriété hosts avec un tableau des hôtes auxquels appartient le prototype de règle LLD.
selectItems query Retourner une propriété items avec les prototypes d’élément qui appartiennent au prototype de règle LLD.

Prend en charge count.
selectTriggers query Retourner une propriété triggers avec les prototypes de déclencheur qui appartiennent au prototype de règle LLD.

Prend en charge count.
selectLLDMacroPaths query Retourner une propriété lld_macro_paths avec une liste de macros LLD et les chemins vers les valeurs attribuées à chaque macro correspondante.
selectPreprocessing query Retourner une propriété preprocessing avec les options de prétraitement du prototype de règle LLD.
selectOverrides query Retourner une propriété lld_rule_overrides avec une liste de filtres de substitution, de conditions et d’opérations effectuées sur les objets prototypes.
filter object Retourner uniquement les résultats qui correspondent exactement au filtre donné.

Accepte un objet, où les clés sont des noms de propriété et les valeurs sont soit une valeur unique, soit un tableau de valeurs à faire correspondre.

Ne prend pas en charge les propriétés de type de données text data type.

Prend en charge des propriétés supplémentaires :
host - nom technique de l’hôte auquel appartient le prototype de règle LLD.
limitSelects integer Limite le nombre d’enregistrements renvoyés par les sous-sélections.

S’applique aux sous-sélections suivantes : selectItems, selectGraphs, selectTriggers.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : itemid, name, key_, delay, type, status.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs de retour

(integer/array) renvoie 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 prototypes de règles de découverte à partir d’un hôte

Récupérez tous les prototypes de règles de découverte pour un ID d’hôte spécifique.

Requête:

{
    "jsonrpc": "2.0",
    "method": "discoveryruleprototype.get",
    "params": {
        "hostids": "10084"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Découvrir les tablespaces pour {#DB}",
            "key_": "db.tablespace.discovery[{#DB}]",
            "delay": "0",
            "history": "31d",
            "trends": "365d",
            "status": "0",
            "value_type": "4",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "3",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Voir aussi

Source

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