grupodehost.get

Descripción

entero/matriz grupodehost.get(parámetros de objeto)

El método permite recuperar grupos de hosts de acuerdo con los parámetros dados.

::: nota clásica Este método está disponible para usuarios de cualquier tipo. Permisos para activar el método pueden ser suspendidos en la configuración de roles de usuario. Ver Usuario roles 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	cadena/matriz	Devuelve sólo grupos de hosts que contienen hosts o templates con los gráficos proporcionados.
grupoids	cadena/matriz	Devuelve sólo grupos de hosts con los ID de grupo de hosts proporcionados.
hostids	cadena/matriz	Devuelve sólo los grupos de hosts que contienen los hosts dados.
mantenimientoids	cadena/matriz	Devuelve sólo los grupos de hosts que se ven afectados por los mantenimientos dados.
monitorados_hosts	indicador	Devuelve sólo grupos de hosts que contienen hosts monitoreados.
real_hosts	indicador	Devuelve sólo grupos de hosts que contienen hosts.
templed_hosts	indicador	Devuelve sólo grupos de hosts que contienen templates.
templateids	cadena/matriz	Devuelve sólo los grupos de hosts que contienen los templates proporcionados.
triggerids	cadena/matriz	Devuelve sólo grupos de hosts que contienen hosts o templates con los triggers dados.
with_graphs	indicador	Devuelve sólo grupos de hosts que contienen hosts con gráficos.
with_graph_prototypes	indicador	Devuelve sólo grupos de hosts que contienen hosts con prototipos de gráfica.
with_hosts_and_templates	flag	Devuelve sólo grupos de hosts que contienen hosts o templates.
with_httptests	indicador	Devuelve sólo grupos de hosts que contienen hosts con verificaciones web. Anula el parámetro `with_monitored_httptests`.
with_items	indicador	Devuelve sólo grupos de hosts que contienen hosts o templates con items. Anula los parámetros `with_monitored_items` y `with_simple_graph_items`.
with_item_prototypes	indicador	Devuelve sólo grupos de hosts que contienen hosts con prototipos de item. Anula el parámetro `with_simple_graph_item_prototypes`.
con_simple_graph_item_prototitpo	indicador	Devuelve sólo grupos de hosts que contienen hosts con prototipos de items, que están habilitados para la creación y tienen tipo de información numérica.
con_monitored_httptests	indicador	Devuelve sólo grupos de hosts que contienen hosts con verificaciones web habilitadas.
with_monitored_items	indicador	Devuelve sólo grupos de hosts que contienen hosts o templates con items habilitados. Anula el parámetro `with_simple_graph_items`.
with_monitored_triggers	indicador	Devuelve sólo 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	indicador	Devuelve sólo grupos de hosts que contienen hosts con items numéricos.
with_triggers	indicador	Devuelve sólo grupos de hosts que contienen hosts con triggers. Anula el parámetro `with_monitored_triggers`.
selectDiscoveryRule	consulta	Devuelve una propiedad discoveryRule con la regla LLD que creó el grupo de hosts.
selectGroupDiscovery	consulta	Devuelve una propiedad `groupDiscovery` con el objeto de descubrimiento del grupo de hosts. El objeto de descubrimiento del grupo de hosts vincula un grupo de hosts descubierto a un prototipo de grupo de hosts y tiene las siguientes propiedades: `grupoid` - `(cadena)` ID del grupo de hosts descubierto; `últimaverificación` - `(marcadetiempo)` hora en que se descubrió por última vez el grupo de hosts; `nombre` - `(cadena)` nombre del prototipo del grupo de hosts; `parent_group_prototypeid` - `(cadena)` ID del prototipo del grupo de hosts a partir del cual se ha creado el grupo de hosts; `ts_delete` - `(marca de tiempo)` hora en la que se creó un grupo de hosts ya no descubierto será eliminado.
selectHosts	consulta	Devuelve una propiedad hosts con los hosts que pertenecen al grupo de hosts. Admite `count`.
selectTemplates	consulta	Devuelve una propiedad templates con los templates que pertenecen al grupo de hosts. Admite `count`.
limitSelects	número entero	Limita el número de registros devueltos por las subselecciones. Se aplica a las siguientes subselecciones: `selectHosts`: los resultados se ordenarán por `host`; `selectTemplates`: resultados se ordenará por `host`.
campodeclasificación	cadena/matriz	Ordena el resultado según las propiedades dadas. Los valores posibles son: `grupoid`, `nombre`.
countOutput	boolean	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página comentario de referencia página.
editable	booleano
excluirBuscar	booleano
filtro	objeto
límite	número entero
salida	consulta
preservarclaves	booleano
buscar	objeto
buscarPorCualquier	booleano
buscarWildcardsHabilitado	booleano
clasificación	cadena/matriz
iniciarBuscar	booleano

Valores de retorno

(integer/array) Devuelve:

una matriz de objetos;
el número de objetos recuperados, si el parámetro countOutputha sido usado

Ejemplos

Recuperando datos por nombre

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

Solicitud:

{
           "jsonrpc": "2.0",
           "método": "grupodehost.get",
           "parámetros": {
               "salida": "extender",
               "filtro": {
                   "nombre": [
                       "Servidores Zabbix",
                       "Servidores Linux"
                   ]
               }
           },
           "autenticación": "6f38cddc44cfbb6c1bd186f9a220b5a0",
           "identificación": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "ID de grupo": "2",
                   "nombre": "Servidores Linux",
                   "interno": "0"
               },
               {
                   "ID de grupo": "4",
                   "nombre": "servidores Zabbix",
                   "interno": "0"
               }
           ],
           "identificación": 1
       }

Ver también

Fuente

CGrupodeHost::get() en ui/incluir/clases/api/servicios/CGroupdeHost.php.

Documentation