Configurar API - Agregar, Actualizar y Eliminar networkRange

Este artículo explica cómo usar la API de Cato para gestionar rangos de red para un sitio con estos comandos:

addNetworkRange
updateNetworkRange
removeNetworkRange

Visión general de networkRange

Utilice las APIs de mutación de networkRange para agregar, actualizar y eliminar rangos de red para un sitio de Socket en su cuenta y defina los siguientes ajustes para el sitio:

ID de rango de red (creado automáticamente para addNetworkRange)
ID de interfaz LAN Socket
Configuraciones para el rango de red incluyendo: subred, IP local o IP de Gateway, y VLAN
Para configuraciones de Azure vSocket HA, la dirección IP flotante
Configuraciones DHCP para el rango de red

Para cuentas de revendedor, puede crear claves API separadas dentro de cada cuenta de cliente que está configurando los ajustes con la API de Cato.

Localizando el accountId para su cuenta

El ID de cuenta se muestra en la página Administración> Información General.

Ingrese este ID en el argumento accountId para la API de creación del sitio, por ejemplo:

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

Detalles para los argumentos de addNetworkRange y updateNetworkRange

Se utilizan los mismos argumentos para crear o actualizar un rango de red para un sitio Socket usando la API de configuración de Cato. Para addNetworkRange, los argumentos son obligatorios a menos que se marquen como opcionales. Para updateNetworkRange, incluya los argumentos para las configuraciones de la interfaz Socket que está actualizando.

networkRangeId - ID para el rango de red (para updateNetworkRange)
lanSocketInterfaceId - ID para la interfaz de red con la que está asociado el rango de red (para addNetworkRange)
name - Nombre de rango de red
rangeType - Tipo de rango de red (Routed, Direct, etcétera)
subnet - Rango nativo para la interfaz LAN en formato CIDR
localIP - Dirección IP local para el rango de red LAN
gateway - Para rangos enrutados, la siguiente dirección IP de salto para el router vecino
vlan - ID de VLAN para el rango de red
azureFloutingIP - Para configuraciones Azure HA, la siguiente dirección IP de salto para la tabla de rutas LAN
dhcpSettings - Define si este rango de red utiliza la configuración DHCP predeterminada de la cuenta o ajustes personalizados

networkRangeId (para updateNetworkRange)

El networkRangeId puede recuperarse usando la API de solo lectura entityLookup, use el type con el valor siteRange

También puede usar el parámetro search con el valor como el nombre del sitio, y la consulta filtra los rangos de otros sitios.

lanSocketInterfaceId (para addNetworkRange)

Utilice la consulta API entityLookup para recuperar valores para los argumentos de lanSocketInterfaceId, de la siguiente manera. Para más información, consulte Cato API - EntityLookup.

Utilice el type con el valor networkInterface, y los valores de estos campos parent:

id - <site id>
name - <name of interface>

Vea un script de ejemplo para el lanSocketInterfaceId a continuación, Script de ejemplo de Postman.

nombre de rango de red

El argumento name es para el nombre de rango de red.

tipo de rango de red

El rangeType es un argumento enum que define el tipo de rango de red.

Estas son las opciones:

Routed - Rango de red que se conecta a un Socket a través de una ruta
Direct - Rango de red directamente conectado al Socket o firewall (no a través de un router), pero el rango IP es diferente del rango nativo del sitio.
VLAN - Los VLANs que se conectan a Cato son similares a un puerto troncal
Native - Rango de IP definido para cada interfaz LAN
SecondaryNative - Para configuraciones de Socket HA, el rango nativo para el Socket secundario

subred de rango de red

Defina el rango IP para el rango de red para el sitio en el argumento subnet en el formato CIDR IPSubnet. /31 y /32 bloques CIDR no son compatibles.

localIP de rango de red

(Obligatorio para estos rangos: Native, SocendaryNative, Direct, VLAN) Defina la dirección IP local para el rango de red LAN en el argumento localIP.

puerta de enlace de rango de red

(Obligatorio para rangos enrutados) Defina la dirección IP de Gateway para el rango de red LAN en el argumento gateway.

vlan de rango de red

(Obligatorio para rangos VLAN) Defina el ID de VLAN para el rango de red LAN en el argumento vlan.

ip flotante de azure de rango de red

(Obligatorio para configuraciones HA de Azure Socket) Defina la IP flotante para el rango de red LAN en el argumento azureFloatingIp.

configuraciones DHCP de rango de red (opcional)

El dhcpSettings es un argumento enum que define las configuraciones DHCP para el rango de red.

Estas son las opciones:

tipoDHCP - Configure uno de los siguientes tipos de DHCP para el rango de red:
- DHCP_RELAY - El rango de red usa un relé DHCP configurado para la cuenta (definido en el argumento relayGroupId)
- DHCP_RANGE - El rango de red utiliza el servidor DHCP de Cato para DHCP, de acuerdo con el rango IP definido en el argumento ipRange
- ACCOUNT_DEFAULT - El rango de red usa el relé DHCP predeterminado definido para la cuenta
- DHCP_DISABLED - El DHCP está deshabilitado para este rango de red
ipRange - Para la opción DHCP_Range anteriormente, defina el rango IP que el servidor DHCP de Cato puede asignar a los hosts
relayGroupId - Ingrese el ID para el Grupo de Relé DHCP que este rango de red utiliza

Para entityLookup, use el type con el valor dhcpRelayGroup

removeNetworkRange

Utilice la API removeNetworkRange para eliminar un Rango de Red de un sitio. Solo necesita utilizar el networkRangeId con esta API.

Script de Ejemplo de Postman

entityLookup de ejemplo para lanSocketInterfaceID

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        items {
            entity {
                id
                name
                type
            }
            description
        }
    }
}

Variables de GraphQL para entityLookup para lanSocketInterfaceID

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

Script de Ejemplo de Postman para Crear Nuevo Rango VLAN

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

Variable de GraphQL para Nuevo Rango VLAN

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