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 el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
graphids ID/array Devuelve únicamente los grupos de hosts que contienen hosts con los gráficos indicados.
groupids ID/array Devuelve únicamente los grupos de hosts con los ID de grupo de hosts indicados.
hostids ID/array Devuelve únicamente los grupos de hosts que contienen los hosts indicados.
maintenanceids ID/array Devuelve únicamente los grupos de hosts afectados por los mantenimientos indicados.
triggerids ID/array Devuelve únicamente los grupos de hosts que contienen hosts con los triggers indicados.
with_graphs boolean Devuelve únicamente los grupos de hosts que contienen hosts con gráficos.
with_graph_prototypes boolean Devuelve únicamente los grupos de hosts que contienen hosts con prototipos de gráficos.
with_hosts boolean Devuelve únicamente los grupos de hosts que contienen hosts.
with_httptests boolean Devuelve únicamente los grupos de hosts que contienen hosts con comprobaciones web.

Anula el parámetro with_monitored_httptests.
with_items boolean Devuelve únicamente los grupos de hosts que contienen hosts con items.

Anula los parámetros with_monitored_items y with_simple_graph_items.
with_item_prototypes boolean Devuelve únicamente los grupos de hosts que contienen hosts con prototipos de items.

Anula el parámetro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Devuelve únicamente los grupos de hosts que contienen hosts con prototipos de items habilitados para su creación y cuyo tipo de información es numérico.
with_monitored_httptests boolean Devuelve únicamente los grupos de hosts que contienen hosts con comprobaciones web habilitadas.
with_monitored_hosts boolean Devuelve únicamente los grupos de hosts que contienen hosts monitorizados.
with_monitored_items boolean Devuelve únicamente los grupos de hosts que contienen hosts con items habilitados.

Anula el parámetro with_simple_graph_items.
with_monitored_triggers boolean Devuelve únicamente 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 Devuelve únicamente los grupos de hosts que contienen hosts con items numéricos.
with_triggers boolean Devuelve únicamente los grupos de hosts que contienen hosts con triggers.

Anula el parámetro with_monitored_triggers.
selectDiscoveryRules query Devuelve una propiedad discoveryRules con las reglas de descubrimiento LLD que descubrieron el grupo de hosts.
selectGroupDiscoveries query Devuelve 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 a partir del cual se descubrió el grupo de hosts;
name - (string) nombre del prototipo de grupo de hosts;
lastcheck - (timestamp) momento en que se descubrió el grupo de hosts por última vez;
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 - (predeterminado) el grupo de hosts se ha descubierto,
1 - el grupo de hosts ya no se descubre.
selectHostPrototypes query Devuelve una propiedad hostPrototypes con los prototipos de hosts que descubrieron este grupo de hosts.
selectHosts query Devuelve una propiedad hosts con los hosts que pertenecen al grupo de hosts.

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

Se aplica a las siguientes subselecciones:
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 los comentarios 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; utilice with_monitored_hosts en su lugar.
Devuelve únicamente los grupos de hosts que contienen hosts monitorizados.
real_hosts
(deprecated)		 flag Este parámetro está obsoleto; utilice with_hosts en su lugar.
Devuelve únicamente los grupos de hosts 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.