26 Meilleurs hôtes
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 hosts 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 hosts, veuillez vous référer au comportement des paramètres présenté dans les tableaux ci-dessous.
Paramètres
Les paramètres suivants sont pris en charge pour le widget Top hosts.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Intervalle d'actualisation | 0 | rf_rate | 0 - Aucune 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. Note: 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 la propriété. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un modèle de tableau de bord. |
|
| Groupes d'hôtes (Widget) | 1 | groupids._reference | Au lieu de l'ID du groupe d'hôtes:ABCDE._hostgroupids - définissez 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 modèle de tableau de bord. |
|
| Hôtes | 3 | hostids.0 | ID de hôte. Note: 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 la propriété. Pour plusieurs hôtes, le paramètre Groupes d'hôtes doit soit ne 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 modèle de tableau de bord. |
|
| Hôtes (Widget/Tableau de bord) | 1 | hostids._reference | Au lieu de l'ID de hôte:DASHBOARD.hostids - définissez le sélecteur Hôte comme source de données pour les hôtes;ABCDE._hostids - définissez 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 modèle de tableau de bord. |
|
| Balises d'hôte | ||||
| Type d'évaluation | 0 | 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 modèle de tableau de bord. |
|
| Nom de la balise | 1 | tags.0.tag | Toute valeur de chaîne. Note: Le numéro dans le nom de la propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre: - obligatoire lors de la configuration de Balises d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un modèle de tableau de bord. |
|
| Opérateur | 0 | tags.0.operator | 0 - Contient; 1 - Égal à; 2 - Ne contient pas; 3 - N'est pas égal à; 4 - Existe; 5 - N'existe pas. Note: Le numéro dans le nom de la propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre: - obligatoire lors de la configuration de Balises d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un modèle de tableau de bord. |
|
| Valeur de la balise | 1 | tags.0.value | Toute valeur de chaîne. Note: Le numéro dans le nom de la propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre: - obligatoire lors de la configuration de Balises d'hôte Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un modèle de tableau de bord. |
|
| Afficher les hôtes en maintenance | 0 | maintenance | 0 - (par défaut) Désactivé; 1 - Activé. |
|
| Colonnes (voir ci-dessous) | ||||
| Trier par | 0 | column | Valeur numérique de la colonne à partir des colonnes configurées. | |
| Ordre | 0 | order | 2 - (par défaut) Top N; 3 - Bottom N. |
|
| Limite d'hôtes | 0 | show_lines | Valeurs possibles comprises entre 1 et 100. Par défaut: 10. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un modèle de tableau de bord. |
|
Colonnes
Les colonnes ont des paramètres communs et des paramètres supplémentaires selon la configuration du paramètre Data.
Pour tous les paramètres liés aux colonnes, le numéro dans le nom de la propriété (par exemple columns.0.name) fait référence à une colonne pour laquelle le paramètre est configuré.
Les paramètres suivants sont pris en charge pour toutes les colonnes.
| Paramètre | type | name | value |
|---|---|---|---|
| Nom | 1 | columns.0.name | Toute valeur de chaîne. Comportement du paramètre : - obligatoire |
| Données | 0 | columns.0.data | 1 - Valeur de l'élément ; 2 - Nom de l'hôte ; 3 - Texte. Comportement du paramètre : - obligatoire |
| Couleur de base | 1 | columns.0.base_color | Code couleur hexadécimal (par ex. FF0000).Comportement du paramètre : - obligatoire |
Valeur de l'élément
Les paramètres suivants sont pris en charge si Data est défini sur "Item value".
Le premier nombre dans le nom de propriété Thresholds (par exemple columnsthresholds.0.color.0) fait référence à la colonne pour laquelle les seuils sont configurés, tandis que le second nombre 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 exemple, "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 | Nom d'élément valide. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les éléments configurés sur le modèle doivent être définis. |
|
| Display | 0 | columns.0.display | 1 - (par défaut) tel quel; 2 - Barre; 3 - Indicateurs. |
|
| Min | 1 | columns.0.min | Toute valeur numérique. Comportement du paramètre: - pris en charge si Display est défini sur "Bar" ou "Indicators" |
|
| Max | 1 | columns.0.max | Toute valeur numérique. Comportement du paramètre: - pris en charge si Display est défini sur "Bar" ou "Indicators" |
|
| Decimal places | 0 | columns.0.decimal_places | Valeurs possibles de 0 à 10. Par défaut: 2. |
|
| Thresholds | ||||
| Color | 1 | columnsthresholds.0.color.0 | Code couleur hexadécimal (par exemple FF0000).Par défaut: "" (vide). |
|
| Threshold | 1 | columnsthresholds.0.threshold.0 | Toute valeur de chaîne. | |
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (par défaut) non utilisé; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - définit le sélecteur Time period 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 de temps uniquement dans les paramètres From et To. Comportement du paramètre: - pris en charge si Aggregation function est défini sur "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | columns.0.time_period.from | Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).Comportement du paramètre: - pris en charge si Time period n'est pas défini et si Aggregation function est défini sur "min", "max", "avg", "count", "sum", "first", "last" - requis si columns.0.time_period.to est défini |
|
| To | 1 | columns.0.time_period.to | Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).Comportement du paramètre: - pris en charge si Time period n'est pas défini et si Aggregation function est défini sur "min", "max", "avg", "count", "sum", "first", "last" - requis si columns.0.time_period.from est défini |
|
| History data | 0 | columns.0.history | 0 - (par défaut) Auto; 1 - Historique; 2 - Tendances. |
|
| Reference | 1 | reference | Toute valeur de chaîne composée de 5 caractères (par exemple, ABCDE ou JBPNL). Cette valeur doit être unique dans le tableau de bord auquel appartient le widget.Comportement du paramètre: - requis |
|
Texte
Les paramètres suivants sont pris en charge si Data est défini sur « Text ».
| Paramètre | type | name | value |
|---|---|---|---|
| Text | 1 | columns.0.text | Toute valeur de chaîne, y compris les macros. Macros prises en charge : {HOST.*}, {INVENTORY.*}. Comportement du paramètre : - obligatoire si Data est défini sur « Text » |
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ de widget de tableau de bord pour le widget Top hosts.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Top hosts
Configurez un widget Top hosts qui affiche les principaux hôtes selon l’utilisation du CPU dans le groupe d’hôtes « 4 ». En outre, configurez les colonnes personnalisées suivantes : « Nom de l’hôte », « Utilisation du CPU en % », « Moy. 1 min », « Moy. 5 min », « Moy. 15 min », « Processus ».
Requête :
{
"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
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}