API конфигурации - updateSocketInterface

Обзор updateSocketInterface

Используйте API updateSocketInterface для обновления следующих настроек интерфейса Socket в разделе Socket для сайта в Приложении управления Cato (Сеть > Сайты > {название сайта} > Конфигурация сайта > Socket)

  • Назначение для интерфейса

  • Имя

  • Настройки интерфейса LAN

  • Пропускная способность сайта

  • Настройки интерфейса WAN

  • Off Cloud (for Cato destination)

  • Настройки альтернативного интерфейса WAN

  • Участник LAG (агрегация ссылок)

  • Тип VRRP

Поиск siteID для сайта

ID сайта не отображается в Приложении управления Cato, вы можете найти ID сайта:

  • Используя запрос API entityLookup (см. Cato API - EntityLookup), используйте type со значением site

    Вы также можете использовать параметр search со значением в качестве названия сайта, и запрос вернет ID сайта

  • Номер в URL для Приложения управления Cato, когда вы выбрали сайт (Сеть > Сайты > {название сайта}). Например, ID сайта равен 12345 для следующего URL: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Понимание значений socketInterfaceId для Socket

socketInterfaceId — это enum, содержащий значения для Cato Sockets. Названия интерфейсов показаны на экране Sockets для сайта (Сеть > Сайты > {название сайта} > Конфигурация сайта > Socket) следующим образом:

  • X1500 Socket - Автоматический, LAN1, LAN2, WAN1, WAN2, WAN3, USB1, USB2

  • X1600 Socket - 1-8, USB1, USB2
  • X1700 Socket - INT_1 - INT_12

Подробности о аргументах updateSocketInterfaceInput

Это аргументы для обновления следующих настроек Интерфейса Socket для сайта с использованием API конфигурации Cato. Только аргумент destType является обязательным, в противном случае включите аргументы для настроек интерфейса Socket, которые вы обновляете.

  • destType - Назначение для интерфейса

  • имя - Имя сайта

  • lan - Настройки интерфейса LAN

  • пропускная способность - Входящая и исходящая пропускная способность сайта

  • wan - Настройки интерфейса WAN

  • offCloud - Настройки для Off Cloud для интерфейсов с назначением Cato

  • altWAN - Настройки для интерфейсов с назначением Альтернативный WAN или Альтернативный WAN (Уровень-2)

  • lag - для назначения LAN LAG Master, минимальное количество каналов (включая мастер и участников) для этой агрегации каналов (LAG)

  • vrrp - для конфигурации HA Socket, тип соединения VRRP между Socket

updateSocketInterfaceInput destType

destType — это аргумент enum, который определяет назначение для интерфейса.

Это варианты:

  • CATO - Трафик WAN для Cato Cloud

  • LAN - Внутренний LAN за Socket

  • VRRP_AND_LAN - для HA Socket, интерфейс используется для трафика LAN и VRRP

  • INTERFACE_DISABLED - Интерфейс отключен и не передает трафик

  • ALTERNATIVE - Трафик WAN не через Cato Cloud, например, MPLS

  • LAYER_2_WAN - Альтернативный WAN (Уровень-2) вариант для сети MPLS с сайтами Socket в одной подсети

  • VRRP - для HA Socket, интерфейс используется только для трафика VRRP

  • LAN_LAG_MASTER_AND_VRRP - для конфигурации HA Socket и LAN LAG, интерфейс является LAN LAG Master и используется для трафика VRRP

  • LAN_LAG_MASTER - для конфигурации LAN LAG, интерфейс является LAN LAG Master

  • LAN_LAG_MEMBER - для конфигурации LAN LAG, интерфейс является членом LAN LAG

  • LAN_AND_HA - для vSocket HA в Azure и AWS, интерфейс предназначен для трафика LAN и HA

updateSocketInterfaceInput name

Аргумент имя для названия интерфейса Socket.

updateSocketInterfaceInput lan

Аргументы lan для настроек интерфейса LAN для Socket.

Это варианты:

  • субнет - Нативный диапазон для интерфейса LAN в формате CIDR

  • localIP - Локальный IP-адрес для диапазона сетей LAN

updateSocketInterfaceInput bandwidth

Для интерфейсов, используемых для трафика WAN, аргументы пропускная способность определяют входящую и исходящую пропускную способность для интерфейса.

