Sidebar

Become a monitoring expert!
Sign up for Zabbix training

host.get

Descripción

integer/array host.get(object parameters)

Este método permite recuperar hosts de acuerdo con los parámetros suministrados.

Parámetros

(object) Parametros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
groupids string/array Retorna únicamente los hosts que pertenecen a los grupos dados.
applicationids string/array Retorna únicamente los hosts que tienen las applications dadas.
dserviceids string/array Retorna únicamente los hosts que están relacionados con los servicios descubiertos dados.
graphids string/array Retorna únicamente los hosts que tienen las gráficas dadas.
hostids string/array Retorna únicamente los hosts con los ID dados.
httptestids string/array Retorna únicamente los hosts que tienen los chequeos web dados.
interfaceids string/array Retorna únicamente los hosts que usan las interfaces dadas.
itemids string/array Retorna únicamente los hosts que tienenn los items dados .
maintenanceids string/array Retorna únicamente los hosts que son afectados por los mantenimientos dados.
monitored_hosts flag Retorna únicamente los hosts que son monitoreados.
proxy_hosts flag Retorna únicamente proxies.
proxyids string/array Retorna únicamente los hosts que son monitoreados mediate los proxies dados.
templated_hosts flag Retorna hosts que y templates.
templateids string/array Retorna únicamente los hosts que tienen asignados los templates dados.
triggerids string/array Retorna únicamente los hosts que tienen los triggers dados.
with_items flag Retorna únicamente los hosts que tienen items.

Sobreescribe los parámetros with_monitored_items y with_simple_graph_items.
with_applications flag Retorna únicamente los hosts que tienen applications.
with_graphs flag Retorna únicamente los hosts que tienen gráficas.
with_httptests flag Retorna únicamente los hosts que tienen chequeos web.

Sobreescribe el parámetro with_monitored_httptests.
with_monitored_httptests flag Retorna únicamente los hosts que tengan chequeos web habilitados.
with_monitored_items flag Retorna únicamente los hosts que tengan items habilitados.

Sobreescribe el parámetro with_simple_graph_items.
with_monitored_triggers flag Retorna únicamente los hosts que tengan triggers habilitados. Todos los trigger que intervienen en el trigger deben estar también habilitados.
with_simple_graph_items flag Retorna únicamente los hosts que tengan items con información de tipo numérico.
with_triggers flag Retorna únicamente los hosts que tengan triggers.

Sobreescribe el parámetro with_monitored_triggers.
withInventory flag Retorna únicamente los hosts que tengan datos en el inventario.
selectGroups query Retorna los host groups a los que pertenece el host, en la propiedad groups.
selectApplications query Retorna las applications del host en la propiedad applications.

Admite count.
selectDiscoveries query Retorna las low level discoveries del host en la propiedad discoveries.

Admite count.
selectDiscoveryRule query Retorna la LLD que creó el host en las propiedad discoveryRule.
selectGraphs query Retorna las gráficas del host en la propiedad graphs.

Admite count.
selectHostDiscovery query Retorna el objeto host discovery en la propiedad hostDiscovery.

El objeto host discovery relaciona un host descubierto con el host prototype o un host prototype con la LLD y tiene las siguientes propiedades:
host - (string) host del host prototype
hostid - (string) ID del host descubierto o del host prototype
parent_hostid - (string) ID del host prototype desde el que se crea el host
parent_itemid - (string) ID de la LLD que crea el host descubierto
lastcheck - (timestamp) Último momento en que el host fué descubierto
ts_delete - (timestamp) Momento en el que el host si no vuelve a ser descubierto será borrado.
selectHttpTests query Retorna los web scenarios del host en la propiedad httpTests.

Admite count.
selectInterfaces query Retorna las interfaces del host en la propiedad interfaces.

Admite count.
selectInventory query Retorna el inventario del host en la propiedad inventory.
selectItems query Retorna los ítems del host en la propiedad items.

