API de Configuração - Adicionando, Atualizando e Removendo networkRange

Este artigo explica como usar a API Cato para gerenciar faixas de rede para um site com estes comandos:

addNetworkRange
updateNetworkRange
removeNetworkRange

Visão geral de networkRange

Use as APIs de mutação de networkRange para adicionar, atualizar e remover faixas de rede para um site Socket na sua conta e definir as seguintes configurações para o site:

ID da faixa de rede (criado automaticamente para addNetworkRange)
ID da interface do Socket LAN
Configurações para a faixa de rede incluindo: sub-rede, IP Local ou IP do Gateway e VLAN
Para configurações HA de vSocket Azure, o endereço IP Flutuante
Configurações de DHCP para a faixa de rede

Para contas de revenda, você pode criar chaves API separadas dentro de cada conta de cliente onde você está configurando as configurações com a API Cato.

Localizando o accountId para Sua Conta

O ID da conta é mostrado na Administração> página de Informações Gerais.

Insira este ID no argumento accountId para a criação do site API, por exemplo:

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

Detalhes para os Argumentos de addNetworkRange e updateNetworkRange

Os mesmos argumentos são usados para criar ou atualizar uma faixa de rede para um site Socket usando a API de configuração Cato. Para addNetworkRange, os argumentos são obrigatórios, a menos que marcados como opcionais. Para updateNetworkRange, inclua os argumentos para as configurações da interface Socket que você está atualizando.

networkRangeId - ID para a faixa de rede (para updateNetworkRange)
lanSocketInterfaceId - ID para a interface de rede à qual a faixa de rede está associada (para addNetworkRange)
name - Nome da Faixa de Rede
rangeType - Tipo de faixa de rede (Roteada, Direta, etc.)
subnet - Faixa nativa para a interface LAN no formato CIDR
localIP - Endereço IP local para a faixa de rede LAN
gateway - Para faixas roteadas, o próximo salto para o endereço IP do roteador vizinho
vlan - ID da VLAN para a faixa de rede
azureFloutingIP - Para configurações HA de Azure, o próximo salto para o endereço IP na tabela de roteamento LAN
dhcpSettings - Define se esta faixa de rede usa as configurações padrão de DHCP da conta ou configurações personalizadas

networkRangeId (para updateNetworkRange)

O networkRangeId pode ser recuperado usando a API somente leitura entityLookup, use o tipo com o valor siteRange

Você também pode usar o parâmetro search com valor como o nome do site, e o filtro da consulta remove faixas de outros sites.

lanSocketInterfaceId (para addNetworkRange)

Use a consulta API entityLookup para recuperar valores para os argumentos lanSocketInterfaceId, da seguinte maneira. Para mais informações, consulte Cato API - EntityLookup.

Use o tipo com valor networkInterface, e os valores destes campos parent:

id - <site id>
name - <nome da interface>

Veja um script de exemplo para o lanSocketInterfaceId abaixo, Script de Exemplo do Postman.

nome da Faixa de Rede

O argumento nome é para o nome da faixa de rede.

Tipo de Faixa de Rede

O tipo de faixa é um argumento enum que define o tipo de faixa de rede.

Estas são as opções:

Roteada - Faixa de rede que conecta ao Socket através de uma rota
Direta - Faixa de rede conectada diretamente ao Socket ou firewall (não via roteador), mas a faixa de IP é diferente da faixa Nativa do site.
VLAN - VLANs que conectam ao Cato são semelhantes a uma porta trunk
Nativa - Faixa de IP definida para cada interface LAN
Secundária Nativa - Para configurações HA de Socket, a faixa nativa para o Socket secundário

sub-rede da Faixa de Rede

Defina a faixa de IP para a faixa de rede para o site no argumento subnet no formato CIDR IPSubnet. /31 e /32 blocos CIDR não são suportados.

localIP da Faixa de Rede

(Obrigatório para estas faixas: Nativa, Secundária Nativa, Direta, VLAN) Defina o endereço IP local para a faixa de rede LAN no argumento localIP.

gateway da Faixa de Rede

(Obrigatório para faixas roteadas) Defina o endereço IP do Gateway para a faixa de rede LAN no argumento gateway.

vlan da Faixa de Rede

(Obrigatório para faixas VLAN) Defina o ID da VLAN para a faixa de rede LAN no argumento vlan.

azureFloatingIp da Faixa de Rede

(Obrigatório para configurações HA de Socket Azure) Defina o IP Flutuante para a faixa de rede LAN no argumento azureFloatingIp.

configurações DHCP da Faixa de Rede (opcional)

O dhcpSettings é um argumento enum que define as configurações de DHCP para a faixa de rede.

Estas são as opções:

dhcpType - Configure um dos seguintes tipos de DHCP para a faixa de rede:
- DHCP_RELAY - A faixa de rede usa um relay DHCP configurado para a conta (definido no argumento relayGroupId)
- DHCP_RANGE - A faixa de rede usa o servidor DHCP Cato para DHCP, de acordo com a faixa de IP definida no argumento ipRange
- ACCOUNT_DEFAULT - A faixa de rede usa o relay DHCP padrão definido para a conta
- DHCP_DISABLED - DHCP está desativado para esta faixa de rede
ipRange - Para a opção DHCP_Range acima, defina a faixa de IP que o servidor DHCP Cato pode atribuir aos hosts
relayGroupId - Insira o ID para o Grupo de Relay DHCP que esta faixa de rede usa

Para o entityLookup, use o tipo com o valor dhcpRelayGroup

removeNetworkRange

Use a API removeNetworkRange para excluir uma Faixa de Rede de um site. Você só precisa usar o networkRangeId com esta API.

Script de Exemplo do Postman

Consulta de exemplo para o entityLookup de lanSocketInterfaceID

query entityLookup ($accountID: ID!, $tipo: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, tipo: $tipo, parent: $parent) {
        items {
            entity {
                id
                nome
                tipo
            }
            descrição
        }
    }
}

Variáveis GraphQL para entityLookup de lanSocketInterfaceID

{    
"accountID": "26",    
"tipo": "networkInterface",    
"parent": {
        "id": 26,
        "tipo": "site"
    }
}

Script de Exemplo do Postman para Criar Nova Faixa VLAN

mutation addNetworkRange ($accountId: ID!, $lanSocketInterfaceId: ID!, $input: AddNetworkRangeInput!) {
    site(accountId: $accountId) {
        addNetworkRange (lanSocketInterfaceId: $lanSocketInterfaceId, input: $input) {
            networkRangeId
        }
    }
}

Variável GraphQL para Nova Faixa VLAN

{
    "accountId": "26",
    "lanSocketInterfaceId": 26,
    "input": {
        "nome": "Guest WIFI",
        "tipo": "VLAN",
        "subnet": "10.1.0.0/24",
        "localIp": "10.1.0.0.1",
        "vlan": 100
    }
}