hostgroup.get

Descrizione

integer/array hostgroup.get(object parameters)

Questo metodo consente di recuperare i gruppi di host in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
graphids ID/array Restituisce solo i gruppi di host che contengono host con i grafici specificati.
groupids ID/array Restituisce solo i gruppi di host con gli ID dei gruppi di host specificati.
hostids ID/array Restituisce solo i gruppi di host che contengono gli host specificati.
maintenanceids ID/array Restituisce solo i gruppi di host interessati dalle manutenzioni specificate.
triggerids ID/array Restituisce solo i gruppi di host che contengono host con i trigger specificati.
with_graphs boolean Restituisce solo i gruppi di host che contengono host con grafici.
with_graph_prototypes boolean Restituisce solo i gruppi di host che contengono host con prototipi di grafici.
with_hosts boolean Restituisce solo i gruppi di host che contengono host.
with_httptests boolean Restituisce solo i gruppi di host che contengono host con controlli web.

Sostituisce il parametro with_monitored_httptests.
with_items boolean Restituisce solo i gruppi di host che contengono host con item.

Sostituisce i parametri with_monitored_items e with_simple_graph_items.
with_item_prototypes boolean Restituisce solo i gruppi di host che contengono host con prototipi di item.

Sostituisce il parametro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Restituisce solo i gruppi di host che contengono host con prototipi di item abilitati per la creazione e con tipo di informazione numerico.
with_monitored_httptests boolean Restituisce solo i gruppi di host che contengono host con controlli web abilitati.
with_monitored_hosts boolean Restituisce solo i gruppi di host che contengono host monitorati.
with_monitored_items boolean Restituisce solo i gruppi di host che contengono host con item abilitati.

Sostituisce il parametro with_simple_graph_items.
with_monitored_triggers boolean Restituisce solo i gruppi di host che contengono host con trigger abilitati. Anche tutti gli item utilizzati nel trigger devono essere abilitati.
with_simple_graph_items boolean Restituisce solo i gruppi di host che contengono host con item numerici.
with_triggers boolean Restituisce solo i gruppi di host che contengono host con trigger.

Sostituisce il parametro with_monitored_triggers.
selectDiscoveryRules query Restituisce una proprietà discoveryRules con le regole LLD che hanno rilevato il gruppo di host.
selectGroupDiscoveries query Restituisce una proprietà groupDiscoveries con gli oggetti di rilevamento dei gruppi di host.

Ogni oggetto di rilevamento di un gruppo di host è un prototipo di gruppo di host collegato al gruppo di host rilevato e presenta le seguenti proprietà:
parent_group_prototypeid - (ID) ID del prototipo di gruppo di host dal quale è stato rilevato il gruppo di host;
name - (string) nome del prototipo di gruppo di host;
lastcheck - (timestamp) momento in cui il gruppo di host è stato rilevato l'ultima volta;
ts_delete - (timestamp) momento in cui il gruppo di host non più rilevato verrà eliminato;
status - (int) stato del rilevamento del gruppo di host:
0 - (predefinito) il gruppo di host è rilevato,
1 - il gruppo di host non è più rilevato.
selectHostPrototypes query Restituisce una proprietà hostPrototypes con i prototipi di host che hanno rilevato questo gruppo di host.
selectHosts query Restituisce una proprietà hosts con gli host appartenenti al gruppo di host.

Supporta count.
limitSelects integer Limita il numero di record restituiti dalle sottoselezioni.

Si applica alle seguenti sottoselezioni:
selectHosts - i risultati saranno ordinati per host.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: groupid, name.
countOutput boolean Questi parametri sono descritti nella documentazione di riferimento.
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 Questo parametro è obsoleto; utilizzare invece with_monitored_hosts.
Restituisce solo i gruppi di host che contengono host monitorati.
real_hosts
(deprecated)		 flag Questo parametro è obsoleto; utilizzare invece with_hosts.
Restituisce solo i gruppi di host che contengono host.

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput

Esempi

Recupero dei dati per nome

Recupera tutti i dati relativi a due gruppi di host denominati "Zabbix servers" e "Linux servers".

Richiesta:

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

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

Vedi anche

Sorgente

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