Documentation
Table of Contents
- host.get
- Descripción
- Parámetros
- Valores de retorno
- Ejemplos
- Recuperando datos por nombre
- Recuperando grupos de equipos
- Recuperando plantillas vinculadas
- Recuperar equipos por plantilla
- Búsqueda por datos de inventario de equipo
- Búsqueda por etiquetas de equipo
- Búsqueda de equipos con etiquetas y etiquetas de plantilla
- Búsqueda de hosts por gravedad del problema
- Ver también
- Fuente
host.get
Descripción
integer/array host.get(object parameters)
El método permite recuperar equipos según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| groupids | ID/array | Devolver solo los equipos que pertenecen a los grupos indicados. |
| dserviceids | ID/array | Devolver solo los equipos que están relacionados con los servicios descubiertos indicados. |
| graphids | ID/array | Devolver solo los equipos que tienen los gráficos indicados. |
| hostids | ID/array | Devolver solo los equipos con los IDs de equipo indicados. |
| httptestids | ID/array | Devolver solo los equipos que tienen las comprobaciones web indicadas. |
| interfaceids | ID/array | Devolver solo los equipos que utilizan las interfaces indicadas. |
| itemids | ID/array | Devolver solo los equipos que tienen los ítems indicados. |
| maintenanceids | ID/array | Devolver solo los equipos que están afectados por los mantenimientos indicados. |
| monitored_hosts | flag | Devolver solo los equipos monitorizados. |
| proxyids | ID/array | Devolver solo los equipos que son monitorizados por los proxies indicados. |
| proxy_groupids | ID/array | Devolver solo los equipos que son monitorizados por los grupos de proxies indicados. |
| templated_hosts | flag | Devolver tanto equipos como plantillas. |
| templateids | ID/array | Devolver solo los equipos que están vinculados a las plantillas indicadas. |
| triggerids | ID/array | Devolver solo los equipos que tienen las alertas indicadas. |
| with_items | flag | Devolver solo los equipos que tienen ítems. Sobrescribe los parámetros with_monitored_items y with_simple_graph_items. |
| with_item_prototypes | flag | Devolver solo los equipos que tienen prototipos de ítems. Sobrescribe el parámetro with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | flag | Devolver solo los equipos que tienen prototipos de ítems, que están habilitados para la creación y tienen tipo de información numérica. |
| with_graphs | flag | Devolver solo los equipos que tienen gráficos. |
| with_graph_prototypes | flag | Devolver solo los equipos que tienen prototipos de gráficos. |
| with_httptests | flag | Devolver solo los equipos que tienen comprobaciones web. Sobrescribe el parámetro with_monitored_httptests. |
| with_monitored_httptests | flag | Devolver solo los equipos que tienen comprobaciones web habilitadas. |
| with_monitored_items | flag | Devolver solo los equipos que tienen ítems habilitados. Sobrescribe el parámetro with_simple_graph_items. |
| with_monitored_triggers | flag | Devolver solo los equipos que tienen alertas habilitadas. Todos los ítems utilizados en la alerta también deben estar habilitados. |
| with_simple_graph_items | flag | Devolver solo los equipos que tienen ítems con tipo de información numérica. |
| with_triggers | flag | Devolver solo los equipos que tienen alertas. Sobrescribe el parámetro with_monitored_triggers. |
| withProblemsSuppressed | booleano | Devolver equipos que tienen problemas suprimidos. Valores posibles: null - (por defecto) todos los equipos;true - solo equipos con problemas suprimidos;false - solo equipos con problemas no suprimidos. |
| evaltype | entero | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (por defecto) Y/O; 2 - O. |
| severities | entero/array | Devolver equipos que solo tienen problemas con las severidades indicadas. Solo se aplica si el objeto problema es una alerta. |
| tags | objeto/array | Devolver solo los equipos con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta según el valor del operador. Formato: [{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...].Un array vacío devuelve todos los equipos. Valores posibles para el operador: 0 - (por defecto) Contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 1 - Igual (sensible a mayúsculas/minúsculas); 2 - No contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 3 - No es igual (sensible a mayúsculas/minúsculas); 4 - Existe; 5 - No existe. |
| inheritedTags | booleano | Devolver equipos que tienen las tags indicadas también en todas sus plantillas vinculadas. Por defecto:Valores posibles: true - las plantillas vinculadas también deben tener las tags indicadas;false - (por defecto) se ignoran las etiquetas de las plantillas vinculadas. |
| selectDiscoveries | consulta | Devolver una propiedad discoveries con las reglas de descubrimiento de bajo nivel del equipo.Admite count. |
| selectDiscoveryRule | consulta | Devolver una propiedad discoveryRule con la regla de descubrimiento de bajo nivel que creó el equipo (a partir del prototipo de equipo en la monitorización de VMware). |
| selectGraphs | consulta | Devolver una propiedad graphs con los gráficos del equipo.Admite count. |
| selectHostDiscovery | consulta | Devolver una propiedad hostDiscovery con los datos del objeto de descubrimiento de equipo.El objeto de descubrimiento de equipo vincula un equipo descubierto a un prototipo de equipo o prototipos de equipo a una regla LLD y tiene las siguientes propiedades: host - (cadena) equipo del prototipo de equipo;hostid - (cadena) ID del equipo descubierto o prototipo de equipo;parent_hostid - (cadena) ID del prototipo de equipo del que se ha creado el equipo;parent_itemid - (cadena) ID de la regla LLD que creó el equipo descubierto;lastcheck - (marca de tiempo) hora en la que el equipo fue descubierto por última vez;status - (entero) estado de descubrimiento del equipo:0 - (por defecto) equipo descubierto, 1 - el equipo ya no está descubierto; ts_delete - (marca de tiempo) hora en la que se eliminará un equipo que ya no está descubierto;ts_disable - (marca de tiempo) hora en la que se deshabilitará un equipo que ya no está descubierto;disable_source - (entero) indicador de si el equipo fue deshabilitado por una regla LLD o manualmente:0 - (por defecto) deshabilitado automáticamente, 1 - deshabilitado por una regla LLD. |
| selectHostGroups | consulta | Devolver una propiedad hostgroups con los datos de los grupos de equipos a los que pertenece el equipo. |
| selectHttpTests | consulta | Devolver una propiedad httpTests con los escenarios web del equipo.Admite count. |
| selectInterfaces | consulta | Devolver una propiedad interfaces con las interfaces del equipo.Admite count. |
| selectInventory | consulta | Devolver una propiedad inventory con los datos de inventario del equipo. |
| selectItems | consulta | Devolver una propiedad items con los ítems del equipo.Admite count. |
| selectMacros | consulta | Devolver una propiedad macros con las macros del equipo. |
| selectParentTemplates | consulta | Devolver una propiedad parentTemplates con las plantillas a las que está vinculado el equipo.Además de los campos del objeto Plantilla, contiene link_type - (entero) la forma en que la plantilla está vinculada al equipo.Valores posibles: 0 - (por defecto) vinculada manualmente; 1 - vinculada automáticamente por LLD. Admite count. |
| selectDashboards | consulta | Devolver una propiedad dashboards.Admite count. |
| selectTags | consulta | Devolver una propiedad tags con las etiquetas del equipo. |
| selectInheritedTags | consulta | Devolver una propiedad inheritedTags con las etiquetas que están en todas las plantillas vinculadas al equipo. |
| selectTriggers | consulta | Devolver una propiedad triggers con las alertas del equipo.Admite count. |
| selectValueMaps | consulta | Devolver una propiedad valuemaps con los mapas de valores del equipo. |
| filter | objeto | Devolver solo aquellos resultados que coincidan exactamente con el filtro indicado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar. No admite propiedades de tipo de dato text data type.Admite propiedades adicionales: propiedades de Interfaz de equipo. |
| limitSelects | entero | Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: selectParentTemplates - los resultados se ordenarán por host;selectInterfaces;selectItems - ordenados por name;selectDiscoveries - ordenados por name;selectTriggers - ordenados por description;selectGraphs - ordenados por name;selectDashboards - ordenados por name. |
| search | objeto | Devolver resultados que coincidan con el patrón indicado (no sensible a mayúsculas/minúsculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas a buscar. Si no se dan opciones adicionales, esto realizará una búsqueda LIKE "%…%".Solo admite propiedades de tipo de dato string y text data type.Admite propiedades adicionales: propiedades de Interfaz de equipo. |
| searchInventory | objeto | Devolver equipos que tengan datos de inventario que coincidan con el patrón indicado (no sensible a mayúsculas/minúsculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas a buscar. Si no se dan opciones adicionales, esto realizará una búsqueda LIKE "%…%".Solo admite propiedades de tipo de dato string y text data type. |
| sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: hostid, host, name, status. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | booleano | |
| selectGroups (obsoleto) |
consulta | Este parámetro está obsoleto, por favor use selectHostGroups en su lugar.Devuelve una propiedad groups con los datos de los grupos de equipos a los que pertenece el equipo. |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperando datos por nombre
Recupere todos los datos sobre dos equipos llamados "servidor Zabbix" y " servidor Linux".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Zabbix server",
"Linux server"
]
}
},
"id": 1
}Respuesta:
{
"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",
"active_available": "1"
},
{
"hostid": "10167",
"proxy_hostid": "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": "",
"inventory_mode": "1",
"active_available": "1"
}
],
"id": 1
}Recuperando grupos de equipos
Recupere los grupos de equipos de los que el equipo "servidor Zabbix" es miembro.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}Response:
{
"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
}Recuperando plantillas vinculadas
Recupere los ID y los nombres de las plantillas vinculadas al equipo "10084".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Recuperar equipos por plantilla
Recupere equipos que tengan la plantilla "10001" (Linux by Zabbix agent) vinculada a ellos.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Búsqueda por datos de inventario de equipo
Recupere equipos que contengan "Linux" en el campo "OS" del inventario de equipo.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 1
}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
}Búsqueda por etiquetas de equipo
Recuperar equipos que tengan la etiqueta "host-name" igual a "linux-server".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"operator": 1
}
]
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"automatic": "0"
},
{
"tag": "os",
"value": "rhel-7",
"automatic": "0"
}
]
}
],
"id": 1
}Recuperar equipos que tengan estas etiquetas no solo a nivel de equipo, sino también en sus plantillas principales vinculadas.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [
{
"tag": "os",
"value": "rhel-7",
"operator": 1
}
],
"inheritedTags": true
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}Búsqueda de equipos con etiquetas y etiquetas de plantilla
Recuperar un equipo con etiquetas y todas las etiquetas que están vinculadas a plantillas principales.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"id": 1
}Respuesta:
{
"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
}Búsqueda de hosts por gravedad del problema
Recuperar equipos que tengan problemas en situación de "desastre".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"id": 1
}Respuesta:
Recuperar equipos que tengan problemas en situación de "Average" y "High".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}Ver también
Fuente
CHost::get() en ui/include/classes/api/services/CHost.php.