Documentation
Table of Contents
- host.get
- Descripció
- Paràmetres
- Valors de retorn
- Exemples
- Recuperar informació per nom
- Recuperar els grups d'equips
- Recuperar les plantilles enllaçades
- Recuperar equips per plantilla
- Cerca d'equip per les dades de l'inventari
- Cerca per etiquetes d'equip
- Cerca d'equips amb les etiquetes i les etiquetes de les plantilles
- Cerca d'equips per gravetat del problema
- Veieu també
- Font
host.get
Descripció
integer/array host.get(object parameters)
El mètode permet recuperar equips segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres definit la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| groupids | string/array | Retorna només els equips que pertanyen als grups donats. |
| dserviceids | string/array | Retorna només els equips associats amb els serveis descoberts donats. |
| graphids | string/array | Retorna només els equips que tenen els gràfics indicats. |
| hostids | string/array | Retorna només els equips amb els ID d'equip donats. |
| httptestids | string/array | Retorna només els equips amb els monitors web indicats. |
| interfaceids | string/array | Retorna només els equips que empren les interfícies donades. |
| itemids | string/array | Retorna només els equips amb els elements donats. |
| maintenanceids | string/array | Retorna només els equips afectats pels manteniments donats. |
| monitored_hosts | mark | Retorna només els equips supervisats. |
| proxy_hosts | mark | Només retorna proxys. |
| proxyids | string/array | Retorna només els equips supervisats pels proxys donats. |
| templated_hosts | flag | Retorna equips i plantilles. |
| templateids | string/array | Retorna només els equips vinculats a les plantilles donades. |
| triggerids | string/array | Retorna només els equips amb els triggers donats. |
| with_items | flag | Retorna només els equips que tenen elements. Substitueix els paràmetres with_monitored_items i with_simple_graph_items. |
| with_item_prototypes | mark | Retorna només els equips que tenen prototipus d'elements. Anul·la el paràmetre with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | marcador | Retorna només els equips que tenen prototipus d'elements, són habilitats per a la creació i tenen informació de tipus numèric. |
| with_graphs | flag | Retorna només equips amb gràfics. |
| with_graph_prototypes | mark | Retorna només els equips amb prototips de gràfics. |
| with_httptests | mark | Retorna només equips amb supervisió web. Anul·la la configuració with_monitored_httptests. |
| with_monitored_httptests | mark | Retorna només equips amb monitors web actius. |
| with_monitored_items | mark | Retorna només els equips amb elements actius. Anul·la la configuració with_simple_graph_items. |
| with_monitored_triggers | mark | Retorna només els equips amb triggers actius. També s'han d'activar tots els elements emprats al trigger. |
| with_simple_graph_items | mark | Retorna només els equips amb elements que contenen informació de tipus numèric. |
| with_triggers | flag | Retorna només els equips amb triggers. Anul·la la configuració with_monitored_triggers. |
| withProblemsSuppressed | boolean | Retorna els equips amb problemes esborrats. Valors possibles: null - (per defecte) tots els equips;true: només els equips amb problemes eborrats;<br >false: només els equips amb problemes no esborrats. |
| evaltype | integer | Regles de cerca d'etiquetes. Valors possibles: 0 - (per defecte) i/o; 2 - O. |
| severities | integer/array | Retorna els equips que només tenen problemes amb una gravetat determinada. S'aplica només si l'objecte problemàtic és un trigger. |
| tags | array/object | Retorna només els equips amb etiquetes donades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no per valor d'etiqueta en funció del valor de l'operador. Format: [{"tag": "<etiqueta>", "value": "< valor>", "operator": "<operador>"}, ...].Una matriu buida retorna tots els equips. Possibles valors d'operador: 0 - (per defecte) Conté; 1 - És igual; 2 - No és com; 3 - No és igual 4 - Existeix; 5 - No existeix. |
| inheritedTags | boolean | Retorna els equips que tenen etiquetes donades així com en totes les seves plantilles enllaçades. Valors per defecte:Possibles valors: true: els models enllaçats també han de tenir les etiquetes;false: les etiquetes de models enllaçats (per defecte) s'ignoren. |
| selectDiscoveries | query | Retorna una propietat descobertes que conté regles de descoberta de baix nivell. Admet count. |
| selectDiscoveryRule | query | Retorna una propietat discoveryRule amb la regla de descoberta de baix nivell que va crear l'equip (a partir del prototip d'equip a la supervisió de VMware). |
| selectGraphs | query | Retorna una propietat gràfics amb gràfics de l'equip. Admet count. |
| selectGroups | query | Retorna una propietat grups amb els grups d'equip als quals pertany l'equip. |
| selectHostDiscovery | query | Retorna una propietat hostDiscovery amb dades de l'objecte de descoberta de l'equip.L'objecte de descoberta de l'equip enllaça un equip descobert a un prototip o un prototip d'equips a una regla de descoberta de baix nivell i té les propietats següents: host - (cadena) equip de l'equip prototip;hostid - (cadena) Id de l'equip descobert o equip prototip;<br >parent_hostid - ( string) ID del prototip d'equip a partir del qual es va crear l'equip;parent_itemid - (cadena) ID de la regla de descoberta de baix nivell que va crear l'equip descobert;darrera comprovació - (timestamp) hora en què es va descobrir l'equip per darrera vegada;ts_delete - (timestamp) hora en què s'eliminarà un equip que ja no es descobreix. |
| selectHttpTests | query | Retorna una propietat httpTests amb escenaris web d'equip. Admet count. |
| selectInterfaces | query | Retorna una propietat interfícies amb interfícies d'equip. Admet count. |
| selectInventory | query | Retorna una propietat inventari amb dades d'inventari de l'equip. |
| selectItems | query | Retorna una propietat elements amb elements de l'equip. Admet count. |
| selectMacros | query | Retorna una propietat de macros amb macros de l'equip. |
| selectParentTemplates | query | Retorna una propietat parentTemplates amb les plantilles a les quals està vinculat l'equip. Admet count. |
| selectDashboards | query | Retorna una propietat taulers. Admet count. |
| selectTags | query | Retorna una propietat etiquetes amb totes les etiquetes d'equip. |
| selectInheritedTags | query | Retorna una propietat inheritedTags amb les etiquetes que es troben a tots els models vinculats a l'equip. |
| selectTriggers | query | Retorna una propietat triggers amb triggers de l'equip. Admet count. |
| selectValueMaps | query | Retorna una propietat valuemaps amb mapes de valors de l'equip. |
| filter | object | Només retorna resultats que coincideixen exactament amb el filtre donat. Accepta una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.< br> Permet filtrar per propietats de la interfície. |
| limitSelects | integer | Limita el nombre de registres retornats per subconsultes. S'aplica a les subconsultes següents: selectParentTemplates - els resultats s'ordenaran per host;< br>selectInterfaces;< br>selectItems - ordenat per name;selectDiscoveries - ordenat per name;selectTriggers - ordenat per description;selectGraphs - ordenat per name ;selectDashboards - ordenat per name. |
| search | object | Retorna resultats que coincideixen amb la cerca genèrica donada. Accepta una matriu on les claus són noms de propietat i els valors són cadenes per cercar. Si no es donen opcions addicionals, es farà una cerca LIKE "%...%".Us permet cercar per propietats de la interfície. Només funciona amb camps de text. |
| searchInventory | object | Retorna només els equips les dades d'inventari dels quals coincideixen amb la cerca genèrica donada. Aquest paràmetre es veu afectat pels mateixos paràmetres addicionals que "cerca". |
| sortfield | string/array | Ordena el resultat segons les propietats donades. Valors possibles: hostid, host, name, status. |
| countOutput | boolean | Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar informació per nom
Recuperar tota la informació de dos equips anomenats "Servidor Zabbix " i "Servidor Linux".
Request:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Servidor Zabbix",
"Servidor Linux"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"proxy_hostid": "0",
"host": "Zabbix server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Zabbix server",
"flags": "0",
"description": "The Zabbix monitoring server.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1"
},
{
"hostid": "10167",
"proxy_hostid": "0",
"host": "Linux server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux server",
"flags": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1"
}
],
"id": 1
}Recuperar els grups d'equips
Recupera els noms dels grups on l'equip "Servidor Zabbix" n'és membre; però no recupera pas els detalls de l'equip.
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectGroups": "extend",
"filter": {
"host": [
"Servidor Zabbix"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"groups": [
{
"groupid": "2",
"name": "Linux servers",
"internal": "0",
"flags": "0"
},
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0",
"flags": "0"
}
]
}
],
"id": 2
}Recuperar les plantilles enllaçades
Recupera l'ID i els noms de les plantilles enllaçades a l'equip "10084".
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1,
"auth": "70785d2b494a7302309b48afcdb3a401"
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Recuperar equips per plantilla
Recupera els equips que tenen la plantilla "10001" (Linux amb agent Zabbix) enllaçada.
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"auth": "70785d2b494a7302309b48afcdb3a401",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Cerca d'equip per les dades de l'inventari
Cerca els equips que contenen "Linux" al camp OS" de l'inventari.
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 2,
"auth": "7f9e00124c75e8f25facd5c093f3e9a0"
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Zabbix server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}Cerca per etiquetes d'equip
Recupera els equips que tenen "Servidor Linux" com a etiqueta de "Host name".
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Host name",
"value": "Servidor Linux",
"operator": 1
}
]
},
"auth": "7f9e00124c75e8f25facd5c093f3e9a0",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "Host name",
"value": "Linux server"
},
{
"tag": "OS",
"value": "RHEL 7"
}
]
}
],
"id": 1
}Recupera els equips que tenen aquestes etiquetes no només a nivell d'equip, sinó també dins les plantilles mare enllaçades.
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [{"tag": "A", "value": "1", "operator": "0"}],
"inheritedTags": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}Cerca d'equips amb les etiquetes i les etiquetes de les plantilles
Cerca un equip amb les etiquetes i totes les etiquetes enllaçades a les plantilles mare.
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "A",
"value": "1"
}
],
"inheritedTags": [
{
"tag": "B",
"value": "2"
}
]
}
],
"id": 1
}Cerca d'equips per gravetat del problema
Cerca els equips que tenen problemes amb gravetat "Desastre".
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
Recupera els equips que tenen com gravetat "Mitjana" i "Alta".
Petició:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}Veieu també
Font
CHost::get() in ui/include/classes/api/services/CHost.php.