Documentation
Table of Contents
itemprototype.get
Description
integer/array itemprototype.get(object parameters)
La méthode permet de récupérer des prototypes d'éléments en fonction des paramètres donnés.
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 | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux règles de découverte bas niveau données. |
| graphids | string/array | Renvoie uniquement les prototypes d'éléments utilisés dans les prototypes de graphique donnés. |
| hostids | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux hôtes donnés. |
| inherited | boolean | Si défini à true, ne renvoie que les prototypes d'éléments hérités d'un modèle. |
| itemids | string/array | Renvoie uniquement les prototypes d'éléments avec les identifiants donnés. |
| monitored | boolean | Si défini à true, ne renvoie que les prototypes d'éléments activés appartenant aux hôtes surveillés. |
| templated | boolean | Si défini à true, ne renvoie que les prototypes d'éléments appartenant aux modèles. |
| templateids | string/array | Renvoie uniquement les prototypes d'éléments appartenant aux modèles donnés. |
| triggerids | string/array | Renvoie uniquement les prototypes d'éléments utilisés dans les prototypes de déclencheur donnés. |
| selectApplications | query | Renvoie les applications auxquelles le prototype d'élément appartient dans la propriété applications. |
| selectApplicationPrototypes | query | Renvoie les prototypes d'application liés au prototype d'élément dans la propriété applicationPrototypes. |
| selectDiscoveryRule | query | Renvoie la règle de découverte bas niveau qui a créé le prototype d'élément dans la propriété discoveryRule. |
| selectGraphs | query | Renvoie les prototypes de graphique contenant le prototype d'élément dans la propriété graphs.Supporte count. |
| selectHosts | query | Renvoie l'hôte auquel le prototype d'élément appartient en tant que tableau dans la propriété hosts. |
| selectTriggers | query | Renvoie les prototypes de déclencheur qui utilisent ce prototype d'élément dans la propriété triggers.Supporte count. |
| selectPreprocessing | query | Renvoie les options de pré-traitement des éléments dans la propriété preprocessing.Il a les propriétés suivantes : type - (string) Les types d'option de pré-traitement :1 - Multiplicateur personnalisé ; 2 - Suppression des espaces à droite ; 3 - Suppression des espaces à gauche ; 4 - Suppression des espaces à droite et à gauche ; 5 - Correspondance d'expression régulière ; 6 - Booléen vers décimal ; 7 - Octal vers décimal ; 8 - Hexadécimal vers décimal ; 9 - Changement simple ; 10 - Changement par seconde. params - (string) Paramètres supplémentaires utilisés par l'option de pré-traitement. Plusieurs paramètres sont séparés par un caractère LF (\n). |
| filter | object | Renvoie uniquement les résultats qui correspondent exactement au filtre donné. Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont une valeur unique ou un tableau de valeurs à comparer. Prend en charge des filtres supplémentaires : host - nom technique de l'hôte auquel le prototype d'élément appartient |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-requêtes suivantes : selectGraphs - les résultats seront triés par name ;selectTriggers - les résultats seront triés par description. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : itemid, name, key_, delay, type et status. |
| 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 | |
| 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ération des prototypes d'éléments d'une règle de découverte bas niveau
Récupérer tous les prototypes d’éléments d’une règle de découverte bas niveau.
Requête :
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23077",
"type": "0",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10079",
"name": "Incoming network traffic on $1",
"key_": "net.if.in[en0]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "bps",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"formula": "",
"error": "",
"lastlogsize": "0",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"mtime": "0",
"flags": "0",
"interfaceid": "0",
"port": "",
"description": "",
"inventory_link": "0",
"lifetime": "30d",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"state": "0",
"snmpv3_contextname": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "10010",
"type": "0",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10001",
"name": "Processor load (1 min average per core)",
"key_": "system.cpu.load[percpu,avg1]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"formula": "",
"error": "",
"lastlogsize": "0",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"mtime": "0",
"flags": "0",
"interfaceid": "0",
"port": "",
"description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
"inventory_link": "0",
"lifetime": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"state": "0",
"snmpv3_contextname": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}Recherche de prototype d'élément d'agent HTTP
Rechercher le prototype d'élément d'agent HTTP avec la méthode de requête HEAD pour un ID d'hôte spécifique.
Requête :
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28257",
"type": "19",
"snmp_community": "",
"snmp_oid": "",
"hostid": "10254",
"name": "discovered",
"key_": "item[{#INAME}]",
"delay": "{#IUPDATE}",
"history": "90d",
"trends": "30d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"formula": "",
"error": "",
"lastlogsize": "0",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"mtime": "0",
"flags": "2",
"interfaceid": "2",
"port": "",
"description": "",
"inventory_link": "0",
"lifetime": "30d",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"state": "0",
"snmpv3_contextname": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "{#IURL}",
"query_fields": [],
"posts": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0"
}
],
"id": 17
}Voir également
Source
CItemPrototype::get() dans frontends/php/include/classes/api/services/CItemPrototype.php.
Source
CItemPrototype::get() in frontends/php/include/classes/api/services/CItemPrototype.php.