net.php¶
Модуль управления сетевыми настройками: управление IP-адресами (IPv4), блокировка/разблокировка IP, получение данных о MAC-адресах и мониторинг трафика.
Методы API¶
| Метод | Действие | Описание |
|---|---|---|
add_ipv4 | добавление IPv4 адресов | Добавляет указанное количество IPv4 адресов на сервер в выбранном порту и VLAN. Если IP не указан, система подберет свободные адреса. |
block_ip | блокировка IP-адреса | Блокирует указанный IP-адрес через BIRD или Blackhole. |
get_acl | получение ACL | Возвращает данные о правилах доступа (ACL) для порта. |
get_bandwidth | получение пропускной способности | Возвращает текущие показатели скорости (bps) для порта. |
get_bps_in | получение входящей скорости | Возвращает текущую скорость входящего трафика (Inbound bps). |
get_bps_out | получение исходящей скорости | Возвращает текущую скорость исходящего трафика (Outbound bps). |
get_mac | получение MAC-адреса | Возвращает информацию о MAC-адресе для указанного порта сервера. |
get_port | получение данных о порте | Возвращает информацию о сетевом интерфейсе сервера (тип, VLAN, скорость и др.) |
get_pspeed | получение скорости порта | Возвращает текущую скорость сетевого интерфейса |
get_snmp | получение SNMP данных | Возвращает данные SNMP из базы данных по тегу |
get_status | получение статуса порта | Возвращает текущий статус сетевого интерфейса |
load_arp_ovirt | загрузка ARP из Ovirt | Запускает процесс загрузки таблицы ARP для инженеров Ovirt |
mac_check1 | проверка MAC-адресов (flow) | Валидация записей port_flow для конкретного ID или всех доступных |
mac_data_list | получение данных по списку MAC | Возвращает данные из БД и port_flow для списка предоставленных MAC-адресов |
nmap | запуск nmap сканирования | Запускает сетевое сканирование (NMAP) для указанного IP-адреса, принадлежащего серверу. |
port_off | выключение порта | Отключает сетевой порт сервера. |
port_on | включение порта | Включает сетевой порт сервера и снимает блокировки (tags). |
remove_ipv4 | удаление IPv4 адреса | Удаляет конкретный или все IPv4 адреса с сервера. |
reset_interface_vlan | сброс VLAN интерфейса | Сбрасывает настройки VLAN сетевого интерфейса сервера до настроек по умолчанию. |
show_cacti | получение графика Cacti | Возвращает данные для построения графиков Cacti для сетевого интерфейса. |
unblock_ip | разблокировка IP | Снимает блокировку с указанного IP-адреса. |
net/add_ipv4¶
Добавляет указанное количество IPv4 адресов на сервер в выбранном порту и VLAN. Если IP не указан, система подберет свободные адреса.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: add_ipv4 |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя сетевого интерфейса (например, eth0, ipmi) |
| ips | ❌ | array<string> | Список конкретных IP-адресов для добавления. Принимает несколько значений: ips[]=1.1.1.1&ips[]=1.1.1.2 |
| amount | ❌ | integer | Количество свободных IP-адресов для подбора (если ips не указан) |
| vlan | ❌ | integer | ID VLAN. Если не указан, определяется автоматически по порту. |
| allow_tech_networks | ❌ | boolean | Разрешить добавление из технических сетей (только для администраторов). |
| tag_id | ❌ | integer | ID тега для фильтрации при подбор IP. |
| fresh_period | ❌ | integer | Период свежести (в секундах) для поиска свободных адресов. |
| ip | ❌ | string | Конкретный IPv4 адрес для назначения серверу. |
| tag | ❌ | string | Тег сети или идентификатор типа интерфейса (например, ipmi, ovirt, bm). |
Пример запроса
Пример успешного ответа
net/block_ip¶
Блокирует указанный IP-адрес через BIRD или Blackhole.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: block_ip |
| token | ✅ | string | Токен авторизации |
| id | ❌ | integer | ID сервера. Если не указан, IP будет найден по значению ip. |
| ip | ✅ | string | IP-адрес для блокировки |
| description | ❌ | string | Причина блокировки (добавляется в описание тега) |
| four_hours | ❌ | integer | Установить временную блокировку на 4 часа. |
Пример запроса
Пример успешного ответа
net/get_acl¶
Возвращает данные о правилах доступа (ACL) для порта.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_acl |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор или номер виртуальной локальной сети. |
| speed | ❌ | string | Установленная скорость передачи данных на порту. |
| trunc | ❌ | string | Параметр обрезки (трассировки) сетевого трафика. |
| port_security | ❌ | integer | Настройка безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или его целевое состояние. |
| reason | ❌ | string | Причина блокировки порта или изменения настроек доступа. |
| duplex | ❌ | string | Режим дуплекса сетевого соединения (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
net/get_bandwidth¶
Возвращает текущие показатели скорости (bps) для порта.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_bandwidth |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор виртуальной локальной сети (VLAN). |
| speed | ❌ | string | Установленная скорость передачи данных на интерфейсе. |
| trunc | ❌ | string | Параметр обрезки (трассировки) пакетов или трафика. |
| port_security | ❌ | integer | Настройки безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или его целевое состояние. |
| reason | ❌ | string | Причина блокировки порта или изменения состояния соединения. |
| duplex | ❌ | string | Режим дуплекса сетевого интерфейса (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для сетевого порта. |
Пример запроса
net/get_bps_in¶
Возвращает текущую скорость входящего трафика (Inbound bps).
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_bps_in |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор или название виртуальной локальной сети (VLAN). |
| speed | ❌ | string | Установленная скорость передачи данных на интерфейсе. |
| trunc | ❌ | string | Параметр обрезки (трассировки) пакетов или специфическая настройка порта. |
| port_security | ❌ | string | Настройка безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или режим работы порта. |
| reason | ❌ | string | Причина блокировки или изменения состояния порта. |
| duplex | ❌ | string | Режим дуплекса сетевого соединения (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
net/get_bps_out¶
Возвращает текущую скорость исходящего трафика (Outbound bps).
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_bps_out |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор виртуальной локальной сети для сетевого интерфейса. |
| speed | ❌ | string | Установленная скорость передачи данных на порту. |
| trunc | ❌ | string | Параметр обрезки (трассировки) пакетов или настроек интерфейса. |
| port_security | ❌ | integer | Настройка безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или целевое состояние порта. |
| reason | ❌ | string | Причина блокировки или изменения состояния порта. |
| duplex | ❌ | string | Режим дуплекса для сетевого соединения (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
net/get_mac¶
Возвращает информацию о MAC-адресе для указанного порта сервера.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_mac |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор виртуальной локальной сети (VLAN). |
| speed | ❌ | string | Установленная скорость передачи данных на интерфейсе. |
| trunc | ❌ | string | Параметр обрезки (трассировки) пакетов или настроек порта. |
| port_security | ❌ | integer | Настройка безопасности порта для ограничения количества MAC-адресов. |
| status | ❌ | string | Текущий статус сетевого интерфейса или целевое состояние порта. |
| reason | ❌ | string | Причина блокировки или изменения состояния порта. |
| duplex | ❌ | string | Режим дуплекса сетевого соединения (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
net/get_port¶
Возвращает информацию о сетевом интерфейсе сервера (тип, VLAN, скорость и др.)
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_port |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Название порта (например, eth0) |
| vlan | ❌ | string | VLAN ID |
| speed | ❌ | string | Скорость порта |
| port_security | ❌ | integer | Настройки безопасности порта. По умолчанию -1. |
| trunc | ❌ | string | Параметр обрезки (truncation) |
| status | ❌ | integer | Статус порта. По умолчанию -1. |
| duplex | ❌ | string | Режим дуплекса |
| reason | ❌ | string | Причина блокировки сетевого интерфейса или порта. |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
Пример успешного ответа
net/get_pspeed¶
Возвращает текущую скорость сетевого интерфейса
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_pspeed |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Название порта |
| vlan | ❌ | string | Идентификатор или номер виртуальной локальной сети. |
| speed | ❌ | string | Установленная скорость передачи данных на интерфейсе. |
| trunc | ❌ | string | Параметр обрезки или ограничения трафика. |
| port_security | ❌ | integer | Настройки безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или его целевое состояние. |
| reason | ❌ | string | Причина блокировки или изменения состояния порта. |
| duplex | ❌ | string | Режим дуплекса сетевого соединения (full/half). |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для порта. |
Пример запроса
net/get_snmp¶
Возвращает данные SNMP из базы данных по тегу
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_snmp |
| id | ✅ | integer | ID сервера |
| tag_id | ✅ | integer | ID тега для SNMP запроса |
| period_from | ❌ | string | Начало периода (timestamp) |
| period_to | ❌ | string | Конец периода (timestamp) |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
Пример успешного ответа
net/get_status¶
Возвращает текущий статус сетевого интерфейса
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_status |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Название порта (например, eth0) или его ID |
| vlan | ❌ | integer | ID виртуальной локальной сети (VLAN) |
| speed | ❌ | string | Скорость порта |
| port_security | ❌ | boolean | Включена ли безопасность порта |
| trunc | ❌ | boolean | Режим транка (trunking) |
| status | ❌ | string | Статус порта |
| token | ✅ | string | Токен авторизации |
| duplex | ❌ | string | Режим дуплекса |
| nic_id | ❌ | integer | ID сетевого интерфейса (NIC ID) |
| port_virt_node | ❌ | string | Виртуальный узел порта |
| reason | ❌ | string | Причина отключения порта или блокировки сетевого интерфейса. |
Пример запроса
net/load_arp_ovirt¶
Запускает процесс загрузки таблицы ARP для инженеров Ovirt
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: load_arp_ovirt |
| engine | ✅ | string | Название движка Ovirt. Допустимые значения: ovirt. |
Пример запроса
Пример успешного ответа
net/mac_check1¶
Валидация записей port_flow для конкретного ID или всех доступных
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: mac_check1 |
| id | ❌ | integer | ID для проверки конкретной записи. Если 0 — проверка всех записей. |
| status | ❌ | integer | Статус для фильтрации. По умолчанию -1. |
| skip | ❌ | integer | Пропуск записей (пагинация). По умолчанию 0. |
| report | ❌ | integer | Флаг генерации отчета о сбоях. По умолчанию -1. |
Пример запроса
Пример успешного ответа
{
"result": "OK",
"action": "mac_check1",
"data": [
"[ERROR] error message",
{
"id": 50,
"updated": "2024-01-01 10:00:00",
"location": "NL",
"mac": "00:1A:2B:3C:4D:5E",
"switch_location": "Rack A",
"switch_info": "Switch-01",
"switch_port": "GigabitEthernet0/1"
}
],
"items": [
{
"id": 1,
"name": "example"
}
]
}
net/mac_data_list¶
Возвращает данные из БД и port_flow для списка предоставленных MAC-адресов
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: mac_data_list |
| mac_list | ❌ | array<string> | Список MAC-адресов для получения данных |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
Пример успешного ответа
net/nmap¶
Запускает сетевое сканирование (NMAP) для указанного IP-адреса, принадлежащего серверу.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: nmap |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера для выполнения сканирования |
| ip | ✅ | string | IP-адрес для сканирования. Должен принадлежать серверу. |
Пример запроса
Пример успешного ответа
net/port_off¶
Отключает сетевой порт сервера.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: port_off |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | VLAN ID |
| speed | ❌ | string | Скорость порта |
| port_security | ❌ | integer | Настройки безопасности порта. По умолчанию -1. |
| trunc | ❌ | string | Параметр транка (trunking) |
| status | ❌ | integer | Статус порта. По умолчанию -1. |
| duplex | ❌ | string | Режим дуплекса |
| block_reason | ❌ | string | Причина блокировки порта для добавления тега администратора. |
| reason | ❌ | string | Причина отключения порта для записи в историю и теги. |
| port_virt_node | ❌ | string | Идентификатор виртуального узла порта. |
Пример запроса
Пример успешного ответа
net/port_on¶
Включает сетевой порт сервера и снимает блокировки (tags).
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: port_on |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| vlan | ❌ | string | Идентификатор или номер виртуальной локальной сети (VLAN). |
| speed | ❌ | string | Установленная скорость передачи данных на сетевом интерфейсе. |
| trunc | ❌ | string | Параметр обрезки (truncation) для настройки сетевого трафика. |
| port_security | ❌ | integer | Настройка безопасности порта для ограничения доступа по MAC-адресам. |
| status | ❌ | string | Текущий статус сетевого интерфейса или целевое состояние порта. |
| reason | ❌ | string | Причина блокировки или изменения состояния сетевого порта. |
| duplex | ❌ | string | Режим дуплекса для управления сетевым соединением. |
| port_virt_node | ❌ | string | Идентификатор виртуального узла для настройки порта. |
Пример запроса
Пример успешного ответа
net/remove_ipv4¶
Удаляет конкретный или все IPv4 адреса с сервера.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: remove_ipv4 |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| ip | ✅ | string | IP-адрес для удаления. |
| remove_all | ❌ | integer | Удалить все адреса (0 - нет, 1 - да). По умолчанию 0. |
Пример запроса
Пример успешного ответа
net/reset_interface_vlan¶
Сбрасывает настройки VLAN сетевого интерфейса сервера до настроек по умолчанию.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: reset_interface_vlan |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port_id | ❌ | integer | Идентификатор конкретного сетевого порта для сброса настроек VLAN |
Пример запроса
Примеры ошибок
net/show_cacti¶
Возвращает данные для построения графиков Cacti для сетевого интерфейса.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: show_cacti |
| token | ✅ | string | Токен авторизации |
| id | ✅ | integer | ID сервера |
| port | ❌ | string | Имя порта (например, eth0) |
| graph | ❌ | integer | ID графика. По умолчанию 1. |
Пример запроса
net/unblock_ip¶
Снимает блокировку с указанного IP-адреса.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: unblock_ip |
| token | ✅ | string | Токен авторизации |
| id | ❌ | integer | ID сервера для выполнения операции разблокировки. |
| ip | ✅ | string | IP-адрес для разблокировки. |
| description | ❌ | string | Текстовое описание или причина блокировки IP-адреса. |
| four_hours | ❌ | integer | Флаг установки временного ограничения на блокировку в течение четырех часов. |
Пример запроса