Configuration API - addSocketSite

Prev Next

Мы настоятельно рекомендуем перед началом использования Cato API ознакомиться с Политикой поддержки Cato API.

Обзор addSocketSite

Используйте API addSocketSite для создания нового Socket сайта в вашем аккаунте и определения следующих настроек для сайта:

  • Имя

  • Описание

  • Тип

  • Тип соединения

  • Часовой пояс

  • Страна

  • Штат

  • Адрес

  • Нативный диапазон

Сайт создается с настройками полосы пропускания по умолчанию 25 Мбит/с на загрузку и 25 Мбит/с на выгрузку, и создается без назначения лицензии.

Для аккаунтов реселлеров вы можете создавать отдельные ключи API внутри каждой учетной записи клиента, в которой настраиваете параметры с помощью API Cato.

Поиск accountId для вашей учетной записи

Этот ID аккаунта не отображается в Приложение управления Cato, вместо этого это номер в URL для Приложение управления Cato. Например, ID аккаунта — 26 для следующего URL: https://cc.catonetworks.com/#!/26/topology.

Введите этот ID в аргумент accountId для API создания сайта, например:

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

Детали аргументов addSocketSite

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

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

  • connectionType - Физический Socket или vSocket для этого сайта

  • siteType - Тип сайта в вашей организации, например, Облачный Центр Данных

  • description - (необязательно) Описание сайта

  • nativeNetworkRange - Диапазон IP для нативной LAN за сайтом в формате CIDR

  • siteLocation - Данные о физическом местоположении сайта

Имя AddSocketSite

Определите имя создаваемого вами Socket сайта.

Тип соединения AddSocketSite

Аргумент connectionType является перечислением, которое определяет тип физического или виртуального Socket для сайта.

Вот доступные параметры:

  • SOCKET_X1500 - X1500 или X1500B Socket для физического сайта

  • SOCKET_X1600 - X1600 Socket для физического сайта

  • SOCKET_X1700 - X1700 или X1700B Socket для физического сайта

  • SOCKET_ESX - vSocket для виртуального сайта VMware

  • SOCKET_AWS - vSocket для виртуального сайта AWS

  • SOCKET_AZURE - vSocket для виртуального сайта Azure

Тип сайта AddSocketSite

siteType - это перечислимый аргумент, который определяет тип сайта, что определяет, какой значок используется для сайта на экране Мониторинг > Топология в Приложении управления Cato.

Вот доступные параметры:

  • BRANCH - Физические или виртуальные сайты

  • HEADQUARTERS - Физические сайты для корпоративных штаб-квартир

  • CLOUD_DC - Виртуальные сайты для облачных центров данных

  • DATACENTER - Физические сайты для центров данных

Описание AddSocketSite (необязательно)

description - это необязательное текстовое поле для описания сайта.

Нативный диапазон сети AddSocketSite

Определите IP-диапазон для локальной сети/нативного диапазона для сайта в аргументе nativeNetworkRange в формате IPSubnet. Нативный диапазон использует CIDR для подсети, и блоки /32 CIDR не поддерживаются.

Местоположение сайта AddSocketSite

Аргументы siteLocation определяют следующие физические детали для сайта. countryCode имеет отношение к количеству лицензий на сайт, которые доступны для конкретного Региона в вашей учетной записи.

Вы можете использовать запрос API entityLookup для получения значений для этих аргументов, см. Cato API - EntityLookup.

Это аргументы siteLocation:

  • countryCode - Двухбуквенный код (ISO 3166-1 alpha-2) для страны, где находится сайт

    Для entityLookup, используйте type со значением country

  • stateCode - (необязательно) Для применимых стран, штат, где находится сайт

    Для entityLookup, используйте type со значением countryState

  • timezone - Часовой пояс для сайта, используется для установки временных рамок для Окон Технического Обслуживания для обновлений Socket и vSocket

    Для entityLookup, используйте type со значением timezone

  • address - (необязательно) Адрес улицы для физического сайта

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

мутатция addSocketSite ($accountId: ID!, $input: AddSocketSiteInput!) {
    site(accountId: $accountId) {
        addSocketSite (input: $input) {
            siteId
        }
    }
}

Переменные GraphQL

{
    "accountId": "26",
    "input": {
        "name": "SampleUsSite2",
        "description": "Мой первый сайт API",
        "siteType": "BRANCH",
        "connectionType": "SOCKET_X1500",
        "nativeNetworkRange": "10.0.0.0/24",
        "siteLocation": {
            "countryCode": "US",
            "timezone": "US/Central",
            "stateCode": "US-AL"
        }
    }
}

Связанные ресурсы