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 Top hosts.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 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. |
|
| Host groups | 2 | groupids.0 | ID de Host group. Nota: Para configurar varios host groups, cree un objeto de campo de widget de dashboard para cada host group con un número incrementado en el nombre de la propiedad. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | En lugar del ID de Host group:ABCDE._hostgroupids - establezca un widget compatible (con su parámetro Reference establecido en "ABCDE") como origen de datos para host groups.Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Hosts | 3 | hostids.0 | ID de Host. Nota: Para configurar varios hosts, cree un objeto de campo de widget de dashboard para cada host con un número incrementado en el nombre de la propiedad. Para varios hosts, el parámetro Host groups debe no estar configurado en absoluto o debe configurarse con al menos un host group al que pertenezcan los hosts configurados. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | En lugar del ID de Host:DASHBOARD.hostids - establezca el selector Host como origen de datos para hosts;ABCDE._hostids - establezca un widget compatible (con su parámetro Reference establecido en "ABCDE") como origen de datos para hosts.Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype | 0 - (predeterminado) And/Or; 2 - Or. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Tag name | 1 | tags.0.tag | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Operator | 0 | tags.0.operator | 0 - Contiene; 1 - Igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Tag value | 1 | tags.0.value | Cualquier valor de cadena. Nota: El número en el nombre de la propiedad hace referencia al orden de la etiqueta en la lista de evaluación de etiquetas. Comportamiento del parámetro: - obligatorio si se configuran Host tags Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. |
|
| Columns (see below) | ||||
| Order by | 0 | column | Valor numérico de la columna de las columnas configuradas. | |
| Order | 0 | order | 2 - (predeterminado) Top N; 3 - Bottom N. |
|
| Host limit | 0 | show_lines | Los valores posibles van de 1 a 1000. Predeterminado: 10. Este parámetro no es compatible si se configura el widget en un template dashboard. |
|
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
Se admiten los siguientes parámetros si Data está establecido en "Item value".
El primer número en el nombre de la propiedad Thresholds (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 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 el frontend de Zabbix (por ejemplo, "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parameter | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Nombre válido del item. Al configurar el widget en un template dashboard, solo deben establecerse los items configurados en el template. |
|
| Display item value as | 0 | columns.0.display_value_as | 0 - (predeterminado) Numérico; 1 - Texto; 2 - Binario. |
|
| Display | 0 | columns.0.display | 1 - (predeterminado) Tal cual; 2 - Barra; 3 - Indicadores; 6 - Sparkline. Parameter behavior: - supported si Display item value as está establecido en "Numeric" |
|
| Min | 1 | columns.0.min | Cualquier valor numérico. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Bar" o "Indicators" |
|
| Max | 1 | columns.0.max | Cualquier valor numérico. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Bar" o "Indicators" |
|
| Decimal places | 0 | columns.0.decimal_places | Los valores posibles van de 0 a 10. Predeterminado: 2. Parameter behavior: - supported si Display item value as está establecido en "Numeric" |
|
| Sparkline | ||||
| Width | 0 | columns.0.sparkline.width | Los valores posibles van de 0 a 10. Predeterminado: 1. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" |
|
| Fill | 0 | columns.0.sparkline.fill | Los valores posibles van de 0 a 10. Predeterminado: 3. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" |
|
| Color | 1 | columns.0.sparkline.color | Código de color hexadecimal (por ejemplo, FF0000).Predeterminado: 42A5F5.Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" |
|
| Time period | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - establece el selector de Time period 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 solo en los parámetros From y To. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" |
|
| From | 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.).Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" - required si columns.0.sparkline.time_period.to está establecido |
|
| To | 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.).Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" - required si columns.0.sparkline.time_period.from está establecido |
|
| History data | 0 | columns.0.sparkline.history | 0 - (predeterminado) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported si Display item value as está establecido en "Numeric" y Display está establecido en "Sparkline" |
|
| Thresholds | ||||
| Color | 1 | columnsthresholds.0.color.0 | Código de color hexadecimal (por ejemplo, FF0000).Parameter behavior: - supported si Display item value as está establecido en "Numeric" |
|
| Threshold | 1 | columnsthresholds.0.threshold.0 | Cualquier valor de cadena. Parameter behavior: - supported si Display item value as está establecido en "Numeric" |
|
| Highlights | ||||
| Color | 1 | columns.0.highlights.0.color | Código de color hexadecimal (por ejemplo, FF0000).Parameter behavior: - supported si Display item value as está establecido en "Text" |
|
| Pattern | 1 | columns.0.highlights.0.pattern | Cualquier valor de cadena. Parameter behavior: - supported si Display item value as está establecido en "Text" |
|
| Show thumbnail | 0 | columns.0.show_thumbnail | 0 - (predeterminado) Deshabilitado; 1 - Habilitado. Parameter behavior: - supported si Display item value as está establecido en "Binary" |
|
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (predeterminado) no usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - establece el selector de Time period 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 solo en los parámetros From y To. Parameter behavior: - supported si Aggregation function está establecido en "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 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.).Parameter behavior: - supported si Time period no está establecido y Aggregation function está establecido en "min", "max", "avg", "count", "sum", "first", "last" - required si columns.0.time_period.to está establecido- required si columns.0.time_period.to está establecido |
|
| To | 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.).Parameter behavior: - supported si Time period no está establecido y Aggregation function está establecido en "min", "max", "avg", "count", "sum", "first", "last" - required si columns.0.time_period.from está establecido |
|
| History data | 0 | columns.0.history | 0 - (predeterminado) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported si Display item value as está establecido en "Numeric" |
|
| Reference | 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.Parameter behavior: - required |
|
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
}