Версия 1.19-79
Дата публикации 09-06-2021 14:30:17
Список команд
Управление пользователями
-
AddRadiusUserMac - Добавить привязку MAC-адреса к учетной записи пользователя услуги Wi-Fi
-
CreateRadiusUser - Создание аккаунта Wi-Fi клиента в базе RADIUS
-
CreateRadiusUserV2 - Создание аккаунта Wi-Fi клиента в базе RADIUS V2
-
DeactivateRadiusUser - Деактивация аккаунта Wi-Fi клиента в базе RADIUS
-
DeactivateRadiusUserTemporarily - Временная деактивация аккаунта Wi-Fi клиента в базе RADIUS
-
EditRadiusUserDomain - Изменить домен аккаунта Wi-Fi клиента в базе RADIUS
-
EditRadiusUser - Редактирование аккаунта Wi-Fi клиента в базе RADIUS
-
GenerateRadiusUser - Генерация пользователей Wi-Fi в базе RADIUS
-
GenerateRadiusUserV2 - Генерация пользователей Wi-Fi в базе RADIUS V2
-
GenerateRadiusUserNew - Генерация пользователей Wi-Fi в базе RADIUS с дополнительными параметрами
-
RemoveRadiusUserAttributes - Удаление атрибутов аккаунта Wi-Fi клиента в базе RADIUS
-
RemoveRadiusUserByDomain - Удаление группы аккаунтов Wi-Fi клиентов по домену из базы RADIUS
-
RemoveRadiusUserByTariff - Удаление всех аккаунтов Wi-Fi, привязанных к тарифному плану
-
RemoveRadiusUserMac - Удалить привязку MAC-адреса устройства пользователя в домене
-
RemoveRadiusUser - Удаление аккаунта Wi-Fi клиента из базы RADIUS
-
RetrieveRadiusAcctData - Запрос данных аккаунтинга для Wi-Fi пользователей
-
RetrieveRadiusOperList - Запрос списка операторов для атрибутов Wi-Fi пользователей
-
RetrieveRadiusUserAcctData - Запрос данных аккаунтинга для Wi-Fi пользователя по ip-адресу
-
RetrieveRadiusUserAttrList - Запрос списка атрибутов Wi-Fi пользователей
-
RetrieveRadiusUserByMac – Получить полное описание учетной записи по MAC-адресу
-
RetrieveRadiusUser - Получить все атрибуты аккаунта Wi-Fi клиента из базы RADIUS
-
RetrieveRadiusUserList - Запрос списка аккаунтов Wi-Fi клиентов из базы RADIUS
-
RetrieveRadiusUserShortInfoList - Получить список пользователей radstat по домену и ссиду
-
RetrieveLastRadiusUserList - Получить список пользователей Wi-Fi из базы RADIUS
-
RetrieveUserListBySSID - Запрос списка пользователей, которые могут подключаться к данному SSID
-
UpdateUserActivity - Обновить время активности пользователя wi-fi на портале
-
GroupRemoveRadiusUsers - Групповое удаление пользователей wi-fi
Управление сервисами
Управление тарифами
-
RemoveRadiusUserTariff - Отвязать аккаунт Wi-Fi пользователя от тарифного плана
-
RetrieveTariffAttrList - Запрос списка атрибутов тарифного плана
-
RetrieveTariffFullAttrList - Возвращает полный список атрибутов тарифного плана из конфигурации
-
RetrieveTariffListV2 - Запрос списка тарифных планов, которые содержат в том числе атрибуты bras
-
RetrieveTariffListV3 - Запрос списка тарифных планов (с пагинацией)
-
RetrieveTariffListV4 - Запрос списка тарифных планов и привязанных к ним порталов
-
RetrieveTariffWithBrasParams - Получить все атрибуты тарифного плана, включая атрибуты bras
-
SetTariffForRadiusUser - Изменить тарифный план для Wi-Fi пользователя
-
RetrieveTariffListCached - Получить список тарифных планов, если хэш изменился.
-
GetServiceProfileOfUser - Просмотр остатков по сервисам для конкретного пользователя
-
GetScriptsStepOfUser - Просмотр порядка следования сервисов для конкретного пользователя
-
GetFullTariffsPartition - Получить список тарифов без фильтрации с пагинацией
-
RetrieveRadiusTariffListByType - Получить список тарифов с фильтрацией по типу
Управление доменами
-
DeleteDomainWithDependencies - Удаление домена и всех его зависимостей из системы SoftWLC
-
IsDomainUsed - Проверка на использование домена где-либо в системе SoftWLC
-
RetrieveDomain - Получить список атрибутов домена по имени в системе SoftWLC
-
RetrieveDomainTimezone - Получить таймзону для домена в системе SoftWLC
-
RetrieveDomainsTimezone - Получить таймзону для списка доменов в системе SoftWLC
-
RetrieveDomainTree - Получить список доменов, зарегистрированных в системе SoftWLC
-
RetrieveDomainTreeV2 - Получить список доменов, зарегистрированных в системе SoftWLC
-
GetFullDomainsChanged - Получить полный список доменов, если хэш дерева доменов изменился
-
GetFullDomainsPartition - Получить полный список доменов с пагинацией
-
GetCurrentDomainCounter - Получить текущую версию дерева доменов
Управление SSID
-
EditSSID - Редактирование параметров и атрибутов SSID в базе wireless
-
EditSSIDAndName - Редактирование параметров и атрибутов SSID и его переименование в базе wireless
-
GetAPDomainListBySSID - Получить список доменов ТД, привязанных к SSID
-
GetSsidLinkListByDomain - Получить список SSID, привязанных к указанному домену
-
GetSsidLinkListBySSID - Получить список привязок SSID по имени SSID’а
-
RemoveSSIDByMac - Удаление SSID с точки доступа по MAC-адресу
-
RetrieveSSIDAttrList - Запрос списка возможных атрибутов SSID
-
RetrieveSSIDListByDomain - Запрос списка SSID, принадлежащих домену
-
RetrieveSSIDListByDomainType - Получить список SSID по типу домена и дополнительным параметрам
-
RetrieveSSIDListByNas - Запрос списка SSID, установленных на точку доступа
-
RetrieveSSIDList - Запрос списка SSID на основе содержащихся в них атрибутов
-
RetrieveSSIDListV2 - Запрос списка SSID с атрибутами по имени и домену
-
RetrieveSSIDListV3 - Получить список SSID (имя, домен) с пагинацией
-
SetSSIDByMac - Установить SSID на точку доступа по MAC-адресу
-
GetSsidLinkExtendedByLinkId - Получение привязки SSID’а с расширенными параметрами по id привязки
-
EditSsidLinkExtended - Редактирование расширенных параметров привязки SSID
-
DeleteSsidLinkExtended - Удаление расширенных параметров для привязки SSID
-
SyncSSID - Запустить асинхронные процессы исправления привязок SSID в EMS
-
DesyncSSID - Запустить асинхронные процессы удаления привязок SSID в EMS
Управление устройствами
-
CreateRuleLink - Создать привязку устройства и правила инициализации
-
EditNas - Редактирование параметров точки доступа (AP) в базе RADIUS
-
GetInitLinkParamList - Получить список дополнительных параметров привязки инициализации
-
GetInitStatus - Получить статус инициализации устройства по MAC-адресу
-
RemoveRuleLinkByNodeDomain - Удалить привязки устройств и правила инициализации по домену ТД
-
RemoveRuleLinkByRuleDomain - Удалить привязки устройств и правила инициализации по домену правила
-
RemoveRuleLink - Удалить привязку устройства и правила инициализации
-
RetrieveNasList - Запрос списка точек доступа (AP) из базы RADIUS
-
RetrieveNasListBySSID - Запрос списка точек доступа, на которых установлен SSID
-
RetrievePolicyMapList - Запрос списка имен Client QoS.PolicyMap по домену из SoftWLC
-
RetrieveProfileList - Запрос списка шаблонов конфигурации из SoftWLC
-
RetrieveRuleLinkList - Получить список связей устройств и правил инициализации
-
RetrieveRuleList - Запрос списка правил инициализации из SoftWLC
-
CreateInitRule - Создание правила инициализации точек доступа
-
RemoveInitRule - Удаление правила инициализации точек доступа
-
SetProfileByDomain - Загрузка шаблона конфигурации на группу точек доступа
-
SetProfileByIp - Загрузка шаблона конфигурации на точку доступа по IP адресу
-
SetProfileByMac - Загрузка шаблона конфигурации на точку доступа по MAC адресу
-
GetInitializationApList - Получение списка неинициализированных ТД
-
GetAccessParamNamesList - Список имен параметров с вкладки Доступ из EMS
-
GetApAccessParamList - Список параметров с вкладки Доступ из EMS для конкретного объекта
-
GetGeoObjectsList - Получить список объектов для вкладки Список ТД
-
RetrieveDomainsIntegralStatus - Получить интегральный статус узла дерева объектов
-
RetrieveDomainsIntegralStatusV2 - Получить интегральный статус узла дерева объектов
-
GetGeoObjectCommonDomain - Получить общий домен для одной агрегации вкладки Карты ТД
-
GetDynamicTunnelsStationsByClient - Получить информацию о станционных ESR
-
Geocode - Получение геокоординат по заданному почтовому адресу
-
GetMacCellList - Получить список объектов с информацией о GenericAp
Управление виртуальными порталами
-
AddTariffToPortal - Добавить тарифный план для виртуального портала
-
CreateHotspotAccessList - Создать белый или черный список пользователей
-
CreateHotspotDefAccessList - Создать белый или черный список номеров пользователей
-
DeleteHotspotAccessList - Удалить белый или черный список пользователей
-
DeleteHotspotDefAccessList - Удалить белый или черный список номеров пользователей
-
EditHotspotAccessList - Редактировать белый или черный список пользователей
-
EditHotspotDefAccessList - Редактировать белый или черный список номеров пользователей
-
EditTariffTitleForPortal - Редактировать этикетку для тарифного плана на виртуальном портале
-
RemoveTariffFromPortal - Удалить тарифный план с виртуального портала
-
RetrieveHotspotAccessLists - Получить списки пользователей с учетом фильтрации и пагинации
-
RetrieveHotspotAccessList - Получить информацию о списке пользователей по имени и домену
-
RetrieveHotspotDefAccessList - Получить информацию о списке номеров пользователей по имени и домену
-
RetrievePortalParams - Получить параметры виртуального портала
-
RetrievePortalTariffList - Вывести список тарифных планов для виртуального портала
-
EditPortalParams - Редактировать параметры виртуального портала
Управление системными пользователями
-
CreateAuthUser - Создать пользователя в базе eltex_auth_service
-
DeleteAuthUser - Удалить пользователя в базе eltex_auth_service
-
EditAuthUser - Редактировать пользователя в базе eltex_auth_service
-
GetAuthUser - Получить информацию о пользователе из базы eltex_auth_service
-
GetAuthUserList - Получить списка пользователей из базы eltex-auth-service
-
GetAuthUserSize - Возвращает количество системных пользователей из базы eltex-auth-service
-
GetAuthRole - Получить информацию о роли из базы eltex_auth_service
-
GetAuthRoleList - Получение списка ролей из базы eltex-auth-service (устар.)
-
GetAuthRoleListAll - Получение списка ролей из базы eltex-auth-service
-
AddAuthRoleToAuthUser - Назначить роль нескольким пользователям
-
AddAuthNas - Добавить серверный адрес в базу eltex_auth_service
-
DeleteAuthNas - Удалить серверный адрес в базе eltex_auth_service
-
GetAuthNas - Получить информацию по серверному адресу из базы eltex-auth-service
-
GetAuthNasList - Получить список серверныx адресов из базы eltex-auth-service
-
SetAuthNas - Редактировать серверный адрес в базе eltex-auth-service
-
GetAuthAttrGroupList - Получить список групп атрибутов в базе eltex-auth-service
-
GetAuthAttrList - Получить список атрибутов из базы eltex_auth_service
-
GetAuthAttrListV2 - Получить список атрибутов из базы eltex_auth_service c указанием локали
-
GetNbiMethodsAllowedList - Получить список методов NBI доступных для пользователя
Интеграция с SSO
Управление шейперами
-
ClearDomainShaper - Стереть все ограничения для указанного домена и SSID, привязанных к нему
-
ClearSsidShaper - Удалить указанный SSID из всех ограничений
-
GetDomainShaper - Получить список ограничений для указанного домена и SSID, привязанных к нему
-
RenameSsidShaperDomain - Переименовать домен SSID в профилях шейпера
-
ClearAutoCreatedDomainShaper - Удаление автоматически созданного профиля шейпера
Управление сценариями
Управление подсетями
Управление VRF
Статистика
-
RetrieveAPDomainTimeStatistics - Запрос статистики по "географическим" доменам ТД
-
RetrieveNasTimeStatistics - Запрос статистики по группе точек доступа по домену
-
RetrieveRadiusSSIDGroupStatistics - Запрос статистики группы SSID по домену
-
RetrieveRadiusSSIDIntervalStatistics - Запрос статистики SSID разделённой по временным промежуткам
-
GetRadioState - Запрос информации по радиоинтерфейсам Wi-Fi устройства
-
GetRadiusCountValue - Возвращает статистику в виде вещественного числа
-
RetrieveApInfo - Запрос общей информации по Wi-Fi устройствам
-
RetrieveOnlineUsersCount - Запрос количества пользователей онлайн
-
RetrieveTodayDownstreamTraffic - Запрос трафика в downstream за сегодняшний день
-
RetrieveTodayNewUsersCount - Запрос количества новых пользователей за сегодня
-
RetrieveTodayUsersCount - Запрос количества пользователей за сегодня
-
RetrieveAPListExtended - Запрос списка ТД с информацией по SSID
-
RetrieveTimeStatistic - Запрос статистики для отображения на графике
-
RetrieveApTimeStatistics - Запрос статистики по точке доступа в указанном временном интервале
-
RetrieveTodayTraffic - Выдать сумму входящего и исходящего трафика за сегодня по ssid и домену
-
RetrieveApSummary - Выдать общую информацию по точкам доступа в сети
-
RetrieveGuestStatistics - Выдать статистику по подключениям неавторизованных пользователей
-
RetrieveUserLocationHistory - Запрос статистики пользователя по перемещению между ТД
-
GetTopActiveUsers - Получить список самых активных пользователей
-
GetAPInfoByMacList - Поиск информации о точках по списку мак-адресов
-
RetrieveDomainSsidTypeStatistic - Получить статистику по трафику для одного домена по типу сети
Управление СОРМ-2
СОРМ-3
Управление списками URL
Управление списками приложений
Управление профилями юр. лиц
-
CreateEntityProfileValues - Создать параметры схем профилей юр. лица
-
DeleteEntityProfileClassById - Удалить схему профиля юр.лица
-
DeleteEntityProfileValue - Удалить параметры схем профилей юр. лица
-
EditEntityProfileClass - Редактировать схему профиля с привязкой по ID
-
EditEntityProfileValue - Редактировать значения параметров схем профилей юр. лица
-
SetEntityProfileValue - Обновить значения параметров схем профилей юр. лица
-
GetEntityProfileClassesByProfileId - Получить список схем профиля юр.лица
-
GetEntityProfileValuesByClassId - Получить список параметров схемы профиля юр. лица
-
GetEntityProfileValueByClassIdAndKey - Получить параметр схемы профиля юр. лица по ключу
Подключение ТД через сети сторонних операторов (OTT)
-
CreateOttStation - Создать станцию OTT (конфигурацию OTT ESR)
-
UpdateOttStation - Редактировать отдельные параметры станций OTT
-
MergeOttStation - Получить все параметры OTT по ESR IP (комбинация параметров профиля и станции)
-
GetOttBlackList - Получить список записей черного списка OTT
-
IsLockedOttBlack - Проверить блокировку ТД по черному списку OTT
-
CapacityParam - Объект параметра емкости ESR по привязкам OTT
Взаимодействие со службой Eltex notification gateway
Прочие команды
-
GetClientStatistics - Получение статистики по клиенту SoftWLC
-
GetGlobalConfig - Получение глобальных настроек системы SoftWLC
-
DisconnectDomain - Разорвать все пользовательские сессии в домене
-
InvalidatePortalDatabaseCache - Сброс кэша базы данных ELTEX_PORTAL
-
GetAddressesListByKladr - Получение списка адресов по КЛАДР по городу, улице и номеру дома.
Описание объектов и атрибутов
-
PortalEditProperties - Параметры редактирования виртуального портала
-
NbiRadiusUsersFlatArray - Список пользователей wi-fi по таблице radstat.
-
NbiRadiusUsersStatCounters - Показатели статистики по пользователям.
-
NbiRadiusItemGraphArray - Массив объектов данных по графику, списку
-
NbiRadiusItemGraphSingle - Объект данных по графику, списку величин
-
NbiLocationSubnetProfile - Объект, описывающий профиль PCRF-подсети
-
NbiServiceProfile - Профиль сервиса для конкретного пользователя
-
NbiLightRadiusUserArray - Массив основных данных Wi-Fi пользователя
-
NbiLightUser - Содержит основные данные о Wi-Fi пользователе
-
NbiTopActiveUsersArray - Список пользователей c информацией по трафику
-
NbiActiveUser - Данные пользователя и статистика по его трафику
-
NbiGeoApListItem - Объект Точки доступа (eltex_ems.ELTEX_OBJ_GEO)
-
NbiGeoApList - Список Точек доступа (eltex_ems.ELTEX_OBJ_GEO)
-
GetGeoObjectListRequest - Условия выборки Точек доступа (eltex_ems.ELTEX_OBJ_GEO)
-
CommonKladrAddress - Контейнер с общей структурой ответа от КЛАДР
-
AvailablePortalCountryCodes - Допустимые коды стран для редактирования параметров портала
-
NbiDomainSsidTypeStatisticItem - Описание объекта статистики по домену
-
NbiDomainIntegralStatus - Интегральный статус узла дерева объектов
-
NbiSsidLinkExtended - Объект привязки SSID’а с расширенными параметрами
-
ProfileValueItem - параметр схемы профиля юр. лица с идентификатором схемы
-
ProfileValueArray - список параметров схемы профиля юр. лица