Áú»¢¶Ä²©

host.get

¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®

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.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ

(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ definit la sortida esperada.

El m¨¨tode admet els par¨¤metres seg¨¹ents.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð Tipus ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
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 ²µ°ù¨¤´Ú¾±³¦²õ 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 ¾±²Ô³Ù±ð°ù´Ú¨ª³¦¾±±ð²õ 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 ²µ°ù¨¤´Ú¾±³¦²õ.
with_graph_prototypes mark Retorna nom¨¦s els equips amb prototips de ²µ°ù¨¤´Ú¾±³¦²õ.
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 ²µ°ù¨¤´Ú¾±³¦²õ amb ²µ°ù¨¤´Ú¾±³¦²õ 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 ¾±²Ô³Ù±ð°ù´Ú¨ª³¦¾±±ð²õ amb ¾±²Ô³Ù±ð°ù´Ú¨ª³¦¾±±ð²õ 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 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 Áú»¢¶Ä²© " i "Servidor Linux".

Request:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "filter": {
                   "host": [
                       "Servidor Áú»¢¶Ä²©",
                       "Servidor Linux"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "proxy_hostid": "0",
                   "host": "Áú»¢¶Ä²© 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": "Áú»¢¶Ä²© server",
                   "flags": "0",
                   "description": "The Áú»¢¶Ä²© 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 Áú»¢¶Ä²©" n'¨¦s membre; per¨° no recupera pas els detalls de l'equip.

±Ê±ð³Ù¾±³¦¾±¨®:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectGroups": "extend",
               "filter": {
                   "host": [
                       "Servidor Áú»¢¶Ä²©"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Resposta:

{
           "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
       }

Recuperar les plantilles enlla?ades

Recupera l'ID i els noms de les plantilles enlla?ades a l'equip "10084".

±Ê±ð³Ù¾±³¦¾±¨®:

{
           "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": "Áú»¢¶Ä²© Server",
                           "templateid": "10047"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recuperar equips per plantilla

Recupera els equips que tenen la plantilla "10001" (Linux amb agent Áú»¢¶Ä²©) enlla?ada.

±Ê±ð³Ù¾±³¦¾±¨®:

{
           "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": "Áú»¢¶Ä²© 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.

±Ê±ð³Ù¾±³¦¾±¨®:

{
           "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": "Áú»¢¶Ä²© 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".

±Ê±ð³Ù¾±³¦¾±¨®:

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

±Ê±ð³Ù¾±³¦¾±¨®:

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

±Ê±ð³Ù¾±³¦¾±¨®:

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

±Ê±ð³Ù¾±³¦¾±¨®:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": 5
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "name": "Áú»¢¶Ä²© server"
               }
           ],
           "id": 1
       }

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

±Ê±ð³Ù¾±³¦¾±¨®:

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