Documentation
Table of Contents
host.get
Description
integer/array host.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des h?tes 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 |
|---|---|---|
| groupids | string/array | Renvoie uniquement les h?tes appartenant aux groupes donn¨¦s. |
| applicationids | string/array | Renvoie uniquement les h?tes ayant les applications donn¨¦es. |
| dserviceids | string/array | Renvoie uniquement les h?tes associ¨¦s aux services d¨¦couverts donn¨¦s. |
| graphids | string/array | Renvoie uniquement les h?tes qui ont les graphiques donn¨¦s. |
| hostids | string/array | Renvoyer uniquement les h?tes avec les ID d'h?te donn¨¦s. |
| httptestids | string/array | Renvoie uniquement les h?tes ayant les surveillances Web donn¨¦es. |
| interfaceids | string/array | Renvoie uniquement les h?tes qui utilisent les interfaces donn¨¦es. |
| itemids | string/array | Renvoie uniquement les h?tes ayant les ¨¦±ô¨¦³¾±ð²Ô³Ù²õ donn¨¦s. |
| maintenanceids | string/array | Renvoie uniquement les h?tes affect¨¦s par les maintenances donn¨¦es. |
| monitored_hosts | flag | Renvoyer uniquement les h?tes surveill¨¦s. |
| proxy_hosts | flag | Renvoie uniquement les proxies. |
| proxyids | string/array | Renvoie uniquement les h?tes surveill¨¦s par les proxies donn¨¦s. |
| templated_hosts | flag | Renvoie les h?tes et les ³¾´Ç»å¨¨±ô±ð²õ. |
| templateids | string/array | Renvoie uniquement les h?tes li¨¦s aux ³¾´Ç»å¨¨±ô±ð²õ donn¨¦s. |
| triggerids | string/array | Renvoie uniquement les h?tes ayant les »å¨¦³¦±ô±ð²Ô³¦³ó±ð³Ü°ù²õ donn¨¦s. |
| with_items | flag | Renvoie uniquement les h?tes qui ont des ¨¦±ô¨¦³¾±ð²Ô³Ù²õ. ?crase les param¨¨tres with_monitored_items et with_simple_graph_items. |
| with_applications | flag | Renvoie uniquement les h?tes ayant des applications. |
| with_graphs | flag | Renvoie uniquement les h?tes dot¨¦s de graphiques. |
| with_httptests | flag | Renvoie uniquement les h?tes disposant de surveillance Web. ?crase le param¨¨tre with_monitored_httptests. |
| with_monitored_httptests | flag | Renvoie uniquement les h?tes ayant des surveillances Web actives. |
| with_monitored_items | flag | Renvoie uniquement les h?tes ayant des ¨¦±ô¨¦³¾±ð²Ô³Ù²õ actifs. ?crase le param¨¨tre with_simple_graph_items. |
| with_monitored_triggers | flag | Renvoie uniquement les h?tes ayant des »å¨¦³¦±ô±ð²Ô³¦³ó±ð³Ü°ù²õ actifs. Tous les ¨¦±ô¨¦³¾±ð²Ô³Ù²õ utilis¨¦s dans le d¨¦clencheur doivent ¨¦galement ¨ºtre activ¨¦s. |
| with_simple_graph_items | flag | Renvoie uniquement les h?tes contenant des ¨¦±ô¨¦³¾±ð²Ô³Ù²õ contenant des informations de type num¨¦rique. |
| with_triggers | flag | Renvoie uniquement les h?tes ayant des »å¨¦³¦±ô±ð²Ô³¦³ó±ð³Ü°ù²õ. ?crase le param¨¨tre with_monitored_triggers. |
| withInventory | flag | Renvoie uniquement les h?tes disposant de donn¨¦es d'inventaire. |
| selectGroups | query | Renvoie une propri¨¦t¨¦ groups avec les groupes h?tes auxquels l'h?te appartient. |
| selectApplications | query | Renvoie une propri¨¦t¨¦ applications avec les applications h?tes.Supporte count. |
| selectDiscoveries | query | Renvoie une propri¨¦t¨¦ discoveries avec les r¨¨gles de d¨¦couverte bas niveau.Supporte count. |
| selectDiscoveryRule | query | Renvoie une propri¨¦t¨¦ discoveryRule avec la r¨¨gle de d¨¦couverte de bas niveau qui a cr¨¦¨¦ l'h?te (¨¤ partir du prototype d'h?te dans la surveillance VMware). |
| selectGraphs | query | Renvoie une propri¨¦t¨¦ graphs avec les graphiques d'h?tes.Supporte count. |
| selectHostDiscovery | query | Renvoie une propri¨¦t¨¦ hostDiscovery avec les donn¨¦es d'objet de d¨¦couverte d'h?te.L'objet de d¨¦couverte d'h?te lie un h?te d¨¦couvert ¨¤ un prototype d'h?te ou un prototype ¨¤ une r¨¨gle de d¨¦couverte bas niveau et poss¨¨de les propri¨¦t¨¦s suivantes : host - (string) h?te du prototype d'h?te ;hostid - (string) ID de l'h?te d¨¦couvert ou du prototype d'h?te ;parent_hostid - (string) ID du prototype d'h?te ¨¤ partir duquel l'h?te a ¨¦t¨¦ cr¨¦¨¦ ;parent_itemid - (string) ID de la r¨¨gle de d¨¦couverte bas niveau qui a cr¨¦¨¦ l'h?te d¨¦couvert ;lastcheck - (timestamp) heure de la derni¨¨re d¨¦couverte de l'h?te ;ts_delete - (timestamp) heure ¨¤ laquelle un h?te qui n'est plus d¨¦couvert sera supprim¨¦. |
| selectHttpTests | query | Renvoie une propri¨¦t¨¦ '' httpTests'' avec les sc¨¦narios Web de l'h?te. Supporte count. |
| selectInterfaces | query | Renvoie une propri¨¦t¨¦ interfaces avec les interfaces h?tes.Supporte count. |
| selectInventory | query | Renvoie une propri¨¦t¨¦ inventory avec les donn¨¦es d'inventaire de l'h?te. |
| selectItems | query | Renvoie une propri¨¦t¨¦ items avec les ¨¦±ô¨¦³¾±ð²Ô³Ù²õ de l'h?te.Supporte count. |
| selectMacros | query | Renvoie une propri¨¦t¨¦ macros avec les macros de l'h?te. |
| selectParentTemplates | query | Renvoie une propri¨¦t¨¦ parentTemplates avec les ³¾´Ç»å¨¨±ô±ð²õ auxquels l'h?te est li¨¦.Supporte count. |
| selectScreens | query | Renvoie une propri¨¦t¨¦ screens avec les ¨¦³¦°ù²¹²Ô²õ d'h?tes.Supporte count. |
| selectTriggers | query | Renvoie une propri¨¦t¨¦ triggers avec les »å¨¦³¦±ô±ð²Ô³¦³ó±ð³Ü°ù²õ de l'h?te.Supporte count. |
| 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. Permet le filtrage par les propri¨¦t¨¦s de l'interface. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoy¨¦s par les sous-requ¨ºtes. S'applique aux sous-requ¨ºtes suivantes: selectParentTemplates - les r¨¦sultats seront tri¨¦s par host ;selectInterfaces ;selectItems - tri¨¦s par name ;selectDiscoveries - tri¨¦s par name ;selectTriggers - tri¨¦s par description ;selectGraphs - tri¨¦s par name ;selectApplications - tri¨¦s par name ;selectScreens - tri¨¦s par name. |
| search | object | Renvoie les r¨¦sultats correspondant ¨¤ la recherche g¨¦n¨¦rique donn¨¦e. Accepte un tableau dans lequel les cl¨¦s sont des noms de propri¨¦t¨¦s et les valeurs sont des cha?nes ¨¤ rechercher. Si aucune option suppl¨¦mentaire n'est donn¨¦e, cela effectuera une recherche LIKE "%¡%".Permet de rechercher par propri¨¦t¨¦s de l'interface. Fonctionne uniquement avec les champs de texte. |
| searchInventory | object | Renvoie uniquement les h?tes dont les donn¨¦es d'inventaire correspondent ¨¤ la recherche g¨¦n¨¦rique donn¨¦e. Ce param¨¨tre est affect¨¦ par les m¨ºmes param¨¨tres suppl¨¦mentaires que "search". |
| sortfield | string/array | Trie le r¨¦sultat en fonction des propri¨¦t¨¦s donn¨¦es. Valeurs possibles : hostid, host, name, 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 | |
| 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 donn¨¦es par nom
R¨¦cup¨¦rer toutes les donn¨¦es sur deux h?tes nomm¨¦s "Áú»¢¶Ä²© server" et "Linux server".
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Áú»¢¶Ä²© server",
"Linux server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"maintenances": [],
"hostid": "10160",
"proxy_hostid": "0",
"host": "Áú»¢¶Ä²© server",
"status": "0",
"disable_until": "0",
"error": "",
"available": "0",
"errors_from": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"ipmi_available": "0",
"snmp_disable_until": "0",
"snmp_available": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"ipmi_errors_from": "0",
"snmp_errors_from": "0",
"ipmi_error": "",
"snmp_error": "",
"jmx_disable_until": "0",
"jmx_available": "0",
"jmx_errors_from": "0",
"jmx_error": "",
"name": "Áú»¢¶Ä²© server",
"description": "The Áú»¢¶Ä²© monitoring server.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": ""
},
{
"maintenances": [],
"hostid": "10167",
"proxy_hostid": "0",
"host": "Linux server",
"status": "0",
"disable_until": "0",
"error": "",
"available": "0",
"errors_from": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"ipmi_available": "0",
"snmp_disable_until": "0",
"snmp_available": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"ipmi_errors_from": "0",
"snmp_errors_from": "0",
"ipmi_error": "",
"snmp_error": "",
"jmx_disable_until": "0",
"jmx_available": "0",
"jmx_errors_from": "0",
"jmx_error": "",
"name": "Linux server",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": ""
}
],
"id": 1
}R¨¦cup¨¦ration des groupes d'h?tes
R¨¦cup¨¦rer les noms des groupes dont l'h?te "Áú»¢¶Ä²© server" est membre, mais aucun d¨¦tail sur l'h?te lui-m¨ºme.
¸é±ð±ç³Ü¨º³Ù±ð:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectGroups": "extend",
"filter": {
"host": [
"Áú»¢¶Ä²© server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"groups": [
{
"groupid": "2",
"name": "Linux servers",
"internal": "0",
"flags": "0"
},
{
"groupid": "4",
"name": "Áú»¢¶Ä²© servers",
"internal": "0",
"flags": "0"
}
]
}
],
"id": 2
}R¨¦cup¨¦ration des ³¾´Ç»å¨¨±ô±ð²õ li¨¦s
R¨¦cup¨¦rer les identifiants et les noms des ³¾´Ç»å¨¨±ô±ð²õ li¨¦s ¨¤ l'h?te "10084".
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1,
"auth": "70785d2b494a7302309b48afcdb3a401"
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Template OS Linux",
"templateid": "10001"
},
{
"name": "Template App Áú»¢¶Ä²© Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Recherche par donn¨¦es d'inventaire de l'h?te
R¨¦cup¨¦rer les h?tes qui contiennent "Linux" dans le champ "OS" de l'inventaire d'h?te.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 2,
"auth": "7f9e00124c75e8f25facd5c093f3e9a0"
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Áú»¢¶Ä²© server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}Voir ¨¦galement
Source
CHost::get() dans frontends/php/include/classes/api/services/CHost.php.