API de configuration - updateHa

Prev Next

Nous recommandons fortement qu'avant de commencer à utiliser l'API Cato, vous consultiez la politique de support pour l'API Cato.

Aperçu de updateHa

Utilisez l'API de mutation updateHa pour mettre à jour les paramètres suivants dans la section Socket pour un site avec une configuration Socket Haute Disponibilité (HA) dans l'application de gestion Cato (Réseau > Sites > {nom du site} > Configuration du site > Socket) :

  • Adresse IP de gestion pour le Socket principal et secondaire

  • VRID - ID pour les messages VRRP qui identifient quand le Socket principal est hors service et quand il est de nouveau fonctionnel

Remarque :

Vous ne pouvez exécuter l'API updateHa qu'après que les deux Sockets sont attribués à un site, et qu'il est configuré comme un site HA de socket en utilisant l'application de gestion Cato.

Localisation du siteID pour un Site

L'ID du site n'est pas affiché dans l'application de gestion Cato, vous pouvez localiser l'ID du site :

  • Utilisation de la requête API entityLookup (voir Cato API - EntityLookup), utilisez le type avec la valeur site

    Vous pouvez également utiliser le paramètre search avec la valeur comme le nom du site, et la requête renvoie l'ID du site

  • Numéro dans l'URL pour l'application de gestion Cato, lorsque vous avez sélectionné un site (Réseau > Sites > {site name}). Par exemple, l'ID du site est 12345 pour l'URL suivante: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Détails des arguments updateHa

Ce sont les arguments pour mettre à jour les paramètres de HA Socket pour un site en utilisant l'API de configuration Cato. Tous les arguments updateHaInput sont optionnels :

  • primaryManagementIp - Adresse IP de gestion pour le Socket principal

  • secondaryManagementIp- Adresse IP de gestion pour le Socket secondaire

  • VRID - Identifiant du routeur virtuel pour les messages VRRP

updateHaInput primaryManagementIp

Mettre à jour l'adresse IP de gestion pour le Socket principal. Vous pouvez utiliser cette adresse IP pour accéder à l'interface Web Socket pour le Socket principal.

updateHaInput secondaryManagementIp

Mettre à jour l'adresse IP de gestion pour le Socket secondaire. Vous pouvez utiliser cette adresse IP pour accéder à l'interface Web Socket pour le Socket secondaire.

updateHaInput vrid

Mettre à jour le VRID (Identifiant du routeur virtuel) pour les messages VRRP entre les Sockets principal et secondaire. Le VRID par défaut est 100.

Script Postman Exemple

mutation updateHa ($accountId: ID!, $siteId: ID!, $input: UpdateHaInput!) {
    site(accountId: $accountId) {
        updateHa (siteId: $siteId, input: $input) {
            siteId
        }
    }
}

Variables GraphQL

{
    "accountId": "26",
    "siteId": 126,
    "input": {
        "primaryManagementIp": "192.168.4.2",
        "secondaryManagementIp": "192.168.4.3",
        "vrid": 100
    }
}

Ressources Associées