Nous recommandons fortement qu'avant de commencer à utiliser l'API Cato, vous consultiez la politique de support pour l'API Cato.
Vue d'ensemble de Mettre à jour l'interface Socket
Utilisez l'API Mettre à jour l'interface Socket pour mettre à jour les paramètres d'interface Socket suivants dans la section Socket pour un site dans l'application de gestion Cato (Réseau > Sites > {site name} > Configuration du site > Socket)
Destination pour l'interface
Nom
Paramètres de l'interface LAN
Bande passante du site
Paramètres de l'interface WAN
Hors Cloud (pour destination Cato)
Paramètres de l'interface WAN alternative
Membre LAG (agrégation de lien)
Type VRRP
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
typeavec la valeur siteVous pouvez également utiliser le paramètre
searchavec la valeur comme le nom du site, et la requête renvoie l'ID du siteNumé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
Comprendre les valeurs socketInterfaceId pour un Socket
Le socketInterfaceId est un énumérateur qui contient des valeurs pour les Sockets Cato. Les noms d'interface sont affichés dans l'écran Sockets pour un site (Réseau > Sites > {site name} > Configuration du site > Socket) comme suit :
Socket X1500 - Automatique, LAN1, LAN2, WAN1, WAN2, WAN3, USB1, USB2
Socket X1600 - 1-8, USB1, USB2
Socket X1700 - INT_1 - INT_12
Détails pour les arguments updateSocketInterfaceInput
Ce sont les arguments pour mettre à jour les paramètres suivants de l'interface Socket pour un site en utilisant l'API de configuration Cato. Seul l'argument destType est obligatoire, sinon incluez les arguments pour les paramètres de l'interface Socket que vous mettez à jour.
destType - Destination pour l'interface
nom - Nom de la site
lan - Paramètres de l'interface LAN
bande passante - Bande passante montante et descendante du site
wan - Paramètres de l'interface WAN
offCloud - Paramètres pour Hors Cloud pour les interfaces avec la destination Cato
altWAN - Paramètres pour les interfaces avec la destination WAN alternatif ou WAN alternatif (couche-2)
lag - Pour la destination LAN LAG Master, nombre minimum de liens (y compris le master et le membre) pour cette agrégation de liens (LAG)
vrrp - Pour la haute disponibilité (HA) du Socket, type de connexion VRRP entre les Sockets
updateSocketInterfaceInput destType
Le destType est un argument enum, qui définit la destination pour l'interface.
Voici les options :
CATO - Trafic WAN pour le Cato Cloud
LAN - LAN interne derrière le Socket
VRRP_AND_LAN - Pour la HA du Socket, l'interface est utilisée pour le trafic LAN et VRRP
INTERFACE_DISABLED - L'interface est désactivée et ne transmet pas de trafic
ALTERNATIVE - Trafic WAN ne passant pas par le Cato Cloud, comme MPLS
LAYER_2_WAN - Option WAN alternatif (couche-2) pour un réseau MPLS avec des sites Socket sur le même sous-réseau
VRRP - Pour la HA du Socket, l'interface est utilisée uniquement pour le trafic VRRP
LAN_LAG_MASTER_AND_VRRP - Pour la HA du Socket et la configuration LAN LAG, l'interface est le LAN LAG Master et est utilisée pour le trafic VRRP
LAN_LAG_MASTER - Pour la configuration LAN LAG, l'interface est le LAN LAG Master
LAN_LAG_MEMBER - Pour la configuration LAN LAG, l'interface est un membre LAN LAG
LAN_AND_HA - Pour la haute disponibilité (HA) de vSocket dans Azure et AWS, l'interface est pour le trafic LAN et HA
updateSocketInterfaceInput nom
L'argument nom est pour le nom de l'interface Socket.
updateSocketInterfaceInput lan
Les arguments lan sont pour les paramètres d'une interface LAN pour le Socket.
Voici les options :
subnet - Plage native pour l'interface LAN au format CIDR
localIP - Adresse IP locale pour la plage réseau LAN
updateSocketInterfaceInput bande passante
Pour les interfaces utilisées pour le trafic WAN, les arguments bande passante définissent la bande passante montante et descendante pour l'interface.
Voici les options :
upstreamBandwidth - la bande passante maximale en amont pour cette interface
downstreamBandwidth - la bande passante maximale en aval pour cette interface
updateSocketInterfaceInput wan
Les arguments wan sont pour les paramètres d'une interface WAN pour la Socket. Les rôles WAN sont généralement utilisés pour définir le trafic dans les règles réseau. La priorité est utilisée pour la priorité de basculement pour une Socket avec des interfaces actives et passives
Voici les options :
rôle - définir le rôle pour l'interface WAN : aucun, automatique, wan_1, wan_2, wan_3
priorité - définir la priorité de basculement pour l'interface : ACTIF, PASSIF, DERNIER_RECOURS
DERNIER_RECOURS est l'interface de priorité la plus basse
updateSocketInterfaceInput offCloud
Les arguments offCloud sont pour les sites de Socket qui utilisent la fonctionnalité Hors-Cloud pour router le trafic via Internet public au lieu du Cato Cloud.
Voici les options :
activé - Valeur booléenne, lorsque
truealors le trafic Hors-Cloud est activé pour le sitepublicIP (facultatif) - Définit une adresse IP publique statique pour initier la connexion à Internet
publicStaticPort (facultatif) - Définit un numéro de port statique pour le trafic Hors-Cloud
updateSocketInterfaceInput altWan
Les arguments altWan sont pour les sites de Socket qui se connectent à un réseau WAN Alternatif, tel que MPLS. En général, des IPs et des interfaces privées sont utilisées pour se connecter directement au fournisseur MPLS.
Voici les options :
privateInterfaceIp - Adresse IP privée pour l'interface Socket pour le trafic
privateNetwork - Plage IP privée (avec CIDR) pour le LAN
privateGatewayIp - Adresse IP privée pour la passerelle WAN Alternatif (tel qu'un pare-feu ou routeur MPLS)
privateVlanTag (facultatif) - Étiquette VLAN pour l'interface (adresse IP privée)
publicInterfaceIP (facultatif) - Adresse IP publique pour l'interface Socket pour le trafic
publicNetwork (facultatif) - Plage IP publique (avec CIDR) pour le LAN
publicGatewayIp (facultatif) - Adresse IP publique pour la passerelle WAN Alternatif (tel qu'un pare-feu ou routeur MPLS)
publicVlantag (facultatif) - Étiquette VLAN pour l'interface (adresse IP publique)
updateSocketInterfaceInput lag
L'argument lag est pour l'interface LAG LAN maître et définit le nombre minimum d'interfaces (y compris maître et membre) pour le LAG de ce site Socket.
Voici l'option :
minLinks - nombre minimum d'interfaces (liens) dans le LAG
updateSocketInterfaceInput vrrp
L'argument enum vrrp est pour les configurations HA Socket et définit le type de connexion VRRP entre les Sockets pour les messages de maintien.
Voici les options :
VIA_SWITCH - La connexion VRRP est routée via un switch entre les Sockets
DIRECT_LINK - La connexion VRRP est routée directement entre les Sockets
Exemple de script Postman
Exemple de script - Mise à jour de la Plage Native et du Nom
Ceci est un exemple d'utilisation de l'API de configuration pour changer le nom de l'interface LAN1 en LAN-01, et mettre à jour le sous-réseau et l'IP locale de la plage native pour Socket.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}Variables GraphQL
{
"accountId": "26",
"siteId": 26,
"socketInterfaceId": "LAN1",
"input": {
"name": "LAN-01",
"destType": "LAN",
"lan": {
"subnet": "10.0.0.0/24",
"localIp": "10.0.0.1"
}
}
}Exemple de script - Changer la Bande Passante et le Nom
Ceci est un exemple d'utilisation de l'API de configuration pour changer la bande passante et le nom pour l'interface WAN.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}Variables GraphQL
{
"accountId": "26",
"siteId": 126,
"socketInterfaceId": "WAN1",
"input": {
"name": "WAN Demo",
"destType": "CATO",
"bandwidth": {
"upstreamBandwidth": 100,
"downstreamBandwidth": 100
}
}
}