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 ID/array Retorna només els equips que pertanyen als grups donats.
dserviceids ID/array Retorna només els equips associats amb els serveis descoberts donats.
graphids ID/array Retorna només els equips que tenen els gràfics indicats.
hostids ID/array Retorna només els equips amb els ID d'equip donats.
httptestids ID/array Retorna només els equips amb els monitors web indicats.
interfaceids ID/array Retorna només els equips que empren les interfícies donades.
itemids ID/array Retorna només els equips amb els elements donats.
maintenanceids ID/array Retorna només els equips afectats pels manteniments donats.
monitored_hosts flag Retorna només els equips monitorats.
proxyids ID/array Retorna només els equips monitorats pels proxys donats.
proxy_groupids ID/array Retorna només els equips que són monitorats per els grups de proxys donats.
templated_hosts flag Retorna tant equips com plantilles.
templateids ID/array Retorna només els equips vinculats a les plantilles donades.
triggerids ID/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 flag Retorna només els equips que tenen prototipus d'elements.

Sobreescriu el paràmetre with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag 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_graph flag Retorna només equips amb gràfics.
with_graph_prototypes flag Retorna només els equips amb prototips de gràfics.
with_httptests flag Retorna només equips amb monitoratge web.

Sobreescriu el paràmetre with_monitored_httptests.
with_monitored_httptests flag Retorna només equips amb monitors web actius.
with_monitored_items flag Retorna només els equips amb elements actius.

Anul·la la configuració with_simple_graph_items.
with_monitored_triggers flag Retorna només els equips amb triggers actius. També s'han d'activar tots els elements emprats al trigger.
with_simple_graph_items flag 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 object/array 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 - (per defecte) les etiquetes de models enllaçats s'ignoren.
selectDiscoveries query Retorna una propietat discoveries 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 al monitoratge de VMware).
selectGraphs query Retorna una propietat graphs amb gràfics de l'equip.

Admet count.
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 - (string) equip de l'equip prototip;
hostid - (string) Id de l'equip descobert o equip prototip;
parent_hostid - (string) ID del prototip d'equip a partir del qual es va crear l'equip;
parent_itemid - (string) ID de la regla de descoberta de baix nivell que va crear l'equip descobert;
lastcheck - (timestamp) hora en què es va trobar l'equip per darrer cop;
status - (int) estat de la descoberta de l'equip:
0 - (per defecte) l'euqip s'ha trobat,
1 - l'equip ja no es troba;
ts_delete - (timestamp) hora en què s'eliminarà un equip que ja no es descobreix;
ts_disable - (timestamp) hora quan l'equip que ja no es troba es desactivarà;
disable_source - (int) indicador sobre si l'equip s'ha deshabilitat per una regla LLD o manualment:
0 - (per defecte) desactivat automàticament,
1 - desactivat per una regla LLD.
selectHostGroups query Retorna una propietat hostgrups amb els grups d'equip als quals pertany l'equip.
selectHttpTests query Retorna una propietat httpTests amb escenaris web d'equip.

Admet count.
selectInterfaces query Retorna una propietat interfaces amb interfícies d'equip.

Admet count.
selectInventory query Retorna una propietat inventory amb dades d'inventari de l'equip.
selectItems query Retorna una propietat items 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.

A més dels camps de l'objecte de la plantilla, també conté link_type - (integer) de quina manera la plantilla s'ha enllaçat a l'equip.
Valors possibles:
0 - (per defecte) enllaçada manualment;
1 - enllaçada automàticament per una regla LLD.

Admet count.
selectDashboards query Retorna una propietat dashboards.

Admet count.
selectTags query Retorna una propietat tags 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 un objecte, on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.

No admet propietats del tipus d'informació text.

Admet propietats addicionals: propietats d'interfície d'equip.
limitSelects integer Limita el nombre de registres retornats per subconsultes.

S'aplica a les subconsultes següents:
selectParentTemplates - els resultats s'ordenaran per host;
selectInterfaces;
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 (sensible a majúscules i minúscules).

Admet un objecte, 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 de tipus LIKE "%...%".

Només permet les propietats de tipus de dades string i text.

Admet propietats addicionals: propietats d'interfície d'equip.
searchInventory object Retorna només els equips les dades d'inventari dels quals coincideixen amb el patró donat (sensible a majúscules i minúscules).

Admet un objecte, 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 de tipus LIKE "%...%".

Només permet les propietats de tipus de dades string i text.
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
selectGroups
(obsolet)
query Aquest paràmetre és obsolet; si et plau, empra selectHostGroups en el seu lloc.
Retorna la propietat groups amb informació dels grups d'equips on pertany l'equip.

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".

Petició:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "filter": {
                   "host": [
                       "Servidor Zabbix",
                       "Servidor Linux"
                   ]
               }
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "proxyid": "0",
                   "host": "Servidor Zabbix",
                   "status": "0",
                   "ipmi_authtype": "-1",
                   "ipmi_privilege": "2",
                   "ipmi_username": "",
                   "ipmi_password": "",
                   "maintenanceid": "0",
                   "maintenance_status": "0",
                   "maintenance_type": "0",
                   "maintenance_from": "0",
                   "name": "Servidor Zabbix",
                   "flags": "0",
                   "description": "El servidor de monitorització Zabbix.",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "proxy_groupid": "0",
                   "monitored_by": "0",
                   "inventory_mode": "1",
                   "active_available": "1",
                   "assigned_proxyid": "0"
               },
               {
                   "hostid": "10167",
                   "proxyid": "0",
                   "host": "Linux server",
                   "status": "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": "",
                   "proxy_groupid": "0",
                   "monitored_by": "0",
                   "inventory_mode": "1",
                   "active_available": "1",
                   "assigned_proxyid": "0"
               }
           ],
           "id": 1
       }

Recuperar els grups d'equips

Recupera els noms dels grups on l'equip "Servidor Zabbix" n'és membre.

Petició:

{
       "jsonrpc": "2.0",
       "method": "host.get",
       "params": {
       "output": ["hostid"],
       "selectHostGroups": "extend",
       "filter": {
       "host": [
       "Servidor Zabbix"
       ]
       }
       },
       "id": 1
       }

Resposta:

{
       "jsonrpc": "2.0",
       "result": [
       {
       "hostid": "10085",
       "hostgroups": [
       {
       "groupid": "2",
       "name": "Linux servers",
       "flags": "0",
       "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
       },
       {
       "groupid": "4",
       "name": "Zabbix servers",
       "flags": "0",
       "uuid": "6f6799aa69e844b4b3918f779f2abf08"
       }
       ]
       }
       ],
       "id": 1
       }

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
       }

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"
           },
           "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": 1
       }

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 "linux-server" 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": "linux-server",
                       "operator": 1
                   }
               ]
           },
           "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": "os",
       "value": "rhel-7",
       "operator": 1
       }
       ],
       "inheritedTags": true
       },
       "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"]
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10502",
                   "name": "Desktop",
                   "tags": [
                       {
                           "tag": "host-name",
                           "value": "linux-server"
                       },
                       {
                           "tag": "os",
                           "value": "rhel-7"
                       }
                   ],
                   "inheritedTags": [
                       {
                           "tag": "class",
                           "value": "os"
                       },
                       {
                           "tag": "target",
                           "value": "linux"
                       },
                       {
                           "tag": "os",
                           "value": "rhel-7"
                       }
                   ]
               }
           ],
           "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
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "name": "Zabbix server"
               }
           ],
           "id": 1
       }

Recupera els equips que tenen com gravetat "Mitjana" i "Alta".

Petició:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": [3, 4]
           },
           "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.