API de configuration - Ajout, mise à jour et suppression de staticHost

Nous vous recommandons fortement de consulter la politique d'assistance pour l'API de Cato avant de commencer à utiliser l'API de Cato.

Cet article explique comment utiliser l'API Cato pour gérer les hôtes définis pour un site avec ces commandes :

addStaticHost
updateStaticHost
removeStaticHost

Vue d'ensemble de staticHost

Utilisez les API de mutation staticHost pour ajouter, mettre à jour et supprimer des hôtes pour un site dans votre compte et définir les paramètres suivants pour l'hôte :

Nom de l'hôte
Adresse IP de l'hôte
Adresse MAC (facultatif - utilisée pour réserver une attribution d'IP DHCP pour l'hôte)

Pour les comptes de revendeur, vous pouvez créer des clés API séparées à l'intérieur de chaque compte client lorsque vous configurez les paramètres avec l'API de 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 :

En utilisant 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 pour valeur 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 sélectionnez un site (Réseau > Sites > {nom du site}). Par exemple, l'ID du site est 12345 pour l'URL suivante : https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Détails des arguments pour addStaticHost et updateStaticHost

Les mêmes arguments sont utilisés pour créer ou mettre à jour un hôte derrière un site en utilisant l'API de configuration de Cato. Pour addStaticHost, les arguments sont obligatoires sauf indication contraire. Pour updateStaticHost, incluez les arguments des paramètres d'hôte que vous mettez à jour.

hostId - Pour updateStaticHost, entrez l'ID de l'hôte que vous mettez à jour

Pour addStaticHost, cet ID est généré lors de la création du nouvel hôte
name - Nom de l'hôte derrière le site
ip - Adresse IP de l'hôte derrière le site
macAddress - (facultatif) Adresse MAC de l'hôte derrière le site

L'adresse MAC de l'hôte est utilisée pour la réservation DHCP pour les hôtes avec une adresse IP statique

StaticHost hostId

Le hostId est l'ID interne Cato pour l'entité hôte.

Le networkRangeId peut être récupéré en utilisant l'API en lecture seule entityLookup, utilisez le type avec la valeur host

StaticHost name

Utilisez l'argument name pour définir le nom de l'hôte.

StaticHost ip

Utilisez l'argument ip pour définir l'adresse IP de l'hôte.

StaticHost macAddress (facultatif)

Utilisez l'argument macAddress pour définir l'adresse MAC de l'hôte pour la réservation DHCP.

Pour les comptes qui utilisent Cato comme serveur DHCP, l'adresse IP des hôtes définis avec une adresse MAC est réservée et ne peut pas être attribuée à un autre hôte. Assurez-vous que l'adresse IP de l'hôte n'est pas dans la plage DHCP pour un segment de réseau défini pour le site.

removeStaticHost

Utilisez l'API removeStaticHost pour supprimer un hôte défini pour un site. Vous devez uniquement utiliser le hostId avec cette API.

Script Postman d'exemple

mutation addStaticHost ($accountId: ID!, $siteId: ID!, $input:AddStaticHostInput!) {
    site(accountId: $accountId) {
      addStaticHost(
        siteId: $siteId, 
        input: $input
      ) {
      hostId
    }
  }
}

Variables GraphQL

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

Ressources liées