Documentation
Table of Contents
- host.get
- ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
- ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
- 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
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
´¥±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç´¥Tipo|¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô| |--|--|-- ----| |groupids|cadena/matriz|Devuelve solo equipos que pertenecen a los grupos dados.| |dserviceids|cadena/matriz|Devuelve solo equipos que est¨¢n relacionados con los servicios descubiertos dados.| |graphids|cadena/matriz| Devuelve solo equipos que tienen los gr¨¢ficos proporcionados.| |hostids|cadena/matriz|Devuelve solo equipos con los ID de equipo proporcionados.| |httptestids|cadena/matriz|Devuelve solo equipos que tienen las comprobaciones web proporcionadas.| |interfaceids|cadena/ matriz|Devuelve solo equipos que usan las interfaces dadas.| |itemids|cadena/matriz|Devuelve solo equipos que tienen los elementos dados.| |maintenanceids|cadena/matriz|Devuelve solo equipos que se ven afectados por los mantenimientos dados.| |monitored _hosts|flag|Devuelve solo equipos monitoreados.| |proxy_hosts|flag|Devuelve solo proxies.| |proxyids|string/array|Devuelve solo equipos que son monitoreados por los proxies dados.| |template_hosts|flag|Devuelve tanto equipos como plantillas.| |templateids|string/array|Devuelve solo equipos que est¨¢n vinculados a las plantillas dadas.| |triggerids|string/array|Devuelve solo equipos que tienen los iniciadores dados.| |with_items|flag|Devuelve solo equipos que tienen m¨¦tricas.
Anula los par¨¢metros with_monitored_items y with_simple_graph_items.| |with_item_prototypes|flag|Devuelve solo equipos que tienen prototipos de m¨¦tricas.
Anula el with_simple_graph_item_prototypes par¨¢metro.| |with_simple_graph_item_prototypes|flag|Devuelve solo equipos que tienen prototipos de m¨¦tricas, que est¨¢n habilitados para la creaci¨®n y tienen tipo de informaci¨®n num¨¦rica.| |with_graphs|flag|Devuelve solo equipos que tener gr¨¢ficos.| |with_graph_prototypes|flag|Devuelve solo equipos que tienen prototipos de gr¨¢ficos.| |with_httptests|flag|Devuelve solo equipos que tienen comprobaciones web.
Anula el par¨¢metro with_monitored_httptests.| |with?_monitored_httptests|flag|Devuelve solo equipos que tienen comprobaciones web habilitadas.| |with_monitored_items|flag|Devuelve solo equipos que tienen elementos habilitados.
Anula el par¨¢metro with_simple_graph_items.| |with?_monitored_triggers|flag|Devuelve solo equipos que tienen iniciadores habilitados. Todos los elementos utilizados en el iniciador tambi¨¦n deben estar habilitados.| |with_simple_graph_items|flag|Devuelve solo equipos que tienen elementos con tipo de informaci¨®n num¨¦rico.| |with_triggers|flag|Devuelve solo equipos que tienen iniciadores.
Anula el par¨¢metro with_monitored_triggers.| |withProblemsSuppressed|booleano|Devuelve equipos que han suprimido problemas.
Valores posibles:null - (predeterminado) todos los equipos;true - solo equipos con problemas suprimidos;false - solo equipos con problemas no suprimidos.| |evaltype|integer|Reglas para la b¨²squeda de etiquetas.
Valores posibles:<br >0 - (predeterminado) Y/O;
2 - O.| |severities|integer/array|Devuelve equipos que solo tienen problemas con gravedades dadas. Se aplica solo si el objeto problem¨¢tico es el desencadenante.| |tags|object/array|Devuelve solo equipos con etiquetas dadas. Coincidencia exacta por etiqueta y b¨²squeda que distinga entre may¨²sculas y min¨²sculas por valor de etiqueta seg¨²n el valor del operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].
Una matriz vac¨ªa devuelve todos los equipos.
Valores posibles del operador:
0 - (predeterminado) Contiene;<br >1 - Igual;
2 - No me gusta;
3 - No igual;
4 - Existe;
5 - No existe.| |inheritedTags|boolean|Devuelve equipos que han proporcionado etiquetas tambi¨¦n en todas sus plantillas vinculadas. Valor predeterminado:
Valores posibles:true: las plantillas vinculadas tambi¨¦n deben tener etiquetas;false: (predeterminado) las etiquetas de las plantillas vinculadas se ignoran.| |selectDiscoveries| consulta|Devuelve una propiedad discoveries con reglas de descubrimiento de bajo nivel del host.
Admite count.| |selectDiscoveryRule|query|Devuelve una [discoveryRule] (/manual/api/reference/discoveryrule/object) propiedad con la regla de descubrimiento de bajo nivel que cre¨® el host (desde el prototipo de host en el monitoreo de VMware).||selectGraphs|query|Devolver a graphs con gr¨¢ficos de host.
Admite count.| |selectHostDiscovery|query|Devuelve una propiedad hostDiscovery con datos del objeto de descubrimiento de host.
El objeto de descubrimiento de host vincula un host descubierto a un prototipo de host o un prototipo de host a una regla LLD y tiene las siguientes propiedades:host - (string) host del prototipo de host;hostid - (string ) ID del host descubierto o prototipo de host;parent_hostid - (string) ID del prototipo de host a partir del cual se cre¨® el host;parent_itemid - (string) ID de la regla LLD que cre¨® el host descubierto;lastcheck - (timestamp) hora en que el equipo fue descubierto por ¨²ltima vez;ts_delete - (timestamp) hora en que un equipo que ya no se descubre se eliminar¨¢.| |selectHostGroups|query|Devuelve una propiedad hostgroups con datos de los grupos de hosts a los que pertenece el host.| |selectHttpTests|query|Devuelve un httpTests propiedad con escenarios web de host.
Admite count.| |selectInterfaces|query|Devuelve una interfaces propiedad con interfaces de host.
Admite count.| |selectInventory|query|Devuelve una propiedad inventario con datos de inventario de host.|| selectItems|query|Devuelve una propiedad items con elementos host.
Admite count.| |selectMacros|query|Devuelve una macros con macros de host.||selectParentTemplates|query|Devuelve una propiedad parentTemplates con plantillas al 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 host.
Valores posibles:
0 - (predeterminado) vinculado manualmente;
1 - vinculado autom¨¢ticamente por LLD.
Admite count.| |selectDashboards|query|Devuelve una propiedad dashboards.< br>
Admite count.| |selectTags|query|Devuelve una propiedad tags con etiquetas de host.| |selectInheritedTags|query|Devuelve una inheritedTags propiedad con etiquetas que est¨¢n en todas las plantillas que est¨¢n vinculadas al host.| |selectTriggers|query|Devuelve un triggers propiedad con activadores de host.
Admite count.| |selectValueMaps|query|Devuelve una propiedad valuemaps con mapas de valores de host.| |filter |objeto|Devuelve s¨®lo aquellos resultados que exactamente ma | |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;< br>selectItems - ordenado por nombre;selectDiscoveries - ordenado por nombre;selectTriggers - ordenado por »å±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô;selectGraphs - ordenado por nombre ;selectDashboards - ordenado por nombre.||search|object|Devuelve resultados que coinciden con el patr¨®n dado (no distingue entre may¨²sculas y min¨²sculas).
Acepta una matriz, donde las claves son nombres de propiedades, y los valores son cadenas para buscar. Si no se proporcionan opciones adicionales, se realizar¨¢ una b¨²squeda LIKE "%¡%".
Permite buscar por propiedades de la interfaz. Funciona solo para los campos string y text.||searchInventory|object|Devuelve solo hosts que tienen datos de inventario que coinciden con la b¨²squeda con comod¨ªn dada.
Este par¨¢metro se ve afectado por los mismos par¨¢metros adicionales que search .||sortfield|string/array|Ordena el resultado seg¨²n las propiedades dadas.
Valores posibles: hostid, host, name, status.| |countOutput|boolean|Estos par¨¢metros ser comunes para todos los m¨¦todos get se describen en detalle en el comentario de referencia.| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^ | |output|consulta|^| |preservekeys|boolean|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| |selectGroups
(obsoleto)|query|Este par¨¢metro est¨¢ obsoleto; utilice selectHostGroups en su lugar.
Devuelve una propiedad groups con 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 Áú»¢¶Ä²©" y " servidor Linux".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Áú»¢¶Ä²© server",
"Linux server"
]
}
},
"id": 1
}Respuesta:
{
"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",
"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 Áú»¢¶Ä²©" es miembro.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Áú»¢¶Ä²© server"
]
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"hostgroups": [
{
"groupid": "2",
"name": "Linux servers",
"flags": "0",
"uuid": "dc579cd7a1a34222933f24f52a68bcd8"
},
{
"groupid": "4",
"name": "Áú»¢¶Ä²© 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": "Áú»¢¶Ä²© Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Recuperar equipos por plantilla
Recupere equipos que tengan la plantilla "10001" (Linux by Áú»¢¶Ä²© 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": "Áú»¢¶Ä²© 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": "Áú»¢¶Ä²© server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}B¨²squeda por etiquetas de equipo
Recupera los equipos que tienen 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"
},
{
"tag": "os",
"value": "rhel-7"
}
]
}
],
"id": 1
}Recupera los equipos que tienen estas etiquetas no solo en el 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.