API de Configuración - addSocketSite

Descripción general de addSocketSite

Utilice la API de mutación addSocketSite para crear un nuevo sitio de Socket en su cuenta y definir las siguientes configuraciones para el sitio:

Nombre
Descripción
Tipo
Tipo de conexión
Zona horaria
País
Estado
Dirección
Rango Nativo

El sitio se crea con configuraciones de ancho de banda predeterminadas, 25 Mbps de bajada y 25 Mbps de subida, y se crea sin una licencia asignada.

Para cuentas de revendedores, puede crear claves API separadas dentro de cada cuenta de cliente que esté configurando con la API de Cato.

Ubicar el accountId para su cuenta

Este ID de cuenta no se muestra en la Aplicación de Administración de Cato, en su lugar, es el número en la URL de la Aplicación de Administración de Cato. Por ejemplo, el ID de cuenta es 26 para la siguiente URL: https://cc.catonetworks.com/#!/26/topology.

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

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

Detalles para los Argumentos de addSocketSite

Estos son los argumentos para crear un nuevo sitio de Socket utilizando la API de configuración de Cato. Los argumentos son obligatorios a menos que se marquen como opcionales:

name - Nombre del sitio
connectionType - Socket Físico o vSocket para este sitio
siteType - Tipo de sitio en su organización, por ejemplo Centro de Datos en la Nube
description - (opcional) Descripción del sitio
nativeNetworkRange - Rango IP para LAN nativa detrás del sitio, en formato CIDR
siteLocation - Datos sobre la ubicación física del sitio

Nombre de AddSocketSite

Defina el nombre del sitio de Socket que está creando.

Tipo de conexión de AddSocketSite

El connectionType es un argumento enum que define el tipo de Socket físico o virtual para el sitio.

Estas son las opciones:

SOCKET_X1500 - Socket X1500 o X1500B para un sitio físico
SOCKET_X1600 - Socket X1600 para un sitio físico
SOCKET_X1700 - Socket X1700 o X1700B para un sitio físico
SOCKET_ESX - vSocket para un sitio virtual VMware
SOCKET_AWS - vSocket para un sitio virtual AWS
SOCKET_AZURE - vSocket para un sitio virtual Azure

Tipo de sitio de AddSocketSite

El siteType es un argumento enum que define el tipo de sitio que determina qué icono se usa para el sitio en la pantalla de Monitoreo > Topología en la Aplicación de Administración de Cato.

Estas son las opciones:

Descripción de AddSocketSite (Opcional)

El description es un campo de texto libre opcional para describir el sitio.

Rango de red nativo de AddSocketSite

Defina el rango IP para el rango nativo de LAN para el sitio en el argumento nativeNetworkRange en el formato IPSubnet. El rango nativo utiliza CIDR para la subred, y los bloques CIDR /32 no son compatibles.

Ubicación del sitio de AddSocketSite

Los argumentos siteLocation definen los siguientes detalles físicos para el sitio. El countryCode es relevante para el número de licencias de sitios que están disponibles para una Región específica en su cuenta.

Puede usar la consulta API entityLookup para recuperar valores para estos argumentos, consulte API de Cato - EntityLookup.

Estos son los argumentos siteLocation:

countryCode - Código de dos letras (ISO 3166-1 alpha-2) para el país donde se encuentra el sitio

Para entityLookup, use el type con el valor country
stateCode - (Opcional) Para los países aplicables, el estado donde se encuentra el sitio

Para entityLookup, use el type con el valor countryState
zona horaria - Zona horaria para el sitio, usada para establecer el marco de tiempo para la Ventana de Mantenimiento para actualizaciones de Socket y vSocket

Para entityLookup, use el type con el valor timezone
dirección - (Opcional) Dirección de la calle para el sitio físico

Guion de ejemplo de Postman

mutación addSocketSite ($accountId: ID!, $input: AddSocketSiteInput!) {
    site(accountId: $accountId) {
        addSocketSite (input: $input) {
            siteId
        }
    }
}

Variables de GraphQL

{
    "accountId": "26",
    "input": {
        "name": "SampleUsSite2",
        "description": "Mi primer sitio API",
        "siteType": "BRANCH",
        "connectionType": "SOCKET_X1500",
        "nativeNetworkRange": "10.0.0.0/24",
        "siteLocation": {
            "countryCode": "US",
            "timezone": "US/Central",
            "stateCode": "US-AL"
        }
    }
}

Recursos Relacionados

Usando la API de Creación de Sitios Cato con Postman