Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres definint la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
graphids	string/array	Retorna només grups d'equips que contenen equips o patrons amb els gràfics donats.
groupids	string/array	Retorna només els grups d'equips amb els ID de grup d'equips donats.
hostids	string/array	Retorna només els grups d'equips que contenen els equips donats.
maintenanceids	string/array	Retorna només els grups d'equips afectats pels manteniments donats.
triggerids	string/array	Retorna només grups d'equips que contenen equips o patrons amb els triggers donats.
with_graphs	flag	Retorna només grups d'equips que contenen equips amb gràfics.
with_graph_prototypes	flag	Retorna només grups d'equips que contenen equips amb prototips de gràfics.
with_hosts_and_templates	flag	Retorna només grups d'equips que contenen plantilles o.
with_httptests	flag	Retorna només grups d'equips que contenen equips amb comprovacions web. Anul·la la configuració `with_monitored_httptests`.
with_items	flag	Retorna només grups d'equips que contenen equips o plantilles amb elements. Substitueix la configuració `with_monitored_items` i `with_simple_graph_items`.
with_item_prototypes	flag	Retorna només grups d'equips que contenen equips o plantilles amb prototips d'elements. Anul·la el paràmetre `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	marcador	Retorna només grups d'equips que contenen equips amb prototips d'elements, activats en crear-los i amb informació de tipus numèric.
with_monitored_httptests	flag	Retorna només grups d'equips que contenen equips amb monitors web activats.
with_monitored_hosts	flag	Retorna només grups d'equips que contenen equips monitorats.
with_monitored_items	flag	Retorna només grups d'equips que contenen equips o plantilles amb elements activats. Anul·la la configuració `with_simple_graph_items`.
with_monitored_triggers	flag	Retorna només grups d'equips que contenen equips amb triggers activats. També s'han d'activar tots els elements emprats al trigger.
with_simple_graph_items	flag	Retorna només grups d'equips que contenen equips amb elements numèrics.
with_triggers	flag	Retorna només grups d'equips que contenen equips amb triggers. Anul·la la configuració `with_monitored_triggers`.
selectDiscoveryRule	query	Retorna una propietat discoveryRule que conté la regla de descobriment de baix nivell que va crear el grup d'equips.
selectGroupDiscovery	query	Retorna la propietat `groupDiscovery` que conté l'objecte de descobriment del grup d'equips. L'objecte de descobriment del grup d'equips enllaça un grup d'equips descobert a un grup d'equips prototip i té les propietats següents: `groupid` - `(cadena)` identificador del grup d'equips descobert; `última comprovació` - `(marca de temps)` el darrer grup de temps descobert 'equips; `nom` - `(cadena)` nom del prototip del grup d'equips;< br>`parent_group_prototypeid` - `(cadena)` ID del prototip del grup d'equips a partir del qual es va crear l'equip; `ts_delete' -`(marca de temps)` hora en què un grup d'equips que ja no es descobreix s'esborrarà.
selectHosts	query	Retorna una propietat equips que conté els equips que pertanyen al grup d'equips. Admet `count`.
limitSelects	integer	Limita el nombre de registres retornats per les subconsultes. S'aplica a les subconsultes següents: `selectHosts`: els resultats s'ordenaran per `host`;< br>`selectTemplates` - els resultats s'ordenaran per `host`.
sortfield	string/array	Ordena el resultat per les propietats donades. Els valors possibles són: `groupid`, `name`.
countOutput	boolean	Aquests paràmetres, comuns a tots els mètodes `get`, es descriuen als comentaris de referència.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean
monitored_hosts(obsolet)	flag	Aquest paràmetre és obsolet; empreu `with_monitored_hosts` en el seu lloc. Retorna només grups d'equips que contenen equips monitorats.
real_hosts (obsolet)	flag	Aquest paràmetre és obsolet; empreu `with_hosts` en el seu lloc. Retorna només grups d'equips que contenen equips.

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

recupear informació per nom

Recupera tota la informació dels grups d'equips anomenats "Servidors Zabbix" i "Servidors Linux".

Petició:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Servidors Zabbix",
                "Servidors Linux"
            ]
        }
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "internal": "0"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "internal": "0"
        }
    ],
    "id": 1
}

Veieu també

Equip

Font

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

What’s next?

hostgroup.massadd

Docs

hostgroup.get

Descripció