29 Éléments principaux
Description
Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord correspondants permettent de configurer le widget Top items 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 Top items, 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 Top items.
| 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. |
|
| Groupes d'hôtes | 2 | groupids.0 | ID du groupe d'hôtes. Remarque : Pour configurer plusieurs groupes d'hôtes, créez un objet de champ de widget de tableau de bord pour chaque groupe d'hôtes avec un numéro incrémenté dans le nom de propriété. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Groupes d'hôtes (Widget) | 1 | groupids._reference | Au lieu de l'ID du groupe d'hôtes :ABCDE._hostgroupids - définir un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données pour les groupes d'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. |
|
| Hôtes | 3 | hostids.0 | ID de l'hôte. Remarque : Pour configurer plusieurs hôtes, créez un objet de champ de widget de tableau de bord pour chaque hôte avec un numéro incrémenté dans le nom de propriété. Pour plusieurs hôtes, le paramètre Groupes d'hôtes ne doit soit pas être configuré du tout, soit être configuré avec au moins un groupe d'hôtes auquel appartiennent les hôtes configurés. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Hôtes (Widget/Tableau de bord) | 1 | hostids._reference | Au lieu de l'ID de l'hôte :DASHBOARD.hostids - définir le sélecteur d'hôte du tableau de bord comme source de données pour les hôtes ;ABCDE._hostids - définir un widget compatible (avec son paramètre Reference défini sur "ABCDE") 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. |
|
| Tags d'hôte | ||||
| Type d'évaluation | 0 | host_tags_evaltype | 0 - (par défaut) Et/Ou ; 2 - Ou. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Nom du tag | 1 | host_tags.0.tag | Toute valeur de chaîne. Remarque : Le numéro dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Opérateur | 0 | host_tags.0.operator | 0 - Contient ; 1 - Égal ; 2 - Ne contient pas ; 3 - N'est pas égal ; 4 - Existe ; 5 - N'existe pas. Remarque : Le numéro dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Valeur du tag | 1 | host_tags.0.value | Toute valeur de chaîne. Remarque : Le numéro dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Disposition | 0 | layout | 0 - (par défaut) Horizontale ; 1 - Verticale. |
|
| Afficher les problèmes | 0 | show_problems | 0 - Tous ; 1 - (par défaut) Non supprimés ; 2 - Aucun. |
|
| Éléments (voir ci-dessous) | ||||
Configuration avancée
Les paramètres de configuration avancée suivants sont pris en charge pour le widget Top items.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Ordre des hôtes | ||||
| Trier par | 0 | host_ordering_order_by | 0 - (par défaut) Nom de l'hôte ; 3 - Valeur de l'élément. |
|
| Modèles d'élément | 1 | host_ordering_item.0 | Nom ou modèle de l'élément (par ex. "*: Number of processed *values per second"). Remarque : pour configurer plusieurs modèles d'élément, créez un objet de champ de widget de tableau de bord pour chaque modèle d'élément avec un numéro incrémenté dans le nom de la propriété. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles des éléments configurés sur le modèle doivent être définis. Comportement du paramètre : - obligatoire si Trier par est défini sur « Valeur de l'élément » |
|
| Ordre | 0 | host_ordering_order | 2 - (par défaut) Top N ; 3 - Bottom N. |
|
| Limite | 0 | host_ordering_limit | Les valeurs possibles vont de 1 à 100. Par défaut : 10. |
|
| Ordre des éléments | ||||
| Trier par | 0 | item_ordering_order_by | 1 - Hôte ; 2 - Nom de l'élément ; 3 - (par défaut) Valeur de l'élément. |
|
| Modèles d'hôte | 1 | item_ordering_host.0 | Nom ou modèle de l'hôte. Remarque : pour configurer plusieurs modèles d'hôte, créez un objet de champ de widget de tableau de bord pour chaque modèle d'hôte avec un numéro incrémenté dans le nom de la propriété. Comportement du paramètre : - obligatoire si Trier par est défini sur « Hôte » |
|
| Ordre | 0 | item_ordering_order | 2 - (par défaut) Top N ; 3 - Bottom N. |
|
| Limite | 0 | item_ordering_limit | Les valeurs possibles vont de 1 à 100. Par défaut : 10. |
|
Colonnes
Le premier nombre dans le nom de propriété (par ex. columns.0.items.0, columns.0.item_tags_evaltype) représente la colonne particulière, tandis que le second nombre, s'il est présent, représente l'entité configurée (par ex. modèle d'élément, tag).
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Modèles d'élément | 1 | columns.0.items.0 | Nom ou modèle de Item (par ex. "*: Number of processed *values per second"). Remarque : pour configurer plusieurs modèles d'élément, créez un objet de champ de widget de tableau de bord pour chaque modèle d'élément avec un second nombre incrémenté dans le nom de propriété. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles pour les éléments configurés sur le modèle doivent être définis. Comportement du paramètre : - obligatoire |
|
| Tags d'élément | ||||
| Type d'évaluation | 0 | columns.0.item_tags_evaltype | 0 - (par défaut) And/Or; 2 - Or. |
|
| Nom du tag | 1 | columns.0.item_tags.0.tag | Toute valeur de chaîne. Remarque : le second nombre dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'élément |
|
| Opérateur | 0 | columns.0.item_tags.0.operator | 0 - Contient ; 1 - Égal à ; 2 - Ne contient pas ; 3 - N'est pas égal à ; 4 - Existe ; 5 - N'existe pas. Remarque : le second nombre dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'élément |
|
| Valeur du tag | 1 | columns.0.item_tags.0.value | Toute valeur de chaîne. Remarque : le second nombre dans le nom de propriété fait référence à l'ordre du tag dans la liste d'évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d'élément |
|
| Couleur de base | 1 | columns.0.base_color | Code couleur hexadécimal (par ex. FF0000). |
|
| Afficher la valeur comme | 0 | columns.0.display_value_as | 1 - (par défaut) Numérique ; 2 - Texte. |
|
| Affichage | 0 | columns.0.display | 1 - (par défaut) Tel quel ; 2 - Barre ; 3 - Indicateurs ; 6 - Sparkline. |
|
| Min | 1 | columns.0.min | Toute valeur numérique. Les suffixes (par ex. "1d", "2w", "4K", "8G") sont pris en charge. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" et Affichage est défini sur "Barre" ou "Indicateurs" |
|
| Max | 1 | columns.0.max | Toute valeur numérique. Les suffixes (par ex. "1d", "2w", "4K", "8G") sont pris en charge. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" et Affichage est défini sur "Barre" ou "Indicateurs" |
|
| Sparkline | ||||
| Largeur | 0 | columns.0.sparkline.width | Les valeurs possibles vont de 0 à 10. Par défaut : 1. Comportement du paramètre : - pris en charge si Affichage est défini sur "Sparkline" |
|
| Remplissage | 0 | columns.0.sparkline.fill | Les valeurs possibles vont de 0 à 10. Par défaut : 3. Comportement du paramètre : - pris en charge si Affichage est défini sur "Sparkline" |
|
| Couleur | 1 | columns.0.sparkline.color | Code couleur hexadécimal (par ex. FF0000).Par défaut : 42A5F5.Comportement du paramètre : - pris en charge si Affichage est défini sur "Sparkline" |
|
| Période | 1 | columns.0.sparkline.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 De et À. Comportement du paramètre : - pris en charge si Affichage est défini sur "Sparkline" |
|
| De | 1 | columns.0.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 : - pris en charge si Affichage est défini sur "Sparkline" - obligatoire si columns.0.sparkline.time_period.to est défini |
|
| À | 1 | columns.0.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 : - pris en charge si Affichage est défini sur "Sparkline" - obligatoire si columns.0.sparkline.time_period.from est défini |
|
| Données d'historique | 0 | columns.0.sparkline.history | 0 - (par défaut) Auto ; 1 - Historique ; 2 - Tendances. Comportement du paramètre : - pris en charge si Affichage est défini sur "Sparkline" |
|
| Seuils | ||||
| Couleur | 1 | columns.0.thresholds.0.color | Code couleur hexadécimal (par ex. FF0000).Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" |
|
| Seuil | 1 | columns.0.thresholds.0.threshold | Toute valeur numérique. Les suffixes (par ex. "1d", "2w", "4K", "8G") sont pris en charge. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" |
|
| Mises en évidence | ||||
| Mise en évidence | 1 | columns.0.highlights.0.color | Code couleur hexadécimal (par ex. FF0000).Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Texte" |
|
| Seuil | 1 | columns.0.highlights.0.pattern | Toute expression régulière. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Texte" |
|
| Décimales | 0 | columns.0.decimal_places | Les valeurs possibles vont de 0 à 10. Par défaut : 2. |
|
| Configuration avancée | ||||
| Fonction d'agrégation | 0 | columns.0.aggregate_function | Si Afficher la valeur comme est défini sur "Numérique" : 0 - (par défaut) non utilisé ; 1 - min ; 2 - max ; 3 - avg ; 4 - count ; 5 - sum ; 6 - first ; 7 - last. Si Afficher la valeur comme est défini sur "Texte" : 0 - (par défaut) non utilisé ; 4 - count ; 6 - first ; 7 - last. |
|
| Période | 1 | columns.0.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 De et À. Comportement du paramètre : - pris en charge si Fonction d'agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" |
|
| De | 1 | columns.0.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 Fonction d'agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" - obligatoire si columns.0.time_period.to est défini |
|
| À | 1 | columns.0.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 Fonction d'agrégation est définie sur "min", "max", "avg", "count", "sum", "first", "last" - obligatoire si columns.0.time_period.from est défini |
|
| Données d'historique | 0 | columns.0.history | 0 - (par défaut) Auto ; 1 - Historique ; 2 - Tendances. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" |
|
| Agréger | 0 | columns.0.aggregate_columns | 0 - (par défaut) Chaque élément 1 - Combiné. Comportement du paramètre : - pris en charge si Afficher la valeur comme est défini sur "Numérique" et Affichage est défini sur "Tel quel", "Barre" ou "Indicateurs". |
|
| Fonction d'agrégation combinée | 0 | columns.0.column_aggregate_function | 1 - min ; 2 - max ; 3 - avg ; 4 - count ; 5 - sum (par défaut). Comportement du paramètre : - obligatoire lors de la configuration de Agréger. |
|
| Nom de colonne combinée | 1 | columns.0.combined_column_name | Toute valeur de chaîne. Comportement du paramètre : - obligatoire lors de la configuration de Agréger. |
|
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ de widget de tableau de bord pour le widget Top items.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Top items
Configurez un widget Top items qui affiche les données de l’hôte « 10084 » et uniquement pour les éléments dont le tag nommé « component » contient la valeur « cpu ». De plus, affichez les données avec les hôtes placés en haut et utilisez une jauge colorée pour la représentation des cellules.
Requête :
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}