hostgroup.get

Descripción

integer/array hostgroup.get(object parameters)

El método permite recuperar grupos de equipos según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener 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/array	Devolver solo los grupos de equipos que contienen equipos con las gráficas indicadas.
groupids	ID/array	Devolver solo los grupos de equipos con los IDs de grupo de equipos indicados.
hostids	ID/array	Devolver solo los grupos de equipos que contienen los equipos indicados.
maintenanceids	ID/array	Devolver solo los grupos de equipos que están afectados por los mantenimientos indicados.
triggerids	ID/array	Devolver solo los grupos de equipos que contienen equipos con las alertas indicadas.
with_graphs	flag	Devolver solo los grupos de equipos que contienen equipos con gráficas.
with_graph_prototypes	flag	Devolver solo los grupos de equipos que contienen equipos con prototipos de gráficas.
with_hosts	flag	Devolver solo los grupos de equipos que contienen equipos.
with_httptests	flag	Devolver solo los grupos de equipos que contienen equipos con comprobaciones web. Sobrescribe el parámetro `with_monitored_httptests`.
with_items	flag	Devolver solo los grupos de equipos que contienen equipos con métricas. Sobrescribe los parámetros `with_monitored_items` y `with_simple_graph_items`.
with_item_prototypes	flag	Devolver solo los grupos de equipos que contienen equipos con prototipos de métricas. Sobrescribe el parámetro `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Devolver solo los 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.
with_monitored_httptests	flag	Devolver solo los grupos de equipos que contienen equipos con comprobaciones web habilitadas.
with_monitored_hosts	flag	Devolver solo los grupos de equipos que contienen equipos monitorizados.
with_monitored_items	flag	Devolver solo los grupos de equipos que contienen equipos con métricas habilitadas. Sobrescribe el parámetro `with_simple_graph_items`.
with_monitored_triggers	flag	Devolver solo los grupos de equipos que contienen equipos con alertas habilitadas. Todos los elementos utilizados en la alerta también deben estar habilitados.
with_simple_graph_items	flag	Devolver solo los grupos de equipos que contienen equipos con métricas numéricas.
with_triggers	flag	Devolver solo los grupos de equipos que contienen equipos con alertas. Sobrescribe el parámetro `with_monitored_triggers`.
selectDiscoveryRules	query	Devolver una propiedad `discoveryRules` con las reglas LLD que descubrieron el grupo de equipos.
selectGroupDiscoveries	query	Devolver una propiedad `groupDiscoveries` con los objetos de descubrimiento de grupo de equipos. Cada objeto de descubrimiento de 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 de grupo de equipos desde el que se descubrió el grupo de equipos; `name` - `(string)` nombre del prototipo de grupo de equipos; `lastcheck` - `(timestamp)` hora en la que el grupo de equipos fue descubierto por última vez; `ts_delete` - `(timestamp)` hora en la que se eliminará el grupo de equipos que ya no se descubre; `status` - `(int)` estado del descubrimiento del grupo de equipos: 0 - (por defecto) el grupo de equipos está descubierto, 1 - el grupo de equipos ya no se descubre.
selectHostPrototypes	query	Devolver una propiedad `hostPrototypes` con los prototipos de equipos que descubrieron este grupo de equipos.
selectHosts	query	Devolver una propiedad `hosts` con los equipos que pertenecen al grupo de equipos. Admite `count`.
limitSelects	integer	Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: `selectHosts` - los resultados se ordenarán por `host`.
sortfield	string/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `groupid`, `name`.
countOutput	boolean	Estos parámetros se describen en el comentario de referencia.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

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 grupos de equipos llamados "Zabbix servers" y "Linux servers".

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Zabbix servers",
                       "Linux servers"
                   ]
               }
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

Véase también

Equipo

Fuente

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

Documentation