Admite count.
selectMacros query Retrtorna las macros del host en la propiedad macros.
selectParentTemplates query Retorna los templates asignados al host en la propiedad parentTemplates.

Admite count.
selectScreens query Retorna las screens del host en la propiedad screens.

Admite count.
selectTriggers query Retorna los triggers del host en la propiedad triggers.

Admite count.
filter object Retorna únicamente aquellos objetos que coinciden con el fitro dado.

Admite un vector, donde las keys (índices) son los nombres de las propiedades, y los valores son un único valor o una lista de valores con los que, al menos uno, debe coincidir.

Permite filtrar por propiedades de la interfaz.
limitSelects integer Limita la cantidad de registros a retornar por las subselecciones.

Aplica para las siguientes subselecciones:
selectParentTemplates - los resultados van a ser ordenados por la propiedad host;
selectInterfaces;
selectItems - ordenados por la propiedad name;
selectDiscoveries - ordenados por la propiedad name;
selectTriggers - ordenados por la propiedad description;
selectGraphs - ordenados por la propiedad name;
selectApplications - ordenados por la propiedad name;
selectScreens - ordenados por la propiedad name.
search object Retorna los resultados que coincidan con la b[usqueda mediante wildcard.

Admite un vector, donde las keys (índices) son los nombres de las propiedades, y los valores son las cadenas a comparar. Si no se dan otras opciones, la búsqueda será del tipo LIKE "%…%".

Admite la búsqueda por propiedades de la interface. Funciona solo con propiedades con valores de texto.
searchInventory object Retorna únicamente los hosts que tengan datos en el inventario que coincidan con la búsqueda medientewildcard.

Este parámetro es afectado por los mismos parámetros que afectan al parámetro search.
sortfield string/array Ordena el resultado por los valores de las propiedades dadas.

Los posibles valores son: hostid, host, name, status.
countOutput boolean Estos paráetros son comunes a todos los métodos get y son descritos en detalle en los comentarios de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores retornados

(integer/array) Retorna uno de:

  • un vector de objetos
  • la cantidad de objetos a retornar, si se usó el parámetro countOutput.

Ejemplos

Recuperando datos por el nombre

Recuperar los datos de dos hosts llamados "Zabbix server" y "Linux server".

Pedido:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "filter": {
                   "host": [
                       "Zabbix server",
                       "Linux server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "maintenances": [],
                   "hostid": "10160",
                   "proxy_hostid": "0",
                   "host": "Zabbix 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": "Zabbix server",
                   "description": "The Zabbix 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
       }

Recuperando host groups

Recuperar los host groups de los que el host "Zabbix server" es miembro. pero no los detalles del host.

Pedido:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectGroups": "extend",
               "filter": {
                   "host": [
                       "Zabbix server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Respuesta:

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

Recuperando los templates asignados

Recuperar los IDs y nombres de los templates asignados al host con ID "10084".

Pedido:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectParentTemplates": [
                   "templateid",
                   "name"
               ],
               "hostids": "10084"
           },
           "id": 1,
           "auth": "70785d2b494a7302309b48afcdb3a401"
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "parentTemplates": [
                       {
                           "name": "Template OS Linux",
                           "templateid": "10001"
                       },
                       {
                           "name": "Template App Zabbix Server",
                           "templateid": "10047"
                       }
                   ]
               }
           ],
           "id": 1
       }

Buscando por datos de inventario

Recuperar los hosts que contengan "Linux" en el campo "OS" del inventario.

Pedido:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": [
                   "host"
               ],
               "selectInventory": [
                   "os"
               ],
               "searchInventory": {
                   "os": "Linux"
               }
           },
           "id": 2,
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0"
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "host": "Zabbix server",
                   "inventory": {
                       "os": "Linux Ubuntu"
                   }
               },
               {
                   "hostid": "10107",
                   "host": "Linux server",
                   "inventory": {
                       "os": "Linux Mint"
                   }
               }
           ],
           "id": 1
       }

Vea también

Códigp

CHost::get() in frontends/php/include/classes/api/services/CHost.php.