host.get

Descripción

integer/array host.get(object parameters)

El método permite recuperar hosts según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
groupids ID/array Devuelve únicamente los hosts que pertenecen a los grupos indicados.
dserviceids ID/array Devuelve únicamente los hosts relacionados con los servicios descubiertos indicados.
graphids ID/array Devuelve únicamente los hosts que tienen los gráficos indicados.
hostids ID/array Devuelve únicamente los hosts con los ID de host indicados.
httptestids ID/array Devuelve únicamente los hosts que tienen las comprobaciones web indicadas.
interfaceids ID/array Devuelve únicamente los hosts que utilizan las interfaces indicadas.
itemids ID/array Devuelve únicamente los hosts que tienen los item indicados.
maintenanceids ID/array Devuelve únicamente los hosts afectados por los mantenimientos indicados.
monitored_hosts flag Devuelve únicamente los hosts monitorizados.
proxyids ID/array Devuelve únicamente los hosts monitorizados por los proxy indicados.
proxy_groupids ID/array Devuelve únicamente los hosts monitorizados por los grupos de proxy indicados.
templated_hosts flag Devuelve tanto los hosts como los template.
templateids ID/array Devuelve únicamente los hosts vinculados a los template indicados.
triggerids ID/array Devuelve únicamente los hosts que tienen los trigger indicados.
with_items flag Devuelve únicamente los hosts que tienen item.

Anula los parámetros with_monitored_items y with_simple_graph_items.
with_item_prototypes flag Devuelve únicamente los hosts que tienen prototipos de item.

Anula el parámetro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Devuelve únicamente los hosts que tienen prototipos de item habilitados para su creación y cuyo tipo de información es numérico.
with_graphs flag Devuelve únicamente los hosts que tienen gráficos.
with_graph_prototypes flag Devuelve únicamente los hosts que tienen prototipos de gráfico.
with_httptests flag Devuelve únicamente los hosts que tienen comprobaciones web.

Anula el parámetro with_monitored_httptests.
with_monitored_httptests flag Devuelve únicamente los hosts que tienen comprobaciones web habilitadas.
with_monitored_items flag Devuelve únicamente los hosts que tienen item habilitados.

Anula el parámetro with_simple_graph_items.
with_monitored_triggers flag Devuelve únicamente los hosts que tienen trigger habilitados. Todos los item utilizados en el trigger también deben estar habilitados.
with_simple_graph_items flag Devuelve únicamente los hosts que tienen item cuyo tipo de información es numérico.
with_triggers flag Devuelve únicamente los hosts que tienen trigger.

Anula el parámetro with_monitored_triggers.
withProblemsSuppressed boolean Si se establece en true, devuelve únicamente los hosts con problemas suprimidos.
evaltype integer Método de evaluación de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
severities integer/array Devuelve los hosts que solo tienen problemas con las gravedades indicadas. Se aplica únicamente si el objeto del problema es un trigger.
tags object/array Devuelve únicamente los hosts con las etiquetas indicadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los hosts.

Valores posibles de operador:
0 - (predeterminado) Contiene;
1 - Es igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
inheritedTags boolean Devuelve los hosts que tienen las tags indicadas también en todos sus template vinculados.

Valores posibles:
true - los template vinculados también deben tener las tags indicadas;
false - (predeterminado) se ignoran las etiquetas de los template vinculados.
selectDiscoveryData query Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del host. El objeto de descubrimiento del host vincula un host descubierto con un prototipo de host a partir del cual se descubrió.

Tiene las siguientes propiedades:
host - (string) ID del host;
parent_hostid - (string) ID del prototipo de host a partir del cual se creó el host;
status - (int) estado de descubrimiento del host:
0 - (predeterminado) el host está descubierto,
1 - el host ya no está descubierto;
ts_delete - (timestamp) momento en que se eliminará un host que ya no está descubierto;
ts_disable - (timestamp) momento en que se deshabilitará un host que ya no está descubierto;
disable_source - (int) indicador de si el host fue deshabilitado por una regla de LLD o manualmente:
0 - (predeterminado) deshabilitado automáticamente,
1 - deshabilitado por una regla de LLD.
selectDiscoveryRule query Devuelve una propiedad discoveryRule 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 Devuelve una propiedad discoveryRules con las reglas de LLD del host.

Admite count.
selectGraphs query Devuelve una propiedad graphs con los gráficos del host.

Admite count.
selectHostGroups query Devuelve una propiedad hostgroups con los datos de los grupos de hosts a los que pertenece el host.
selectHttpTests query Devuelve una propiedad httpTests con los escenarios web del host.

