En esta página
27 hosts principales
Descripción
Estos parámetros y los posibles valores de las propiedades para los respectivos objetos de campo del widget de dashboard permiten configurar el widget Top hosts en los métodos dashboard.create y dashboard.update.
Las propiedades fields del widget no se validan durante la creación o actualización de un dashboard.
Esto permite a los usuarios modificar los widgets integrados y crear widgets personalizados, pero también introduce el riesgo de crear o actualizar widgets incorrectamente.
Para garantizar la creación o actualización exitosa del widget Top hosts, consulte el comportamiento de los parámetros descrito en las tablas a continuación.
Parámetros
Los siguientes parámetros son compatibles con el widget Hosts principales.
| Parámetro | tipo | nombre | valor | |
|---|---|---|---|---|
| Intervalo de actualización | 0 | rf_rate | 0 - Sin actualización; 10 - 10 segundos; 30 - 30 segundos; 60 - (predeterminado) 1 minuto; 120 - 2 minutos; 600 - 10 minutos; 900 - 15 minutos. |
|
| Grupos de hosts | 2 | groupids.0 | ID del grupo de hosts. Nota: Para configurar varios grupos de hosts, cree un objeto de campo del widget del dashboard para cada grupo de hosts, con un número incrementado en el nombre de la propiedad. Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Grupos de hosts (widget) | 1 | groupids._reference | En lugar del ID del grupo de hosts:ABCDE._hostgroupids - establezca un widget compatible (con su parámetro Referencia establecido en "ABCDE") como fuente de datos para los grupos de hosts.Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Hosts | 3 | hostids.0 | ID del host. Nota: Para configurar varios hosts, cree un objeto de campo del widget del dashboard para cada host, con un número incrementado en el nombre de la propiedad. Para varios hosts, el parámetro Grupos de hosts debe no estar configurado o estar configurado con al menos un grupo de hosts al que pertenezcan los hosts configurados. Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Hosts (widget/dashboard) | 1 | hostids._reference | En lugar del ID del host:DASHBOARD.hostids - establezca el selector de hosts como fuente de datos para los hosts;ABCDE._hostids - establezca un widget compatible (con su parámetro Referencia establecido en "ABCDE") como fuente de datos para los hosts.Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Etiquetas de host | ||||
| Tipo de evaluación | 0 | evaltype | 0 - (predeterminado) Y/O; 2 - O. Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Nombre de etiqueta | 1 | tags.0.tag | Cualquier valor de cadena. Nota: El número del nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio al configurar Etiquetas de host Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Operador | 0 | tags.0.operator | 0 - Contiene; 1 - Es igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. Nota: El número del nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio al configurar Etiquetas de host Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Valor de etiqueta | 1 | tags.0.value | Cualquier valor de cadena. Nota: El número del nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio al configurar Etiquetas de host Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
| Mostrar hosts en mantenimiento | 0 | maintenance | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Columnas (véase abajo) | ||||
| Ordenar por | 0 | column | Valor numérico de la columna entre las columnas configuradas. | |
| Orden | 0 | order | 2 - (predeterminado) Primeros N; 3 - Últimos N. |
|
| Límite de hosts | 0 | show_lines | Los valores posibles van de 1 a 1000. Predeterminado: 10. Este parámetro no es compatible al configurar el widget en un dashboard de template. |
|
Columnas
Las columnas tienen parámetros comunes y parámetros adicionales dependiendo de la configuración del parámetro Datos.
Para todos los parámetros relacionados con las columnas, el número en el nombre de la propiedad (por ejemplo, columns.0.name) hace referencia a una columna para la que se configura el parámetro.
Los siguientes parámetros son compatibles con todas las columnas.
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Nombre | 1 | columns.0.name | Cualquier valor de cadena. Comportamiento del parámetro: - obligatorio |
| Datos | 0 | columns.0.data | 1 - Valor de la métrica; 2 - Nombre del equipo; 3 - Texto. Comportamiento del parámetro: - obligatorio |
| Color base | 1 | columns.0.base_color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - obligatorio |
Valor del item
Los siguientes parámetros son compatibles si Datos está establecido en «Valor del item».
El primer número del nombre de la propiedad Umbrales (por ejemplo, columnsthresholds.0.color.0) hace referencia a la columna para la que se configuran los umbrales, mientras que el segundo número hace referencia a la posición del umbral en una lista ordenada de forma ascendente.
Sin embargo, si los umbrales se configuran en un orden diferente, los valores se ordenarán de forma ascendente después de actualizar la configuración del widget en el frontend de Zabbix (por ejemplo, "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parámetro | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Nombre de item válido. Al configurar el widget en un dashboard de template, solo deben establecerse los items configurados en el template. |
|
| Mostrar el valor del item como | 0 | columns.0.display_value_as | 0 - (predeterminado) Numérico; 1 - Texto; 2 - Binario. |
|
| Mostrar | 0 | columns.0.display | 1 - (predeterminado) Tal cual; 2 - Barra; 3 - Indicadores; 6 - Sparkline. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» |
|
| Mín. | 1 | columns.0.min | Cualquier valor numérico. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Barra» o «Indicadores» |
|
| Máx. | 1 | columns.0.max | Cualquier valor numérico. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Barra» o «Indicadores» |
|
| Posiciones decimales | 0 | columns.0.decimal_places | Los valores posibles van de 0 a 10. Predeterminado: 2. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» |
|
| Sparkline | ||||
| Ancho | 0 | columns.0.sparkline.width | Los valores posibles van de 0 a 10. Predeterminado: 1. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» |
|
| Relleno | 0 | columns.0.sparkline.fill | Los valores posibles van de 0 a 10. Predeterminado: 3. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» |
|
| Color | 1 | columns.0.sparkline.color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: 42A5F5.Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» |
|
| Período de tiempo | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - establece el selector de Período de tiempo como fuente de datos;ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.Predeterminado: DASHBOARD._timeperiodComo alternativa, puede establecer el período de tiempo únicamente en los parámetros Desde y Hasta. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» |
|
| Desde | 1 | columns.0.sparkline.time_period.from | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» - obligatorio si columns.0.sparkline.time_period.to está establecido |
|
| Hasta | 1 | columns.0.sparkline.time_period.to | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» - obligatorio si columns.0.sparkline.time_period.from está establecido |
|
| Datos históricos | 0 | columns.0.sparkline.history | 0 - (predeterminado) Automático; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» y Mostrar está establecido en «Sparkline» |
|
| Umbrales | ||||
| Color | 1 | columnsthresholds.0.color.0 | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» |
|
| Umbral | 1 | columnsthresholds.0.threshold.0 | Cualquier valor de cadena. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» |
|
| Resaltados | ||||
| Color | 1 | columns.0.highlights.0.color | Código de color hexadecimal (por ejemplo, FF0000).Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Texto» |
|
| Patrón | 1 | columns.0.highlights.0.pattern | Cualquier valor de cadena. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Texto» |
|
| Mostrar miniatura | 0 | columns.0.show_thumbnail | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Binario» |
|
| Función de agregación | 0 | columns.0.aggregate_function | 0 - (predeterminado) no utilizada; 1 - mín.; 2 - máx.; 3 - promedio; 4 - recuento; 5 - suma; 6 - primero; 7 - último. |
|
| Período de tiempo | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - establece el selector de Período de tiempo como fuente de datos;ABCDE._timeperiod - establece un widget compatible (con su parámetro reference igual a ABCDE) como fuente de datos.Predeterminado: DASHBOARD._timeperiodComo alternativa, puede establecer el período de tiempo únicamente en los parámetros Desde y Hasta. Comportamiento del parámetro: - compatible si Función de agregación está establecida en «mín.», «máx.», «promedio», «recuento», «suma», «primero» o «último» |
|
| Desde | 1 | columns.0.time_period.from | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - compatible si Período de tiempo no está establecido y Función de agregación está establecida en «mín.», «máx.», «promedio», «recuento», «suma», «primero» o «último» - obligatorio si columns.0.time_period.to está establecido- obligatorio si columns.0.time_period.to está establecido |
|
| Hasta | 1 | columns.0.time_period.to | Cadena de tiempo válida en sintaxis absoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, etc.).Comportamiento del parámetro: - compatible si Período de tiempo no está establecido y Función de agregación está establecida en «mín.», «máx.», «promedio», «recuento», «suma», «primero» o «último» - obligatorio si columns.0.time_period.from está establecido |
|
| Datos históricos | 0 | columns.0.history | 0 - (predeterminado) Automático; 1 - Historial; 2 - Tendencias. Comportamiento del parámetro: - compatible si Mostrar el valor del item como está establecido en «Numérico» |
|
| Referencia | 1 | reference | Cualquier valor de cadena compuesto por 5 caracteres (por ejemplo, ABCDE o JBPNL). Este valor debe ser único dentro del dashboard al que pertenece el widget.Comportamiento del parámetro: - obligatorio |
|
Texto
Se admiten los siguientes parámetros si Datos está establecido en "Texto".
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Texto | 1 | columns.0.text | Cualquier valor de cadena, incluidas macros. Macros admitidas: {HOST.*}, {INVENTORY.*}. Comportamiento del parámetro: - obligatorio si Datos está establecido en "Texto" |
Ejemplos
Los siguientes ejemplos tienen como objetivo describir únicamente la configuración de los objetos de campo del widget de panel para el widget Equipos principales.
Para obtener más información sobre la configuración de un panel, consulte dashboard.create.
Configuración de un widget Top hosts
Configure un widget Top hosts que muestre los equipos principales por utilización de CPU en el grupo de equipos "4". Además, configure las siguientes columnas personalizadas: "Nombre del equipo", "Utilización de CPU en %", "1m avg", "5m avg", "15m avg", "Procesos".
{
"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
}Respuesta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}