17 Navigateur d’éléments
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 Navigateur d'hôte dans les méthodes dashboard.create et dashboard.update.
Les propriétés des « champs » 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éation ou une mise à jour widgets erronée. Pour garantir la création ou la mise à jour valide du widget Navigateur d'hôte, 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 Item navigator.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - Aucun rafraîchissement; 10 - 10 secondes; 30 - 30 secondes; 60 - (par défaut) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Host groups | 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 tableau de bord de modèle. |
|
| Host groups (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 tableau de bord de modèle. |
|
| Hosts | 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 Host groups 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 tableau de bord de modèle. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Au lieu de l'ID de hôte:DASHBOARD.hostid - définissez le sélecteur Host comme source de données pour les hôtes;ABCDE._hostid - 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 tableau de bord de modèle. |
|
| Host tags | ||||
| Evaluation type | 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. |
|
| Tag name | 1 | host_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Host tags Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Operator | 0 | host_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Host tags Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Tag value | 1 | host_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Host tags Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Item patterns | 1 | items.0 | Nom ou motif de élément. Note: Pour configurer plusieurs motifs d'éléments, créez un objet de champ de widget de tableau de bord pour chaque motif d'élément avec un numéro incrémenté dans le nom de la propriété. |
|
| Item tags | ||||
| Evaluation type | 0 | item_tags_evaltype | 0 - (par défaut) Et/Ou; 2 - Ou. |
|
| Tag name | 1 | item_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Item tags |
|
| Operator | 0 | item_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Item tags |
|
| Tag value | 1 | item_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 tags dans la liste d'évaluation des tags. Comportement du paramètre: - obligatoire lors de la configuration de Item tags |
|
| State | 0 | state | -1 - (par défaut) Tous; 0 - Normal; 1 - Non pris en charge. |
|
| Show problems | 0 | show_problems | 0 - Tous; 1 - (par défaut) Non masqués; 2 - Aucun. |
|
| Group by | ||||
| Attribute | 0 | group_by.0.attribute | 0 - Groupe d'hôtes; 1 - Nom d'hôte; 2 - Valeur du tag d'hôte; 3 - Valeur du tag d'élément. Note: Le numéro dans le nom de la propriété fait référence à l'ordre des attributs dans la liste des attributs de regroupement. Comportement du paramètre: - obligatoire lors de la configuration de Group by |
|
| Value | 1 | group_by.0.tag_name | Toute valeur de chaîne. Note: Le numéro dans le nom de la propriété fait référence à l'attribut de regroupement défini dans le paramètre Attribute. Comportement du paramètre: - obligatoire lors de la configuration de Group by et si Attribute est défini sur "Valeur du tag d'hôte" ou "Valeur du tag d'élément" |
|
| Item limit | 0 | show_lines | Les valeurs possibles vont de 1 à 9999. Par défaut: 100. |
|
| 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: - obligatoire |
|
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ de widget de tableau de bord pour le widget Item navigator.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Navigateur d’éléments
Configurez un widget Navigateur d’éléments qui affiche jusqu’à 1000 éléments regroupés par leur hôte puis par la valeur de tag d’élément « component ».
Requête :
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "itemnavigator",
"name": "Item navigator",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 0,
"name": "group_by.0.attribute",
"value": 0
},
{
"type": 0,
"name": "group_by.1.attribute",
"value": 3
},
{
"type": 1,
"name": "group_by.1.tag_name",
"value": "component"
},
{
"type": 0,
"name": "show_lines",
"value": 1000
},
{
"type": 1,
"name": "reference",
"value": "DFNLK"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}