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 hosts que contienen hosts con los gráficos indicados.
groupids	ID/array	Devolver solo los grupos de hosts con los IDs de grupo de hosts indicados.
hostids	ID/array	Devolver solo los grupos de hosts que contienen los hosts indicados.
maintenanceids	ID/array	Devolver solo los grupos de hosts que están afectados por los mantenimientos indicados.
triggerids	ID/array	Devolver solo los grupos de hosts que contienen hosts con los disparadores indicados.
with_graphs	flag	Devolver solo los grupos de hosts que contienen hosts con gráficos.
with_graph_prototypes	flag	Devolver solo los grupos de hosts que contienen hosts con prototipos de gráficos.
with_hosts	flag	Devolver solo los grupos de hosts que contienen hosts.
with_httptests	flag	Devolver solo los grupos de hosts que contienen hosts con comprobaciones web. Sobrescribe el parámetro `with_monitored_httptests`.
with_items	flag	Devolver solo los grupos de hosts que contienen hosts con elementos. Sobrescribe los parámetros `with_monitored_items` y `with_simple_graph_items`.
with_item_prototypes	flag	Devolver solo los grupos de hosts que contienen hosts con prototipos de elementos. Sobrescribe el parámetro `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Devolver solo los grupos de hosts que contienen hosts con prototipos de elementos, 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 hosts que contienen hosts con comprobaciones web habilitadas.
with_monitored_hosts	flag	Devolver solo los grupos de hosts que contienen hosts monitorizados.
with_monitored_items	flag	Devolver solo los grupos de hosts que contienen hosts con elementos habilitados. Sobrescribe el parámetro `with_simple_graph_items`.
with_monitored_triggers	flag	Devolver solo los grupos de hosts que contienen hosts con disparadores habilitados. Todos los elementos utilizados en el disparador también deben estar habilitados.
with_simple_graph_items	flag	Devolver solo los grupos de hosts que contienen hosts con elementos numéricos.
with_triggers	flag	Devolver solo los grupos de hosts que contienen hosts con disparadores. Sobrescribe el parámetro `with_monitored_triggers`.
selectDiscoveryRules	query	Devolver una propiedad `discoveryRules` con las reglas LLD que descubrieron el grupo de hosts.
selectDiscoveryData	query	Devolver una propiedad `discoveryData` con los objetos de descubrimiento de grupos de hosts. Cada objeto de descubrimiento de grupo de hosts es un prototipo de grupo de hosts vinculado al grupo de hosts descubierto y tiene las siguientes propiedades: `parent_group_prototypeid` - `(ID)` ID del prototipo de grupo de hosts desde el que se descubrió el grupo de hosts; `name` - `(cadena)` nombre del prototipo de grupo de hosts; `ts_delete` - `(timestamp)` momento en que se eliminará el grupo de hosts que ya no se descubre; `status` - `(int)` estado del descubrimiento del grupo de hosts: 0 - (por defecto) el grupo de hosts está descubierto, 1 - el grupo de hosts ya no se descubre.
selectHostPrototypes	query	Devolver una propiedad `hostPrototypes` con los prototipos de host que descubrieron este grupo de hosts.
selectHosts	query	Devolver una propiedad `hosts` con los hosts que pertenecen al grupo de hosts. Admite `count`.
limitSelects	entero	Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: `selectHosts` - los resultados se ordenarán por `host`.
sortfield	cadena/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `groupid`, `name`.
countOutput	booleano	Estos parámetros se describen en el comentario de referencia.
editable	booleano
excludeSearch	booleano
filter	objeto
limit	entero
output	query
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/array
startSearch	booleano
selectGroupDiscoveries	query	Devolver una propiedad `groupDiscoveries` con los objetos de descubrimiento de grupos de hosts. Cada objeto de descubrimiento de grupo de hosts es un prototipo de grupo de hosts vinculado al grupo de hosts descubierto. Esta consulta está obsoleta, por favor 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 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