Это варианты:

  • upstreamBandwidth - максимальная исходящая пропускная способность для этого интерфейса

  • downstreamBandwidth - максимальная входящая пропускная способность для этого интерфейса

updateSocketInterfaceInput wan

Аргументы wan предназначены для настроек интерфейса WAN для Socket. Роли WAN обычно используются для определения трафика в сетевых правилах. Приоритет используется для приоритета переключения на резервный канал для Socket с активными и пассивными интерфейсами

Это варианты:

  • role - определяет роль для интерфейса WAN: нет, автоматический, wan_1, wan_2, wan_3

  • precedence - определяет приоритет переключения на резервный канал для интерфейса: АКТИВНЫЙ, ПАССИВНЫЙ, ПОСЛЕДНИЙ_РЕЗЕРВ

    ПОСЛЕДНИЙ_РЕЗЕРВ - интерфейс с самым низким приоритетом

updateSocketInterfaceInput offCloud

Аргументы offCloud предназначены для сайтов Socket, которые используют вне облака для маршрутизации трафика через публичный Интернет вместо облака Cato.

Это варианты:

  • enabled - Булево значение, если true, то трафик вне облака включен для сайта

  • publicIP (опционально) - Определяет статический публичный IP-адрес для установления соединения с Интернетом

  • publicStaticPort (опционально) - Определяет статический номер порта для трафика вне облака

updateSocketInterfaceInput altWan

Аргументы altWan предназначены для сайтов Socket, которые подключаются к альтернативной сети WAN, например MPLS. Обычно используются частные IP и интерфейсы для прямого подключения к провайдеру MPLS.

Это варианты:

  • privateInterfaceIp - Частный IP-адрес для интерфейса Socket для трафика

  • privateNetwork - Частный диапазон IP (с CIDR) для ЛВС

  • privateGatewayIp - Частный IP-адрес для шлюза альтернативной сети WAN (например, файервола или маршрутизатора MPLS)

  • privateVlanTag (опционально) - Тег VLAN для интерфейса (частный IP-адрес)

  • publicInterfaceIP (опционально) - Публичный IP-адрес для интерфейса Socket для трафика

  • publicNetwork (опционально) - Публичный диапазон IP (с CIDR) для ЛВС

  • publicGatewayIp (опционально) - Публичный IP-адрес для шлюза альтернативной сети WAN (например, файервола или маршрутизатора MPLS)

  • publicVlantag (опционально) - Тег VLAN для интерфейса (публичный IP-адрес)

updateSocketInterfaceInput lag

Аргумент lag предназначен для главного интерфейса LAN LAG и определяет минимальное количество интерфейсов (включая главный и участника) для LAG для этого сайта Socket.

Это вариант:

  • minLinks - минимальное количество интерфейсов (связей) в LAG

updateSocketInterfaceInput vrrp

Аргумент enum vrrp предназначен для конфигураций HA Socket и определяет тип VRRP соединения между сокетами для поддержания активного соединения.

Это варианты:

  • VIA_SWITCH - VRRP соединение маршрутизируется через коммутатор между сокетами

  • DIRECT_LINK - VRRP соединение маршрутизируется напрямую между сокетами

Пример скрипта Postman

Пример скрипта - изменение собственного диапазона и имени

Это пример использования API конфигурации для изменения имени интерфейса LAN1 на LAN-01, а также обновление подсети и localIP собственного диапазона для Socket.

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL Variables

{
    "accountId": "26",
    "siteId": 26,
    "socketInterfaceId": "LAN1",
    "input": {
        "name": "LAN-01",
        "destType": "LAN",
        "lan": {
            "subnet": "10.0.0.0/24",
            "localIp": "10.0.0.1"
        }
    }
}

Пример скрипта - изменение пропускной способности и имени

Это пример использования API конфигурации для изменения пропускной способности и имени для интерфейса WAN.

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL Variables

{
    "accountId": "26",
    "siteId": 126,
    "socketInterfaceId": "WAN1",
    "input": {
        "name": "WAN Demo",
        "destType": "CATO",
        "bandwidth": {
            "upstreamBandwidth": 100,
            "downstreamBandwidth": 100
        }
    }
}

Была ли эта статья полезной?

Пользователи, считающие этот материал полезным: 0 из 0

0 комментариев