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.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | 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) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ 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.