Конфигурация API — Добавление, Обновление и Удаление staticHost

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

В этой статье объясняется, как использовать Cato API для управления узлами, определенными для сайта, с помощью этих команд:

addStaticHost
updateStaticHost
removeStaticHost

Обзор staticHost

Используйте staticHost мутации API, чтобы добавлять, обновлять и удалять узлы для сайта в вашей учетной записи и определять следующие настройки для узла:

Имя узла
IP-адрес узла
MAC-адрес (необязательно - используется для резервирования назначения IP в DHCP для узла)

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

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

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

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

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

Подробности для аргументов addStaticHost и updateStaticHost

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

hostId - Для updateStaticHost введите ID узла, который вы обновляете

Для addStaticHost, этот ID генерируется при создании нового узла
name - Имя узла за сайтом
ip - IP-адрес узла за сайтом
macAddress - (необязательно) MAC-адрес узла за сайтом

MAC-адрес узла используется для резервирования DHCP для узлов со статическим IP-адресом

staticHost hostId

hostId — это внутренний Cato ID для сущности узла.

networkRangeId может быть получен с помощью entityLookup API только для чтения, используйте тип со значением host

staticHost name

Используйте аргумент name для определения имени узла.

staticHost ip

Используйте аргумент ip, чтобы указать IP-адрес узла.

staticHost macAddress (Необязательно)

Используйте аргумент macAddress для задания MAC-адреса узла для резервирования DHCP.

Для учетных записей, использующих Cato в качестве DHCP-сервера, IP-адрес узлов, определенных с MAC-адресом, резервируется и не может быть назначен другому узлу. Убедитесь, что IP-адрес для узла находится вне диапазона DHCP для сегмента сети, определенного для сайта.

removeStaticHost

Используйте API removeStaticHost, чтобы удалить узел, определенный для сайта. Вам нужно использовать только hostId с этим API.

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

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

Переменные GraphQL

{
 "accountId": "26",
 "siteId": 126,
 "input": {
 "primaryManagementIp": "192.168.4.2",
 "secondaryManagementIp": "192.168.4.3",
 "vrid": 100
 }
}

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