Documentation
Table of Contents
hostgroup.get
Descripción
integer/array hostgroup.get(object parameters)
El método permite recuperar grupos de equipos de acuerdo con la información de los parámetros suministrados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede 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 |
|---|---|---|
| graphids | ID/matriz | Devuelve solo grupos de equipos que contienen equipos con los gráficos proporcionados. |
| groupids | ID/matriz | Devuelve solo grupos de equipos con los ID de grupo de equipos proporcionados. |
| hostids | ID/matriz | Devuelve sólo los grupos de equipos que contienen los equipos dados. |
| maintenanceids | ID/matriz | Devuelve solo los grupos de equipos que se ven afectados por los mantenimientos dados. |
| triggerids | ID/matriz | Devuelve solo grupos de equipos que contienen equipos con los iniciadores dados. |
| with_graphs | flag | Devuelve solo grupos de equipos que contienen equipos con gráficos. |
| with_graph_prototypes | flag | Devuelve solo grupos de equipos que contienen equipos con prototipos de gráficos. |
| with_hosts | flag | Devuelve sólo grupos de equipos que contienen equipos. |
| with_httptests | flag | Devuelve solo grupos de equipos que contienen equipos con comprobaciones web. Anula el parámetro with_monitored_httptests. |
| with_items | flag | Devuelve solo grupos de equipos que contienen equipos con métricas. Anula los parámetros with_monitored_items y with_simple_graph_items. |
| with_item_prototypes | flag | Devuelve solo grupos de equipos que contienen equipos con prototipos de métricas. Anula el parámetro with_simple_graph_item_prototypes. |
| con_simple_graph_item_prototypes | flag | Devuelve solo grupos de equipos que contienen equipos con prototipos de métricas, que están habilitados para la creación y tienen tipo de información numérica. |
| con_monitored_httptests | flag | Devuelve solo grupos de hosts que contienen hosts con comprobaciones web habilitadas. |
| with_monitored_hosts | flag | Devuelve solo grupos de equipos que contienen equipos monitoreados. |
| with_monitored_items | flag | Devuelve solo grupos de equipos que contienen equipos con métricas habilitadas. Anula el parámetro with_simple_graph_items. |
| with_monitored_triggers | flag | Devuelve solo grupos de equipos que contienen equipos con iniciadores habilitados. Todas las métricas utilizadas en el iniciador también deben estar habilitados. |
| with_simple_graph_items | flag | Devuelve solo grupos de equipos que contienen equipos con métricas numéricas. |
| with_triggers | flag | Devuelve solo grupos de equipos que contienen equipos con iniciadores. Anula el parámetro with_monitored_triggers. |
| selectDiscoveryRules | query | Devuelve una propiedad discoveryRules con las reglas LLD que descubrieron el grupo de hosts. |
| selectGroupDiscoveries | query | Devuelve una propiedad groupDiscoveries con los objetos de descubrimiento del grupo de equipos.Cada objeto de descubrimiento del grupo de equipos es un prototipo de grupo de equipos vinculado al grupo de equipos descubierto y tiene las siguientes propiedades: parent_group_prototypeid - (ID) ID del prototipo del grupo de equipos a partir del cual se descubrió el grupo de equipos;name - (string) nombre del prototipo del grupo de equipos;lastcheck - ( marca de tiempo) hora en que se descubrió por última vez el grupo de equipos;ts_delete - (marca de tiempo) hora en que se eliminará el grupo de hosts que ya no se descubre;status - (int) Estado de descubrimiento del grupo de equipos:0 - (predeterminado) se descubre el grupo de equipos, 1 - el grupo de equipos ya no se descubre. |
| selectHostPrototypes | query | Devuelve una propiedad hostPrototypes con prototipos de equipos que descubrieron este grupo de equipos. |
| selectHosts | query | Devuelve una propiedad hosts con los equipos que pertenecen al grupo de equipos.Admite count. |
| limitSelects | entero | Limita el número de registros devueltos por las subselecciones. Se aplica a las siguientes subselecciones: selectHosts: los resultados se ordenarán por host. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: groupid, name. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano | |
| monitored_hosts (obsoleto) |
flag | Este parámetro está en desuso; utilice with_monitored_hosts en su lugar.Devuelve solo grupos de equipos que contengan equipos monitoreados. |
| real_hosts (obsoleto) |
flag | Este parámetro está en desuso, utilice with_hosts en su lugar.Devuelve solo grupos de equipos que contienen equipos. |
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 grupos de equipos denominados "servidores Zabbix" y "servidores Linux".
{
"jsonrpc": "2.0",
"method": "hostgroup.get",
"params": {
"output": "extend",
"filter": {
"name": [
"servidores Zabbix",
"servidores Linux"
]
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"groupid": "2",
"name": "servidores Linux",
"internal": "0"
},
{
"groupid": "4",
"name": "servidores Zabbix",
"internal": "0"
}
],
"id": 1
}Ver también
Fuente
CHostGroup::get() en ui/include/classes/api/services/CHostGroup.php.