[comment]: # ({f8d4c2e5-f8d4c2e5}) # hostgroup.get [comment]: # ({/f8d4c2e5-f8d4c2e5}) [comment]: # ({20294517-08ff22f2}) ### Descripción `integer/array hostgroup.get(object parameters)` El método permite recuperar grupos de hosts según los parámetros dados. ::: noteclassic Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte [Roles de usuario](/manual/web_interface/frontend_sections/users/user_roles) para obtener más información. ::: [comment]: # ({/20294517-08ff22f2}) [comment]: # ({5291ff51-7f042696}) ### Parámetros `(object)` Parámetros que definen la salida deseada. El método admite los siguientes parámetros. |Parámetro|[Tipo](/manual/api/reference_commentary#data-types)|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 triggers indicados.| |with\_graphs|boolean|Devolver solo los grupos de hosts que contienen hosts con gráficos.| |with\_graph\_prototypes|boolean|Devolver solo los grupos de hosts que contienen hosts con prototipos de gráficos.| |with\_hosts|boolean|Devolver solo los grupos de hosts que contienen hosts.| |with\_httptests|boolean|Devolver solo los grupos de hosts que contienen hosts con comprobaciones web.

Sobrescribe el parámetro `with_monitored_httptests`.| |with\_items|boolean|Devolver solo los grupos de hosts que contienen hosts con items.

Sobrescribe los parámetros `with_monitored_items` y `with_simple_graph_items`.| |with\_item\_prototypes|boolean|Devolver solo los grupos de hosts que contienen hosts con prototipos de item.

Sobrescribe el parámetro `with_simple_graph_item_prototypes`.| |with\_simple\_graph\_item\_prototypes|boolean|Devolver solo los grupos de hosts que contienen hosts con prototipos de item, que están habilitados para la creación y tienen tipo de información numérica.| |with\_monitored\_httptests|boolean|Devolver solo los grupos de hosts que contienen hosts con comprobaciones web habilitadas.| |with\_monitored\_hosts|boolean|Devolver solo los grupos de hosts que contienen hosts monitorizados.| |with\_monitored\_items|boolean|Devolver solo los grupos de hosts que contienen hosts con items habilitados.

Sobrescribe el parámetro `with_simple_graph_items`.| |with\_monitored\_triggers|boolean|Devolver solo los grupos de hosts que contienen hosts con triggers habilitados. Todos los items utilizados en el trigger también deben estar habilitados.| |with\_simple\_graph\_items|boolean|Devolver solo los grupos de hosts que contienen hosts con items numéricos.| |with\_triggers|boolean|Devolver solo los grupos de hosts que contienen hosts con triggers.

Sobrescribe el parámetro `with_monitored_triggers`.| |selectDiscoveryRules|query|Devolver una propiedad [`discoveryRules`](/manual/api/reference/discoveryrule/object) con las reglas LLD que descubrieron el grupo de hosts.| |selectDiscoveryData|query|Devolver una propiedad `discoveryData` con los objetos de descubrimiento de grupo 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;
`ts_delete` - `(timestamp)` hora en que se eliminará el grupo de hosts que ya no se descubre;
`status` - `(int)` estado de 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`](/manual/api/reference/hostprototypes/object) con los prototipos de host que descubrieron este grupo de hosts.| |selectHosts|query|Devolver una propiedad [`hosts`](/manual/api/reference/host/object) 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](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |filter|object|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| |selectGroupDiscoveries|query|Devolver una propiedad `groupDiscoveries` con los objetos de descubrimiento de grupo 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.| [comment]: # ({/5291ff51-7f042696}) [comment]: # ({07ca11ca-7223bab1}) ### Valores de retorno `(integer/array)` Devuelve: - un array de objetos - el número de objetos recuperados, si se ha utilizado el parámetro `countOutput` [comment]: # ({/07ca11ca-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Ejemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6271b06c-8ed2756a}) #### Recuperar datos por nombre Recuperar todos los datos sobre dos grupos de hosts llamados "Zabbix servers" y "Linux servers". [Solicitud](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "hostgroup.get", "params": { "output": "extend", "filter": { "name": [ "Zabbix servers", "Linux servers" ] } }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "groupid": "2", "name": "Linux servers", "flags": "0", "uuid": "dc579cd7a1a34222933f24f52a68bcd8" }, { "groupid": "4", "name": "Zabbix servers", "flags": "0", "uuid": "6f6799aa69e844b4b3918f779f2abf08" } ], "id": 1 } ``` [comment]: # ({/6271b06c-8ed2756a}) [comment]: # ({6a994b89-e5f0abe1}) ### Véase también - [Equipo](/manual/api/reference/host/object#host) [comment]: # ({/6a994b89-e5f0abe1}) [comment]: # ({1e72ea39-1e72ea39}) ### Fuente CHostGroup::get() en *ui/include/classes/api/services/CHostGroup.php*. [comment]: # ({/1e72ea39-1e72ea39})