Documentation
Table of Contents
12 Panal
Descripción
Estos parámetros y los posibles valores de propiedad para los respectivos objetos de campo del widget del tablero permiten configurar el widget Panal en los métodos dashboard.create y dashboard.update.
Las propiedades de los "campos" del widget no se validan durante la creación o actualización de un tablero. Esto permite a los usuarios modificar 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 Panal, consulte el comportamiento de los parámetros descrito en las tablas siguientes.
Parámetros
Los siguientes parámetros son compatibles con el widget Panal.
|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 equipos|<|2|groupids.0|ID de grupo de equipos.
Nota: Para configurar varios grupos de equipos, cree un objeto de campo de widget de tablero para cada grupo de equipos con un número incrementado en el nombre de la propiedad.
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |Equipos|<|3|hostids.0|ID de equipo.
Nota: Para configurar varios equipos, cree un objeto de campo de widget de tablero para cada equipo con un número incrementado en el nombre de la propiedad. Para varios equipos, el parámetro Grupos de equipos no debe estar configurado en absoluto o configurarse con al menos un grupo de equipos al que pertenecen los equipos configurados.
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |Etiquetas de equipo|<|<|<|<| |<|Tipo de evaluación|0|evaltype_host|0 - (predeterminado) Y/O;
2 - O.
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |^|Nombre de etiqueta|1|host_tags.0.tag|Cualquier valor de cadena.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento del parámetro:
- obligatorio si se configuran Etiquetas de equipo
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |^|Operador|0|host_tags.0.operator|0 - Contiene;
1 - Es igual;
2 - No contiene;
3 - No es igual;
4 - Existe ;
5 - No existe.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento del parámetro:
- obligatorio si se configuran Etiquetas de equipos
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |^|Valor de etiqueta|1|host_tags.0.value|Cualquier valor de cadena.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento del parámetro:
- obligatorio si se configuran etiquetas de equipo
Este parámetro no se admite si se configura el widget en una plantilla de tablero.| |Patrones de métricas|<|1|items.0|Nombre o patrón de métrica.
Nota: Para configurar varios patrones de métricas, cree un objeto de campo de widget de tablero para cada patrón de métrica con un número incrementado en el nombre de la propiedad.
Comportamiento del parámetro:
- requerido| |Etiquetas de métricas|<|<|<|<| |<|Tipo de evaluación|0|evaltype_item|0 - (predeterminado) Y/O;
2 - O.| |^|Nombre de etiqueta|1|item_tags.0.tag|Cualquier valor de cadena.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento de parámetros:
- obligatorio si se configuran Etiquetas de métricas| |^|Operador|0|item_tags.0.operator|0 - Contiene;
1 - Es igual;
2 - No contiene;
3 - No es igual;
4 - Existe ;
5 - No existe.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento del parámetro:
- obligatorio si se configuran Etiquetas de métricas| |^|Valor de etiqueta|1|item_tags.0.value|Cualquier valor de cadena.
Nota: El número en el nombre de la propiedad hace referencia al orden de las etiquetas en la lista de evaluación de etiquetas.
Comportamiento de parámetros:
- obligatorio si se configuran Etiquetas de métricas| |Mostrar equipos en mantenimiento|<|0|maintenance|0 - (predeterminado) Deshabilitado;
1 - Habilitado.| |Mostrar|<|0|show.0|1 - Etiqueta principal;
2 - Etiqueta secundaria.
Nota: Para configurar varios valores, cree un objeto de campo de widget de tablero para cada valor con un número incrementado en el nombre de la propiedad.
Predeterminado: 1, 2.| |Referencia|<|1|reference|Cualquier valor de cadena que consta de 5 caracteres (por ejemplo, ABCDE o JBPNL). Este valor debe ser único dentro del tablero al que pertenece el widget.
Comportamiento del parámetro:
- requerido|
Configuración avanzada
Los siguientes parámetros de configuración avanzada son compatibles con el widget Panel.
El número en el nombre de la propiedad Thresholds (por ejemplo, thresholds.0.color) hace referencia al lugar del threshold en una lista, ordenada en orden ascendente. Sin embargo, si los umbrales se configuran en un orden diferente, los valores se ordenarán en orden ascendente después de actualizar la configuración del widget en la interfaz de Zabbix. (por ejemplo, "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Parámetro | tipo | nombre | valor |
|---|---|---|---|
| Etiqueta principal | |||
| Tipo | 0 | primary_label_type | 0 - (predeterminado) Texto; 1 - Valor. |
| Texto | 1 | primary_label | Cualquier valor de cadena, incluidas las macros. Macros admitidas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros de usuario. < br>Predeterminado: {HOST.NAME} Comportamiento del parámetro: - compatible si Tipo está configurado en "Texto" |
| Lugares decimales | 0 | primary_label_decimal_places | Los valores posibles oscilan entre 0 y 6. Predeterminado: 2. Comportamiento de parámetros : - compatible si Tipo está establecido en "Valor" |
| Tamaño (tipo) | 0 | primary_label_size_type | 0 - (predeterminado) Automático; 1 - Personalizado. |
| Tamaño | 0 | primary_label_size | Los valores posibles oscilan entre 1 y 100. Valor predeterminado: 20. Comportamiento del parámetro: - compatible si Tamaño (tipo) está configurado en "Personalizado" |
| Negrita | 0 | primary_label_bold | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
| Color | 1 | primary_label_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: basado en el tema de Objeto de configuración y Objeto de usuario:1F2C33 para "tema azul" o "hc-light";EEEEEE para "tema oscuro" tema" o "hc-dark". |
| Unidades (casilla de verificación) | 0 | primary_label_units_show | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. Comportamiento de parámetros : - compatible si Tipo está establecido en "Valor" |
| Unidades (valor) | 1 | primary_label_units | Cualquier valor de cadena."" (vacío)Comportamiento del parámetro: - compatible si Tipo está configurado en "Valor" y Unidades (casilla de verificación) está configurado en "Habilitado" |
| Posición | 0 | primary_label_units_pos | 0 - Antes del valor; 1 - (predeterminado) Después del valor. Comportamiento del parámetro: - compatible si Tipo está establecido en "Valor" y Unidades (casilla de verificación) está establecido en "Habilitado" Este parámetro se ignora si se establece en uno de los siguientes tiempo- unidades relacionadas: unixtime, uptime, s. |
| Etiqueta secundaria | |||
| Tipo | 0 | secondary_label_type | 0 - Texto; 1 - (predeterminado) Valor. |
| Texto | 1 | secondary_label | Cualquier valor de cadena, incluidas las macros. Macros admitidas: {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros de usuario. < br>Predeterminado: {{ITEM.LASTVALUE}.fmtnum(2)} Comportamiento del parámetro: - compatible si Tipo está configurado en "Texto" |
| Lugares decimales | 0 | secondary_label_decimal_places | Los valores posibles oscilan entre 0 y 6. Predeterminado: 2. Comportamiento de parámetros : - compatible si Tipo está establecido en "Valor" |
| Tamaño (tipo) | 0 | secondary_label_size_type | 0 - (predeterminado) Automático; 1 - Personalizado. |
| Tamaño | 0 | secondary_label_size | Los valores posibles oscilan entre 1 y 100. Predeterminado: 30. Comportamiento del parámetro: - compatible si Tamaño (tipo) está configurado en "Personalizado" |
| Negrita | 0 | secondary_label_bold | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
| Color | 1 | secondary_label_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: basado en el tema de Objeto de configuración y Objeto de usuario:1F2C33 para "tema azul" o "hc-light";EEEEEE para "tema oscuro" tema" o "hc-dark". |
| Unidades (casilla de verificación) | 0 | secondary_label_units_show | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. Comportamiento de parámetros : - compatible si Tipo está establecido en "Valor" |
| Unidades (valor) | 1 | secondary_label_units | Cualquier valor de cadena."" (vacío)Comportamiento del parámetro: - compatible si Tipo está configurado en "Valor" y Unidades (casilla de verificación) está configurado en "Habilitado" |
| Posición | 0 | secondary_label_position | 0 - Antes del valor; 1 - (predeterminado) Después del valor. Comportamiento del parámetro: - compatible si Tipo está establecido en "Valor" y Unidades (casilla de verificación) está establecido en "Habilitado" Este parámetro se ignora si se establece en una de las siguientes unidades de tiempo relacionadas: unixtime, uptime, s. |
| Color de fondo | |||
| Color de fondo | 1 | bg_color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: basado en el tema de Objeto de configuración y Objeto de usuario:D9E7ED para "tema azul";3D5059 para "tema oscuro";<br >AAD7E9 para "hc-light";335463 para "hc-dark". |
| Umbrales | |||
| Interpolación de color | 0 | interpolation | 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
| Color | 1 | thresholds.0.color | Código de color hexadecimal (por ejemplo, FF0000). |
| Umbral | 1 | thresholds.0.threshold | Cualquier valor numérico. Se admiten Sufijos (por ejemplo, "1d", "2w", "4K", "8G"). |
Ejemplos
Los siguientes ejemplos pretenden describir únicamente la configuración de los objetos de campo del widget del tablero para el widget Panal. Para obtener más información sobre cómo configurar un tablero, consulte dashboard.create.
Configuración de un widget Panal
Configure un widget Panal que muestre la utilización de los procesos del servidor Zabbix. Además, cambie la etiqueta principal de las celdas en forma de panal y ajuste visualmente el widget con umbrales.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "honeycomb",
"name": "Honeycomb",
"x": "0",
"y": "0",
"width": "24",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "items.0",
"value": "Zabbix server: Utilization*"
},
{
"type": 1,
"name": "primary_label",
"value": "{ITEM.NAME}"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "70"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "90"
},
{
"type": 1,
"name": "reference",
"value": "KSTMQ"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Respuesta: