13 Carte d'hôte

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 Host card 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 Host card, 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 Carte d'hôte.

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.
Hôte 3 hostid.0 ID de l'hôte.

Comportement du paramètre :
- obligatoire si Hôte (Widget/Tableau de bord) n'est pas défini

Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.
Hôte (Widget/Tableau de bord) 1 hostid._reference Au lieu de l'ID de l'hôte :
DASHBOARD.hostid - définit le sélecteur d'hôte du tableau de bord comme source de données pour l'hôte ;
ABCDE._hostid - définit un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour l'hôte.

Comportement du paramètre :
- obligatoire si Hôte n'est pas défini

Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.
Afficher les problèmes supprimés 0 show_suppressed 0 - (par défaut) Désactivé ;
1 - Activé.
Afficher 0 sections.0 0 - Groupes d'hôtes ;
1 - Description ;
2 - Surveillance ;
3 - Disponibilité ;
4 - Surveillé par ;
5 - Modèles ;
6 - Inventaire ;
7 - Tags.

Remarque : Le nombre dans le nom de propriété fait référence à l'ordre des sections dans la liste des sections. Pour configurer plusieurs sections, créez un objet de champ de widget de tableau de bord pour chaque section avec un nombre incrémenté dans le nom de propriété.

Les paramètres suivants sont pris en charge si Afficher est défini sur "Inventaire".

Paramètre type name value
Champs d'inventaire 0 inventory.0 ID de l'inventaire.

Remarque : Pour configurer plusieurs champs d'inventaire, créez un objet de champ de widget de tableau de bord pour chaque champ d'inventaire avec un nombre incrémenté dans le nom de propriété.

Exemples

Les exemples suivants visent uniquement à décrire la configuration des objets de champ du widget de tableau de bord pour le widget Host card. Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.

Configuration d’un widget Carte d’hôte

Configurez un widget Carte d’hôte qui affiche les sections suivantes : « Monitoring », « Availability », « Monitored by », « Inventory » et « Tags ».

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "hostcard",
                        "name": "Host card",
                        "x": 0,
                        "y": 0,
                        "width": 14,
                        "height": 7,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostid.0",
                                "value": 10084
                            },
                            {
                                "type": 0,
                                "name": "show_suppressed",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "sections.0",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "sections.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "sections.2",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "sections.3",
                                "value": 6
                            },
                            {
                                "type": 0,
                                "name": "sections.4",
                                "value": 7
                            },
                            {
                                "type": 0,
                                "name": "inventory.0",
                                "value": 25
                            },
                            {
                                "type": 0,
                                "name": "inventory.1",
                                "value": 26
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Voir aussi