Admite count.
selectInterfaces query Devuelve una propiedad interfaces con las interfaces del host.

Admite count.
selectInventory query Devuelve una propiedad inventory con los datos del inventario del host.
selectItems query Devuelve una propiedad items con los item del host.

Admite count.
selectMacros query Devuelve una propiedad macros con las macros del host.
selectParentTemplates query Devuelve una propiedad parentTemplates con los template 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 - (predeterminado) vinculado manualmente;
1 - vinculado automáticamente por LLD.

Admite count.
selectDashboards query Devuelve una propiedad dashboards.

Admite count.
selectTags query Devuelve una propiedad tags con las etiquetas del host.
selectInheritedTags query Devuelve una propiedad inheritedTags con las etiquetas presentes en todos los template vinculados al host.
selectTriggers query Devuelve una propiedad triggers con los trigger del host.

Admite count.
selectValueMaps query Devuelve una propiedad valuemaps con los mapas de valores del host.
filter object Devuelve únicamente los resultados que coinciden exactamente con el filtro indicado.

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son un único valor o una matriz de valores con los que se debe comparar.

No admite propiedades del tipo de datos text.

Admite propiedades adicionales: propiedades de la interfaz del host.
limitSelects integer Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
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 Devuelve los resultados que coinciden con el patrón indicado (sin distinguir entre mayúsculas y minúsculas).

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son cadenas que se deben buscar. Si no se proporcionan opciones adicionales, se realizará una búsqueda LIKE "%…%".

Admite únicamente propiedades de los tipos de datos string y text.

Admite propiedades adicionales: propiedades de la interfaz del host.
searchInventory object Devuelve los hosts cuyos datos de inventario coinciden con el patrón indicado (sin distinguir entre mayúsculas y minúsculas).

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son cadenas que se deben buscar. Si no se proporcionan opciones adicionales, se realizará una búsqueda LIKE "%…%".

Admite únicamente propiedades de los tipos de datos string y text.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: hostid, host, name, status.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectDiscoveries query Devuelve una propiedad discoveries con las reglas de descubrimiento de bajo nivel del host.

Admite count.

Esta consulta está obsoleta; utilice selectDiscoveryRules en su lugar.
selectHostDiscovery query Devuelve una propiedad hostDiscovery con los datos del objeto de descubrimiento del host.

Esta consulta está obsoleta; utilice selectDiscoveryData en su lugar.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar datos por nombre

Recuperar todos los datos sobre dos equipos llamados "Zabbix server" y "Linux server".

Solicitud:

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

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10160",
            "proxyid": "0",
            "host": "Zabbix 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": "Zabbix server",
            "flags": "0",
            "description": "The Zabbix monitoring server.",
            "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 grupos de equipos

Recuperar los grupos de equipos a los que pertenece el equipo "Zabbix server".

Solicitud:

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

Respuesta:

{
    "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 plantillas vinculadas

Recuperar los IDs y nombres de las plantillas vinculadas al equipo "10084".

Solicitud:

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

Recuperar los equipos que tienen la plantilla "10001" (Linux por Zabbix agent) vinculada a ellos.

Solicitud:

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

Recuperar equipos que contengan "Linux" en el campo "SO" del inventario de equipos.

Solicitud:

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

Recuperar hosts que tengan la etiqueta "host-name" igual a "linux-server".

Solicitud:

{
    "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 hosts que tengan estas etiquetas no solo a nivel de host sino también en sus templates padre vinculados.

Solicitud:

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

Recuperar hosts excluyendo aquellos con la etiqueta "component".

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "component",
                "value": "",
                "operator": 5
            }
        ]
    },
    "id": 1
}

Respuesta:

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

Búsqueda de equipo con etiquetas y etiquetas de plantilla

Recuperar un equipo con etiquetas y todas las etiquetas que están vinculadas a las plantillas padre.

Solicitud:

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

Buscar equipos por gravedad del problema

Recuperar equipos que tienen problemas de tipo "Desastre".

Solicitud:

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

Respuesta:

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

Recuperar equipos que tienen problemas de tipo "Media" y "Alta".

Solicitud:

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

Recuperar los items del host

Recuperar los 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:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectItems": ["itemid","name","status"],
        "filter": {
            "host": [
                "Zabbix server"
            ]
        }
    },
    "id": 1
}

Respuesta:

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

Ver también

Fuente

CHost::get() en ui/include/classes/api/services/CHost.php.