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/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.
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 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` - `(string)` nombre del prototipo de grupo de hosts; `lastcheck` - `(timestamp)` hora en que se descubrió por última vez el grupo de hosts; `ts_delete` - `(timestamp)` hora 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	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
monitored_hosts (obsoleto)	flag	Este parámetro está obsoleto, por favor use `with_monitored_hosts` en su lugar. Devolver solo los grupos de hosts que contienen hosts monitorizados.
real_hosts (obsoleto)	flag	Este parámetro está obsoleto, por favor use `with_hosts` en su lugar. Devolver solo los grupos de hosts que contienen hosts.

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando datos por nombre

Recupere todos los datos sobre dos grupos de equipos denominados "servidores Zabbix" y "servidores Linux".

Solicitud:

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

Host

Fuente

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

Documentation