[comment]: # ({65bbffce-65bbffce})
# host.get
[comment]: # ({/65bbffce-65bbffce})
[comment]: # ({54619a1f-93035b19})
### Descripción
`integer/array host.get(object parameters)`
El método permite recuperar equipos según los parámetros dados.
::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
para más información.
:::
[comment]: # ({/54619a1f-93035b19})
[comment]: # ({71515b4e-77a8fabb})
### Parámetros
`(object)` Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
|Parámetro|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|groupids|ID/array|Devolver solo los hosts que pertenecen a los grupos indicados.|
|dserviceids|ID/array|Devolver solo los hosts que están relacionados con los servicios descubiertos indicados.|
|graphids|ID/array|Devolver solo los hosts que tienen los gráficos indicados.|
|hostids|ID/array|Devolver solo los hosts con los IDs de host indicados.|
|httptestids|ID/array|Devolver solo los hosts que tienen las comprobaciones web indicadas.|
|interfaceids|ID/array|Devolver solo los hosts que utilizan las interfaces indicadas.|
|itemids|ID/array|Devolver solo los hosts que tienen los items indicados.|
|maintenanceids|ID/array|Devolver solo los hosts que están afectados por los mantenimientos indicados.|
|monitored\_hosts|flag|Devolver solo los hosts monitorizados.|
|proxyids|ID/array|Devolver solo los hosts que son monitorizados por los proxies indicados.|
|proxy_groupids|ID/array|Devolver solo los hosts que son monitorizados por los grupos de proxies indicados.|
|templated\_hosts|flag|Devolver tanto hosts como templates.|
|templateids|ID/array|Devolver solo los hosts que están vinculados a los templates indicados.|
|triggerids|ID/array|Devolver solo los hosts que tienen los triggers indicados.|
|with\_items|flag|Devolver solo los hosts que tienen items.
Sobrescribe los parámetros `with_monitored_items` y `with_simple_graph_items`.|
|with\_item\_prototypes|flag|Devolver solo los hosts que tienen prototipos de item.
Sobrescribe el parámetro `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|flag|Devolver solo los hosts que tienen prototipos de item, que están habilitados para la creación y tienen tipo de información numérico.|
|with\_graphs|flag|Devolver solo los hosts que tienen gráficos.|
|with\_graph\_prototypes|flag|Devolver solo los hosts que tienen prototipos de gráfico.|
|with\_httptests|flag|Devolver solo los hosts que tienen comprobaciones web.
Sobrescribe el parámetro `with_monitored_httptests`.|
|with\_monitored\_httptests|flag|Devolver solo los hosts que tienen comprobaciones web habilitadas.|
|with\_monitored\_items|flag|Devolver solo los hosts que tienen items habilitados.
Sobrescribe el parámetro `with_simple_graph_items`.|
|with\_monitored\_triggers|flag|Devolver solo los hosts que tienen triggers habilitados. Todos los items utilizados en el trigger también deben estar habilitados.|
|with\_simple\_graph\_items|flag|Devolver solo los hosts que tienen items con tipo de información numérico.|
|with\_triggers|flag|Devolver solo los hosts que tienen triggers.
Sobrescribe el parámetro `with_monitored_triggers`.|
|withProblemsSuppressed|boolean|Si se establece en `true`, devolver solo los hosts con problemas suprimidos.|
|evaltype|integer|[Método de evaluación](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter) de la etiqueta.
Valores posibles:
0 - *(por defecto)* And/Or;
2 - Or.|
|severities|integer/array|Devolver hosts que solo tengan problemas con las severidades indicadas. Se aplica solo si el objeto de problema es un trigger.|
|tags|object/array|Devolver solo los hosts con las etiquetas indicadas.
Formato: `[{"tag": "", "value": "", "operator": ""}, ...]`.
Un array vacío devuelve todos los hosts.
Valores posibles de [operator](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter):
0 - *(por defecto)* Contiene;
1 - Igual;
2 - No contiene;
3 - No es igual;
4 - Existe;
5 - No existe.|
|inheritedTags|boolean|Devolver hosts que tengan las `tags` indicadas también en todos sus templates vinculados.
Valores posibles:
`true` - los templates vinculados también deben tener las `tags` indicadas;
`false` - *(por defecto)* se ignoran las etiquetas de los templates vinculados.|
|selectDiscoveryData|query|Devolver una propiedad `discoveryData` con los datos del objeto de descubrimiento de host. El objeto de descubrimiento de host vincula un host descubierto a un prototipo de host del que se descubrió.
Tiene las siguientes propiedades:
`host` - `(string)` ID del host;
`parent_hostid` - `(string)` ID del prototipo de host del que se ha creado el host;
`status` - `(int)` estado del descubrimiento del host:
0 - *(por defecto)* el host está descubierto,
1 - el host ya no está descubierto;
`ts_delete` - `(timestamp)` hora en la que se eliminará un host que ya no está descubierto;
`ts_disable` - `(timestamp)` hora en la que se deshabilitará un host que ya no está descubierto;
`disable_source` - `(int)` indicador de si el host fue deshabilitado por una regla LLD o manualmente:
0 - *(por defecto)* deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.|
|selectDiscoveryRule|query|Devolver una propiedad [`discoveryRule`](/manual/api/reference/discoveryrule/object) con la regla de descubrimiento de bajo nivel que creó el host (a partir del prototipo de host en la monitorización de VMware).|
|selectDiscoveryRules|query|Devolver una propiedad [`discoveryRules`](/manual/api/reference/discoveryrule/object) con las reglas LLD del host.
Admite `count`.|
|selectGraphs|query|Devolver una propiedad [`graphs`](/manual/api/reference/graph/object) con los gráficos del host.
Admite `count`.|
|selectHostGroups|query|Devolver una propiedad [`hostgroups`](/manual/api/reference/hostgroup/object) con los datos de los grupos de hosts a los que pertenece el host.|
|selectHttpTests|query|Devolver una propiedad [`httpTests`](/manual/api/reference/httptest/object) con los escenarios web del host.
Admite `count`.|
|selectInterfaces|query|Devolver una propiedad [`interfaces`](/manual/api/reference/hostinterface/object) con las interfaces del host.
Admite `count`.|
|selectInventory|query|Devolver una propiedad [`inventory`](/manual/api/reference/host/object#host-inventory) con los datos de inventario del host.|
|selectItems|query|Devolver una propiedad [`items`](/manual/api/reference/item/object) con los items del host.
Admite `count`.|
|selectMacros|query|Devolver una propiedad [`macros`](/manual/api/reference/usermacro/object) con las macros del host.|
|selectParentTemplates|query|Devolver una propiedad `parentTemplates` con los [templates](/manual/api/reference/template/object) a los que está vinculado el host.
Además de los campos del objeto Template, contiene `link_type` - `(integer)` la forma en que el template está vinculado al host.
Valores posibles:
0 - *(por defecto)* vinculado manualmente;
1 - vinculado automáticamente por LLD.
Admite `count`.|
|selectDashboards|query|Devolver una propiedad [`dashboards`](/manual/api/reference/templatedashboard/object).
Admite `count`.|
|selectTags|query|Devolver una propiedad [`tags`](/manual/api/reference/host/object#host-tag) con las etiquetas del host.|
|selectInheritedTags|query|Devolver una propiedad [`inheritedTags`](/manual/api/reference/host/object#host-tag) con las etiquetas que están en todos los templates vinculados al host.|
|selectTriggers|query|Devolver una propiedad [`triggers`](/manual/api/reference/trigger/object) con los triggers del host.
Admite `count`.|
|selectValueMaps|query|Devolver una propiedad [`valuemaps`](/manual/api/reference/valuemap/object) con los mapas de valores del host.|
|filter|object|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 datos `text` [data type](/manual/api/reference_commentary#data-types).
Admite propiedades adicionales: propiedades de [Host interface](/manual/api/reference/hostinterface/object#host-interface-object).|
|limitSelects|integer|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`;
`selectDiscoveryRules` - ordenados por `name`;
`selectTriggers` - ordenados por `description`;
`selectGraphs` - ordenados por `name`;
`selectDashboards` - ordenados por `name`.|
|search|object|Devolver resultados que coincidan con el patrón indicado (no distingue 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 "%…%"`.
Admite solo propiedades de tipo de datos `string` y `text` [data type](/manual/api/reference_commentary#data-types).
Admite propiedades adicionales: propiedades de [Host interface](/manual/api/reference/hostinterface/object#host-interface-object).|
|searchInventory|object|Devolver hosts que tengan datos de inventario que coincidan con el patrón indicado (no distingue 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 "%…%"`.
Admite solo propiedades de tipo de datos `string` y `text` [data type](/manual/api/reference_commentary#data-types).|
|sortfield|string/array|Ordenar el resultado por las propiedades indicadas.
Valores posibles: `hostid`, `host`, `name`, `status`.|
|countOutput|boolean|Estos parámetros se describen en el [comentario de referencia](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectDiscoveries|query|Devolver una propiedad [`discoveries`](/manual/api/reference/discoveryrule/object) con las reglas de descubrimiento de bajo nivel del host.
Admite `count`.
Esta consulta está **obsoleta**, utilice `selectDiscoveryRules` en su lugar.|
|selectHostDiscovery|query|Devolver una propiedad `hostDiscovery` con los datos del objeto de descubrimiento de host.
Esta consulta está **obsoleta**, utilice `selectDiscoveryData` en su lugar.|
[comment]: # ({/71515b4e-77a8fabb})
[comment]: # ({7223bab1-7223bab1})
### Valores de retorno
`(entero/matriz)` Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput`
ha sido usado.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Ejemplos
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({bdf49605-c6ea3cce})
#### Recuperando datos por nombre
Recupere todos los datos sobre dos equipos llamados "servidor Zabbix" y " servidor
Linux".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Zabbix server",
"Linux server"
]
}
},
"id": 1
}
```
Respuesta:
```json
{
"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
}
```
[comment]: # ({/bdf49605-c6ea3cce})
[comment]: # ({8d87c206-9078aff7})
#### Recuperando grupos de equipos
Recupere los grupos de equipos de los que el equipo "servidor Zabbix" es miembro.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}
```
Response:
```json
{
"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
}
```
[comment]: # ({/8d87c206-9078aff7})
[comment]: # ({3f6d4bdf-59c8a46a})
#### Recuperando plantillas vinculadas
Recupere los ID y los nombres de las plantillas vinculadas al equipo "10084".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}
```
[comment]: # ({/3f6d4bdf-59c8a46a})
[comment]: # ({9a8b8f9f-942e31bf})
#### Recuperar equipos por plantilla
Recupere equipos que tengan la plantilla "10001" (*Linux by Zabbix agent*) vinculada a ellos.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}
```
[comment]: # ({/9a8b8f9f-942e31bf})
[comment]: # ({63a1e5ba-8be1d99c})
#### Búsqueda por datos de inventario de equipo
Recupere equipos que contengan "Linux" en el campo "OS" del inventario de equipo.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Zabbix server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}
```
[comment]: # ({/63a1e5ba-8be1d99c})
[comment]: # ({cfc9b43a-b4e37e5e})
#### Búsqueda por etiquetas de host
Recuperar hosts que tengan la etiqueta "host-name" igual a "linux-server".
[Solicitud](/manual/api#performing-requests):
```json
{
"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:
```json
{
"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 hosts que tengan estas etiquetas no solo a nivel de host, sino también en sus templates padre vinculados.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [
{
"tag": "os",
"value": "rhel-7",
"operator": 1
}
],
"inheritedTags": true
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}
```
Recuperar hosts excluyendo aquellos con la etiqueta "component".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "component",
"value": "",
"operator": 5
}
]
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"tags": [
{
"tag": "class",
"value": "os",
"automatic": "0"
},
{
"tag": "target",
"value": "linux",
"automatic": "0"
}
]
},
{
"hostid": "10629",
"tags": [
{
"tag": "class",
"value": "application",
"automatic": "0"
},
{
"tag": "target",
"value": "browser",
"automatic": "0"
}
]
}
],
"id": 1
}
```
[comment]: # ({/cfc9b43a-b4e37e5e})
[comment]: # ({c6c128e0-9ebae84e})
#### 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.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"id": 1
}
```
Respuesta:
```json
{
"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
}
```
[comment]: # ({/c6c128e0-9ebae84e})
[comment]: # ({ee33fbef-219d4ee1})
#### Búsqueda de hosts por gravedad del problema
Recuperar equipos que tengan problemas en situación de "desastre".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"name": "Zabbix server"
}
],
"id": 1
}
```
Recuperar equipos que tengan problemas en situación de "Average" y "High".
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}
```
[comment]: # ({/ee33fbef-219d4ee1})
[comment]: # ({2a837857-56ff1999})
#### Recuperar items de host
Recuperar items para el host "Zabbix server". La solicitud se limita a las propiedades del item `itemid`, `name` y `status`. Debido al gran tamaño de la respuesta, solo se muestra un subconjunto de items en el ejemplo.
[Solicitud](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectItems": ["itemid","name","status"],
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"items": [
{
"itemid": "42227",
"name": "Host name of Zabbix agent running",
"status": "0"
},
{
"itemid": "42237",
"name": "Zabbix agent ping",
"status": "0"
},
{
"itemid": "42250",
"name": "Version of Zabbix agent running",
"status": "0"
},
{
"itemid": "42251",
"name": "Maximum number of open file descriptors",
"status": "0"
},
{
"itemid": "42252",
"name": "Maximum number of processes",
"status": "0"
},
{
"itemid": "69869",
"name": "Interface enp0s3: Inbound packets discarded",
"status": "0"
},
{
"itemid": "69870",
"name": "Interface enp0s3: Inbound packets with errors",
"status": "0"
},
{
"itemid": "69871",
"name": "Interface enp0s3: Bits received",
"status": "0"
},
{
"itemid": "69872",
"name": "Interface enp0s3: Outbound packets discarded",
"status": "0"
},
{
"itemid": "69873",
"name": "Interface enp0s3: Outbound packets with errors",
"status": "0"
},
{
"itemid": "69874",
"name": "Interface enp0s3: Bits sent",
"status": "0"
},
{
"itemid": "42253",
"name": "Number of processes",
"status": "0"
},
{
"itemid": "42254",
"name": "Number of running processes",
"status": "0"
},
{
"itemid": "42255",
"name": "System boot time",
"status": "0"
}
]
}
],
"id": 1
}
```
[comment]: # ({/2a837857-56ff1999})
[comment]: # ({fd8058f7-06c7fe93})
### Ver también
- [Grupo de hosts](/manual/api/reference/hostgroup/object#host-group)
- [Template](/manual/api/reference/template/object#template)
- [Macro de usuario](/manual/api/reference/usermacro/object#hosttemplate-level-macro)
- [Interfaz de host](/manual/api/reference/hostinterface/object#host-interface)
- [Proxy](/manual/api/reference/proxy/object#proxy)
- [Grupo de proxies](/manual/api/reference/proxygroup/object#proxy-group)
[comment]: # ({/fd8058f7-06c7fe93})
[comment]: # ({55c08f7a-55c08f7a})
### Fuente
CHost::get() en *ui/include/classes/api/services/CHost.php*.
[comment]: # ({/55c08f7a-55c08f7a})