On this page
28 Host principali
Descrizione
Questi parametri e i possibili valori delle proprietà per i rispettivi oggetti campo del widget dashboard consentono di configurare il widget Top hosts nei metodi dashboard.create e dashboard.update.
Le proprietà fields del widget non vengono validate durante la creazione o l'aggiornamento di una dashboard.
Ciò consente agli utenti di modificare i widget integrati e creare widget personalizzati, ma introduce anche il rischio di creare o aggiornare i widget in modo errato.
Per garantire la corretta creazione o il corretto aggiornamento del widget Top hosts, fare riferimento al comportamento dei parametri descritto nelle tabelle seguenti.
Parametri
I seguenti parametri sono supportati per il widget Top hosts.
| Parametro | type | name | value | |
|---|---|---|---|---|
| Intervallo di aggiornamento | 0 | rf_rate | 0 - Nessun aggiornamento; 10 - 10 secondi; 30 - 30 secondi; 60 - (predefinito) 1 minuto; 120 - 2 minuti; 600 - 10 minuti; 900 - 15 minuti. |
|
| Gruppi di host | 2 | groupids.0 | ID del gruppo di host. Nota: Per configurare più gruppi di host, creare un oggetto campo widget dashboard per ciascun gruppo di host con un numero incrementato nel nome della proprietà. Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Gruppi di host (Widget) | 1 | groupids._reference | Invece dell'ID del gruppo di host:ABCDE._hostgroupids - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati per i gruppi di host.Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Host | 3 | hostids.0 | ID dell'host. Nota: Per configurare più host, creare un oggetto campo widget dashboard per ciascun host con un numero incrementato nel nome della proprietà. Per più host, il parametro Gruppi di host non deve essere configurato affatto oppure deve essere configurato con almeno un gruppo di host a cui appartengono gli host configurati. Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Host (Widget/Dashboard) | 1 | hostids._reference | Invece dell'ID dell'host:DASHBOARD.hostids - imposta il selettore host della dashboard come origine dati per gli host;ABCDE._hostids - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati per gli host.Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Tag host | ||||
| Tipo di valutazione | 0 | evaltype | 0 - (predefinito) And/Or; 2 - Or. Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Nome tag | 1 | tags.0.tag | Qualsiasi valore stringa. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag host Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Operatore | 0 | tags.0.operator | 0 - Contiene; 1 - Uguale a; 2 - Non contiene; 3 - Diverso da; 4 - Esiste; 5 - Non esiste. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag host Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Valore tag | 1 | tags.0.value | Qualsiasi valore stringa. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag host Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Mostra host in manutenzione | 0 | maintenance | 0 - (predefinito) Disabilitato; 1 - Abilitato. |
|
| Colonne (vedi sotto) | ||||
| Ordina per | 0 | column | Valore numerico della colonna tra le colonne configurate. | |
| Ordine | 0 | order | 2 - (predefinito) Top N; 3 - Bottom N. |
|
| Limite host | 0 | show_lines | I valori possibili vanno da 1 a 1000. Predefinito: 10. Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
Colonne
Le colonne hanno parametri comuni e parametri aggiuntivi a seconda della configurazione del parametro Data.
Per tutti i parametri relativi alle colonne, il numero nel nome della proprietà (ad esempio columns.0.name) fa riferimento a una colonna per la quale il parametro è configurato.
I seguenti parametri sono supportati per tutte le colonne.
| Parametro | type | name | value |
|---|---|---|---|
| Nome | 1 | columns.0.name | Qualsiasi valore stringa. Comportamento del parametro: - obbligatorio |
| Dati | 0 | columns.0.data | 1 - Valore dell'item; 2 - Nome dell'host; 3 - Testo. Comportamento del parametro: - obbligatorio |
| Colore di base | 1 | columns.0.base_color | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - obbligatorio |
Valore dell'item
I seguenti parametri sono supportati se Data è impostato su "Item value".
Il primo numero nel nome della proprietà Thresholds (ad esempio columnsthresholds.0.color.0) fa riferimento alla colonna per la quale sono configurate le soglie, mentre il secondo numero fa riferimento alla posizione della soglia in un elenco ordinato in ordine crescente.
Tuttavia, se le soglie sono configurate in un ordine diverso, i valori verranno ordinati in ordine crescente dopo l'aggiornamento della configurazione del widget nel frontend di Zabbix (ad esempio "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parametro | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Nome item valido. Quando si configura il widget in una dashboard template, devono essere impostati solo gli item configurati sul template. |
|
| Visualizza il valore dell'item come | 0 | columns.0.display_value_as | 0 - (predefinito) Numerico; 1 - Testo; 2 - Binario. |
|
| Visualizzazione | 0 | columns.0.display | 1 - (predefinito) Così com'è; 2 - Barra; 3 - Indicatori; 6 - Sparkline. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" |
|
| Min | 1 | columns.0.min | Qualsiasi valore numerico. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Bar" o "Indicators" |
|
| Max | 1 | columns.0.max | Qualsiasi valore numerico. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Bar" o "Indicators" |
|
| Posizioni decimali | 0 | columns.0.decimal_places | I valori possibili vanno da 0 a 10. Predefinito: 2. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" |
|
| Sparkline | ||||
| Larghezza | 0 | columns.0.sparkline.width | I valori possibili vanno da 0 a 10. Predefinito: 1. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" |
|
| Riempimento | 0 | columns.0.sparkline.fill | I valori possibili vanno da 0 a 10. Predefinito: 3. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" |
|
| Colore | 1 | columns.0.sparkline.color | Codice colore esadecimale (ad esempio FF0000).Predefinito: 42A5F5.Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" |
|
| Periodo di tempo | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - imposta il selettore del periodo di tempo della dashboard come origine dati;ABCDE._timeperiod - imposta un widget compatibile (con il suo parametro reference uguale a ABCDE) come origine dati.Predefinito: DASHBOARD._timeperiodIn alternativa, è possibile impostare il periodo di tempo solo nei parametri From e To. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" |
|
| Da | 1 | columns.0.sparkline.time_period.from | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" - richiesto se columns.0.sparkline.time_period.to è impostato |
|
| A | 1 | columns.0.sparkline.time_period.to | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" - richiesto se columns.0.sparkline.time_period.from è impostato |
|
| Dati cronologici | 0 | columns.0.sparkline.history | 0 - (predefinito) Auto; 1 - History; 2 - Trends. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" e Visualizzazione è impostato su "Sparkline" |
|
| Thresholds | ||||
| Colore | 1 | columnsthresholds.0.color.0 | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" |
|
| Soglia | 1 | columnsthresholds.0.threshold.0 | Qualsiasi valore stringa. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" |
|
| Highlights | ||||
| Colore | 1 | columns.0.highlights.0.color | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Text" |
|
| Pattern | 1 | columns.0.highlights.0.pattern | Qualsiasi valore stringa. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Text" |
|
| Mostra miniatura | 0 | columns.0.show_thumbnail | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Binary" |
|
| Funzione di aggregazione | 0 | columns.0.aggregate_function | 0 - (predefinito) non utilizzata; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Periodo di tempo | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - imposta il selettore del periodo di tempo della dashboard come origine dati;ABCDE._timeperiod - imposta un widget compatibile (con il suo parametro reference uguale a ABCDE) come origine dati.Predefinito: DASHBOARD._timeperiodIn alternativa, è possibile impostare il periodo di tempo solo nei parametri From e To. Comportamento del parametro: - supportato se Funzione di aggregazione è impostato su "min", "max", "avg", "count", "sum", "first", "last" |
|
| Da | 1 | columns.0.time_period.from | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Periodo di tempo non è impostato e Funzione di aggregazione è impostato su "min", "max", "avg", "count", "sum", "first", "last" - richiesto se columns.0.time_period.to è impostato |
|
| A | 1 | columns.0.time_period.to | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Periodo di tempo non è impostato e Funzione di aggregazione è impostato su "min", "max", "avg", "count", "sum", "first", "last" - richiesto se columns.0.time_period.from è impostato |
|
| Dati cronologici | 0 | columns.0.history | 0 - (predefinito) Auto; 1 - History; 2 - Trends. Comportamento del parametro: - supportato se Visualizza il valore dell'item come è impostato su "Numeric" |
|
| Reference | 1 | reference | Qualsiasi valore stringa composto da 5 caratteri (ad esempio ABCDE o JBPNL). Questo valore deve essere univoco all'interno della dashboard a cui appartiene il widget.Comportamento del parametro: - richiesto |
|
Testo
I seguenti parametri sono supportati se Data è impostato su "Text".
| Parametro | type | name | value |
|---|---|---|---|
| Testo | 1 | columns.0.text | Qualsiasi valore stringa, incluse le macro. Macro supportate: {HOST.*}, {INVENTORY.*}. Comportamento del parametro: - obbligatorio se Data è impostato su "Text" |
Esempi
Gli esempi seguenti hanno lo scopo di descrivere solo la configurazione degli oggetti campo del widget della dashboard per il widget Top hosts.
Per ulteriori informazioni sulla configurazione di una dashboard, vedere dashboard.create.
Configurazione di un widget Top hosts
Configurare un widget Top hosts che visualizzi i principali host in base all'utilizzo della CPU nel gruppo host "4". Inoltre, configurare le seguenti colonne personalizzate: "Nome host", "Utilizzo CPU in %", "Media 1m", "Media 5m", "Media 15m", "Processi".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Risposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}