hostgroup.get

Descripción

integer/array hostgroup.get(object parameters)

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

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 para obtener más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parameter Type Description
graphids ID/array Devuelve solo los grupos de host que contienen hosts con los gráficos indicados.
groupids ID/array Devuelve solo los grupos de host con los IDs de grupo de host indicados.
hostids ID/array Devuelve solo los grupos de host que contienen los hosts indicados.
maintenanceids ID/array Devuelve solo los grupos de host afectados por los mantenimientos indicados.
triggerids ID/array Devuelve solo los grupos de host que contienen hosts con los triggers indicados.
with_graphs boolean Devuelve solo los grupos de host que contienen hosts con gráficos.
with_graph_prototypes boolean Devuelve solo los grupos de host que contienen hosts con prototipos de gráfico.
with_hosts boolean Devuelve solo los grupos de host que contienen hosts.
with_httptests boolean Devuelve solo los grupos de host que contienen hosts con comprobaciones web.

Sobrescribe el parámetro with_monitored_httptests.
with_items boolean Devuelve solo los grupos de host que contienen hosts con items.

Sobrescribe los parámetros with_monitored_items y with_simple_graph_items.
with_item_prototypes boolean Devuelve solo los grupos de host que contienen hosts con prototipos de item.

Sobrescribe el parámetro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Devuelve solo los grupos de host que contienen hosts con prototipos de item, que están habilitados para creación y tienen un tipo de información numérico.
with_monitored_httptests boolean Devuelve solo los grupos de host que contienen hosts con comprobaciones web habilitadas.
with_monitored_hosts boolean Devuelve solo los grupos de host que contienen hosts monitorizados.
with_monitored_items boolean Devuelve solo los grupos de host que contienen hosts con items habilitados.

Sobrescribe el parámetro with_simple_graph_items.
with_monitored_triggers boolean Devuelve solo los grupos de host que contienen hosts con triggers habilitados. Todos los items usados en el trigger también deben estar habilitados.
with_simple_graph_items boolean Devuelve solo los grupos de host que contienen hosts con items numéricos.
with_triggers boolean Devuelve solo los grupos de host que contienen hosts con triggers.

Sobrescribe el parámetro with_monitored_triggers.
selectDiscoveryRules query Devuelve una propiedad discoveryRules con las reglas LLD que descubrieron el grupo de host.
selectGroupDiscoveries query Devuelve una propiedad groupDiscoveries con los objetos de descubrimiento de grupo de host.

Cada objeto de descubrimiento de grupo de host es un prototipo de grupo de host vinculado al grupo de host descubierto y tiene las siguientes propiedades:
parent_group_prototypeid - (ID) ID del prototipo de grupo de host a partir del cual se descubrió el grupo de host;
name - (string) nombre del prototipo de grupo de host;
lastcheck - (timestamp) momento en que se descubrió por última vez el grupo de host;
ts_delete - (timestamp) momento en que se eliminará el grupo de host que ya no se descubra;
status - (int) estado del descubrimiento del grupo de host:
0 - (predeterminado) el grupo de host está descubierto,
1 - el grupo de host ya no está descubierto.
selectHostPrototypes query Devuelve una propiedad hostPrototypes con los prototipos de host que descubrieron este grupo de host.
selectHosts query Devuelve una propiedad hosts con los hosts que pertenecen al grupo de host.

Admite count.
limitSelects integer Limita el número de registros devueltos por las subconsultas.

Se aplica a las siguientes subconsultas:
selectHosts - los resultados se ordenarán por host.
sortfield string/array Ordena 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
(deprecated)		 flag Este parámetro está obsoleto; use with_monitored_hosts en su lugar.
Devuelve solo los grupos de host que contienen hosts monitorizados.
real_hosts
(deprecated)		 flag Este parámetro está obsoleto; use with_hosts en su lugar.
Devuelve solo los grupos de host que contienen hosts.

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 hosts 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",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

Véase también

Fuente

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