18 Valeur d’élément
Description
Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord respectifs permettent de configurer le widget Valeur d'élément dans les méthodes dashboard.create et dashboard.update.
Les propriétés fields du widget ne sont pas validées lors de la création ou de la mise à jour d'un tableau de bord.
Cela permet aux utilisateurs de modifier les widgets intégrés et de créer des widgets personnalisés, mais introduit également le risque de créer ou de mettre à jour des widgets de manière incorrecte.
Pour garantir la réussite de la création ou de la mise à jour du widget Valeur d'élément, veuillez vous référer au comportement des paramètres décrit dans les tableaux ci-dessous.
Paramètres
Les paramètres suivants sont pris en charge pour le widget Valeur de l'élément.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Intervalle d'actualisation | 0 | rf_rate | 0 - Pas d'actualisation; 10 - 10 secondes; 30 - 30 secondes; 60 - (par défaut) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Élément | 4 | itemid.0 | ID de l'élément. Comportement du paramètre : - obligatoire si Élément (widget) n'est pas défini |
|
| Élément (widget) | 1 | itemid._reference | Au lieu de l'ID de l'élément :ABCDE._itemid - définir un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour les éléments.Comportement du paramètre : - obligatoire si Élément n'est pas défini |
|
| Afficher | 0 | show.0 | 1 - Description; 2 - Valeur; 3 - Heure; 4 - Indicateur de changement; 5 - Sparkline. Par défaut : 1, 2, 3, 4. Remarque : pour configurer plusieurs valeurs, créez un objet de champ de widget de tableau de bord pour chaque valeur avec un numéro incrémenté dans le nom de la propriété. |
|
| Remplacer l'hôte | 1 | override_hostid._reference | ABCDE._hostid - définir un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour les hôtes ;DASHBOARD._hostid - définir le sélecteur d'hôte du tableau de bord comme source de données pour les hôtes.Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
Configuration avancée
Les paramètres de configuration avancée suivants sont pris en charge pour le widget Valeur d’élément.
Le nombre dans le nom de propriété Thresholds (par ex. thresholds.0.color) fait référence à la position du seuil dans une liste, triée par ordre croissant.
Cependant, si les seuils sont configurés dans un ordre différent, les valeurs seront triées par ordre croissant après la mise à jour de la configuration du widget dans l’interface Zabbix (par ex. "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1" ; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Couleur d’arrière-plan | 1 | bg_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
|
| Seuils | ||||
| Couleur | 1 | thresholds.0.color | Code couleur hexadécimal (par ex. FF0000). |
|
| Seuil | 1 | thresholds.0.threshold | Toute valeur de chaîne. | |
| Fonction d’agrégation | 0 | aggregate_function | 0 - (par défaut) non utilisée ; 1 - min ; 2 - max ; 3 - avg ; 4 - count ; 5 - sum ; 6 - first ; 7 - last. |
|
| Période | 1 | time_period._reference | DASHBOARD._timeperiod - définir le sélecteur de période du tableau de bord comme source de données ;ABCDE._timeperiod - définir un widget compatible (avec son paramètre reference égal à ABCDE) comme source de données.Par défaut : DASHBOARD._timeperiodVous pouvez également définir la période uniquement dans les paramètres From et To. Comportement du paramètre : - pris en charge si Fonction d’agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | time_period.from | Chaîne temporelle valide en syntaxe absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période n’est pas définie et si Fonction d’agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" - obligatoire si time_period.to est défini |
|
| To | 1 | time_period.to | Chaîne temporelle valide en syntaxe absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période n’est pas définie et si Fonction d’agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" - obligatoire si time_period.from est défini |
|
| Données d’historique | 0 | history | 0 - (par défaut) Auto ; 1 - Historique ; 2 - Tendances. |
|
Description
Les paramètres de configuration avancés suivants sont pris en charge si Afficher est défini sur « Description ».
| Paramètre | type | nom | valeur |
|---|---|---|---|
| Description | 1 | description | Toute valeur de chaîne, y compris les macros. Macros prises en charge : {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros utilisateur. Par défaut : {ITEM.NAME}. |
| Position horizontale | 0 | desc_h_pos | 0 - Gauche ; 1 - (par défaut) Centre ; 2 - Droite. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et la même Position verticale. |
| Position verticale | 0 | desc_v_pos | 0 - Haut ; 1 - Milieu ; 2 - (par défaut) Bas. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et la même Position verticale. |
| Taille | 0 | desc_size | Les valeurs possibles vont de 1 à 100. Par défaut : 15. |
| Gras | 0 | desc_bold | 0 - (par défaut) Désactivé ; 1 - Activé. |
| Couleur | 1 | desc_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
Valeur
Les paramètres de configuration avancés suivants sont pris en charge si Afficher est défini sur « Valeur ».
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Décimales | ||||
| Décimales | 0 | decimal_places | Les valeurs possibles vont de 1 à 10. Par défaut : 2. |
|
| Taille | 0 | decimal_size | Les valeurs possibles vont de 1 à 100. Par défaut : 35. |
|
| Position | ||||
| Position horizontale | 0 | value_h_pos | 0 - Gauche ; 1 - (par défaut) Centre ; 2 - Droite. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et Position verticale. |
|
| Position verticale | 0 | value_v_pos | 0 - Haut ; 1 - (par défaut) Milieu ; 2 - Bas. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et Position verticale. |
|
| Taille | 0 | value_size | Les valeurs possibles vont de 1 à 100. Par défaut : 45. |
|
| Gras | 0 | value_bold | 0 - Désactivé ; 1 - (par défaut) Activé. |
|
| Couleur | 1 | value_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
|
| Unités | ||||
| Unités (case à cocher) | 0 | units_show | 0 - Désactivé ; 1 - (par défaut) Activé. |
|
| Unités (valeur) | 1 | units | Toute valeur de chaîne. | |
| Position | 0 | units_pos | 0 - Avant la valeur ; 1 - Au-dessus de la valeur ; 2 - (par défaut) Après la valeur ; 3 - En dessous de la valeur. |
|
| Taille | 0 | units_size | Les valeurs possibles vont de 1 à 100. Par défaut : 35. |
|
| Gras | 0 | units_bold | 0 - Désactivé ; 1 - (par défaut) Activé. |
|
| Couleur | 1 | units_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
|
Heure
Les paramètres de configuration avancée suivants sont pris en charge si Afficher est défini sur « Heure ».
| Paramètre | type | nom | valeur |
|---|---|---|---|
| Position horizontale | 0 | time_h_pos | 0 - Gauche; 1 - (par défaut) Centre; 2 - Droite. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et la même Position verticale. |
| Position verticale | 0 | time_v_pos | 0 - (par défaut) Haut; 1 - Milieu; 2 - Bas. Deux éléments ou plus (Description, Valeur, Heure) ne peuvent pas partager la même Position horizontale et la même Position verticale. |
| Taille | 0 | time_size | Les valeurs possibles vont de 1 à 100. Par défaut : 15. |
| Gras | 0 | time_bold | 0 - (par défaut) Désactivé; 1 - Activé. |
| Couleur | 1 | time_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
Indicateur de changement
Les paramètres de configuration avancée suivants sont pris en charge si Afficher est défini sur « Indicateur de changement ».
| Paramètre | type | name | value |
|---|---|---|---|
| Couleur de l’indicateur de changement ↑ | 1 | up_color | Code couleur hexadécimal (par exemple FF0000).Par défaut : "" (vide). |
| Couleur de l’indicateur de changement ↓ | 1 | down_color | Code couleur hexadécimal (par exemple FF0000).Par défaut : "" (vide). |
| Couleur de l’indicateur de changement ↕ | 1 | updown_color | Code couleur hexadécimal (par exemple FF0000).Par défaut : "" (vide). |
Sparkline
Les paramètres de configuration avancés suivants sont pris en charge si Afficher est défini sur « Sparkline ».
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Largeur | 0 | sparkline.width | Les valeurs possibles vont de 0 à 10. Par défaut : 1. |
|
| Remplissage | 0 | sparkline.fill | Les valeurs possibles vont de 0 à 10. Par défaut : 3. |
|
| Couleur | 1 | sparkline.color | Code couleur hexadécimal (par exemple FF0000).Par défaut : 42A5F5. |
|
| Période | 1 | sparkline.time_period._reference | DASHBOARD._timeperiod - définit le sélecteur de période du tableau de bord comme source de données ;ABCDE._timeperiod - définit un widget compatible (avec son paramètre reference égal à ABCDE) comme source de données.Par défaut : DASHBOARD._timeperiodVous pouvez également définir la période uniquement dans les paramètres De et À. |
|
| De | 1 | sparkline.time_period.from | Chaîne temporelle valide en syntaxe absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - obligatoire si sparkline.time_period.to est défini |
|
| À | 1 | sparkline.time_period.to | Chaîne temporelle valide en syntaxe absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - obligatoire si sparkline.time_period.from est défini |
|
| Données d’historique | 0 | sparkline.history | 0 - (par défaut) Auto ; 1 - Historique ; 2 - Tendances. |
|
Exemples
Les exemples suivants visent à décrire uniquement la configuration des objets de champ du widget de tableau de bord pour le widget Valeur d'élément.
Pour plus d'informations sur la configuration d'un tableau de bord, consultez dashboard.create.
Configuration d’un widget Valeur d’élément
Configurez un widget Valeur d’élément qui affiche la valeur de l’élément pour l’élément « 42266 » (disponibilité de l’agent Zabbix). De plus, ajustez finement l’apparence du widget à l’aide de plusieurs options avancées, notamment une couleur d’arrière-plan dynamique qui change en fonction de l’état de disponibilité de l’agent Zabbix.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 12,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42266
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "E1E1E1"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "1"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}