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 Navigateur d'éléments.

Paramètre 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 de hôtes 2 groupids.0 ID du groupe de hôtes.

Remarque : pour configurer plusieurs groupes de hôtes, créez un objet de champ de widget de tableau de bord pour chaque groupe de hôtes en incrémentant le numéro 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.
Groupes de hôtes (widget) 1 groupids._reference Au lieu de l'ID du groupe de hôtes :
ABCDE._hostgroupids - définissez un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour les groupes de 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 en incrémentant le numéro dans le nom de la propriété. Pour plusieurs hôtes, le paramètre Groupes de hôtes doit soit ne pas être configuré, soit être configuré avec au moins un groupe de 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.hostid - définissez le sélecteur d'hôte du tableau de bord comme source de données pour les hôtes ;
ABCDE._hostid - définissez un widget compatible (avec son paramètre Référence 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.
Étiquettes 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 de l'étiquette 1 host_tags.0.tag Toute valeur de chaîne.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes 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 - Est égal à ;
2 - Ne contient pas ;
3 - N'est pas égal à ;
4 - Existe ;
5 - N'existe pas.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes 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 de l'étiquette 1 host_tags.0.value Toute valeur de chaîne.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes 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.
Motifs d'éléments 1 items.0 Nom ou motif d'élément.

Remarque : 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 en incrémentant le numéro dans le nom de la propriété.
Étiquettes d'élément
Type d'évaluation 0 item_tags_evaltype 0 - (par défaut) Et/Ou ;
2 - Ou.
Nom de l'étiquette 1 item_tags.0.tag Toute valeur de chaîne.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes d'élément
Opérateur 0 item_tags.0.operator 0 - Contient ;
1 - Est égal à ;
2 - Ne contient pas ;
3 - N'est pas égal à ;
4 - Existe ;
5 - N'existe pas.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes d'élément
Valeur de l'étiquette 1 item_tags.0.value Toute valeur de chaîne.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes.

Comportement du paramètre :
- obligatoire lors de la configuration des Étiquettes d'élément
État 0 state -1 - (par défaut) Tous ;
0 - Normal ;
1 - Non pris en charge.
Afficher les problèmes 0 show_problems 0 - Tous ;
1 - (par défaut) Non supprimés ;
2 - Aucun.
Regrouper par
Attribut 0 group_by.0.attribute 0 - Groupe de hôtes ;
1 - Nom d'hôte ;
2 - Valeur de l'étiquette d'hôte ;
3 - Valeur de l'étiquette d'élément.

Remarque : le numéro dans le nom de la propriété fait référence à l'ordre de l'attribut dans la liste des attributs de regroupement.

Comportement du paramètre :
- obligatoire lors de la configuration de Regrouper par
Valeur 1 group_by.0.tag_name Toute valeur de chaîne.

Remarque : le numéro dans le nom de la propriété fait référence à l'attribut de regroupement défini dans le paramètre Attribut.

Comportement du paramètre :
- obligatoire lors de la configuration de Regrouper par lorsque Attribut est défini sur « Valeur de l'étiquette d'hôte » ou « Valeur de l'étiquette d'élément »
Limite d'éléments 0 show_lines Les valeurs possibles sont comprises entre 1 et 9999.

Valeur par défaut : 100.
Référence 1 reference Toute valeur de chaîne composée de 5 caractères (par exemple, ABCDE ou JBPNL). Cette valeur doit être unique au sein du 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
}

Voir aussi