Recomendamos fortemente que, antes de começar a usar a Cato API, revise a Política de Suporte para a Cato API.
Visão geral da updateSocketInterface
Use a API de mutação updateSocketInterface para atualizar as seguintes configurações de interface do Socket na seção Socket para um site no Aplicativo de Gerenciamento Cato (Network > Sites > {site name} > Configuração do Site > Socket)
Destino para a interface
Nome
Configurações da interface LAN
Largura de banda do site
Configurações da interface WAN
Off Cloud (para destino Cato)
Configurações de interface WAN alternativa
Membro LAG (agregação de link)
Tipo de VRRP
Localizando o siteID para um Site
O ID do site não é exibido no Aplicativo de Gerenciamento Cato, você pode localizar o ID do site:
Usando a consulta de API entityLookup (veja Cato API - EntityLookup), use o
tipocom o valor siteVocê também pode usar o parâmetro
searchcom o valor como o nome do site, e a consulta retorna o site IDNúmero na URL para o Aplicativo de Gerenciamento Cato, quando você selecionou um site (Network > Sites > {site name}). Por exemplo, o site ID é 12345 para a seguinte URL: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics
Entendendo os Valores do socketInterfaceId para um Socket
O socketInterfaceId é um argumento de enumeração que contém valores para os Sockets Cato. Os nomes das interfaces são exibidos na tela de Sockets para um site (Network > Sites > {site name} > Configuração do Site > Socket) conforme segue:
Socket X1500 - Automático, LAN1, LAN2, WAN1, WAN2, WAN3, USB1, USB2
Socket X1600 - 1-8, USB1, USB2
Socket X1700 - INT_1 - INT_12
Detalhes para os Argumentos updateSocketInterfaceInput
Estes são os argumentos para atualizar as seguintes configurações de Interface Socket para um site usando a API de configuração Cato. Somente o argumento destType é obrigatório, caso contrário, inclua os argumentos para as configurações de interface Socket que você está atualizando.
destType - Destino para a interface
name - Nome do site
lan - Configurações da interface LAN
largura de banda - Largura de banda de upload e download do site
wan - Configurações da interface WAN
offCloud - Configurações para Off Cloud para interfaces com o destino Cato
altWAN - Configurações para interfaces com o destino WAN Alternativa ou WAN Alternativa (Camada-2)
lag - Para o destino LAN LAG Master, número mínimo de links (incluindo mestre e membro) para esta agregação de links (LAG)
vrrp - Para configuração de alta disponibilidade (HA) do Socket, tipo de conexão VRRP entre os Sockets
updateSocketInterfaceInput destType
O destType é um argumento enum que define o destino para a interface.
Essas são as opções:
CATO - Tráfego WAN para a Nuvem Cato
LAN - LAN interna atrás do Socket
VRRP_AND_LAN - Para HA do Socket, a interface é usada para tráfego LAN e VRRP
INTERFACE_DISABLED - Interface está desativada e não está transmitindo tráfego
ALTERNATIVE - Tráfego WAN fora da Nuvem Cato, como MPLS
LAYER_2_WAN - opção WAN Alternativa (Camada-2) para uma rede MPLS com sites Socket na mesma sub-rede
VRRP - Para HA do Socket, a interface é usada apenas para tráfego VRRP
LAN_LAG_MASTER_AND_VRRP - Para configuração HA e LAG LAN do Socket, a interface é o Mestre LAG LAN e é usada para tráfego VRRP
LAN_LAG_MASTER - Para configuração LAG LAN, a interface é o Mestre LAG LAN
LAN_LAG_MEMBER - Para configuração LAG LAN, a interface é um membro LAG LAN
LAN_AND_HA - Para HA vSocket na Azure e AWS, a interface é para tráfego LAN e HA
updateSocketInterfaceInput name
O argumento name é para o nome da interface Socket.
updateSocketInterfaceInput lan
Os argumentos lan são para as configurações de uma interface LAN para o Socket.
Essas são as opções:
sub-rede - Faixa nativa para a interface LAN no formato CIDR
localIP - Endereço IP local para a faixa de rede LAN
updateSocketInterfaceInput bandwidth
Para interfaces que são usadas para tráfego WAN, os argumentos bandwidth definem a largura de banda de upload e download para a interface.
Essas são as opções:
upstreamBandwidth - a largura de banda máxima enviada para esta interface
downstreamBandwidth - a largura de banda máxima de tráfego recebido para esta interface
updateSocketInterfaceInput wan
Os argumentos wan são para as configurações para uma interface WAN para o Socket. As Funções WAN são geralmente usadas para definir o tráfego em Regras de Rede. A precedência é usada para a precedência de failover para um Socket com interfaces ativas e passivas
Essas são as opções:
função - define a função para a interface WAN: nenhum, automático, wan_1, wan_2, wan_3
precedência - define a precedência de failover para a interface: ATIVO, PASSIVO, ÚLTIMO_RECURSO
ÚLTIMO_RECURSO é a interface de menor precedência
updateSocketInterfaceInput offCloud
Os argumentos offCloud são para sites de Socket que usam o recurso Fora da Nuvem para rotear o tráfego pela Internet pública em vez de pela Nuvem Cato.
Essas são as opções:
ativado - valor Booleano, quando
trueentão o tráfego Fora da Nuvem está ativado para o sitepublicIP (opcional) - Define um endereço IP público estático para iniciar a conexão com a Internet
publicStaticPort (opcional) - Define um número de porta estática para o tráfego Fora da Nuvem
updateSocketInterfaceInput altWan
Os argumentos altWan são para sites de Socket que se conectam a uma Rede WAN Alternativa, como MPLS. Geralmente, IPs Privados e interfaces são usados para conectar diretamente ao provedor MPLS.
Estas são as opções:
privateInterfaceIp - Endereço IP Privado para a Interface de Socket para o tráfego
privateNetwork - Faixa de IP privada (com CIDR) para a LAN
privateGatewayIp - Endereço IP Privado para o gateway WAN Alternativa (como firewall ou roteador MPLS)
privateVlanTag (opcional) - Tag VLAN para a interface (endereço IP privado)
publicInterfaceIP (opcional) - Endereço IP Público para a Interface de Socket para o tráfego
publicNetwork (opcional) - Faixa de IP público (com CIDR) para a LAN
publicGatewayIp (opcional) - Endereço IP Público para o gateway WAN Alternativa (como firewall ou roteador MPLS)
publicVlantag (opcional) - Tag VLAN para a interface (endereço IP público)
updateSocketInterfaceInput lag
O argumento lag é para a Interface LAG Master LAN e define o número mínimo de interfaces (incluindo master e membro) para o LAG para este site de Socket.
Essa é a opção:
minLinks - número mínimo de interfaces (links) no LAG
updateSocketInterfaceInput vrrp
O argumento enum vrrp é para configurações de HA de Socket e define o tipo de conexão VRRP entre os Sockets para as mensagens keepalive.
Essas são as opções:
VIA_SWITCH - A conexão VRRP é roteada via um switch entre os Sockets
DIRECT_LINK - A conexão VRRP é roteada diretamente entre os Sockets
Script Exemplo do Postman
Script de Exemplo - Atualizando Faixa Nativa e Nome
Este é um exemplo de uso da API de Configuração para alterar o Nome da Interface LAN1 para LAN-01, e atualizar a Sub-rede e o IP local da faixa nativa para o Socket.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}Variáveis do 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"
}
}
}Script de Exemplo - Alterando Largura de Banda e Nome
Este é um exemplo de uso da API de Configuração para alterar a Largura de Banda e o Nome para a Interface WAN.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}Variáveis do GraphQL
{
"accountId": "26",
"siteId": 126,
"socketInterfaceId": "WAN1",
"input": {
"name": "WAN Demo",
"destType": "CATO",
"bandwidth": {
"upstreamBandwidth": 100,
"downstreamBandwidth": 100
}
}
}