Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Введение, SoapUI

  1. Управление пользователями

  2. Управление сервисами

  3. Управление тарифами

  4. Управление доменами

  5. Управление SSID

  6. Управление устройствами

  7. Управление виртуальными порталами

  8. Управление системными пользователями

  9. Интеграция с SSO

  10. Управление шейперами

  11. Управление сценариями

  12. Управление подсетями

  13. Управление VRF

  14. Статистика

  15. Управление СОРМ-2

  16. Управление списками URL

  17. Управление списками приложений

  18. Управление профилями юр. лиц

  19. Подключение ТД через сети сторонних операторов (OTT)

  20. Взаимодействие со службой Eltex notification gateway

  21. Взаимодействие со службой Eltex EMS

  22. Прочие команды

  23. Описание объектов и атрибутов

  24. Справка

  25. Настройка репликации статистики

Список команд

Управление пользователями

Управление сервисами

Управление тарифами

Управление доменами

Управление SSID

Управление устройствами

Управление виртуальными порталами

Управление системными пользователями

Интеграция с SSO

Управление шейперами

Управление сценариями

Управление подсетями

Управление VRF

Статистика

Управление СОРМ-2

СОРМ-3

Управление списками URL

Управление списками приложений

Управление профилями юр. лиц

Подключение ТД через сети сторонних операторов (OTT)

Взаимодействие со службой Eltex notification gateway

Взаимодействие со службой Eltex EMS

Прочие команды

Описание объектов и атрибутов

Справка

Настройка репликации статистики

Введение

Основные функции

  1. Интерфейс основан на протоколе SOAP/XML и создан для унификации доступа к базам данным, файловой системе, используемых компонентами SoftWLC.
    Как правило, когда нужен быстрый доступ к данным и оптимизация выборки, компонент обращается к ним напрямую.
    Если же нужно упростить доступ к одним и тем же данным из разных компонентов, используется NBI.

  2. С NBI взаимодействуют все основные компоненты SoftWLC: Личный кабинет, Конструктор порталов, Портал, EMS.

  3. Важной задачей NBI является возможность подключения к нему сторонних, вышестоящих OSS/BSS.
    Для третьих лиц NBI представляется ограниченным набором команд, которые можно использовать в своих целях.

  4. В состав NBI так же входит ПО для генерации сертификатов для TLS авторизации и веб-сервис для скачиваниях их по URL.

Тестирование в SoapUI

Для тестирования команд с машины оператора может быть использовано ПО SoapUI.

Инструкция:

  1. Запустить SoapUI.

  2. File - New SOAP project

  3. Initial WSDL: http://<IP>:<PORT8080>/axis2/services/RadiusNbiService?wsdl

  4. В дереве проектов кликнуть на имя проекта правой кнопкой и перейти в Show Project Veiw

  5. Перейти в WS-Security Configurations - Add a new Outgoing WSS Configuration, указать имя (например admin)

  6. На той же вкладке чуть ниже - Add a new WSS Entry - тип Username, указать Username: admin, Password: password (те, что были указаны при установке пакета eltex-auth-service-db), Password Type: PasswordText

  7. После этого можно запускать команды. Для проверки найти GetVersion в дереве команд (разворачивается под проектом в левой панели).
    Открыть двойным щелчком, в индивидуальном диалоге команды в нижнем левом углу кликнуть Auth, выбрать нужную конфигурацию Outgoing WSS.
    Заполнять Username, Password в этом диалоге уже не нужно.
    Запуск команды выполняет кнопкой с зеленой стрелкой - Submit request to URL.

Экранирование символов

При использовании JAVA API для взаимодействия с NBI, экранирование символов не требуется.
При использовании текстового варианта, например при работе в SoapUI, служебные символы XML нужно экранировать.

Список символов и их экранированных вариантов:

&   &amp;
"   &quot;
'   &apos;
<   &lt;
>   &gt;

Чтобы передать значение параметра AL’L<2>3"4&, в XML следует писать

AL&apos;L&lt;2&gt;3&quot;4&amp;

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddRadiusUserMac – Добавить привязку MAC-адреса к учетной записи пользователя услуги Wi-Fi

Общая информация

  1. Команда актуальна, начиная с версии 1.6

  2. expiresTime - дата, при достижении которой MAC-адрес устройства удаляется из базы данных MongoDB pcrf.macs, что делает невозможным прохождение MAC авторизации.

  3. sessionTimeout - время, в течение которого сессия считается открытой. Если с момента последнего пребывания устройства (MAC) в сети это время еще не прошло, то BRAS и Портал сразу активируют сервисы услуги без активации сервиса WELCOME. По историческим причинам параметр называется sessionTimeout и не изменено на openTimeout, чтобы не изменять API. В базе данных MongoDB pcrf.macs параметр хранится в поле open_timeout.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес устройства пользователя услуги Wi-Fi

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

expiresTime

Дата, при достижении которой MAC-адрес устройства отвязывается от учетной записи Wi-Fi клиента.

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

sessionTimeout

Время открытой сессии в секундах.

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:AddRadiusUserMac>
         <nbi:mac>aa:bb:cc:dd:ee:04</nbi:mac>
         <nbi:username>test</nbi:username>
         <nbi:domain>nsk.root</nbi:domain>
         <nbi:expiresTime>2018-01-01T00:00:00+07:00</nbi:expiresTime>
         <nbi:openTimeout>3600</nbi:openTimeout>
      </nbi:AddRadiusUserMac>
Ответ
      <ns:AddRadiusUserMacResponse">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail />
         </ns:return>
      </ns:AddRadiusUserMacResponse>
Код Описание ошибки

7

Не указан домен учетной записи пользователя.

8

Домен не удовлетворяет правилам FQDN.

10

Пользователь, выполняющий операцию, не имеет прав на указанный домен.

11

Такой учетной записи не существует.

20

Имя пользователя некорректно.

62

Указанный домен не зарегистрирован.

63

MAC-адрес не передан или не валиден

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateRadiusUser – Создание аккаунта Wi-Fi клиента в базе RADIUS

Общая информация

  1. Команда неактуальна, начиная с версии 1.18. Рекомендуется использовать CreateRadiusUserV2

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

tariffCode

Код тарифного плана. Может быть пустым. Если установлен, то новый пользователь будет принадлежать данному тарифному плану.

[a-zA-Z0-9 ]\{1,64}

Текст латинскими буквами и цифрами до 64-х символов

tlsCrtData

Исходные данные для генерации клиентского сертификата. Объект TlsCrtData. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации обязательным является только тег period, остальные могут быть заменены значениями по умолчанию.

attribute

Атрибуты пользователя, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserItemSingle

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://object.nbi.radius.eltex.org/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
   <soap:Header/>
   <soap:Body>
      <nbi:CreateRadiusUser>
         <nbi:username>username8</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:tariffCode>default</nbi:tariffCode>
         <nbi:tlsCrtData>
            <xsd:country>RU</xsd:country>
            <xsd:emailDomain>eltex.nsk.ru</xsd:emailDomain>
            <xsd:location>Novosibirsk</xsd:location>
            <xsd:organization>Eltex</xsd:organization>
            <xsd:organizationUnit>In-soft</xsd:organizationUnit>
            <xsd:period>365</xsd:period>
            <xsd:state>Novosibirsk</xsd:state>
         </nbi:tlsCrtData>
         <!--Zero or more repetitions:-->
         <nbi:attribute>
            <xsd1:name>Operator-Name</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>Денис</xsd1:value>
         </nbi:attribute>
         <nbi:attribute>
            <xsd1:name>Operator-Family</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>Владимиров</xsd1:value>
         </nbi:attribute>
         <nbi:attribute>
            <xsd1:name>Cleartext-Password</xsd1:name>
            <xsd1:oper>:=</xsd1:oper>
            <xsd1:value>1234</xsd1:value>
            </nbi:attribute>
         <nbi:attribute>
            <xsd1:name>Eltex-User-Category</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>hotspot</xsd1:value>
            </nbi:attribute>
      </nbi:CreateRadiusUser>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:CreateRadiusUserResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiCodeRadiusUserItemSingleResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiRadiusUserItemSingle">
               <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/username8.zip</ax22:clientCrtLink>
               <ax22:domain>root</ax22:domain>
               <ax22:name>username8</ax22:name>
               <ax22:password>1234</ax22:password>
               <ax22:tariffCode>default</ax22:tariffCode>
               <ax22:check xsi:type="ax22:NbiAttrArray">
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Cleartext-Password</ax22:name>
                     <ax22:oper>:=</ax22:oper>
                     <ax22:value>1234</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>TLS-Client-Cert-Serial</ax22:name>
                     <ax22:oper>:=</ax22:oper>
                     <ax22:value>0123</ax22:value>
                  </ax22:attr>
               </ax22:check>
               <ax22:common xsi:type="ax22:NbiAttrArray">
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Operator-Name</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>Денис</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Operator-Family</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>Владимиров</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Eltex-User-Category</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>hotspot</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Operator-Creator-Name</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>N</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Operator-Creator-Family</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>A</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Operator-Creator-Phone</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>79134445566</ax22:value>
                  </ax22:attr>
               </ax22:common>
               <ax22:reply xsi:type="ax22:NbiAttrArray">
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Eltex-User-Create-Date</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>2020-06-10 15:58:21</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Eltex-User-State</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>1</ax22:value>
                  </ax22:attr>
                  <ax22:attr xsi:type="ax22:NbiAttr">
                     <ax22:name>Eltex-State-Begin-Date</ax22:name>
                     <ax22:oper>=</ax22:oper>
                     <ax22:value>1591779501</ax22:value>
                  </ax22:attr>
               </ax22:reply>
               <ax22:verificationWay xsi:nil="true"/>
            </ax22:response>
         </ns:return>
      </ns:CreateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен клиента

19

Данный аккаунт уже существует

20

Имя пользователя некорректно

21

Отсутствуют атрибуты

22

Атрибут некорректный или отсутствует

23

Нельзя редактировать зарезервированный атрибут

24

Отсутствует оператор атрибута пользователя

25

Такого оператора '=:' атрибута пользователя не существует

26

Некорректный оператор для атрибута пользователя

28

Отсутствует обязательный атрибут пользователя

62

Домен не зарегистрирован

75

Некорректное значение для объекта TlsCrtData

76

Ошибка создания клиентского сертификата

100

Тарифного плана с таким кодом не существует

101

Код тарифного плана некорректен

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateRadiusUserV2 – Создание аккаунта Wi-Fi клиента в базе RADIUS V2

Общая информация

  1. Команда актуальна, начиная с версии 1.18

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

tariffCode

Код тарифного плана. Может быть пустым. Если установлен, то новый пользователь будет принадлежать данному тарифному плану.

[a-zA-Z0-9 ]\{1,64}

Текст латинскими буквами и цифрами до 64-х символов

certificateSubjectInfo

Исходные данные для генерации клиентского сертификата. Объект CertificateSubjectInfo. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации сертификата должны быть заполнены все теги объекта. При отсутствии обязательного тега создание пользователя не происходит.

attribute

Атрибуты пользователя, ожидается один или больше объект. При условии создания сертификата,если в запросе не будут указаны атрибуты соответствующие полям certSubjectInfo, то атрибуты для создания пользователя проставятся из данных объекта certSubjectInfo. NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserItemSingle

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://tls.object.nbi.radius.eltex.org/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:CreateRadiusUserV2>
         <nbi:username>username</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:tariffCode>default</nbi:tariffCode>
         <nbi:certificateSubjectInfo>
            <xsd:country>RU</xsd:country>
            <xsd:email>usermail@mail.ru</xsd:email>
            <xsd:location>Novosibirsk</xsd:location>
            <xsd:organization>Eltex-In-Soft</xsd:organization>
            <xsd:organizationUnit>SoftWLC.Core</xsd:organizationUnit>
            <xsd:period>365</xsd:period>
            <xsd:state>Novosibirsk Oblast</xsd:state>
         </nbi:certificateSubjectInfo>
         <nbi:attribute>
            <xsd1:name>Eltex-User-Category</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>enterprise</xsd1:value>
         </nbi:attribute>
         <nbi:attribute>
            <xsd1:name>Cleartext-Password</xsd1:name>
            <xsd1:oper>:=</xsd1:oper>
            <xsd1:value>pass</xsd1:value>
         </nbi:attribute>
      </nbi:CreateRadiusUserV2>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:CreateRadiusUserV2Response xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
               <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/username/root.zip</ax21:clientCrtLink>
               <ax21:domain>root</ax21:domain>
               <ax21:name>username</ax21:name>
               <ax21:password>pass</ax21:password>
               <ax21:tariffCode>default</ax21:tariffCode>
               <ax21:check xsi:type="ax21:NbiAttrArray">
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Cleartext-Password</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>pass</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>d9</ax21:value>
                  </ax21:attr>
               </ax21:check>
               <ax21:common xsi:type="ax21:NbiAttrArray">
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-User-Category</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>enterprise</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Organization</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>Eltex-In-Soft</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Division</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>SoftWLC.Core</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Email</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>usermail@mail.ru</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Country</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>RU</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-State</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>Novosibirsk Oblast</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Location</ax21:name>
                     <ax21:oper>:=</ax21:oper>
                     <ax21:value>Novosibirsk</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Creator-Name</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value/>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Creator-Family</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value/>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Operator-Creator-Phone</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value/>
                  </ax21:attr>
               </ax21:common>
               <ax21:reply xsi:type="ax21:NbiAttrArray">
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-User-Create-Date</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>2020-09-30 09:44:04</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-User-State</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>1</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-State-Begin-Date</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>1601433844</ax21:value>
                  </ax21:attr>
               </ax21:reply>
               <ax21:verificationWay xsi:nil="true"/>
            </ax21:response>
         </ns:return>
      </ns:CreateRadiusUserV2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен клиента

19

Данный аккаунт уже существует

20

Имя пользователя некорректно

21

Отсутствуют атрибуты

22

Атрибут некорректный или отсутствует

23

Нельзя редактировать зарезервированный атрибут

24

Отсутствует оператор атрибута пользователя

25

Такого оператора '=:' атрибута пользователя не существует

26

Некорректный оператор для атрибута пользователя

28

Отсутствует обязательный атрибут пользователя

62

Домен не зарегистрирован

75

Некорректное значение для объекта CertificateSubjectInfo

76

Ошибка создания клиентского сертификата

100

Тарифного плана с таким кодом не существует

101

Код тарифного плана некорректен

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

488

У роли нет прав на метод

509

Некорректное значение срока действия сертификата.

510

Отсутствует обязательный параметр для сертификата (organization, organizationUnit, email, country, state, location).

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeactivateRadiusUser – Деактивация аккаунта Wi-Fi клиента в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

deactivate

Флаг, если выставлен в 'true', значит пользователя нужно деактивировать. Если 'false', то пользователь активируется.

.*

Текст, если равен 'true' (не зависимо от регистра), значит флаг выставлен в true. Если пустое значение, флаг считается выставленным в true. Иначе - false.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

11

Данного аккаунта не существует
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username>test</xsd:username>
         <xsd:domain>wifi.root</xsd:domain>
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>11</ns:code>
            <ns:detail>No radius user tes[wifi.root] on RADIUS server</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

20

Имя пользователя некорректно.
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username />
         <xsd:domain>wifi.root</xsd:domain>
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>20</ns:code>
            <ns:detail>Incorrect field 'username'</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username>test</xsd:username>
         <xsd:domain />
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>8</ns:code>
            <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен пользователя
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username>test</xsd:username>
         <xsd:domain>wifi</xsd:domain>
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>10</ns:code>
            <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username>test</xsd:username>
         <xsd:domain>test1.root</xsd:domain>
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>62</ns:code>
            <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>18</ns:code>
            <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>3</ns:code>
            <ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:DeactivateRadiusUser>
         <xsd:username>test</xsd:username>
         <xsd:domain>wifi.root</xsd:domain>
         <xsd:deactivate>true</xsd:deactivate>
      </xsd:DeactivateRadiusUser>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>0</ns:code>
            <ns:detail />
         </ns:return>
      </ns:DeactivateRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация – Временная деактивация аккаунта Wi-Fi клиента в базе RADIUS

  1. Команда актуальна, начиная с версии 1.9

  2. Если необходимо деактивировать пользователя до времени deactivationStopTime, выставлять флаг deactivate в значение true не нужно

  3. Параметр deactivationStopTime, имеющий значение времени ранее времени авторизации, не имеет эффекта.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

deactivate

Флаг, если выставлен в true, значит пользователя нужно деактивировать. Если 'false', то пользователь активируется.

.*

Текст, если равен true (не зависимо от регистра), значит флаг выставлен в true. Если пустое значение, флаг считается выставленным в true. Иначе - false.

deactivationStopTime

Время окончания деактивации.

.*

Время по стандарту "ISO 8601" в формате yyyy-MM-ddTHH:mm:ss±HH:MM, например 2008-11-15T22:52:58+03:00

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DeactivateRadiusUserTemporarily>
         <nbi:username>79123456789</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:deactivate>false</nbi:deactivate>
         <nbi:deactivationStopTime>2018-01-31T09:42:41Z</nbi:deactivationStopTime>
      </nbi:DeactivateRadiusUserTemporarily>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeactivateRadiusUserTemporarilyResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiResponse"
         xmlns:ax219="http://statistics.object.nbi.radius.eltex.org/xsd"
         xmlns:ax216="http://statistic.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax239="http://scripts.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:ax248="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax245="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax224="http://sorm3.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax268="http://ott.object.nbi.radius.eltex.org/xsd"
         xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
         xmlns:ax221="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax26="http://radiusUser.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax242="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax264="http://geo.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax261="http://topactiveusers.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax21="http://authService.object.nbi.radius.eltex.org/xsd"
         xmlns:ax227="http://apList.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax214="http://request.object.nbi.radius.eltex.org/xsd"
         xmlns:ax236="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax258="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax211="http://tariff.object.nbi.radius.eltex.org/xsd"
         xmlns:ax233="http://locationHistory.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax255="http://sorm2.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax230="http://domains.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax251="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax273="http://service.response.object.nbi.radius.eltex.org/xsd"
         xmlns:ax270="http://profile.object.nbi.radius.eltex.org/xsd">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:DeactivateRadiusUserTemporarilyResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditRadiusUserDomain – Изменить домен аккаунта Wi-Fi клиента в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Проверка существования старого домена не выполняется.

  3. Проверка существования нового домена выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

newDomain

Новый домен клиента.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://nbi.radius.eltex.org">
   <soapenv:Header />
   <soapenv:Body>
      <xsd:EditRadiusUserDomain>
         <xsd:username>client</xsd:username>
         <xsd:domain>enterprise.root</xsd:domain>
         <xsd:newDomain>hotspot.root</xsd:newDomain>
      </xsd:EditRadiusUserDomain>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:EditRadiusUserDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
         <ns:return>
            <ns:code>0</ns:code>
            <ns:detail />
         </ns:return>
      </ns:EditRadiusUserDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

11

Такого пользователя RADIUS не существует

20

Некорректное поле username (отсутствует)

62

Несуществующий домен

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditRadiusUser – Редактирование аккаунта Wi-Fi клиента в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Проверка существования домена не выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

params

Атрибуты пользователя, ожидается один или больше объект NbiAttr. Если значение атрибута выставлено в null (xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"), то он будет удален.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soap:Header/>
   <soap:Body>
      <nbi:EditRadiusUser>
         <nbi:username>test</nbi:username>
         <nbi:domain>wifi.root</nbi:domain>
         <nbi:attributes>
            <xsd:name>Cleartext-Password</xsd:name>
            <xsd:oper>:=</xsd:oper>
            <xsd:value>123</xsd:value>
         </nbi:attributes>
      </nbi:EditRadiusUser>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:EditRadiusUserResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

11

Такого пользователя RADIUS не существует

20

Некорректное поле username (отсутствует)

21

Нет ожидаемых атрибутов пользователя

22

Имя атрибута пользователя некорректно или отсутствует

24

Некорректный оператор атрибута пользователя

25

Такого оператора атрибута пользователя не существует

26

Атрибут пользователя не содержит оператора

27

Некорректное значение для атрибута

123

Нет таких атрибутов в аккаунте пользователя

427

Списка с таким именем и доменом не существует

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

445

Атрибут нередактируемый

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUser – Генерация пользователей Wi-Fi в базе RADIUS

Общая информация

  1. Команда неактуальна, начиная с версии 1.18. Рекомендуется использовать GenerateRadiusUserV2

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество генерируемых клиентов.

\d*

Число.

domain

Домен генерируемых клиентов. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

namelength

Длина генерируемых логинов.

\d*

Число.

passwordLength

Длина генерируемых паролей.

\d*

Число.

tariffCode

Код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану.

.{0,64}

Текст.

tlsCrtData

Исходные данные для генерации клиентского сертификата. Объект TlsCrtData. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации обязательным является только тег period, остальные могут быть заменены значениями по умолчанию.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:GenerateRadiusUser>
            <xsd:count>3</xsd:count>
            <xsd:domain>test.root</xsd:domain>
            <xsd:nameLength>10</xsd:nameLength>
            <xsd:passwordLength>7</xsd:passwordLength>
            <xsd:tariffCode></xsd:tariffCode>
            <xsd:tlsCrtData>
                <xsd3:country>RU</xsd3:country>
                <xsd3:emailDomain>gmail.com</xsd3:emailDomain>
                <xsd3:location>Moscow</xsd3:location>
                <xsd3:organization>Organization</xsd3:organization>
                <xsd3:organizationUnit>IT</xsd3:organizationUnit>
                <xsd3:period>365</xsd3:period>
                <xsd3:state>Moscow</xsd3:state>
            </xsd:tlsCrtData>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name>Eltex-User-Deactivated</xsd1:name>
                <xsd1:oper>==</xsd1:oper>
                <xsd1:value>true</xsd1:value>
            </xsd:attributes>
        </xsd:GenerateRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GenerateRadiusUserResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/qNmgNgyCTy</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>qNmgNgyCTy</ns:name>
                        <ns:password>vBKBTZwhpU</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/xsCrttVhQm</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>xsCrttVhQm</ns:name>
                        <ns:password>VvIEAUIHiH</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/xvdbPamcRF</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>xvdbPamcRF</ns:name>
                        <ns:password>rnzoXXNWDO</ns:password>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:GenerateRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта TlsCrtData

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUserV2 – Генерация пользователей Wi-Fi в базе RADIUS V2

Общая информация

  1. Команда актуальна, начиная с версии 1.18

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество генерируемых клиентов.

\d*

Число.

domain

Домен генерируемых клиентов. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

namelength

Длина генерируемых логинов.

\d*

Число.

passwordLength

Длина генерируемых паролей.

\d*

Число.

tariffCode

Код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану.

.{0,64}

Текст.

certificateSubjectInfo

Исходные данные для генерации клиентского сертификата. Объект CertificateSubjectInfo. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации сертификата должны быть заполнены все теги объекта. При отсутствии обязательного тега создание пользователя не происходит.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://tls.object.nbi.radius.eltex.org/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GenerateRadiusUserV2>
         <nbi:count>1</nbi:count>
         <nbi:domain>root</nbi:domain>
         <nbi:nameLength>10</nbi:nameLength>
         <nbi:passwordLength>10</nbi:passwordLength>
         <nbi:tariffCode>default</nbi:tariffCode>
         <nbi:certificateSubjectInfo>
            <xsd:country>RU</xsd:country>
            <xsd:email>test@mail.ru</xsd:email>
            <xsd:location>Novosibirsk</xsd:location>
            <xsd:organization>Eltex</xsd:organization>
            <xsd:organizationUnit>SoftWLC.Core</xsd:organizationUnit>
            <xsd:period>10</xsd:period>
            <xsd:state>Novosibirsk Oblast</xsd:state>
         </nbi:certificateSubjectInfo>
         <nbi:attributes>
            <xsd1:name>Eltex-User-Category</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>enterprise</xsd1:value>
         </nbi:attributes>
         <xsd:attributes>
            <xsd1:name>Eltex-User-Deactivated</xsd1:name>
            <xsd1:oper>==</xsd1:oper>
            <xsd1:value>true</xsd1:value>
         </xsd:attributes>
      </nbi:GenerateRadiusUserV2>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GenerateRadiusUserV2Response xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiCodeRadiusUserGItemResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiRadiusUserGItemArray">
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/yhrvaaeaaf/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>SoftWLC.Core</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>test@mail.ru</ax22:email>
                  <ax22:location>Novosibirsk</ax22:location>
                  <ax22:name>yhrvaaeaaf</ax22:name>
                  <ax22:organization>Eltex</ax22:organization>
                  <ax22:password>uJBbDdvSCS</ax22:password>
                  <ax22:state>Novosibirsk Oblast</ax22:state>
               </ax22:item>
            </ax22:response>
         </ns:return>
      </ns:GenerateRadiusUserV2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта CertificateSubjectInfo

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

509

Некорректное значение срока действия сертификата.

510

Отсутствует обязательный параметр для сертификата (organization, organizationUnit, email, country, state, location).

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUserNew – Генерация пользователей Wi-Fi в базе RADIUS

Общая информация

  1. Команда неактуальна, начиная с версии 1.18. Рекомендуется использовать GenerateRadiusNewV2

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество генерируемых клиентов.

\d*

Число.

domain

Домен генерируемых клиентов. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

namelength

Длина генерируемых логинов.

\d*

Число.

passwordLength

Длина генерируемых паролей.

\d*

Число.

passworDigit

Использовать для генерации паролей только цифры - true, использовать буквы - false или пустое.

^(true|false|)$

true, false или пустое значение.

tariffCode

Код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану.

.{0,64}

Текст.

tlsCrtData

Исходные данные для генерации клиентского сертификата. Объект TlsCrtData. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации обязательным является только тег period, остальные могут быть заменены значениями по умолчанию.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:GenerateRadiusUser>
            <xsd:count>3</xsd:count>
            <xsd:domain>test.root</xsd:domain>
            <xsd:nameLength>10</xsd:nameLength>
            <xsd:passwordLength>7</xsd:passwordLength>
            <xsd:passwordDigit>false</xsd:passwordDigit>
            <xsd:tariffCode></xsd:tariffCode>
            <xsd:tlsCrtData>
                <xsd3:country>RU</xsd3:country>
                <xsd3:emailDomain>gmail.com</xsd3:emailDomain>
                <xsd3:location>Moscow</xsd3:location>
                <xsd3:organization>Organization</xsd3:organization>
                <xsd3:organizationUnit>IT</xsd3:organizationUnit>
                <xsd3:period>365</xsd3:period>
                <xsd3:state>Moscow</xsd3:state>
            </xsd:tlsCrtData>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name>Eltex-User-Deactivated</xsd1:name>
                <xsd1:oper>==</xsd1:oper>
                <xsd1:value>true</xsd1:value>
            </xsd:attributes>
        </xsd:GenerateRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GenerateRadiusUserResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/qNmgNgyCTy</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>qNmgNgyCTy</ns:name>
                        <ns:password>vBKBTZwhpU</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/xsCrttVhQm</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>xsCrttVhQm</ns:name>
                        <ns:password>VvIEAUIHiH</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/xvdbPamcRF</ns:clientCrtLink>
                        <ns:domain>msc .root</ns:domain>
                        <ns:name>xvdbPamcRF</ns:name>
                        <ns:password>rnzoXXNWDO</ns:password>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:GenerateRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта TlsCrtData

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUserNewV2 – Генерация пользователей Wi-Fi в базе RADIUS V2

Общая информация

  1. Команда актуальна, начиная с версии 1.18

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество генерируемых клиентов.

\d*

Число.

domain

Домен генерируемых клиентов. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

namelength

Длина генерируемых логинов.

\d*

Число.

passwordLength

Длина генерируемых паролей.

\d*

Число.

passworDigit

Использовать для генерации паролей только цифры - true, использовать буквы - false или пустое.

^(true|false|)$

true, false или пустое значение.

tariffCode

Код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану.

.{0,64}

Текст.

certificateSubjectInfo

Исходные данные для генерации клиентского сертификата. Объект CertificateSubjectInfo. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации сертификата должны быть заполнены все теги объекта. При отсутствии обязательного тега создание пользователя не происходит.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://tls.object.nbi.radius.eltex.org/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GenerateRadiusUserNewV2>
         <nbi:count>2</nbi:count>
         <nbi:domain>root</nbi:domain>
         <nbi:nameLength>10</nbi:nameLength>
         <nbi:passwordLength>10</nbi:passwordLength>
         <nbi:passwordDigit>true</nbi:passwordDigit>
         <nbi:tariffCode>default</nbi:tariffCode>
         <nbi:certificateSubjectInfo>
            <xsd:country>RU</xsd:country>
            <xsd:email>test@mail.ru</xsd:email>
            <xsd:location>Novosibirsk</xsd:location>
            <xsd:organization>Eltex</xsd:organization>
            <xsd:organizationUnit>SoftWLC.Core</xsd:organizationUnit>
            <xsd:period>10</xsd:period>
            <xsd:state>Novosibirsk Oblast</xsd:state>
         </nbi:certificateSubjectInfo>
         <nbi:attributes>
            <xsd1:name>Eltex-User-Category</xsd1:name>
            <xsd1:oper>=</xsd1:oper>
            <xsd1:value>enterprise</xsd1:value>
         </nbi:attributes>
         <xsd:attributes>
            <xsd1:name>Eltex-User-Deactivated</xsd1:name>
            <xsd1:oper>==</xsd1:oper>
            <xsd1:value>true</xsd1:value>
         </xsd:attributes>
      </nbi:GenerateRadiusUserNewV2>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GenerateRadiusUserNewV2Response xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiCodeRadiusUserGItemResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiRadiusUserGItemArray">
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/jtejaxsirl/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>SoftWLC.Core</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>test@mail.ru</ax22:email>
                  <ax22:location>Novosibirsk</ax22:location>
                  <ax22:name>jtejaxsirl</ax22:name>
                  <ax22:organization>Eltex</ax22:organization>
                  <ax22:password>3980875755</ax22:password>
                  <ax22:state>Novosibirsk Oblast</ax22:state>
               </ax22:item>
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/gokcyhxaqw/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>SoftWLC.Core</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>test@mail.ru</ax22:email>
                  <ax22:location>Novosibirsk</ax22:location>
                  <ax22:name>gokcyhxaqw</ax22:name>
                  <ax22:organization>Eltex</ax22:organization>
                  <ax22:password>1261575798</ax22:password>
                  <ax22:state>Novosibirsk Oblast</ax22:state>
               </ax22:item>
            </ax22:response>
         </ns:return>
      </ns:GenerateRadiusUserNewV2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта CertificateSubjectInfo

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

509

Некорректное значение срока действия сертификата.

510

Отсутствует обязательный параметр для сертификата (organization, organizationUnit, email, country, state, location).

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUserByAttributes – Генерация пользователей Wi-Fi в базе RADIUS со списком дополнительных параметров

Общая информация

  1. Команда неактуальна, начиная с версии 1.18. Рекомендуется использовать GenerateRadiusUserByAttributesV2

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

genAttributes

Параметры для генерации пользователей NbiParameterArray.

tlsCrtData

Исходные данные для генерации клиентского сертификата. Объект TlsCrtData. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации обязательным является только тег period, остальные могут быть заменены значениями по умолчанию.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

В качестве параметров генерации пользователей можно указывать:

  • userNameLength - длина генерируемых логинов;
    обязательный параметр;

  • userNameType - регулярное выражение, содержащее список символов из которых будут случайно генерироваться логины;
    обязательный параметр;

  • passwordLength - длина генерируемых паролей;
    обязательный параметр;

  • passwordType - регулярное выражение, содержащее список символов из которых будут случайно генерироваться пароли;
    обязательный параметр;

  • code - код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану;
    по умолчанию пустое значение;

  • count - количество генерируемых клиентов;
    обязательный параметр;

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:GenerateRadiusUserByAttributes>
            <nbi:genAttributes>
                <xsd:parameter>
                   <xsd:name>userNameLength</xsd:name>
                   <xsd:value>10</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>passwordLength</xsd:name>
                   <xsd:value>7</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>userNameType</xsd:name>
                   <xsd:value>[0-9]</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>passwordType</xsd:name>
                   <xsd:value>[0-9]</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>count</xsd:name>
                   <xsd:value>3</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>domain</xsd:name>
                   <xsd:value>test.root</xsd:value>
                </xsd:parameter>
            </nbi:genAttributes>
            <xsd:tlsCrtData>
                <xsd3:country>RU</xsd3:country>
                <xsd3:emailDomain>gmail.com</xsd3:emailDomain>
                <xsd3:location>Moscow</xsd3:location>
                <xsd3:organization>Organization</xsd3:organization>
                <xsd3:organizationUnit>IT</xsd3:organizationUnit>
                <xsd3:period>365</xsd3:period>
                <xsd3:state>Moscow</xsd3:state>
            </xsd:tlsCrtData>
            <!--1 or more repetitions:-->
            <nbi:attributes>
                <xsd:name>Eltex-User-Deactivated</xsd:name>
                <xsd:oper>==</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Eltex-User-Category</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>voucher</xsd:value>
            </nbi:attributes>
        </xsd:GenerateRadiusUserByAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GenerateRadiusUserByAttributesResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/7575861395</ns:clientCrtLink>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>7575861395</ns:name>
                        <ns:password>2597841</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/4846538602</ns:clientCrtLink>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>4846538602</ns:name>
                        <ns:password>4966076</ns:password>
                    </ns:item>
                    <ns:item>
                        <ns:clientCrtLink>http://1.1.1.1:8080/8426878867</ns:clientCrtLink>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>8426878867</ns:name>
                        <ns:password>0625670</ns:password>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:GenerateRadiusUserByAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта TlsCrtData

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

486

Не удается сгенерировать список символов по переданному регулярному выражению для логина пользователя

487

Не удается сгенерировать список символов по переданному регулярному выражению для пароля пользователя

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GenerateRadiusUserByAttributesV2 – Генерация пользователей Wi-Fi в базе RADIUS со списком дополнительных параметров V2

Общая информация

  1. Команда актуальна, начиная с версии 1.18

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

genAttributes

Параметры для генерации пользователей NbiParameterArray.

certSubjectInfo

Исходные данные для генерации клиентского сертификата. Объект CertificateSubjectInfo. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации сертификата должны быть заполнены все теги объекта. При отсутствии обязательного тега создание пользователя не происходит.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr.

В качестве параметров генерации пользователей можно указывать:

  • userNameLength - длина генерируемых логинов;
    обязательный параметр;

  • userNameType - регулярное выражение, содержащее список символов из которых будут случайно генерироваться логины;
    обязательный параметр;

  • passwordLength - длина генерируемых паролей;
    обязательный параметр;

  • passwordType - регулярное выражение, содержащее список символов из которых будут случайно генерироваться пароли;
    обязательный параметр;

  • code - код тарифного плана. Если указан, созданные пользователи будут принадлежать данному тарифному плану;
    по умолчанию пустое значение;

  • count - количество генерируемых клиентов;
    обязательный параметр;

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd" xmlns:xsd1="http://tls.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GenerateRadiusUserByAttributesV2>
            <nbi:genAttributes>
                <xsd:parameter>
                   <xsd:name>userNameLength</xsd:name>
                   <xsd:value>10</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>passwordLength</xsd:name>
                   <xsd:value>7</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>userNameType</xsd:name>
                   <xsd:value>[0-9]</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>passwordType</xsd:name>
                   <xsd:value>[0-9]</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>count</xsd:name>
                   <xsd:value>3</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                   <xsd:name>domain</xsd:name>
                   <xsd:value>root</xsd:value>
                </xsd:parameter>
            </nbi:genAttributes>
         <nbi:certificateSubjectInfo>
            <xsd1:country>RU</xsd1:country>
            <xsd1:email>TEST@mail.ru</xsd1:email>
            <xsd1:location>Loc</xsd1:location>
            <xsd1:organization>Org</xsd1:organization>
            <xsd1:organizationUnit>Uit</xsd1:organizationUnit>
            <xsd1:period>10</xsd1:period>
            <xsd1:state>state</xsd1:state>
         </nbi:certificateSubjectInfo>
         <nbi:attributes>
             <xsd:name>Eltex-User-Deactivated</xsd:name>
             <xsd:oper>==</xsd:oper>
             <xsd:value>true</xsd:value>
         </nbi:attributes>
         <nbi:attributes>
             <xsd:name>Eltex-User-Category</xsd:name>
             <xsd:oper>=</xsd:oper>
             <xsd:value>voucher</xsd:value>
            </nbi:attributes>
      </nbi:GenerateRadiusUserByAttributesV2>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GenerateRadiusUserByAttributesV2Response xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiCodeRadiusUserGItemResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiRadiusUserGItemArray">
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/6814420237/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>Uit</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>TEST@mail.ru</ax22:email>
                  <ax22:location>Loc</ax22:location>
                  <ax22:name>6814420237</ax22:name>
                  <ax22:organization>Org</ax22:organization>
                  <ax22:password>8621183</ax22:password>
                  <ax22:state>state</ax22:state>
               </ax22:item>
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/8927337468/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>Uit</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>TEST@mail.ru</ax22:email>
                  <ax22:location>Loc</ax22:location>
                  <ax22:name>8927337468</ax22:name>
                  <ax22:organization>Org</ax22:organization>
                  <ax22:password>8549728</ax22:password>
                  <ax22:state>state</ax22:state>
               </ax22:item>
               <ax22:item xsi:type="ax22:NbiRadiusUserGItem">
                  <ax22:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/8303419871/root.zip</ax22:clientCrtLink>
                  <ax22:country>RU</ax22:country>
                  <ax22:division>Uit</ax22:division>
                  <ax22:domain>root</ax22:domain>
                  <ax22:email>TEST@mail.ru</ax22:email>
                  <ax22:location>Loc</ax22:location>
                  <ax22:name>8303419871</ax22:name>
                  <ax22:organization>Org</ax22:organization>
                  <ax22:password>9253105</ax22:password>
                  <ax22:state>state</ax22:state>
               </ax22:item>
            </ax22:response>
         </ns:return>
      </ns:GenerateRadiusUserByAttributesV2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователей или на домен тарифного плана

56

Не указано количество генерируемых пользователей

7

Не указан домен генерируемых пользователей

57

Не указана длина имен генерируемых пользователей

58

Не указана длина генерируемых паролей пользователей

62

Домен пользователей не зарегистрирован

100

Тарифного плана с таким кодом не существует

22

Некорректное имя атрибута

23

Нельзя редактировать зарезервированный атрибут

24

Некорректный оператор

25

Оператора не существует

26

Атрибут не содержит данного оператора

27

Некорректное значение для атрибута

75

Некорректное значение для объекта CertificateSubjectInfo

76

Ошибка создания клиентского сертификата

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

486

Не удается сгенерировать список символов по переданному регулярному выражению для логина пользователя

487

Не удается сгенерировать список символов по переданному регулярному выражению для пароля пользователя

509

Некорректное значение срока действия сертификата.

510

Отсутствует обязательный параметр для сертификата (organization, organizationUnit, email, country, state, location).

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateUserTlsCertificateV2 – Создание клиентского сертификата Wi-Fi клиента V2

Общая информация

  1. Команда актуальна, начиная с версии 1.18

  2. В отличие от предыдущей версии для создания сертификата используются данные пользователя.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

oldDomain

Старый домен клиента. Используется для пересоздания сертификата в случае смены домена.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN. Может не присутствовать в запросе.

Domain

newDomain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

password

Пароль пользователя.

Текст буквами и цифрами от 4-x до 253-х символов

validityPeriod

Срок действия сертификата

Целое число от 1 до 3650

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserItemSingle

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:CreateUserTLSCertificateV2>
         <nbi:username>username</nbi:username>
         <nbi:oldDomain>oldDomain</nbi:oldDomain>
         <nbi:newDomain>newDomain</nbi:newDomain>
         <nbi:password>password</nbi:password>
         <nbi:validityPeriod>3650</nbi:validityPeriod>
      </nbi:CreateUserTLSCertificateV2>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:CreateUserTLSCertificateV2Response xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:CreateUserTLSCertificateV2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен клиента

11

Такого пользователя RADIUS username[domain] не существует

19

Данный аккаунт уже существует

20

Имя пользователя некорректно

21

Отсутствуют атрибуты

22

Атрибут некорректный или отсутствует

23

Нельзя редактировать зарезервированный атрибут

24

Отсутствует оператор атрибута пользователя

25

Такого оператора '=:' атрибута пользователя не существует

26

Некорректный оператор для атрибута пользователя

28

Отсутствует обязательный атрибут пользователя

62

Домен не зарегистрирован

75

Некорректное значение для объекта CertificateSubjectInfo

76

Ошибка создания клиентского сертификата

100

Тарифного плана с таким кодом не существует

101

Код тарифного плана некорректен

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

509

Некорректное значение срока действия сертификата.

510

Отсутствует обязательный параметр для сертификата (organization, organizationUnit, email, country, state, location).

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUserAttributes – Удаление атрибутов аккаунта Wi-Fi клиента в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. В команде, для удаления, можно использовать только атрибуты с флагом write=true. Также нельзя удалить обязательный атрибут "Cleartext-Password".

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

attribute

Названия атрибутов пользователя, которые необходимо удалить из аккаунта Wi-Fi клиента, ожидается один или больше элемент.

.*

Текст, любые символы

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain></nbi:domain>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '' does not conform to the rules FQDN</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен клиента
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>root</nbi:domain>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>ru</nbi:domain>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such 'ru' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

21

Отсутствуют атрибуты
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>21</ax21:code>
                <ax21:detail>No attributes in stored request!</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

22

Отсутствует имя атрибута
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute></nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>22</ax21:code>
                <ax21:detail>Incorrect attribute name!</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

23

Нельзя редактировать зарезервированный атрибут
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute>Eltex-User-Create-Date</nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>23</ax21:code>
                <ax21:detail>Attribute 'Eltex-User-Create-Date' can not be edited</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

122

Нельзя удалять обязательные атрибуты
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute>Cleartext-Password</nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>122</ax21:code>
                <ax21:detail>Can not remove mandatory attribute 'Cleartext-Password'</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

123

В учетной записи пользователя нет такого атрибута
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute>Called-Station-Id</nbi:attribute>
            <nbi:attribute>Calling-Station-Id</nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>123</ax21:code>
                <ax21:detail>No attribute 'Called-Station-Id' in account</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

11

Данного аккаунта не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute>Called-Station-Id</nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>11</ax21:code>
                <ax21:detail>No user 'test[enterprise.root]' in RADIUS server</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

20

Имя пользователя некорректно.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username></nbi:username>
            <nbi:domain></nbi:domain>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>20</ax21:code>
                <ax21:detail>Incorrect field 'username'</ax21:detail>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveRadiusUserAttributes>
            <nbi:username>test</nbi:username>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:attribute>Called-Station-Id</nbi:attribute>
            <nbi:attribute>Calling-Station-Id</nbi:attribute>
        </nbi:RemoveRadiusUserAttributes>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserAttributesResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:RemoveRadiusUserAttributesResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUserByDomain – Удаление группы аккаунтов Wi-Fi клиентов по домену из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен клиента.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

10

Домен роли не имеет прав на домен пользователя
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByDomain>
            <xsd:domain>root</xsd:domain>
        </xsd:RemoveRadiusUserByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByDomain>
            <xsd:domain>?</xsd:domain>
        </xsd:RemoveRadiusUserByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByDomain>
            <xsd:domain>spb.root</xsd:domain>
        </xsd:RemoveRadiusUserByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'spb.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

79

Ошибка при удалении сертификатов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByDomain>
            <xsd:domain>spb.root</xsd:domain>
        </xsd:RemoveRadiusUserByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>79</ns:code>
                <ns:detail>Failed to delete certificates for users</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByDomain>
            <xsd:domain>bolotnoe.nso.root</xsd:domain>
        </xsd:RemoveRadiusUserByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveRadiusUserByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUserByTariff – Удаление всех аккаунтов Wi-Fi, привязанных к тарифному плану

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffCode

Код тарифного плана

^.{1,64}$

Текст до 64-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByTariff>
            <xsd:tariffCode>code</xsd:tariffCode>
        </xsd:RemoveRadiusUserByTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>100</ns:code>
                <ns:detail>No Tariff with code 'code'</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

101

Код тарифного плана некорректен.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByTariff>
            <xsd:tariffCode></xsd:tariffCode>
        </xsd:RemoveRadiusUserByTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'tariffCode'</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

79

Ошибка при удалении сертификатов.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByTariff>
            <xsd:tariffCode>test1</xsd:tariffCode>
        </xsd:RemoveRadiusUserByTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>79</ns:code>
                <ns:detail>Failed to delete certificates for users</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByTariff>
            <xsd:tariffCode>red</xsd:tariffCode>
        </xsd:RemoveRadiusUserByTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to tariff domain: 'enterprise.root'. Role`s domains: 'hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserByTariff>
            <xsd:tariffCode>test1</xsd:tariffCode>
        </xsd:RemoveRadiusUserByTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserByTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail>Deleted 0 users.</ns:detail>
            </ns:return>
        </ns:RemoveRadiusUserByTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUserMac – Удалить привязку MAC-адреса устройства пользователя в домене

Общая информация

  1. Команда актуальна, начиная с версии 1.6

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес устройства пользователя услуги Wi-Fi

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ошибке или число удаленных записей БД в случае успеха

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:RemoveRadiusUserMac>
            <nbi:mac>aa:bb:cc:dd:ee:03</nbi:mac>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RemoveRadiusUserMac>
Ответ
        <ns:RemoveRadiusUserMacResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax22:detail>1</ax22:detail>
            </ns:return>
        </ns:RemoveRadiusUserMacResponse>
Код Описание ошибки

7

Не указан домен учетной записи пользователя.

8

Домен не удовлетворяет правилам FQDN.

10

Пользователь, выполняющий операцию, не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован.

63

MAC-адрес не передан или не валиден.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveMacsByRadiusUser – Получить полное описание пользователя со списком зарегистрированных MAC-адресов для УЗ

Общая информация

  1. Команда актуальна, начиная с версии 1.6

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserWithMac

Примеры команд и кодов

Код Описание ошибки

20

Имя пользователя некорректно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>йцу</nbi:username>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>20</ax21:code>
                <ax21:detail>Incorrect username</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан домен учетной записи пользователя.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>test</nbi:username>
            <nbi:domain></nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>7</ax21:code>
                <ax21:detail>In request by key 'domain' value is empty or null</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>test</nbi:username>
            <nbi:domain>123!</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '123!' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Указанный домен не зарегистрирован.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>test</nbi:username>
            <nbi:domain>ru</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ru' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь, выполняющий операцию, не имеет прав на указанный домен.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>test</nbi:username>
            <nbi:domain>root</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

11

Такого пользователя не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>tes</nbi:username>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>11</ax21:code>
                <ax21:detail>No such RADIUS user 'tes' [ 'nsk.root' ]</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveMacsByRadiusUser>
            <nbi:username>test</nbi:username>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveMacsByRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveMacsByRadiusUserResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiRadiusUserWithMacs">
                    <ax21:clientCrtLink/>
                    <ax21:domain>nsk.root</ax21:domain>
                    <ax21:name>test</ax21:name>
                    <ax21:password>123</ax21:password>
                    <ax21:tariffCode/>
                    <ax21:check xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Cleartext-Password</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>123</ax21:value>
                        </ax21:attr>
                    </ax21:check>
                    <ax21:common xsi:type="ax21:NbiAttrArray"/>
                    <ax21:reply xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-11-10 15:31:46</ax21:value>
                        </ax21:attr>
                    </ax21:reply>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:02.493+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:00</ax21:mac>
                    </ax21:mac>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:11.156+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:01</ax21:mac>
                    </ax21:mac>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:15.223+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:02</ax21:mac>
                    </ax21:mac>
                </ax21:response>
            </ns:return>
        </ns:RetrieveMacsByRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUser – Удаление аккаунта Wi-Fi клиента из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Удаляется Wi-Fi клиента из базы RADIUS и связанные с ним параметры из других хранилищ

Удаляемые сущности:

  • сам пользователь (MySQL radius);

  • сертификаты TLS, созданные для этого пользователя;

  • MAC адреса, отвечающие за узнавание пользователя на портале (MongoDB pcrf.macs);

  • персональные квоты по сервисам (MongoDB pcrf.service);

  • персональные данные о фазе сценария BRAS (MongoDB pcrf.scripts).

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:RemoveRadiusUser>
         <nbi:username>username8</nbi:username>
         <nbi:domain>Ap.root</nbi:domain>
      </nbi:RemoveRadiusUser>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RemoveRadiusUserResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax22:NbiResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:RemoveRadiusUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'domain'

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователя

20

Имя пользователя некорректно

62

Домен не зарегистрирован

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusAcctData – Запрос данных аккаунтинга для Wi-Fi пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин пользователя Wi-Fi. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

.*

Любой текст. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

Wi-Fi пользователь

domain

Поле для поиска по домену пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

userMac

Поле для поиска по MAC-адресу пользователя. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

.*

6 двузначных шестнадцатеричных чисел, разделенных ':' или '-'. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

nasIp

Поле для поиска по IP-адресу точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

.*

4 целых числа в диапазоне [0…​255] разделенных точкой. Может содержать спец-символы '%' (несколько произвольных символов) и '?' (один произвольный символ).

AP

workTime

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

nasDomain

Поле для поиска по домену точки доступа. Может быть пустым. Хотя бы одно поле поиска должно присутствовать.

(?=^.{0,235}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]\{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

AP

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAcct

Примеры команд и кодов

Код Описание ошибки

10

Домен роли не имеет прав на домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain>wifi</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

29

Все поля для поиска пусты
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username></xsd:username>
            <xsd:domain></xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>29</ns:code>
                <ns:detail>All fields for search is empty!</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusAcctData>
            <xsd:username>andrey</xsd:username>
            <xsd:domain>root</xsd:domain>
            <xsd:userMac></xsd:userMac>
            <xsd:nasIp></xsd:nasIp>
            <xsd:workTime></xsd:workTime>
            <xsd:nasDomain></xsd:nasDomain>
        </xsd:RetrieveRadiusAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:acct>
                        <ns:authentic>RADIUS</ns:authentic>
                        <ns:connectionInfoStart>CONNECT 0Mbps 802.11g</ns:connectionInfoStart>
                        <ns:connectionInfoStop>CONNECT 0Mbps 802.11g</ns:connectionInfoStop>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:framedAddress>192.168.41.25</ns:framedAddress>
                        <ns:framedProtocol/>
                        <ns:groupname/>
                        <ns:inputBytesDrop>0</ns:inputBytesDrop>
                        <ns:inputOctets>117432</ns:inputOctets>
                        <ns:inputPacketsDrop>0</ns:inputPacketsDrop>
                        <ns:nasDomain>root</ns:nasDomain>
                        <ns:nasIP>192.168.40.30</ns:nasIP>
                        <ns:nasMac>A8-F9-4B-B0-04-80:Eltex-Local</ns:nasMac>
                        <ns:nasPortId>0</ns:nasPortId>
                        <ns:nasPortType>Wireless-802.11</ns:nasPortType>
                        <ns:nasSecret>eltex</ns:nasSecret>
                        <ns:outputBytesDrop>0</ns:outputBytesDrop>
                        <ns:outputOctets>186991</ns:outputOctets>
                        <ns:outputPacketLost>0</ns:outputPacketLost>
                        <ns:outputPacketsDrop>0</ns:outputPacketsDrop>
                        <ns:realm>enterprise</ns:realm>
                        <ns:serviceType/>
                        <ns:sessionId>1A049FB9-5830074B</ns:sessionId>
                        <ns:sessionTime>67</ns:sessionTime>
                        <ns:startDelay>0</ns:startDelay>
                        <ns:startTime>2015-05-21T16:35:44.000+07:00</ns:startTime>
                        <ns:stopDelay>0</ns:stopDelay>
                        <ns:stopTime>2015-05-21T17:35:44.000+07:00</ns:stopTime>
                        <ns:terminateCause/>
                        <ns:uniqueId>6cd7f5179d688aa2</ns:uniqueId>
                        <ns:userMAC>74-DE-2B-FD-59-D9</ns:userMAC>
                        <ns:username>andrey</ns:username>
                        <ns:xascendSessionSvrKey/>
                    </ns:acct>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusOperList – Получить список операторов для атрибутов Wi-Fi пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

attr

Фильтр по имени атрибута Wi-Fi пользователей. Может отсутствовать.

.*

Текст.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiEntryDescr

Примеры команд и кодов

Код Описание ошибки

23

Нельзя редактировать зарезервированный атрибут
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusOperList>
            <xsd:attr>Eltex-User-Create-Date</xsd:attr>
        </xsd:RetrieveRadiusOperList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusOperListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>23</ns:code>
                <ns:detail>Attribute 'Eltex-User-Create-Date' can not be edited</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusOperListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusOperList>
            <xsd:attr></xsd:attr>
        </xsd:RetrieveRadiusOperList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusOperListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:entry>
                        <ns:descr>As a reply item, it means 'add the item to the reply list, but only if there is no other item of the same attribute.'</ns:descr>
                        <ns:entry>=</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>For check attributes: Replaces in the configuration items any attribute of the same name. If no attribute of that name appears in the request, then this attribute is added. For reply attributes: Replaces in the configuration items any attribute of the same name. If no attribute of that name appears in the reply, then this attribute is added.</ns:descr>
                        <ns:entry>:=</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the named attribute is present in the request, AND has the given value.</ns:descr>
                        <ns:entry>==</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>For check attributes: Adds the current attribute with value to the list of configuration items. For reply attributes: Adds the current attribute with value to the reply items.</ns:descr>
                        <ns:entry>+=</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, matches if the given attribute is in the request, AND does not have the given value.</ns:descr>
                        <ns:entry>!=</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute with a value greater than the one given.</ns:descr>
                        <ns:entry>></ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute with a value greater than, or equal to the one given.</ns:descr>
                        <ns:entry>>=</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute with a value less than the one given.</ns:descr>
                        <ns:entry><
                        </ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute with a value less than, or equal to the one given.</ns:descr>
                        <ns:entry><=
                        </ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute which matches the given regular expression. This operator may only be applied to string attributes.</ns:descr>
                        <ns:entry>=~</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains an attribute which does not match the given regular expression.</ns:descr>
                        <ns:entry>!~</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request contains the named attribute, no matter what the value is.</ns:descr>
                        <ns:entry>=*</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>As a check item, it matches if the request does not contain the named attribute, no matter what the value is.</ns:descr>
                        <ns:entry>!*</ns:entry>
                    </ns:entry>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusOperListResponse>
    </soapenv:Body>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserAcctData2 - Запрос данных аккаунтинга для Wi-Fi пользователя по имени, nas-ip и домену

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

userName

Имя устройства Wi-Fi пользователя.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

nasIp

NAS ip-адрес устройства Wi-Fi пользователя.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255] разделенных точкой.

domain

Домен устройства Wi-Fi пользователя.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username, domain, tariffCode или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAcct, объект NbiAcct с суммарными данными, общее число записей

Примеры команд и кодов

Код Описание ошибки

104

Некорректное значение поля nasIp
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData2>
            <xsd:userName>name1</xsd:userName>
            <xsd:nasIp>192.12.3</xsd:nasIp>
            <xsd:domain>root</xsd:domain>
            <xsd:timeStart></xsd:timeStart>
            <xsd:timeEnd></xsd:timeEnd>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </xsd:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse2
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>104</ns:code>
                <ns:detail>Illegal value '192.12.3' for field 'nasIp'!</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse2>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной период. timeStart больше timeEnd
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData2>
            <xsd:userName>name1</xsd:userName>
            <xsd:nasIp>192.12.3.4</xsd:nasIp>
            <xsd:domain>root</xsd:domain>
            <xsd:timeStart>2014-12-01T00:00:00+03:00</xsd:timeStart>
            <xsd:timeEnd>2014-11-01T00:00:00+03:00</xsd:timeEnd>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </xsd:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse2
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>107</ns:code>
                <ns:detail>Incorrect time period. Time start must be before time end.</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse2>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAcctData2>
            <nbi:domain></nbi:domain>
            <nbi:timeStart>2016-01-14T16:46:35</nbi:timeStart>
            <nbi:timeEnd>2016-03-15T16:46:35</nbi:timeEnd>
            <nbi:count>3</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserAcctData2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctData2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeAcctSummaryResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail>3 items from 3893</ax21:detail>
                <ax21:response xsi:type="ax21:NbiAcctArraySummary">
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>7088</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.203.243</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B1-64-21:Rostelecom for Rosbank</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>3627</ax21:outputOctets>
                        <ax21:outputPacketLost>0</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>02E124C7-5C7A8854</ax21:sessionId>
                        <ax21:sessionTime>50</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-15T14:15:14.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-15T14:16:04.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>41c0e5c87c1eafbf</ax21:uniqueId>
                        <ax21:userMAC>00-01-DA-FD-AD-C7</ax21:userMAC>
                        <ax21:username>0001dafdadc7</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>8322</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.207.59</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B3-0A-E1:Welcome to Sberbank Rostelecom</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>4579</ax21:outputOctets>
                        <ax21:outputPacketLost>3</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>5BD58A03-14636E26</ax21:sessionId>
                        <ax21:sessionTime>39</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-09T18:40:12.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-09T18:40:51.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>e1d4e7355a7d26fe</ax21:uniqueId>
                        <ax21:userMAC>00-03-AA-E3-DB-E1</ax21:userMAC>
                        <ax21:username>0003aae3dbe1</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:acct xsi:type="ax21:NbiAcct">
                        <ax21:authentic>Local</ax21:authentic>
                        <ax21:connectionInfoStart>CONNECT 0Mbps 802.11g</ax21:connectionInfoStart>
                        <ax21:connectionInfoStop>CONNECT 0Mbps 802.11g</ax21:connectionInfoStop>
                        <ax21:domain/>
                        <ax21:framedAddress/>
                        <ax21:framedProtocol/>
                        <ax21:groupname/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>2935</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP>192.168.207.59</ax21:nasIP>
                        <ax21:nasMac>A8-F9-4B-B3-0A-E1:Welcome to Sberbank Rostelecom</ax21:nasMac>
                        <ax21:nasPortId>0</ax21:nasPortId>
                        <ax21:nasPortType>Wireless-802.11</ax21:nasPortType>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>2502</ax21:outputOctets>
                        <ax21:outputPacketLost>2</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm/>
                        <ax21:serviceType/>
                        <ax21:sessionId>7E4CA96B-7F6A3F86</ax21:sessionId>
                        <ax21:sessionTime>15</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime>2016-02-09T18:45:15.000+06:00</ax21:startTime>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime>2016-02-09T18:45:30.000+06:00</ax21:stopTime>
                        <ax21:terminateCause>User-Request</ax21:terminateCause>
                        <ax21:uniqueId>56553180b5e4ee49</ax21:uniqueId>
                        <ax21:userMAC>00-03-AA-E3-DB-E1</ax21:userMAC>
                        <ax21:username>0003aae3dbe1</ax21:username>
                        <ax21:xascendSessionSvrKey/>
                    </ax21:acct>
                    <ax21:summary xsi:type="ax21:NbiAcct">
                        <ax21:authentic xsi:nil="true"/>
                        <ax21:connectionInfoStart xsi:nil="true"/>
                        <ax21:connectionInfoStop xsi:nil="true"/>
                        <ax21:domain xsi:nil="true"/>
                        <ax21:framedAddress xsi:nil="true"/>
                        <ax21:framedProtocol xsi:nil="true"/>
                        <ax21:groupname xsi:nil="true"/>
                        <ax21:inputBytesDrop>0</ax21:inputBytesDrop>
                        <ax21:inputOctets>58348250</ax21:inputOctets>
                        <ax21:inputPacketsDrop>0</ax21:inputPacketsDrop>
                        <ax21:nasDomain xsi:nil="true"/>
                        <ax21:nasIP xsi:nil="true"/>
                        <ax21:nasMac xsi:nil="true"/>
                        <ax21:nasPortId xsi:nil="true"/>
                        <ax21:nasPortType xsi:nil="true"/>
                        <ax21:nasSecret xsi:nil="true"/>
                        <ax21:outputBytesDrop>0</ax21:outputBytesDrop>
                        <ax21:outputOctets>63189776</ax21:outputOctets>
                        <ax21:outputPacketLost>91102</ax21:outputPacketLost>
                        <ax21:outputPacketsDrop>0</ax21:outputPacketsDrop>
                        <ax21:realm xsi:nil="true"/>
                        <ax21:serviceType xsi:nil="true"/>
                        <ax21:sessionId xsi:nil="true"/>
                        <ax21:sessionTime>513401215</ax21:sessionTime>
                        <ax21:startDelay>0</ax21:startDelay>
                        <ax21:startTime xsi:nil="true"/>
                        <ax21:stopDelay>0</ax21:stopDelay>
                        <ax21:stopTime xsi:nil="true"/>
                        <ax21:terminateCause xsi:nil="true"/>
                        <ax21:uniqueId xsi:nil="true"/>
                        <ax21:userMAC xsi:nil="true"/>
                        <ax21:username xsi:nil="true"/>
                        <ax21:xascendSessionSvrKey xsi:nil="true"/>
                    </ax21:summary>
                    <ax21:totalCount>3893</ax21:totalCount>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserAcctData2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserAcctData - Запрос данных аккаунтинга для Wi-Fi пользователя по ip-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

userIp

Адрес устройства Wi-Fi пользователя.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255] разделенных точкой.

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAcct

Примеры команд и кодов

Код Описание ошибки

104

Некорректное значение поля userIp
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData>
            <xsd:userIp>192.12.3</xsd:userIp>
            <xsd:timeStart></xsd:timeStart>
            <xsd:timeEnd></xsd:timeEnd>
        </xsd:RetrieveRadiusUserAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>104</ns:code>
                <ns:detail>Illegal value '192.12.3' for field 'userIp'!</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной период. timeStart больше timeEnd
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData>
            <xsd:userIp>100.12.3.3</xsd:userIp>
            <xsd:timeStart>2014-12-01T00:00:00+03:00</xsd:timeStart>
            <xsd:timeEnd>2014-11-01T00:00:00+03:00</xsd:timeEnd>
        </xsd:RetrieveRadiusUserAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>107</ns:code>
                <ns:detail>Incorrect time period. Time start must be before time end.</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUserAcctData>
            <xsd:userIp>100.16.1.16</xsd:userIp>
            <xsd:timeStart>2014-12-01T00:00:00+03:00</xsd:timeStart>
            <xsd:timeEnd></xsd:timeEnd>
        </xsd:RetrieveRadiusUserAcctData>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAcctDataResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail>1000 items from 163152</ns:detail>
                <ns:response>
                    <ns:acct>
                        <ns:authentic>RADIUS</ns:authentic>
                        <ns:connectionInfoStart>CONNECT 0Mbps 802.11g</ns:connectionInfoStart>
                        <ns:connectionInfoStop>CONNECT 0Mbps 802.11g</ns:connectionInfoStop>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:framedAddress>100.16.1.16</ns:framedAddress>
                        <ns:framedProtocol/>
                        <ns:groupname/>
                        <ns:inputBytesDrop>0</ns:inputBytesDrop>
                        <ns:inputOctets>0</ns:inputOctets>
                        <ns:inputPacketsDrop>0</ns:inputPacketsDrop>
                        <ns:nasDomain>root</ns:nasDomain>
                        <ns:nasIP>192.168.40.30</ns:nasIP>
                        <ns:nasMac>A8-F9-4B-B0-04-80:Eltex-Local</ns:nasMac>
                        <ns:nasPortId>0</ns:nasPortId>
                        <ns:nasPortType>Wireless-802.11</ns:nasPortType>
                        <ns:nasSecret>eltex</ns:nasSecret>
                        <ns:outputBytesDrop>0</ns:outputBytesDrop>
                        <ns:outputOctets>0</ns:outputOctets>
                        <ns:outputPacketLost>0</ns:outputPacketLost>
                        <ns:outputPacketsDrop>0</ns:outputPacketsDrop>
                        <ns:realm>enterprise</ns:realm>
                        <ns:serviceType/>
                        <ns:sessionId>1A049FB9-5830074B</ns:sessionId>
                        <ns:sessionTime>67</ns:sessionTime>
                        <ns:startDelay>0</ns:startDelay>
                        <ns:startTime>2014-11-30T14:18:57.000+03:00</ns:startTime>
                        <ns:stopDelay>0</ns:stopDelay>
                        <ns:stopTime>2014-12-01T17:35:44.000+07:00</ns:stopTime>
                        <ns:terminateCause/>
                        <ns:uniqueId>6cd7f5179d688aa2</ns:uniqueId>
                        <ns:userMAC>74-DE-2B-FD-59-D9</ns:userMAC>
                        <ns:username>victor.fedkovich</ns:username>
                        <ns:xascendSessionSvrKey/>
                    </ns:acct>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusUserAcctDataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserAttrList - Запрос списка атрибутов Wi-Fi пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiEntryDescr

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAttrListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:entry>
                        <ns:descr>The maximum number of simultaneous connections.</ns:descr>
                        <ns:entry>Simultaneous-Use</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Deactivating user allowable values 'true' or 'false'.</ns:descr>
                        <ns:entry>Eltex-User-Deactivated</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Summary incoming traffic limit for user, in bytes</ns:descr>
                        <ns:entry>Eltex-Traffic-Limit</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Summary work time limit for user, in seconds</ns:descr>
                        <ns:entry>Eltex-Work-Time-Limit</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>The user's password in clear text (for MD5, PEAP), no more than 253 characters.</ns:descr>
                        <ns:entry>Cleartext-Password</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>MAC-address of the device user, 6 two-digit hex-numbers separated by hyphens (-) or a colon (:).</ns:descr>
                        <ns:entry>Calling-Station-Id</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Enable / Disable SSID as a regular expression. Keep in mind that this attribute to the access point has the form «MAC: SSID», and if the set limit only SSID, the expression must start with '^. + [:].'</ns:descr>
                        <ns:entry>Called-Station-Id</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>WISPr vendor specific attributes for setting the maximum bandwidth rate in bits per second for downstream.</ns:descr>
                        <ns:entry>WISPr-Bandwidth-Max-Down</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>WISPr vendor specific attributes for setting the maximum bandwidth rate in bits per second for upstream.</ns:descr>
                        <ns:entry>WISPr-Bandwidth-Max-Up</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Policy profile for downstream, not more than 253 characters</ns:descr>
                        <ns:entry>LVL7-Wireless-Client-Policy-Down</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Policy profile for upstream, not more than 253 characters</ns:descr>
                        <ns:entry>LVL7-Wireless-Client-Policy-Up</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>The maximum session timeout.</ns:descr>
                        <ns:entry>Session-Timeout</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>For correct VLAN settings for the user, always put '13'.</ns:descr>
                        <ns:entry>Tunnel-Type</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>For correct VLAN settings for the user, always put '6'.</ns:descr>
                        <ns:entry>Tunnel-Medium-Type</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>VLAN ID for the subscriber.Permission is granted to only one ID. To set the VLAN attribute is also used Eltex-Additional-Vlans.</ns:descr>
                        <ns:entry>Tunnel-Private-Group-Id</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>VLAN IDs for the subscriber. IDs separated by commas (,). Allowed to 9 identifiers to the user.</ns:descr>
                        <ns:entry>Eltex-Additional-Vlans</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Reply message to the user, not more than 253 characters.</ns:descr>
                        <ns:entry>Reply-Message</ns:entry>
                    </ns:entry>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusUserAttrListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserByMac – Получить полное описание учетной записи по MAC-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.6

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес устройства пользователя услуги Wi-Fi

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

domain

Домен учетной записи пользователя услуги Wi-Fi

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserWithMac

Примеры команд и кодов

Код Описание ошибки

63

MAC-адрес не передан или не валиден
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>йцу</nbi:mac>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>63</ax21:code>
                <ax21:detail>Incorrect mac</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан домен учетной записи пользователя.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:12:22:11</nbi:mac>
            <nbi:domain></nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>7</ax21:code>
                <ax21:detail>In request by key 'domain' value is empty or null</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:12:22:11</nbi:mac>
            <nbi:domain>!qwe</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '!qwe' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Указанный домен не зарегистрирован.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:12:22:11</nbi:mac>
            <nbi:domain>ru</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ru' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь, выполняющий операцию, не имеет прав на указанный домен.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:12:22:11</nbi:mac>
            <nbi:domain>root</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

401

Данный MAC-адрес не привязан к учетным записям в данном домене
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:12:22:11</nbi:mac>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>401</ax21:code>
                <ax21:detail>No mac 'aa:bb:cc:12:22:11' in domain 'nsk.root'</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserByMac>
            <nbi:mac>aa:bb:cc:dd:ee:00</nbi:mac>
            <nbi:domain>nsk.root</nbi:domain>
        </nbi:RetrieveRadiusUserByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserWithMacsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiRadiusUserWithMacs">
                    <ax21:clientCrtLink/>
                    <ax21:domain>nsk.root</ax21:domain>
                    <ax21:name>test</ax21:name>
                    <ax21:password>123</ax21:password>
                    <ax21:tariffCode/>
                    <ax21:check xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Cleartext-Password</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>123</ax21:value>
                        </ax21:attr>
                    </ax21:check>
                    <ax21:common xsi:type="ax21:NbiAttrArray"/>
                    <ax21:reply xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-11-10 15:31:46</ax21:value>
                        </ax21:attr>
                    </ax21:reply>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:02.493+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:00</ax21:mac>
                    </ax21:mac>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:11.156+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:01</ax21:mac>
                    </ax21:mac>
                    <ax21:mac xsi:type="ax21:NbiMacExpiresInfo">
                        <ax21:expiresTime>2018-01-01T00:00:00.000+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-10T16:56:15.223+07:00</ax21:lastActivityTime>
                        <ax21:mac>aa:bb:cc:dd:ee:02</ax21:mac>
                    </ax21:mac>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUser – Получить все атрибуты аккаунта Wi-Fi клиента из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Проверка существования домена не выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserItemSingle

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRadiusUser>
            <xsd:username>test</xsd:username>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RetrieveRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/enterprise/test.zip</ns:clientCrtLink>
                    <ns:domain>enterprise.root</ns:domain>
                    <ns:name>test</ns:name>
                    <ns:password>123</ns:password>
                    <ns:tariffCode>white</ns:tariffCode>
                    <ns:check>
                        <ns:attr>
                            <ns:name>Cleartext-Password</ns:name>
                            <ns:oper>:=</ns:oper>
                            <ns:value>123</ns:value>
                        </ns:attr>
                    </ns:check>
                    <ns:reply>
                        <ns:attr>
                            <ns:name>Eltex-User-Create-Date</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>2015-11-09 15:38:55</ns:value>
                        </ns:attr>
                        <ns:attr>
                            <ns:name>Eltex-Traffic-Limit</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>67108864</ns:value>
                        </ns:attr>
                        <ns:attr>
                            <ns:name>Eltex-Work-Time-Limit</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>180</ns:value>
                        </ns:attr>
                    </ns:reply>
                </ns:response>
            </ns:return>
        </ns:RetrieveRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

11

Такого пользователя RADIUS не существует

20

Некорректное поле username (отсутствует)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserList – Запрос списка аккаунтов WiFi клиентов из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Не отдает информацию по дочерним доменам

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента, может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffCode

Фильтр по коду тарифного плана. Может отсутствовать.

^.{1,64}$

Текст до 64-х символов.

deactivated

Фильтр активности пользователей. Если отсутствует - означает, что фильтр не задан, 'true' - получить только деактивированных пользователей, 'false' - только активных пользователей.

^(true|false|)$

true, false или пустое значение.

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username, domain, tariffCode или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

attributeName

0 или более строковых элементов, определяющий имена атрибутов, которые нужно вернуть. Если не задано ни одного, то возвращаются все атрибуты, но тогда нельзя использовать сортировку по атрибуту.

.*

Атрибуты пользователя, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество пользователей, которые удовлетворяют условиям выборки.

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserItemSingle.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:RetrieveRadiusUserList>
         <nbi:username></nbi:username>
         <nbi:domain></nbi:domain>
         <nbi:tariffCode></nbi:tariffCode>
         <nbi:deactivated></nbi:deactivated>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy></nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
         <nbi:attributeName>TLS-Client-Cert-Serial</nbi:attributeName>
      </nbi:RetrieveRadiusUserList>
Ответ
      <ns:RetrieveRadiusUserListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>174</ax21:detail>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/0025693512.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>0025693512</ax21:name>
                  <ax21:password>1149413</ax21:password>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1149413</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>5c</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/0039471949.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>0039471949</ax21:name>
                  <ax21:password>4705443</ax21:password>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>4705443</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>3e</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveRadiusUserListResponse>
Код Описание ошибки

8

Домен не соответствует правилам FQDN

10

Домен роли не имеет прав на домен пользователя или домен тарифного плана

100

Тарифного плана с таким кодом не существует

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserListV2 – Запрос списка аккаунтов Wi-Fi клиентов из базы RADIUS с фильтром по произвольному атрибуту

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента, может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffCode

Фильтр по коду тарифного плана. Может отсутствовать.

^.{1,64}$

Текст до 64-х символов.

attrFilter

Фильтрация по произвольному атрибуту в БД RADIUS.

.*

NbiAttr

deactivated

Фильтр активности пользователей. Если отсутствует - означает, что фильтр не задан, 'true' - получить только деактивированных пользователей, 'false' - только активных пользователей.

^(true|false|)$

true, false или пустое значение.

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username, domain или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

attributeName

0 или более строковых элементов, определяющий имена атрибутов, которые нужно вернуть. Если не задано ни одного, то возвращаются все атрибуты, но тогда нельзя использовать сортировку по атрибуту.

.*

Атрибуты пользователя, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество пользователей, которые удовлетворяют условиям выборки.

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserItemSingle.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:RetrieveRadiusUserListV2>
         <nbi:username></nbi:username>
         <nbi:domain></nbi:domain>
         <nbi:tariffCode>100mb</nbi:tariffCode>
         <nbi:attrFilter>
            <xsd:name>TLS-Client-Cert-Serial</xsd:name>
            <xsd:oper>:=</xsd:oper>
            <xsd:value>5c</xsd:value>
         </nbi:attrFilter>
         <nbi:deactivated>false</nbi:deactivated>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy></nbi:orderBy>
         <nbi:orderType></nbi:orderType>
         <nbi:attributeName></nbi:attributeName>
      </nbi:RetrieveRadiusUserListV2>
Ответ
      <ns:RetrieveRadiusUserListV2Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>0</ax21:detail>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/0025693512.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>0025693512</ax21:name>
                  <ax21:password>1149413</ax21:password>
                  <ax21:tariffCode>100mb</ax21:tariffCode>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Deactivated</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1149413</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>5c</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1149413</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Creator-Name</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Nadezhda</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Division</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Uit</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Category</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>enterprise</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Organization</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Org</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Email</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>TEST@mail.ru</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-State</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>state</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Location</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Loc</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Creator-Family</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Ab</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Country</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>RU</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Creator-Phone</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>79135555555</ax21:value>
                     </ax21:attr>
                  </ax21:common>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2020-10-02 14:16:43</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveRadiusUserListV2Response>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не соответствует правилам FQDN

10

Домен роли не имеет прав на домен пользователя или домен тарифного плана

100

Тарифного плана с таким кодом не существует

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserListV3 - Запрос списка аккаунтов Wi-Fi клиентов из базы RADIUS с фильтром по произвольному атрибуту и времени

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для получения списка аккаунтов Wi-Fi клиентов из базы RADIUS с фильтром по произвольному атрибуту и времени.

  3. Проверка существования домена не выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин клиента, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента, может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffCode

Фильтр по коду тарифного плана. Может отсутствовать.

^.{1,64}$

Текст до 64-х символов.

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeStop

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

attrFilter

NbiAttr Фильтрация по произвольному атрибуту в БД RADIUS.

.*

NbiAttr

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username, domain или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

attributeName

0 или более строковых элементов, определяющий имена атрибутов, которые нужно вернуть. Если не задано ни одного, то возвращаются все атрибуты, но тогда нельзя использовать сортировку по атрибуту.

.*

Атрибуты пользователя, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

response

Массив объектов NbiRadiusUserItemSingle.

NbiRadiusUserItemArray

code

Код ответа

int

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество пользователей, которые удовлетворяют условиям выборки.

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveRadiusUserListV3>
         <nbi:username>%user3%</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:tariffCode>100mb</nbi:tariffCode>
         <nbi:timeStart>2020-11-28T07:31:28</nbi:timeStart>
         <nbi:timeStop>2020-12-01T07:31:28</nbi:timeStop>
         <nbi:attrFilter>
            <xsd:name>Eltex-User-Category</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>enterprise</xsd:value>
         </nbi:attrFilter>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy></nbi:orderBy>
         <nbi:orderType></nbi:orderType>
         <nbi:attributeName>TLS-Client-Cert-Serial</nbi:attributeName>
      </nbi:RetrieveRadiusUserListV3>
Ответ
      <ns:RetrieveRadiusUserListV3Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>1</ax21:detail>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>crtOlduser3</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode>100mb</ax21:tariffCode>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>0f</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Category</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>enterprise</ax21:value>
                     </ax21:attr>
                  </ax21:common>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2020-09-09 17:50:25</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/user3.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>user3</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode>100mb</ax21:tariffCode>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>5f</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Category</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>enterprise</ax21:value>
                     </ax21:attr>
                  </ax21:common>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2020-10-02 15:38:46</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>user33</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode>100mb</ax21:tariffCode>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1e</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Category</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>enterprise</ax21:value>
                     </ax21:attr>
                  </ax21:common>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2020-09-10 14:43:44</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveRadiusUserListV3Response>
Код Описание ошибки

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен пользователя или домен тарифного плана

100

Тарифного плана с таким кодом не существует

107

Время начала активности не должно превышать время конца активности

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserShortInfoList - Получить список пользователей wi-fi по домену, ссиду

Общая информация

  1. Команда актуальна, начиная с версии 1.16.

  2. Команда предназначена для получения списка пользователей по таблице radstat.

  3. Все параметры в запросе являются обязательными

  4. Для параметра domain актуально только отношение = (строгое равенство)

  5. Для получения информации о пользователях в домене необходимо чтобы пользователь имел права на работу с доменом

  6. Проверка существования домена не выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

domain

домен

TEXT

строковый формат

ssid

SSID

TEXT

строковый формат

Выходные параметры

Параметр Значение Формат значения

response

Объект, содержащий массив пользователей wi-fi

NbiRadiusUserItemArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveRadiusUsersFreeSearch>
         <nbi:domain>root</nbi:domain>
         <nbi:ssid>eltex_testing</nbi:ssid>
      </nbi:RetrieveRadiusUsersFreeSearch>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserShortInfoListResponse xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemResponse">
                <ax21:code>0</ax21:code>
                <ax21:detail>1</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
                    <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                        <ax21:clientCrtLink></ax21:clientCrtLink>
                        <ax21:domain>root</ax21:domain>
                        <ax21:name>unstopable</ax21:name>
                        <ax21:password></ax21:password>
                        <ax21:tariffCode></ax21:tariffCode>
                        <ax21:check xsi:type="ax21:NbiAttrArray" />
                        <ax21:common xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Email</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>palevrut@icloud.com</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Family</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>Истомин</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Name</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value></ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-SSID</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>eltex_testing</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Phone</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>79137525953</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Division</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value></ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Operator-Position</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value></ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>2020-02-19 11:27:05</ax21:value>
                            </ax21:attr>
                        </ax21:common>
                        <ax21:reply xsi:type="ax21:NbiAttrArray" />
                        <ax21:verificationWay xsi:nil="true" />
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserShortInfoListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на работу с доменом

281

Параметр ssid в запросе не определен или является пустым

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserMacs – Запрос списка привязок MAC-адресов устройств к учетным записям пользователей услуги Wi-Fi

Общая информация

  1. Команда актуальна, начиная с версии 1.6

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Фильтр по логину УЗ пользователя услуги Wi-Fi, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента, может быть пустым. Если домен начинается с символа ".", то в выборку включаются все поддомены, иначе только данный конкрентный домен.

(?=^.{1,235}$)(\.)?(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

mac

Фильтр по MAC-адресу устройства пользователя услуги Wi-Fi. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

6 двузначных шестнадцатеричных чисел, разделенных ':'.

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

user_name, user_domain, mac, last_activity или expires

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

112

Количество элементов не передано или является неположительным числом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username></nbi:username>
            <nbi:domain></nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>-1</nbi:count>
            <nbi:page></nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>112</ax21:code>
                <ax21:detail>Count must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

113

Номер страницы не передан или является неположительным числом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username></nbi:username>
            <nbi:domain></nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>10</nbi:count>
            <nbi:page>-1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>113</ax21:code>
                <ax21:detail>Page must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username>%a%</nbi:username>
            <nbi:domain>.`123</nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>10</nbi:count>
            <nbi:page>2</nbi:page>
            <nbi:orderBy>user_name</nbi:orderBy>
            <nbi:orderType>DESC</nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain "`123" does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Указанный домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username>%a%</nbi:username>
            <nbi:domain>.ru</nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>10</nbi:count>
            <nbi:page>2</nbi:page>
            <nbi:orderBy>user_name</nbi:orderBy>
            <nbi:orderType>DESC</nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain "ru" is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь, выполняющий операцию, не имеет прав на указанный домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username></nbi:username>
            <nbi:domain>root</nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>10</nbi:count>
            <nbi:page>2</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain "root"</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserMacs>
            <nbi:username>%a%</nbi:username>
            <nbi:domain>.root</nbi:domain>
            <nbi:mac></nbi:mac>
            <nbi:count>10</nbi:count>
            <nbi:page>2</nbi:page>
            <nbi:orderBy>user_name</nbi:orderBy>
            <nbi:orderType>DESC</nbi:orderType>
        </nbi:RetrieveRadiusUserMacs>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserMacsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserMacExpiresInfo"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail>1048</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserMacExpiresInfoArray">
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:01:04.188+07:00</ax21:lastActivityTime>
                        <ax21:mac>73-e8-69-fc-1d-89</ax21:mac>
                        <ax21:domain>root</ax21:domain>
                        <ax21:username>zazRE</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:01:10.775+07:00</ax21:lastActivityTime>
                        <ax21:mac>a3-27-fe-27-c0-ed</ax21:mac>
                        <ax21:domain>barnaul.root</ax21:domain>
                        <ax21:username>zaqud</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:52.440+07:00</ax21:lastActivityTime>
                        <ax21:mac>fc-39-87-37-1f-8b</ax21:mac>
                        <ax21:domain>msk.root</ax21:domain>
                        <ax21:username>zaasa</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:46.512+07:00</ax21:lastActivityTime>
                        <ax21:mac>6c-05-31-ea-9e-2d</ax21:mac>
                        <ax21:domain>omsk.root</ax21:domain>
                        <ax21:username>zaFUq</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:50.451+07:00</ax21:lastActivityTime>
                        <ax21:mac>75-90-b1-ff-52-4d</ax21:mac>
                        <ax21:domain>ekb.root</ax21:domain>
                        <ax21:username>zYaGo</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:45.829+07:00</ax21:lastActivityTime>
                        <ax21:mac>25-f1-b3-ba-21-e0</ax21:mac>
                        <ax21:domain>tomsk.root</ax21:domain>
                        <ax21:username>zSgta</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:01:08.051+07:00</ax21:lastActivityTime>
                        <ax21:mac>21-df-3e-96-f8-12</ax21:mac>
                        <ax21:domain>omsk.root</ax21:domain>
                        <ax21:username>zPaUW</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:50.269+07:00</ax21:lastActivityTime>
                        <ax21:mac>ce-87-32-f0-f0-3c</ax21:mac>
                        <ax21:domain>root</ax21:domain>
                        <ax21:username>zOPaH</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:01:07.480+07:00</ax21:lastActivityTime>
                        <ax21:mac>69-1b-06-42-1d-bf</ax21:mac>
                        <ax21:domain>omsk.root</ax21:domain>
                        <ax21:username>zNavU</ax21:username>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiRadiusUserMacExpiresInfo">
                        <ax21:expiresTime>2017-11-09T09:00:41.175+07:00</ax21:expiresTime>
                        <ax21:lastActivityTime>2016-11-09T09:00:50.213+07:00</ax21:lastActivityTime>
                        <ax21:mac>b6-3b-80-3d-3a-80</ax21:mac>
                        <ax21:domain>barnaul.root</ax21:domain>
                        <ax21:username>zJbay</ax21:username>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRadiusUserMacsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveLastRadiusUserList - Получить список пользователей Wi-Fi из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.3.

  2. Команда возвращает список основных данных о пользователях Wi-Fi из базы RADIUS.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен пользователя

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

date

Наименьшая дата создания пользователя

.*

Дата в формате «yyyy-MM-dd HH:mm:ss», например "2017-02-10 09:45:13"

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

response

Список пользователей Wi-Fi

Объект NbiLightRadiusUserArray

code

Код ответа

int

detail

Количество пользователей

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveLastRadiusUserList>
         <nbi:domain>root</nbi:domain>
         <nbi:date>2016-06-21 09:22:47</nbi:date>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
      </nbi:RetrieveLastRadiusUserList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveLastRadiusUserListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeLightRadiusUserResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail>2</ax21:detail>
            <ax21:response xsi:type="ax21:NbiLightRadiusUserArray">
               <ax21:item xsi:type="ax23:NbiLightUser">
                  <ax23:creation_date>2016-06-21 09:22:47</ax23:creation_date>
                  <ax23:domain>toor</ax23:domain>
                  <ax23:username>79874568909</ax23:username>
               </ax21:item>
               <ax21:item xsi:type="ax23:NbiLightUser">
                  <ax23:creation_date>2017-02-16 13:43:48</ax23:creation_date>
                  <ax23:domain>toor</ax23:domain>
                  <ax23:username>hth</ax23:username>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveLastRadiusUserListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveLastRadiusUserListByCategory - Получить список пользователей Wi-Fi из базы RADIUS, для заданной категории

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает список основных данных о пользователях Wi-Fi заданной категории из базы RADIUS.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен пользователя

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

date

Наименьшая дата создания пользователя

.*

Дата в формате «yyyy-MM-dd HH:mm:ss», например "2017-02-10 09:45:13"

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

category

Категория пользователей

enterprise|hotspot|voucher|voucher_bras|bras|service

notcat

Инвертирование указанной категории

0 - выдать указанную категорию; 1- выдать все категории, кроме указанной.

Выходные параметры

Параметр Значение Формат значения

response

Список пользователей Wi-Fi

Объект NbiLightRadiusUserArray

code

Код ответа

int

detail

Количество пользователей

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveLastRadiusUserListByCategory>
         <nbi:domain>root</nbi:domain>
         <nbi:date>2016-06-21 09:22:47</nbi:date>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:category>enterprise</nbi:category>
         <nbi:notcat>0</nbi:notcat>
      </nbi:RetrieveLastRadiusUserListByCategory>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveLastRadiusUserListByCategoryResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeLightRadiusUserResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail>2</ax21:detail>
            <ax21:response xsi:type="ax21:NbiLightRadiusUserArray">
               <ax21:item xsi:type="ax239:NbiLightUser">
                  <ax239:creation_date>2017-02-16 10:51:45</ax239:creation_date>
                  <ax239:domain>toor</ax239:domain>
                  <ax239:username>79123456789</ax239:username>
               </ax21:item>
               <ax21:item xsi:type="ax239:NbiLightUser">
                  <ax239:creation_date>2017-05-22 17:35:53</ax239:creation_date>
                  <ax239:domain>toor</ax239:domain>
                  <ax239:username>testerok</ax239:username>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveLastRadiusUserListByCategoryResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveUserListBySSID – Запрос списка пользователей, которые могут подключаться к данному SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameDomain

Примеры команд и кодов

Код Описание ошибки

33

Имя SSID не задано или не удовлетворяет требованиям.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName></xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'ssidName'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test54</xsd:ssidName>
            <xsd:ssidDomain>wifi</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test54</xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test54</xsd:ssidName>
            <xsd:ssidDomain>test1.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test5</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'test5[wifi.root]'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

49

На SSID настроена авторизация не через radius-сервер
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveUserListBySSID>
            <nbi:ssidName>eltex_local</nbi:ssidName>
            <nbi:ssidDomain>enterprise.root</nbi:ssidDomain>
        </nbi:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNameDomainResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>49</ax21:code>
                <ax21:detail>Attribute 'Security_Type' is no 'WPA Enterprise' (2) for SSID 'eltex_local[enterprise.root]'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

47

SSID использует глобальный radius-сервер (невозможно гарантировать совпадение доменов SSID и глобальный radius-сервера)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveUserListBySSID>
            <nbi:ssidName>eltex_local</nbi:ssidName>
            <nbi:ssidDomain>enterprise.root</nbi:ssidDomain>
        </nbi:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNameDomainResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>47</ax21:code>
                <ax21:detail>Attribute 'Use_Global_Radius' set to 'true' for SSID 'eltex_local[enterprise.root]'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test54</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>andrey</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>andrey2</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>roman</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>test</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

UpdateRadiusUserPortalScenarioIndex – Изменить cценарий портальной аутентификации для Wi-Fi пользователя

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Аккаунт WiFi пользователя. Объект NbiNameDomain.

Wi-Fi пользователь

index

Индекс нового сценария портальной аутентификации для пользователя.

[0-9]+

Целое неотрицательное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiRadiusUserItemSingle

Примеры команд и кодов

Код Описание ошибки

8

Домен пользователя не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>?</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '?' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Отсутствует домен пользователя
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain></xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>7</ax21:code>
                <ax21:detail>Incorrect field 'domain' for user.</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен пользователя или домен тарифного плана
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен клиента не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>123.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such '123.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

20

Логин аккаунта некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name></xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>20</ax21:code>
                <ax21:detail>Incorrect field 'name' for user.</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

11

Пользователя не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>11</ax21:code>
                <ax21:detail>No such radius user 'test[hotspot.root]'.</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

115

Индекс сценария некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index></nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>115</ax21:code>
                <ax21:detail>In request by key 'index' value can not be null</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

120

Пользователь Wi-Fi не привязан к тарифному плану
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>120</ax21:code>
                <ax21:detail>User has no tariff</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

121

Тарифный план не имеет сценария с таким индексом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:user>
            <nbi:index>5</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>121</ax21:code>
                <ax21:detail>Tariff with code 'black' has no scenario with index 5</ax21:detail>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain/>
                    <ax21:name/>
                    <ax21:password/>
                    <ax21:tariffCode/>
                    <ax21:check xsi:nil="true"/>
                    <ax21:common xsi:nil="true"/>
                    <ax21:reply xsi:nil="true"/>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:UpdateRadiusUserPortalScenarioIndex>
            <nbi:user>
                <xsd:domain>hotspot.root</xsd:domain>
                <xsd:name>79131256352</xsd:name>
            </nbi:user>
            <nbi:index>2</nbi:index>
        </nbi:UpdateRadiusUserPortalScenarioIndex>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:UpdateRadiusUserPortalScenarioIndexResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusUserItemSingleResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
                    <ax21:clientCrtLink/>
                    <ax21:domain>hotspot.root</ax21:domain>
                    <ax21:name>79131256352</ax21:name>
                    <ax21:password>1787</ax21:password>
                    <ax21:tariffCode>black</ax21:tariffCode>
                    <ax21:check xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Cleartext-Password</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>1787</ax21:value>
                        </ax21:attr>
                    </ax21:check>
                    <ax21:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-SSID</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Family</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Name</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Division</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Position</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Email</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Phone</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value>79131256352</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Eltex-User-Category</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value>hotspot</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Creator-Name</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value></ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Creator-Family</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/></ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                           <ax21:name>Operator-Creator-Phone</ax21:name>
                           <ax21:oper>=</ax21:oper>
                           <ax21:value/></ax21:value>
                        </ax21:attr>
                    </ax21:common>
                    <ax21:reply xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-State-Begin-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>1448600974</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2015-11-26 13:06:42</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-State</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2</ax21:value>
                        </ax21:attr>
                    </ax21:reply>
                </ax21:response>
            </ns:return>
        </ns:UpdateRadiusUserPortalScenarioIndexResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

UpdateUserActivity - Обновить время активности пользователя wi-fi на портале

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для обновления даты активности пользователя на портале, которая используется для отображения статистики.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Имя и домен пользователя Wi-Fi

NbiNameDomain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:UpdateUserActivity>
         <nbi:user>
            <xsd:domain>root</xsd:domain>
            <xsd:name>user</xsd:name>
         </nbi:user>
      </nbi:UpdateUserActivity>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:UpdateUserActivityResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:UpdateUserActivityResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр пользователя 'domain'

10

Нет прав на указанный домен

11

Пользователь wi-fi не найден в базе пользователей

20

Не указан обязательный параметр пользователя 'name'

62

Указанный домен не найден в базе доменов

69

Не указан обязательный параметр запроса 'user'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GroupRemoveRadiusUsers - Групповое удаление пользователей wi-fi

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для удаления нескольких пользователей wi-fi из базы, используя один (а не серию) запрос к NBI.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

users

перечень пользователей

NbiNameDomainArray

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GroupRemoveRadiusUsers>
         <nbi:users>
            <xsd:item>
               <xsd:domain>hotspot.root</xsd:domain>
               <xsd:name>71117778899</xsd:name>
            </xsd:item>
            <xsd:item>
               <xsd:domain>hotspot.root</xsd:domain>
               <xsd:name>71117778800</xsd:name>
            </xsd:item>
         </nbi:users>
      </nbi:GroupRemoveRadiusUsers>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GroupRemoveRadiusUsersResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:GroupRemoveRadiusUsersResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

27

Запрещено удалять записи категории 'service'

281

обязательный параметр users не задан или имеет пустое значение

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUsersFreeSearch - Получить список пользователей wi-fi с гибким фильтром по таблице radstat

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для получения списка пользователей по таблице radstat.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

filter

текст фильтра

domain

домен

count

желаемое количество записей

startIndex

смещение от начала таблицы (0 - выдать всё с начала)

orderBy

сортировать записи по этому полю

count

порядок сортировки asc/desc

categories

категории пользователей в системе SOftWLC

enterprise, hotspot, voucher, bras, service, voucher_bras

Выходные параметры

Параметр Значение Формат значения

response

Объект, содержащий массив пользователей wi-fi

NbiRadiusUsersFlatArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveRadiusUsersFreeSearch>
         <nbi:filter>789</nbi:filter>
         <nbi:domain>root</nbi:domain>
         <nbi:count>2</nbi:count>
         <nbi:startIndex>0</nbi:startIndex>
         <nbi:orderBy>username</nbi:orderBy>
         <nbi:orderType>acs</nbi:orderType>
         <nbi:categories>hotspot</nbi:categories>
         <nbi:categories>bras</nbi:categories>
      </nbi:RetrieveRadiusUsersFreeSearch>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveRadiusUsersFreeSearchResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax23:response xsi:type="ax23:NbiRadiusUsersFlatArray">
               <ax23:items xsi:type="ax23:NbiRadiusUserFlat">
                  <ax23:category>hotspot</ax23:category>
                  <ax23:createDate>Feb 16, 2017 10:51:45 AM</ax23:createDate>
                  <ax23:deactivated>true</ax23:deactivated>
                  <ax23:devision xsi:nil="true"/>
                  <ax23:email xsi:nil="true"/>
                  <ax23:family xsi:nil="true"/>
                  <ax23:mac xsi:nil="true"/>
                  <ax23:name xsi:nil="true"/>
                  <ax23:phone>79123456789</ax23:phone>
                  <ax23:position xsi:nil="true"/>
                  <ax23:ssid xsi:nil="true"/>
                  <ax23:tariff_name/>
                  <ax23:userDomain>root</ax23:userDomain>
                  <ax23:userName>79123456789</ax23:userName>
                  <ax23:userUpdateDate>Feb 16, 2017 10:51:45 AM</ax23:userUpdateDate>
                  <ax23:validUntil xsi:nil="true"/>
                  <ax23:validity_period xsi:nil="true"/>
               </ax23:items>
               <ax23:items xsi:type="ax23:NbiRadiusUserFlat">
                  <ax23:category>hotspot</ax23:category>
                  <ax23:createDate>Feb 16, 2017 1:16:11 PM</ax23:createDate>
                  <ax23:deactivated>false</ax23:deactivated>
                  <ax23:devision xsi:nil="true"/>
                  <ax23:email xsi:nil="true"/>
                  <ax23:family xsi:nil="true"/>
                  <ax23:mac xsi:nil="true"/>
                  <ax23:name xsi:nil="true"/>
                  <ax23:phone>79134567890</ax23:phone>
                  <ax23:position xsi:nil="true"/>
                  <ax23:ssid xsi:nil="true"/>
                  <ax23:tariff_name>test</ax23:tariff_name>
                  <ax23:userDomain>root</ax23:userDomain>
                  <ax23:userName>79134567890</ax23:userName>
                  <ax23:userUpdateDate>Feb 16, 2017 1:16:11 PM</ax23:userUpdateDate>
                  <ax23:validUntil xsi:nil="true"/>
                  <ax23:validity_period xsi:nil="true"/>
               </ax23:items>
               <ax23:totalCount>2</ax23:totalCount>
            </ax23:response>
            <ax23:totalCount>2</ax23:totalCount>
         </ns:return>
      </ns:RetrieveRadiusUsersFreeSearchResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

112

Запрашиваемое число записей (count) должно быть больше нуля

114

Указанная колонка сортировки (orderBy) не существует

131

Стартовый индекс (startIndex) должен быть больше или равен нулю

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUsersWithFieldFilters - Получить список пользователей wi-fi с фильтром по таблице radstat

Общая информация

  1. Команда актуальна, начиная с версии 1.12.

  2. Команда позволяет получить список пользователей Wi-Fi с фильтрами по таблице radstat.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

startIndex

Смещение от начала таблицы (0 - выдать всё с начала)

^[0-9]*$

Целое неотрицательное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные

String

Название поля таблицы radstat

orderType

Тип сортировки (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

fieldFilters

Список фильтров по конкретному полю таблицы

Фильтры поиска

NbiParameterArray

categories

Категории пользователей в системе SoftWLC

String

enterprise, equipment, hotspot, voucher, bras, service, voucher_bras

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiRadiusUsersFlatArray, содержащий массив пользователей wi-fi

NbiRadiusUsersFlatArray

code

Код ответа

int

detail

Пояснение к ответу

String

Фильтры поиска

Название Описание Формат значения

username

Логин пользователя

String

userdomain

Домен пользователя

String

create_date_start

Начало интервала 'Дата создания'

yyyy-MM-dd

create_date_end

Конец интервала 'Дата создания'

yyyy-MM-dd

user_update_date_start

Начало интервала 'Дата обновления'

yyyy-MM-dd

user_update_date_end

Конец интервала 'Дата обновления'

yyyy-MM-dd

dev_type

Тип устройства пользователя

0 - телефон, 1 - планшет, 2 - ПК

dev_os

ОС устройства пользователя

Название ОС (Windows, Linux, Mac OS, iOS, Android)

dev_browser

Браузер пользователя

Название браузера (Chrome, Edge, Internet Explorer, Opera, Firefox, Safari)

dev_vendor

Производитель устройства пользователя

String

ssid

Имя SSID’а

String

phone

Телефон пользователя

String

deactivated

Блокировка

true/false

advertising

Согласие на рекламу

true/false

search_string

Гибкий фильтр, позволяющий искать по полям username, userdomain и family таблицы radstat

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveRadiusUsersWithFieldFilters>
    <nbi:domain>.root</nbi:domain>
    <nbi:count>1</nbi:count>
    <nbi:startIndex>0</nbi:startIndex>
    <nbi:orderBy>username</nbi:orderBy>
    <nbi:orderType>asc</nbi:orderType>
    <nbi:fieldFilters>
        <xsd:parameter>
            <xsd:name>username</xsd:name>
            <xsd:value>test</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
            <xsd:name>create_date_start</xsd:name>
            <xsd:value>2022-03-27</xsd:value>
        </xsd:parameter>
    </nbi:fieldFilters>
    <nbi:categories>hotspot</nbi:categories>
    <nbi:categories>bras</nbi:categories>
</nbi:RetrieveRadiusUsersWithFieldFilters>
Ответ
<ns:RetrieveRadiusUsersWithFieldFiltersResponse>
    <ns:return xsi:type="ax2124:NbiRadiusUsersFlatResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2124:response xsi:type="ax2124:NbiRadiusUsersFlatArray">
            <ax2124:items xsi:type="ax2124:NbiRadiusUserFlat">
                <ax2124:advertisingPermitted>false</ax2124:advertisingPermitted>
                <ax2124:category>hotspot</ax2124:category>
                <ax2124:clientFamily xsi:nil="true"/>
                <ax2124:clientName xsi:nil="true"/>
                <ax2124:clientPhone xsi:nil="true"/>
                <ax2124:country/>
                <ax2124:createDate>Mar 27, 2022 6:12:17 PM</ax2124:createDate>
                <ax2124:deactivated>false</ax2124:deactivated>
                <ax2124:deactivationUntil xsi:nil="true"/>
                <ax2124:deviceBrowser/>
                <ax2124:deviceOs/>
                <ax2124:deviceType>0</ax2124:deviceType>
                <ax2124:deviceVendor/>
                <ax2124:devision xsi:nil="true"/>
                <ax2124:email xsi:nil="true"/>
                <ax2124:family xsi:nil="true"/>
                <ax2124:hotspotInactive>false</ax2124:hotspotInactive>
                <ax2124:legalId xsi:nil="true"/>
                <ax2124:location/>
                <ax2124:mac xsi:nil="true"/>
                <ax2124:macsList xsi:type="axis2ns2004:anyType">
                    <empty xmlns="http://www.w3.org/2001/XMLSchema">true</empty>
                </ax2124:macsList>
                <ax2124:name xsi:nil="true"/>
                <ax2124:organization/>
                <ax2124:phone xsi:nil="true"/>
                <ax2124:position xsi:nil="true"/>
                <ax2124:ssid xsi:nil="true"/>
                <ax2124:state/>
                <ax2124:tariff_name>test</ax2124:tariff_name>
                <ax2124:userDomain>root</ax2124:userDomain>
                <ax2124:userName>testuser</ax2124:userName>
                <ax2124:userUpdateDate>Jan 1, 1971 7:00:01 AM</ax2124:userUpdateDate>
                <ax2124:validUntil>Mar 27, 2022 7:52:17 PM</ax2124:validUntil>
                <ax2124:validity_period>100</ax2124:validity_period>
            </ax2124:items>
            <ax2124:totalCount>42519</ax2124:totalCount>
        </ax2124:response>
        <ax2124:totalCount>42519</ax2124:totalCount>
    </ns:return>
</ns:RetrieveRadiusUsersWithFieldFiltersResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

112

Запрашиваемое число записей (count) должно быть больше нуля

114

Указанная колонка сортировки (orderBy) не существует

131

Стартовый индекс (startIndex) должен быть больше или равен нулю

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateBrasService - Создание PCRF cервиса в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин сервиса. Уникальность сервиса определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

PCRF сервис

domain

Домен сервиса. Уникальность сервиса определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

attributes

BRAS Атрибуты сервиса, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

response

NbiRadiusUserItemSingle

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:CreateBrasService>
         <nbi:username>service1</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:attributes>
            <xsd:name>Acct-Interim-Interval</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>78</xsd:value>
         </nbi:attributes>
         <nbi:attributes>
            <xsd:name>Cisco-AVPair</xsd:name>
            <xsd:oper>+=</xsd:oper>
            <xsd:value>subscriber:precedence=94</xsd:value>
         </nbi:attributes>
      </nbi:CreateBrasService>
Ответ
      <ns:CreateBrasServiceResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemSingle">
               <ax21:clientCrtLink/>
               <ax21:domain>root</ax21:domain>
               <ax21:name>service1</ax21:name>
               <ax21:password/>
               <ax21:tariffCode/>
               <ax21:check xsi:type="ax21:NbiAttrArray"/>
               <ax21:common xsi:type="ax21:NbiAttrArray"/>
               <ax21:reply xsi:type="ax21:NbiAttrArray">
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Acct-Interim-Interval</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>78</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Cisco-AVPair</ax21:name>
                     <ax21:oper>+=</ax21:oper>
                     <ax21:value>subscriber:precedence=94</ax21:value>
                  </ax21:attr>
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-User-Create-Date</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>2019-02-07 12:13:29</ax21:value>
                  </ax21:attr>
               </ax21:reply>
               <ax21:verificationWay xsi:nil="true"/>
            </ax21:response>
         </ns:return>
      </ns:CreateBrasServiceResponse>
Код Описание ошибки

0

Успешно

7

Некорректный домен

10

У роли нет прав на редактирование домена

11

Такого пользователя RADIUS не существует

19

Пользователь уже существует

20

Некорректное поле username (отсутствует)

295

Ошибка выполнения команды PCRF-API

405

PCRF сервис не может иметь имя существующего PCRF сценария

406

PCRF сервис уже существует

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditBrasService - Редактирование PCRF cервиса в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Чтобы предварительно очистить все значения атрибута нужно передать этот атибут в параметре attributes без значения.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин сервиса. Уникальность сервиса определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

PCRF сервис

domain

Домен сервиса. Уникальность сервиса определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

newDomain

Новый домен сервиса (может быть пустым). Уникальность сервиса определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

attributes

BRAS Атрибуты сервиса, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:EditBrasService>
         <nbi:username>service1</nbi:username>
         <nbi:domain>root</nbi:domain>
         <nbi:newDomain>Clients.root</nbi:newDomain>
         <nbi:attributes>
            <xsd:name>Cisco-AVPair</xsd:name>
            <xsd:oper>+=</xsd:oper>
         </nbi:attributes>
         <nbi:attributes>
            <xsd:name>Cisco-AVPair</xsd:name>
            <xsd:oper>+=</xsd:oper>
            <xsd:value>subscriber:precedence=2227</xsd:value>
         </nbi:attributes>
         <nbi:attributes>
            <xsd:name>Cisco-AVPair</xsd:name>
            <xsd:oper>+=</xsd:oper>
            <xsd:value>subscriber:flow-status=enabled</xsd:value>
         </nbi:attributes>
         <nbi:attributes>
            <xsd:name>Cisco-AVPair</xsd:name>
            <xsd:oper>+=</xsd:oper>
            <xsd:value>subscriber:traffic-class=service2</xsd:value>
         </nbi:attributes>
      </nbi:EditBrasService>
Ответ
      <ns:EditBrasServiceResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditBrasServiceResponse>
Код Описание ошибки

0

Успешно

7

Некорректный домен

10

У роли нет прав на редактирование домена

11

Такого пользователя RADIUS не существует

19

Пользователь уже существует

20

Некорректное поле username (отсутствует)

21

Нет ожидаемых атрибутов пользователя

22

Отсутствует имя атрибута пользователя RADIUS

24

Некорректный оператор атрибута пользователя

26,

Атрибут пользователя не содержит оператора

27,

Некорректное значение для атрибута

28,

Отсутствует обязательный атрибут пользователя

207

Неизвестный атрибут auth-пользователя

295

Ошибка выполнения команды PCRF-API

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveBrasService - Удаление PCRF cервиса из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин сервиса. Уникальность сервиса определяется по логину и домену.

^.\{1,64}$

Текст до 64-х символов.

PCRF сервис

domain

Домен сервиса. Уникальность сервиса определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RemoveBrasService>
         <nbi:username>service1</nbi:username>
         <nbi:domain>Clients.root</nbi:domain>
      </nbi:RemoveBrasService>
Ответ
      <ns:RemoveBrasServiceResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:RemoveBrasServiceResponse>
Код Описание ошибки

0

Успешно

10

У роли нет прав на редактирование домена

11

Такого пользователя RADIUS не существует

20

Некорректное поле username (отсутствует)

277

Нельзя удалить сервис, так как он используется в PCRF тарифе/скрипте

295

Ошибка выполнения команды PCRF-API

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveBrasServicesList - Получить список PCRF сервисов

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

В качестве дополнительных параметров можно передать:

  • PAGE, COUNT - диапазон выборки;

  • ORDER_BY - поле, определяющее по какому элементу сортировать выдаваемые данные (username или domain)

  • ORDER_TYPE - поле, определяющее тип сортировки ASC или DESC (По умолчанию ASC)

  • USER_NAME - поле, определяющее список PCRF сервисов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов)

  • DOMAIN - поле, определяющее список PCRF сервисов, домен которых содержит значение данного поля. Используйте специальный символ . перед доменом (включая вложенные домены)

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрации NbiParameterArray

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

response

Массив объектов NbiRadiusUserItemSingle.

NbiRadiusUserItemArray

total

Общее число записей, удовлетворяющих фильтрам выборки

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveBrasServicesList>
         <nbi:params>
                   <xsd:parameter>
               <xsd:name>USER_NAME</xsd:name>
               <xsd:value>%service%</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>DOMAIN</xsd:name>
               <xsd:value>.root</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>COUNT</xsd:name>
               <xsd:value>10</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>PAGE</xsd:name>
               <xsd:value>1</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>ORDER_BY</xsd:name>
               <xsd:value>username</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>ORDER_TYPE</xsd:name>
               <xsd:value>ASC</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:RetrieveBrasServicesList>
Ответ
      <ns:RetrieveBrasServicesListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>Clients.root</ax21:domain>
                  <ax21:name>newservice</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray"/>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2019-02-06 14:36:47</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Acct-Interim-Interval</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>777</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:precedence=777</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:flow-status=enabled</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:traffic-class=newclass777</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-time=324000</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-volume=8388608</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-default-action=deny</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray"/>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Acct-Interim-Interval</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>78</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:precedence=94</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:flow-status=enabled-uplink</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:traffic-class=trafficClass</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-time=324000</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-volume=96636764160</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-default-action=permit</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-id=feggex;subscriber:filter-action=permit</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-id=ngexame;subscriber:filter-action=permit</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-id=tdomainservice;subscriber:filter-action=permit</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2019-01-30 16:54:19</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service2</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray"/>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2019-01-30 16:53:57</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Acct-Interim-Interval</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>222</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:precedence=2227</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:flow-status=enabled</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:traffic-class=service2</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-time=222</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-volume=238370684928</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-default-action=permit</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service4</ax21:name>
                  <ax21:password/>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray"/>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2019-01-30 16:54:19</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Acct-Interim-Interval</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>100</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:precedence=101</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:flow-status=disabled</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:traffic-class=class90</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-time=90</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:quota-volume=103809024</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cisco-AVPair</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>subscriber:filter-default-action=deny</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
            </ax21:response>
            <ax21:total>4</ax21:total>
         </ns:return>
      </ns:RetrieveBrasServicesListResponse>
Код Описание ошибки

0

Успешно

112

Значение "Count" должно быть целым и положительным

113

Значение "Page" должно быть целым и положительным

114

Некорректное значение orderBy

281

Параметр запроса 'params' не указан или пуст

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveBRASServiceListCached - Получить список сервисов, если хэш изменился.

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

hash

хэш последнего обновления списка сервисов

Целое неотрицательное число.

Выходные параметры

Параметр Значение Формат значения

hash

Целое неотрицательное число.

services

NbiNameDomainArray

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveBRASServiceListCached>
         <nbi:hash>1</nbi:hash>
      </nbi:RetrieveBRASServiceListCached>
Ответ
      <ns:RetrieveBRASServiceListCachedResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax25:hash>119</ax25:hash>
            <ax25:services xsi:type="ax21:NbiNameDomainArray">
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>Clients.root</ax21:domain>
                  <ax21:name>newservice</ax21:name>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service</ax21:name>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service2</ax21:name>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>service4</ax21:name>
               </ax21:item>
            </ax25:services>
         </ns:return>
      </ns:RetrieveBRASServiceListCachedResponse>
Код Описание ошибки

0

Успешно

2

Ошибка обращения к БД MySQL

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateTariff – Создание тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nаme

Имя тарифного плана

^.\{1,64}$

Текст до 64-х символов.

code

Уникальный код тарифного плана

[a-zA-Z0-9]\{1,64}

Текст латинскими буквами и цифрами до 64-х символов.

domain

Домен тарифного плана. Пара имя и домен является уникальной.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

descr

Краткое описание тарифного плана. Может отсутствовать.

.\{0,255}

Текст длиной до 255 символов

attribute

Атрибуты тарифного плана, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст.

Примеры команд и кодов

Код Описание ошибки

101

Некорректный код тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>1</nbi:name>
            <nbi:code></nbi:code>
            <nbi:domain></nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>101</ax21:code>
                <ax21:detail>Illegal tariff code</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

255

Некорректное имя тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name></nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain></nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>255</ax21:code>
                <ax21:detail>Incorrect tariff name: ''</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Некорректный домен тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain></nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '' does not conform to the rules FQDN</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

257

Не задан обязательный атрибут тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>257</ax21:code>
                <ax21:detail>No mandatory attribute 'Eltex-Tariff-Portal-Only'</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

251

Некорректный оператор для атрибута
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>!=</xsd:oper>
                <xsd:value>false</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>251</ax21:code>
                <ax21:detail>No such operator '!=' for tariff attr 'Eltex-Tariff-Portal-Only'</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

25

Оператор не существует
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=!=</xsd:oper>
                <xsd:value>false</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>25</ax21:code>
                <ax21:detail>No such RADIUS operator '=!='</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

252

Некорректное значение для атрибута
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>f</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>252</ax21:code>
                <ax21:detail>Incorrect value 'f' for tariff attr 'Eltex-Tariff-Portal-Only'</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

121

Для тарифного плана не задан сценарий (не указан атрибут Eltex-State-On-${1})
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>121</ax21:code>
                <ax21:detail>Tariff with code 'test' has no scenario with index 1</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

258

Некорректное имя атрибута
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-States-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>258</ax21:code>
                <ax21:detail>Incorrect tariff attribute name 'Eltex-States-On-1'</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

253

Не задан атрибут сценария, завершающий его (Eltex-State-External-Url-${1}, Eltex-State-Session-Timeout-${1}, Eltex-State-Traffic-Limit-${1} или Eltex-State-Work-Time-Limit-${1})
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>253</ax21:code>
                <ax21:detail>No end attribute for scenario 1</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

254

Для сценария установлен страт сессии перед редиректом, но не задан URL-адрес для редиректа
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Start-Session-Before-Redirect-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>254</ax21:code>
                <ax21:detail>Incorrect start session before redirect in scenario 1</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

245

Тарифный план с таким кодом уже существует
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Start-Session-Before-Redirect-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-External-Url-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>http://google.com/</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip1-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>192.168.26.0/24</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip2-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>eltex.nsk.ru</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>245</ax21:code>
                <ax21:detail>Tariff code 'test' already exists</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>ro</nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ro' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь не может создать тарифный план в данном домене
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root'</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

246

Тарифный план с таким именем уже существует в данном домене
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff</nbi:name>
            <nbi:code>test1</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Start-Session-Before-Redirect-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-External-Url-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>http://google.com/</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip1-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>192.168.26.0/24</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip2-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>eltex.nsk.ru</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>246</ax21:code>
                <ax21:detail>Tariff with name 'Test tariff' and domain 'root' already exists</ax21:detail>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:CreateTariff>
            <nbi:name>Test tariff №2</nbi:name>
            <nbi:code>test1</nbi:code>
            <nbi:domain>root</nbi:domain>
            <nbi:descr></nbi:descr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Start-Session-Before-Redirect-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-External-Url-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>http://google.com/</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip1-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>192.168.26.0/24</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip2-2</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>eltex.nsk.ru</xsd:value>
            </nbi:attribute>
        </nbi:CreateTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:CreateTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:CreateTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>

Прочие коды ответов

Код Описание ошибки

132

Некорректное cron-выражение для атрибута

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditTariff – Редактирование существующего тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

code

Уникальный код тарифного плана

[a-zA-Z0-9]{1,64}

Текст латинскими буквами и цифрами до 64-х символов

newNаme

Новое имя тарифного плана. Если имя тарифного плана не изменяется, нужно указать старое имя

^.{1,64}$

Текст до 64-х символов

newCode

Новый уникальный код тарифного плана. Поле не поддерживается. Указывается старый код, либо пустое значение

[a-zA-Z0-9]{1,64}

Текст латинскими буквами и цифрами до 64-х символов

newDomain

Новый домен тарифного плана. Пара имя и домен является уникальной. Если домен не меняется, нужно указать старый домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

newDescr

Новое описание тарифного плана. Может отсутствовать. Если описание не меняется, нужно указать старое описание

.{0,255}

Текст длиной до 255 символов

attribute

Атрибуты тарифного плана, ожидается один или больше объект NbiAttr. Если значение атрибута выставлено в null (xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"), и этот атрибут присутствует в тарифном плане, то он будет удален. Для удаления сценария нужно удалить все его атрибуты (включая атрибут Eltex-State-Start-Session-Before-Redirect-N)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст

Примеры команд и кодов

Код Описание ошибки

101

Некорректный код тарифного плана

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code></nbi:code>
            <nbi:newName></nbi:newName>
            <nbi:newCode></nbi:newCode>
            <nbi:newDomain></nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>101</ax21:code>
                <ax21:detail>Illegal tariff code</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

255

Некорректное имя тарифного плана

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName></nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain></nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>255</ax21:code>
                <ax21:detail>Incorrect tariff name: ''</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Некорректный домен тарифного плана

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain></nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '' does not conform to the rules FQDN</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

251

Некорректный оператор для атрибута

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>!=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-4</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>251</ax21:code>
                <ax21:detail>No such operator '!=' for tariff attr 'Eltex-State-On-3'</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

25

Оператора не существует

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>!</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-4</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>25</ax21:code>
                <ax21:detail>No such RADIUS operator '!'</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

252

Некорректное значение для атрибута

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>t</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-4</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>252</ax21:code>
                <ax21:detail>Incorrect value 't' for tariff attr 'Eltex-State-On-3'</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

121

Для тарифного плана не задан сценарий (не указан атрибут Eltex-State-On-${1})

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-4</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>121</ax21:code>
                <ax21:detail>Tariff with code 'test1' has no scenario with index 4</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

258

Некорректное имя атрибута

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limitik-4</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>258</ax21:code>
                <ax21:detail>Incorrect tariff attribute name 'Eltex-State-Traffic-Limitik-4'</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

253

Не задан атрибут сценария, завершающий его (Eltex-State-External-Url-${1}, Eltex-State-Session-Timeout-${1}, Eltex-State-Traffic-Limit-${1} или Eltex-State-Work-Time-Limit-${1})

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>253</ax21:code>
                <ax21:detail>No end attribute for scenario 3</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

254

Для сценария установлен страт сессии перед редиректом, но не задан URL-адрес для редиректа

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Start-Session-Before-Redirect-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>1048576</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>254</ax21:code>
                <ax21:detail>Incorrect start session before redirect in scenario 3</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

245

Тарифный план с новым кодом уже существует

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test2</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>245</ax21:code>
                <ax21:detail>Tariff code 'test2' already exists</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>ro</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ro' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь не может создать тарифный план в данном домене

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>New name</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root'</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

246

Тарифный план с новым именем уже существует в данном домене

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>test1</nbi:code>
            <nbi:newName>test-group</nbi:newName>
            <nbi:newCode>test1</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr></nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Traffic-Limit-3</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>100000</xsd:value>
            </nbi:attribute>
            <nbi:attribute>
                <xsd:name>Eltex-State-Permitted-Ip2-2</xsd:name>
                <xsd:oper
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
                    <xsd:value
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
                    </nbi:attribute>
                </nbi:EditTariff>
            </soap:Body>
        </soap:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>246</ax21:code>
                <ax21:detail>Tariff with name 'test-group' and domain 'root' already exists</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

275

Нельзя изменить атрибут Eltex-Tariff-Portal-Only, т.к. к тарифному плану уже привязаны пользователи

Запрос

<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditTariff>
            <nbi:code>555</nbi:code>
            <nbi:newName>555</nbi:newName>
            <nbi:newCode>555</nbi:newCode>
            <nbi:newDomain>root</nbi:newDomain>
            <nbi:newDescr>No</nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>false</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax22:NbiResponse">
                <ax22:code>275</ax22:code>
                <ax22:detail>Failed to change type of tariff with code '555' (attribute 'Eltex-Tariff-Portal-Only'). Tariff linked with 792 users.</ax22:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

301

Неподдерживаемое поле: new_code

Запрос

<soap:Envelope>
    <soap:Header/>
    <soap:Body>
        <nbi:EditTariff>
            <nbi:code>pt2</nbi:code>
            <nbi:newName>pt2</nbi:newName>
            <nbi:newCode>pt3</nbi:newCode>
            <nbi:newDomain>nsk.root</nbi:newDomain>
            <nbi:newDescr>описание тарифа</nbi:newDescr>
            <nbi:attribute>
                <xsd:name>Eltex-State-On-1</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>truekkk</xsd:value>
            </nbi:attribute>
        </nbi:EditTariff>
    </soap:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope>
    <soapenv:Body>
        <ns:EditTariffResponse>
            <ns:return xsi:type="ax21:NbiResponse">
                <ax21:code>301</ax21:code>
                <ax21:detail>Not supported field: new_code</ax21:detail>
            </ns:return>
        </ns:EditTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно

Запрос

<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:EditTariff>
         <nbi:code>test0</nbi:code>
         <nbi:newName>newTest</nbi:newName>
         <nbi:newCode></nbi:newCode>
         <nbi:newDomain>root</nbi:newDomain>
         <nbi:newDescr>newDescr</nbi:newDescr>
         <nbi:attribute>
            <xsd:name>Simultaneous-Use</xsd:name>
            <xsd:oper>:=</xsd:oper>
            <xsd:value>4</xsd:value>
         </nbi:attribute>
      </nbi:EditTariff>
   </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope>
   <soapenv:Body>
      <ns:EditTariffResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
         </ns:return>
      </ns:EditTariffResponse>
   </soapenv:Body>
</soapenv:Envelope>

Прочие коды ответов

Код Описание ошибки

132

Некорректное cron-выражение для атрибута

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRadiusUserTariff – Отвязать аккаунт Wi-Fi пользователя от тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента. Уникальность аккаунта определяется по логину и домену.

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента. Уникальность определяется по логину и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRadiusUserTariff>
            <xsd:username>tester</xsd:username>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RemoveRadiusUserTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRadiusUserTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveRadiusUserTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен пользователя не соответствует правилам

10

Домен роли не имеет прав на домен пользователя.

62

Домен клиента не зарегистрирован

20

Логин аккаунта некорректен

11

Пользователя не существует

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveTariff – Удаление тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

code

Уникальный код удаляемого тарифного плана

[\w \.-]\{1,64}

Текст латинскими буквами и цифрами до 64-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст.

Примеры команд и кодов

Код Описание ошибки

101

Некорректный код тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RemoveTariff>
            <nbi:code></nbi:code>
        </nbi:RemoveTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RemoveTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>101</ax21:code>
                <ax21:detail>Illegal tariff code</ax21:detail>
            </ns:return>
        </ns:RemoveTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RemoveTariff>
            <nbi:code>te</nbi:code>
        </nbi:RemoveTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RemoveTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>100</ax21:code>
                <ax21:detail>No tariff with such code</ax21:detail>
            </ns:return>
        </ns:RemoveTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь не может удалить тарифный план в данном домене
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RemoveTariff>
            <nbi:code>test1</nbi:code>
        </nbi:RemoveTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RemoveTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root'</ax21:detail>
            </ns:return>
        </ns:RemoveTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RemoveTariff>
            <nbi:code>test1</nbi:code>
        </nbi:RemoveTariff>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RemoveTariffResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:RemoveTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffAttrList - Запрос списка атрибутов тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст.

response

Массив объектов NbiEntryDescr

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffAttrList/>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffAttrListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeEntryDescrResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiEntryDescrArray">
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Set "true" if tariff is portal only</ax21:descr>
                        <ax21:entry>Eltex-Tariff-Portal-Only</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Portal tariff price, in rubles</ax21:descr>
                        <ax21:entry>Eltex-Tariff-Price</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Deactivating tariff. Allowable values 'true' or 'false'.</ax21:descr>
                        <ax21:entry>Eltex-User-Deactivated</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable / Disable SSID as a regular expression. Keep in mind that this attribute to the access point has the form «MAC: SSID», and if the set limit only SSID, the expression must start with '^.+[:]'</ax21:descr>
                        <ax21:entry>Called-Station-Id</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>The maximum number of simultaneous connections for users of this tariff.</ax21:descr>
                        <ax21:entry>Simultaneous-Use</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>WISPr vendor specific attributes for setting the maximum bandwidth rate in bits per second for downstream for no portal tariff.</ax21:descr>
                        <ax21:entry>WISPr-Bandwidth-Max-Down</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>WISPr vendor specific attributes for setting the maximum bandwidth rate in bits per second for upstream for not portal tariff.</ax21:descr>
                        <ax21:entry>WISPr-Bandwidth-Max-Up</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Policy profile for downstream for no portal tariff, not more than 253 characters</ax21:descr>
                        <ax21:entry>LVL7-Wireless-Client-Policy-Down</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Policy profile for upstream for no portal tariff, not more than 253 characters</ax21:descr>
                        <ax21:entry>LVL7-Wireless-Client-Policy-Up</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>The maximum session timeout for no portal tariff.</ax21:descr>
                        <ax21:entry>Session-Timeout</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Summary incoming traffic limit for users of no portal tariff, in bytes</ax21:descr>
                        <ax21:entry>Eltex-Traffic-Limit</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Summary work time limit for users of no portal tariff, in seconds</ax21:descr>
                        <ax21:entry>Eltex-Work-Time-Limit</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Validity period of users of no portal tariff, minutes since 'Eltex-User-Create-Date'</ax21:descr>
                        <ax21:entry>Eltex-Validity-Period</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>For correct VLAN settings for the users of no portal tariff, always put '13'.</ax21:descr>
                        <ax21:entry>Tunnel-Type</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>For correct VLAN settings for no portal tariff, always put '6'.</ax21:descr>
                        <ax21:entry>Tunnel-Medium-Type</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>VLAN ID for the no portal tariff. Permission is granted to only one ID. To set the VLAN attribute is also used Eltex-Additional-Vlans.</ax21:descr>
                        <ax21:entry>Tunnel-Private-Group-Id</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>VLAN IDs for the no portal tariff. IDs separated by commas (,). Allowed to 9 identifiers to the user.</ax21:descr>
                        <ax21:entry>Eltex-Additional-Vlans</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Reply message for no portal tariff, not more than 253 characters.</ax21:descr>
                        <ax21:entry>Reply-Message</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable (true)/disable (false) portal scenario with idx ${1}</ax21:descr>
                        <ax21:entry>Eltex-State-On-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>URL-address to redirect for scenario ${1} of portal tariff</ax21:descr>
                        <ax21:entry>Eltex-State-External-Url-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>The maximum timeout of scenario with idx ${1} of portal tariff</ax21:descr>
                        <ax21:entry>Eltex-State-Session-Timeout-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Summary work time limit for users for scenario with idx ${1} of portal tariff, in seconds</ax21:descr>
                        <ax21:entry>Eltex-State-Work-Time-Limit-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Summary incoming traffic limit for scenario with idx ${1} of portal tariff, in bytes</ax21:descr>
                        <ax21:entry>Eltex-State-Traffic-Limit-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>The maximum bandwidth rate in bits per second for downstream for scenario with idx ${1} of portal tariff.</ax21:descr>
                        <ax21:entry>Eltex-State-Bandwidth-Max-Down-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>The maximum bandwidth rate in bits per second for upstream for scenario with idx ${1} of portal tariff.</ax21:descr>
                        <ax21:entry>Eltex-State-Bandwidth-Max-Up-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Time during which the user authentication information for scenario ${1} of portal tariff is stored on the AP, in sec</ax21:descr>
                        <ax21:entry>Eltex-State-Away-Time-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable (true)/disable (false) accounting before redirect for scenario ${1} of portal tariff</ax21:descr>
                        <ax21:entry>Eltex-State-Start-Session-Before-Redirect-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Policy profile for downstream for scenario ${1} of portal tariff, not more than 253 characters</ax21:descr>
                        <ax21:entry>Eltex-State-LVL7-Wireless-Client-Policy-Down-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Policy profile for upstream for scenario ${1} of portal tariff, not more than 253 characters</ax21:descr>
                        <ax21:entry>Eltex-State-LVL7-Wireless-Client-Policy-Up-${1}</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Dns name, ip-address or mask (like 172.156.22.0/22) permit in scenario ${2} of portal tariff. ${1} - index of address, may be some</ax21:descr>
                        <ax21:entry>Eltex-State-Permitted-Ip${1}-${2}</ax21:entry>
                    </ax21:entry>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffAttrListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffFullAttrList - Возвращает полный список атрибутов тарифного плана из конфигурации

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает полный список атрибутов тарифного плана из конфигурации (файл tariff-attributes.xml).

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

locale

Локаль, обязательно

"ru", "ru_RU", "en", "en_GB" …​

Текст произвольной длины

Выходные параметры

Параметр Значение Формат значения

response

Cписок атрибутов тарифного плана

Объект NbiTariffAttrArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveTariffFullAttrList>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveTariffFullAttrList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveTariffFullAttrListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiTariffAttrListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiTariffAttrArray">
               <ax21:attrs xsi:type="ax212:NbiTariffAttr">
                  <ax212:canWrite>false</ax212:canWrite>
                  <ax212:descr>Дата создания</ax212:descr>
                  <ax212:group/>
                  <ax212:label>Дата создания</ax212:label>
                  <ax212:name>Eltex-User-Create-Date</ax212:name>
                  <ax212:objType>string</ax212:objType>
                  <ax212:ops>=</ax212:ops>
                  <ax212:scenario>false</ax212:scenario>
                  <ax212:type>groupreply</ax212:type>
                  <ax212:valueRegexp/>
               </ax21:attrs>
               <ax21:attrs xsi:type="ax212:NbiTariffAttr">
                  <ax212:canWrite>true</ax212:canWrite>
                  <ax212:descr>"true", чтобы тарифный план был портальным, иначе "false"</ax212:descr>
                  <ax212:group/>
                  <ax212:label>Портальная аутентификация</ax212:label>
                  <ax212:name>Eltex-Tariff-Portal-Only</ax212:name>
                  <ax212:objType>bool</ax212:objType>
                  <ax212:ops>=</ax212:ops>
                  <ax212:scenario>false</ax212:scenario>
                  <ax212:type>portal</ax212:type>
                  <ax212:valueRegexp>^(true|false)$</ax212:valueRegexp>
               </ax21:attrs>
            </ax21:response>
         </ns:return>
      </ns:RetrieveTariffFullAttrListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariff — Запрос атрибутов тарифного плана

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffCode

Код тарифного плана.

^.{1,64}$

Текст до 64-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объектов NbiSingleTariff

Примеры команд и кодов

Код Описание ошибки

101

Код тарифного плана некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariff>
            <xsd:tariffCode></xsd:tariffCode>
        </xsd:RetrieveTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'tariffCode'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariff>
            <xsd:tariffCode>test</xsd:tariffCode>
        </xsd:RetrieveTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>100</ns:code>
                <ns:detail>No Tariff with code 'test'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariff>
            <xsd:tariffCode>red</xsd:tariffCode>
        </xsd:RetrieveTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to tariff domain: 'enterprise.root'. Role`s domains: 'hotspot.root'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariff>
            <xsd:tariffCode>test1</xsd:tariffCode>
        </xsd:RetrieveTariff>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:createDate>2015-10-20T17:43:41.000+07:00</ns:createDate>
                    <ns:deactivated>false</ns:deactivated>
                    <ns:tariffCode>test1</ns:tariffCode>
                    <ns:tariffDescr>Безлимитный интернет на сутки за смешные 500 рублей</ns:tariffDescr>
                    <ns:tariffDomain>test.hotspot.root</ns:tariffDomain>
                    <ns:tariffName>Безлимит за смешную цену</ns:tariffName>
                    <ns:users>0</ns:users>
                    <ns:check/>
                    <ns:groupcheck>
                        <ns:attr>
                            <ns:name>Simultaneous-Use</ns:name>
                            <ns:oper>:=</ns:oper>
                            <ns:value>1</ns:value>
                        </ns:attr>
                    </ns:groupcheck>
                    <ns:groupreply>
                        <ns:attr>
                            <ns:name>Eltex-User-Create-Date</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>2015-10-20 17:43:41</ns:value>
                        </ns:attr>
                        <ns:attr>
                            <ns:name>Session-Timeout</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>72000</ns:value>
                        </ns:attr>
                    </ns:groupreply>
                    <ns:portal>
                        <ns:attr>
                            <ns:name>Eltex-Tariff-Price</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>500</ns:value>
                        </ns:attr>
                    </ns:portal>
                    <ns:reply/>
                </ns:response>
            </ns:return>
        </ns:RetrieveTariffResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffList – Запрос списка тарифных планов

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Команда не подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffName

Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffCode

Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffDomain

Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffAttr

0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiSingleTariff.

Примеры команд и кодов

Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffList>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>,?</nbi:tariffDomain>
        </nbi:RetrieveTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain ',?' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffList>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>root</nbi:tariffDomain>
        </nbi:RetrieveTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'hotspot.root'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Данный домен не зарегистрирован в системе SoftWLC
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffList>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>wifi.root</nbi:tariffDomain>
        </nbi:RetrieveTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such 'wifi.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffList>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper></xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiTariffArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariff">
                        <ax21:createDate>2015-10-20T15:34:08.000+06:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>black</ax21:tariffCode>
                        <ax21:tariffDescr>Для хотспот клиентов</ax21:tariffDescr>
                        <ax21:tariffDomain>hotspot.root</ax21:tariffDomain>
                        <ax21:tariffName>Черный</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Simultaneous-Use</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>1</ax21:value>
                            </ax21:attr>
                        </ax21:groupcheck>
                        <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2015-10-20 15:34:08</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Away-Time-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1200</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>131072</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>131072</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-External-Url-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>http://192.168.26.205:8080/eltex_portal/state1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-External-Url-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>http://192.168.26.205:8080/state2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip1-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.nsk.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip1-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.nsk.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip10-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.6</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip11-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.7</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip12-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.169.16.243</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip13-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.8</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip14-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.9</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip15-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip16-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.3</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip17-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>mail.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip18-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.4</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip19-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip2-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip2-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>git.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip20-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.6</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip21-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.loc</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip22-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.26.0/24</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip23-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>google.com</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip24-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.4</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip25-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>ya.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip26-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>yandex.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip27-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>gmail.com</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip28-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>rambler.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip29-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>jabber.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip3-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>red.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip4-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip5-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip6-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip7-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.3</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip8-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip9-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1800</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Session-Timeout-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1800</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Traffic-Limit-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>104857600</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Work-Time-Limit-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>900</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Validity-Period</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>7200</ax21:value>
                            </ax21:attr>
                        </ax21:reply>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiSingleTariff">
                        <ax21:createDate>2015-11-16T19:11:21.000+06:00</ax21:createDate>
                        <ax21:deactivated>true</ax21:deactivated>
                        <ax21:tariffCode>blocked</ax21:tariffCode>
                        <ax21:tariffDescr/>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>Залоченный</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Deactivated</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:groupcheck>
                        <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2015-11-16 19:11:21</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffListV2 – Запрос списка тарифных планов, которые содержат в том числе атрибуты bras

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Команда не подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffName

Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffCode

Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffDomain

Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffAttr

0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiSingleTariffWithBrasAttrs.

Примеры команд и кодов

Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>,?</nbi:tariffDomain>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain ',?' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray"/>
            </ns:return>
        </ns:RetrieveTariffListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>root</nbi:tariffDomain>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'hotspot.root'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray"/>
            </ns:return>
        </ns:RetrieveTariffListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Данный домен не зарегистрирован в системе SoftWLC
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>wifi.root</nbi:tariffDomain>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such 'wifi.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray"/>
            </ns:return>
        </ns:RetrieveTariffListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper></xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                        <ax21:createDate>2015-10-20T15:34:08.000+06:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>black</ax21:tariffCode>
                        <ax21:tariffDescr>Для хотспот клиентов</ax21:tariffDescr>
                        <ax21:tariffDomain>hotspot.root</ax21:tariffDomain>
                        <ax21:tariffName>Черный</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Simultaneous-Use</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>1</ax21:value>
                            </ax21:attr>
                        </ax21:groupcheck>
                        <ax21:groupreply xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2015-10-20 15:34:08</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Away-Time-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1200</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>131072</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>131072</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>65536</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-External-Url-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>http://192.168.26.205:8080/eltex_portal/state1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-External-Url-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>http://192.168.26.205:8080/state2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip1-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.nsk.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip1-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.nsk.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip10-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.6</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip11-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.7</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip12-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.169.16.243</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip13-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.8</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip14-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.9</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip15-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip16-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.3</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip17-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>mail.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip18-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.4</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip19-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip2-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip2-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>git.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip20-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.6</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip21-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.loc</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip22-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.26.0/24</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip23-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>google.com</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip24-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.4</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip25-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>ya.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip26-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>yandex.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip27-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>gmail.com</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip28-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>rambler.ru</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip29-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>jabber.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip3-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>red.eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip4-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.2.2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip5-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip6-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip7-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.3</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip8-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>192.168.1.5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Permitted-Ip9-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>eltex.org</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1800</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Session-Timeout-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1800</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-2</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-3</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-4</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Traffic-Limit-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>104857600</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Work-Time-Limit-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>900</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:bras xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Validity-Period</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>7200</ax21:value>
                            </ax21:attr>
                        </ax21:reply>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                        <ax21:createDate>2015-11-16T19:11:21.000+06:00</ax21:createDate>
                        <ax21:deactivated>true</ax21:deactivated>
                        <ax21:tariffCode>blocked</ax21:tariffCode>
                        <ax21:tariffDescr/>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>Залоченный</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Deactivated</ax21:name>
                                <ax21:oper>:=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:groupcheck>
                        <ax21:groupreply xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2015-11-16 19:11:21</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:bras xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper></xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                        <ax21:createDate>2016-08-09T14:46:56.000+06:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>brastar</ax21:tariffCode>
                        <ax21:tariffDescr>Брас-тариф</ax21:tariffDescr>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>Брасовский тариф</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ns:groupcheck/>
                        <ax21:groupreply xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2016-08-09 14:46:56</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Aserv1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Nserv2</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Acct-Interim-Interva</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>600</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Session-Timeout</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>600</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Idle-Timeout</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>600</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:bras xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Bras</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:bras>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                    </ax21:response>
                </ns:return>
            </ns:RetrieveTariffListV2Response>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTariffListV2>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
                <xsd:oper></xsd:oper>
                <xsd:value>false</xsd:value>
            </nbi:tariffAttr>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper></xsd:oper>
                <xsd:value>false</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                        <ax21:createDate>2016-08-12T16:46:19.000+06:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>enterpriseTariff</ax21:tariffCode>
                        <ax21:tariffDescr>Для enterprise-клиентов</ax21:tariffDescr>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>Enterprise</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:groupreply xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2016-08-12 16:46:19</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiTariffIncludeBrasArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                        <ax21:bras xsi:type="ax21:NbiTariffIncludeBrasArray"/>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListV2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffListV3 – Запрос списка тарифных планов(c пагинацией)

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Команда подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffName

Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffCode

Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffDomain

Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

tariffAttr

0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество тарифных планов, которые удовлетворяют условиям выборки

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiSingleTariff.

Примеры команд и кодов

Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>,?</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain ',?' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>root</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Данный домен не зарегистрирован в системе SoftWLC
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>wifi.root</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'wifi.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Значение 'Count' должно быть целым и положительным
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>0</nbi:count>
            <nbi:page>5</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>112</ax21:code>
                <ax21:detail>Count must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

113

Значение 'Page' должно быть целым и положительным
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>0</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>113</ax21:code>
                <ax21:detail>Page must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>112</ax21:code>
                <ax21:detail>In request by key 'count' value can not be null</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>5</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail>15</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariff">
                        <ax21:createDate>2016-10-05T09:49:42.000+07:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>bt1</ax21:tariffCode>
                        <ax21:tariffDescr/>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>bt1</ax21:tariffName>
                        <ax21:users>10</ax21:users>
                        <ax21:check xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Abt1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Nserv5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2016-10-05 09:49:42</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffListV4 - Запрос списка тарифных планов и привязанных к ним порталов

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

tariffName

Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffCode

Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

tariffDomain

Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

tariffAttr

0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiSingleTariffWithPortals.

code

Код ответа

int

detail

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveTariffListV4>
         <nbi:tariffName></nbi:tariffName>
         <nbi:tariffCode></nbi:tariffCode>
         <nbi:tariffDomain></nbi:tariffDomain>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
                <nbi:tariffAttr>
            <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>true</xsd:value>
         </nbi:tariffAttr>
      </nbi:RetrieveTariffListV4>
Ответ
      <ns:RetrieveTariffListV4Response
         <ns:return xsi:type="ax23:NbiCodeTariffResponse2">
            <ax23:code>0</ax23:code>
            <ax23:detail>1</ax23:detail>
            <ax23:response xsi:type="ax23:NbiTariffArray2">
               <ax23:item xsi:type="ax23:NbiSingleTariffWithPortalList">
                  <ax23:createDate>2017-05-23T15:37:51.000+07:00</ax23:createDate>
                  <ax23:deactivated>false</ax23:deactivated>
                  <ax23:tariffCode>hot</ax23:tariffCode>
                  <ax23:tariffDescr/>
                  <ax23:tariffDomain>root</ax23:tariffDomain>
                  <ax23:tariffName>hotspotTar</ax23:tariffName>
                  <ax23:users>10</ax23:users>
                  <ax23:check xsi:type="ax23:NbiAttrArray"/>
                  <ax23:groupcheck xsi:type="ax23:NbiAttrArray"/>
                  <ax23:groupreply xsi:type="ax23:NbiAttrArray">
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-User-Create-Date</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>2017-05-23 15:37:51</ax23:value>
                     </ax23:attr>
                  </ax23:groupreply>
                  <ax23:portal xsi:type="ax23:NbiAttrArray">
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-Tariff-Portal-Only</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>true</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-Tariff-Price</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>1</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-State-On-1</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>true</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-State-Start-Session-Before-Redirect-1</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>false</ax23:value>
                     </ax23:attr>
                  </ax23:portal>
                  <ax23:reply xsi:type="ax23:NbiAttrArray"/>
                  <ax23:portals xsi:type="ax23:NbiNameArray">
                     <ax23:name>portalName</ax23:name>
                     <ax23:name>bras</ax23:name>
                  </ax23:portals>
               </ax23:item>
            </ax23:response>
         </ns:return>
      </ns:RetrieveTariffListV4Response>
Код Описание ошибки

8

Неверное задание фильтра по домену

10

Домен роли не имеет прав на домен тарифного плана

62

Данный домен не зарегистрирован в системе SoftWLC

112

Значение 'Count' должно быть целым и положительным

113

Значение 'Page' должно быть целым и положительным

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffListV5 - Получить список тарифов, привязанных к данному порталу и отфильтрованных по списку доменов

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

  2. Команда не подгружает число пользователей, к которым тариф привязан.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

portal

Имя портала. Может быть пустым, тогда фильтрация по привязке не производится. Тариф включается в результирующий список, если он привязан к данному порталу. Проверка существования портала с данным именем при этом не производится.

^[ \w-]{1,32}$

Текст длиной до 32 символов.

domains

Список доменов пользователя. Может быть пустым, тогда фильтрация по доменам не производится. Тариф включается в ответ, если он доступен хотя бы в одном из доменов данного списка.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

response

Список тарифов, привязанных к указанному порталу, и отфильтрованных по списку доменов.

NbiTariffArrayExtended

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <RetrieveTariffListV5>
            <portal>default</portal>
        </RetrieveTariffListV5>
Ответ
        <ns:RetrieveTariffListV5Response>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiTariffArrayExtended">
                    <ax21:item xsi:type="ax21:NbiSingleTariffExtended">
                        <ax21:createDate xsi:nil="true"/>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>default</ax21:tariffCode>
                        <ax21:tariffDescr xsi:nil="true"/>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>Hotspot Default</ax21:tariffName>
                        <ax21:users>0</ax21:users>
                        <ax21:check xsi:nil="true"/>
                        <ax21:groupcheck xsi:nil="true"/>
                        <ax21:groupreply xsi:nil="true"/>
                        <ax21:portal xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-On-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>600</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Up-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1048576</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-State-Bandwidth-Max-Down-1</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>1048576</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>true</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:nil="true"/>
                        <ax21:bras xsi:type="ax21:NbiAttrArray"/>
                        <ax21:portals xsi:type="ax21:NbiNameArray">
                            <ax21:name>default</ax21:name>
                            <ax21:name>portal portal</ax21:name>
                        </ax21:portals>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListV5Response>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffWithBrasParams — Запрос атрибутов тарифного плана, включая атрибуты bras

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры
Параметр Значение Формат значения Расшифровка формата Ссылка

tariffCode

Код тарифного плана.

^.{1,64}$

Текст до 64-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объектов NbiSingleTariffWithBrasAttrs

Примеры команд и кодов

Код Описание ошибки

101

Код тарифного плана некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariffWithBrasParams>
            <xsd:tariffCode></xsd:tariffCode>
        </xsd:RetrieveTariffWithBrasParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffWithBrasParamsResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'tariffCode'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffWithBrasParamsResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariffWithBrasParams>
            <xsd:tariffCode>test</xsd:tariffCode>
        </xsd:RetrieveTariffWithBrasParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffWithBrasParamsResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>100</ns:code>
                <ns:detail>No Tariff with code 'test'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffWithBrasParamsResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен тарифного плана
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariffWithBrasParams>
            <xsd:tariffCode>red</xsd:tariffCode>
        </xsd:RetrieveTariffWithBrasParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffWithBrasParamsResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to tariff domain: 'enterprise.root'. Role`s domains: 'hotspot.root'</ns:detail>
                <ns:response>
                    <ns:createDate xsi:nil="true"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <ns:deactivated>false</ns:deactivated>
                        <ns:tariffCode/>
                        <ns:tariffDescr/>
                        <ns:tariffDomain/>
                        <ns:tariffName/>
                        <ns:users>0</ns:users>
                        <ns:check/>
                        <ns:groupcheck/>
                        <ns:groupreply/>
                        <ns:portal/>
                        <ns:reply/>
                    </ns:response>
                </ns:return>
            </ns:RetrieveTariffWithBrasParamsResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveTariffWithBrasParams>
            <xsd:tariffCode>brastar</xsd:tariffCode>
        </xsd:RetrieveTariffWithBrasParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTariffWithBrasParamsResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:createDate>2016-08-09T14:46:56.000+06:00</ns:createDate>
                    <ns:deactivated>false</ns:deactivated>
                    <ns:tariffCode>brastar</ns:tariffCode>
                    <ns:tariffDescr>Брасовский тариф</ns:tariffDescr>
                    <ns:tariffDomain>root</ns:tariffDomain>
                    <ns:tariffName>Брасовский тариф</ns:tariffName>
                    <ns:users>0</ns:users>
                    <ns:check/>
                    <ns:groupcheck/>
                    <ns:groupreply>
                        <ns:attr>
                            <ns:name>Cisco-Account-Info</ns:name>
                            <ns:oper>+=</ns:oper>
                            <ns:value>Aserv1</ns:value>
                        </ns:attr>
                        <ns:attr>
                            <ns:name>Cisco-Account-Info</ns:name>
                            <ns:oper>+=</ns:oper>
                            <ns:value>Nserv2</ns:value>
                        </ns:attr>
                        <ns:attr>
                            <ns:name>Eltex-User-Create-Date</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>2016-08-09 14:46:56</ns:value>
                        </ns:attr>
                    </ns:groupreply>
                    <ns:portal>
                        <ns:attr>
                            <ns:name>Eltex-Tariff-Portal-Only</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>false</ns:value>
                        </ns:attr>
                    </ns:portal>
                    <ns:reply/>
                    <ns:bras>
                        <ns:attr>
                            <ns:name>Eltex-Tariff-Bras</ns:name>
                            <ns:oper>=</ns:oper>
                            <ns:value>true</ns:value>
                        </ns:attr>
                    </ns:bras>
                </ns:response>
            </ns:return>
        </ns:RetrieveTariffWithBrasParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetTariffForRadiusUser – Изменить тарифный план для Wi-Fi пользователя

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Аккаунт WiFi пользователя. Объект NbiNameDomain.

Wi-Fi пользователь

tariffCode

Код тарифного плана.

^.{1,64}$

Текст длиной до 64 символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetTariffForRadiusUser>
            <xsd:user>
                <xsd1:domain>enterprise.root</xsd1:domain>
                <xsd1:name>tester</xsd1:name>
            </xsd:user>
            <xsd:tariffCode>test1</xsd:tariffCode>
        </xsd:SetTariffForRadiusUser>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetTariffForRadiusUserResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetTariffForRadiusUserResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

2

Ошибка доступа к БД

7

Отсутствует домен пользователя

10

Домен роли не имеет прав на домен клиента

62

Домен не зарегистрирован

20

Логин аккаунта некорректен

11

Данного пользователя не существует

101

Код тарифного плана некорректен

100

Тарифного плана с таким кодом не существует

444

У оператора(системного пользователя) отсутствует обязательный атрибут(Operator-Creator-Name, Operator-Creator-Family, Operator-Creator-Phone)

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTariffListCached - Получить список тарифных планов, если хэш изменился.

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Система сравнивает переданный в запросе хэш со значением хэша в БД тарифов. Если хэш изменился, ответ будет содержать все доступные пользователю тарифы. Если хэш не изменился, ответ будет пустой.

  3. Команда не подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

hash

хэш последнего обновления списка тарифов

tariffAttr

список фильтров по атрибутам NbiAttr

Выходные параметры

Параметр Значение Формат значения

hash

Хэш последнего обновления списка тарифов

int

response

Объект NbiTariffArray со списком тарифов

NbiTariffArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveTariffListCached>
         <nbi:hash>0</nbi:hash>
         <nbi:tariffAttr>
            <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>true</xsd:value>
         </nbi:tariffAttr>
      </nbi:RetrieveTariffListCached>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveTariffListCachedResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:hash>3</ax21:hash>
            <ax21:response xsi:type="ax21:NbiTariffArray">
               <ax21:item xsi:type="ax21:NbiSingleTariff">
                  <ax21:createDate>2015-12-08T15:49:15.000+06:00</ax21:createDate>
                  <ax21:deactivated>false</ax21:deactivated>
                  <ax21:tariffCode>1</ax21:tariffCode>
                  <ax21:tariffDescr>111</ax21:tariffDescr>
                  <ax21:tariffDomain>hotspot.root</ax21:tariffDomain>
                  <ax21:tariffName>test1</ax21:tariffName>
                  <ax21:users>0</ax21:users>
                  <ax21:check xsi:type="ax21:NbiAttrArray"/>
                  <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                  <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2015-12-08 15:49:15</ax21:value>
                     </ax21:attr>
                  </ax21:groupreply>
                  <ax21:portal xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-On-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                     </ax21:attr>
                  </ax21:portal>
                  <ax21:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Validity-Period</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>600</ax21:value>
                     </ax21:attr>
                  </ax21:reply>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveTariffListCachedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Нулевое значение атрибута фильтрации Домен

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetServicePropfileList - Просмотр остатков по сервисам

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

service

Массив объектов NbiServiceProfile

NbiServiceProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetServicePropfileList>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
      </nbi:GetServicePropfileList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetServicePropfileListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiServiceProfileListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:GetServicePropfileListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetServiceProfileOfUser - Просмотр остатков по сервисам для конкретного пользователя

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Имя пользователя

^.{1,64}$

Текст, любые символы.

userdomain

Домен пользователя.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

service

Массив объектов NbiServiceProfile

NbiServiceProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
    <soap:Header/>
    <soap:Body>
      <nbi:GetServiceProfileOfUser>
         <nbi:username>79137297264</nbi:username>
         <nbi:userdomain>BRAS2-Guest.brasSSID.root</nbi:userdomain>
      </nbi:GetServiceProfileOfUser>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetServiceProfileOfUserResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:service xsi:type="ax21:NbiServiceProfile">
                <ax21:quota xsi:type="ax21:NbiServiceQuota">
                   <ax21:quotatime xsi:nil="true"/>
                   <ax21:quotavolume xsi:nil="true"/>
                   <ax21:servicedomain>BRAS2-Guest.brasSSID.root</ax21:servicedomain>
                   <ax21:servicename>LAN2</ax21:servicename>
                </ax21:quota>
                <ax21:quota xsi:type="ax21:NbiServiceQuota">
                   <ax21:quotatime xsi:nil="true"/>
                   <ax21:quotavolume xsi:nil="true"/>
                   <ax21:servicedomain>BRAS2-Guest.brasSSID.root</ax21:servicedomain>
                   <ax21:servicename>INTERNET2</ax21:servicename>
                </ax21:quota>
            <ax21:userdomain>BRAS2-Guest.brasSSID.root</ax21:userdomain>
            <ax21:username>79137297264</ax21:username>
            </ax21:service>
         </ns:return>
      </ns:GetServiceProfileOfUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'domain'

8

Домен не соответствует правилам

10

Нет прав на указанный в списке ключей домен

62

Указанный домен не зарегистрирован

69

Некорректный параметр запроса 'username'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetScriptsStepOfUser - Просмотр порядка следования сервисов для конкретного пользователя

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Имя пользователя

^.{1,64}$

Текст, любые символы.

userdomain

Домен пользователя.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

service

Массив объектов NbiScriptStep

NbiScriptStep

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
    <soap:Header/>
    <soap:Body>
      <nbi:GetScriptsStepOfUser>
         <nbi:username>79137297264</nbi:username>
         <nbi:userdomain>BRAS2-Guest.brasSSID.root</nbi:userdomain>
      </nbi:GetScriptsStepOfUser>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetScriptsStepOfUserResponse>
            <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:step xsi:type="ax21:NbiScriptStep">
               <ax21:servicename>LAN2</ax21:servicename>
               <ax21:step>1</ax21:step>
            </ax21:step>
            <ax21:step xsi:type="ax21:NbiScriptStep">
               <ax21:servicename>INTERNET2</ax21:servicename>
               <ax21:step xsi:nil="true"/>
            </ax21:step>
         </ns:return>
      </ns:GetScriptsStepOfUserResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'domain'

8

Домен не соответствует правилам

10

Нет прав на указанный в списке ключей домен

62

Указанный домен не зарегистрирован

69

Некорректный параметр запроса 'username'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetFullTariffsPartition - Получить список тарифов без фильтрации с пагинацией

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Фильтрация по домену выполняется в соответствии с ограничениями роли пользователя, от имени которого выполняется запрос.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

skip

Число тарифов, которые надо пропустить

int

Целое неотрицательно число, по умолчанию 0

count

Число тарифов, которые надо вернуть

int

Целое неотрицательно число, по умолчанию 10

Выходные параметры

Параметр Значение Формат значения

hash

Хэш последнего обновления списка тарифов

Integer

array

Массив объектов NbiSingleTariffWithBrasAttrs с описанием тарифов

NbiSingleTariffWithBrasAttrs

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetFullTariffsPartition>
    <nbi:skip>0</nbi:skip>
    <nbi:count>1</nbi:count>
</nbi:GetFullTariffsPartition>
Ответ
<ns:GetFullTariffsPartitionResponse>
    <ns:return xsi:type="ax21:NbiCodeTariffWithBrasHashResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:array xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
            <ax21:createDate>2021-01-27T13:20:14.000+00:00</ax21:createDate>
            <ax21:deactivated>false</ax21:deactivated>
            <ax21:tariffCode>test</ax21:tariffCode>
            <ax21:tariffDescr/>
            <ax21:tariffDomain>root</ax21:tariffDomain>
            <ax21:tariffName>test</ax21:tariffName>
            <ax21:users>0</ax21:users>
            <ax21:check xsi:type="ax21:NbiAttrArray"/>
            <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
            <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                <ax21:attr xsi:type="ax21:NbiAttr">
                    <ax21:name>Eltex-User-Create-Date</ax21:name>
                    <ax21:oper>=</ax21:oper>
                    <ax21:value>2021-01-27 13:20:14</ax21:value>
                </ax21:attr>
            </ax21:groupreply>
            <ax21:portal xsi:type="ax21:NbiAttrArray">
                <ax21:attr xsi:type="ax21:NbiAttr">
                    <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                    <ax21:oper>=</ax21:oper>
                    <ax21:value>true</ax21:value>
                </ax21:attr>
                <ax21:attr xsi:type="ax21:NbiAttr">
                    <ax21:name>Eltex-Tariff-Price</ax21:name>
                    <ax21:oper>=</ax21:oper>
                    <ax21:value>0</ax21:value>
                </ax21:attr>
                <ax21:attr xsi:type="ax21:NbiAttr">
                    <ax21:name>Eltex-State-On-1</ax21:name>
                    <ax21:oper>=</ax21:oper>
                    <ax21:value>true</ax21:value>
                </ax21:attr>
                <ax21:attr xsi:type="ax21:NbiAttr">
                    <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                    <ax21:oper>=</ax21:oper>
                    <ax21:value>false</ax21:value>
                </ax21:attr>
            </ax21:portal>
            <ax21:reply xsi:type="ax21:NbiAttrArray"/>
            <ax21:bras xsi:type="ax21:NbiAttrArray"/>
        </ax21:array>
        <ax21:hash>426</ax21:hash>
    </ns:return>
</ns:GetFullTariffsPartitionResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetCurrentTariffsHash - Получить текущий хэш тарифов

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

Выходные параметры

Параметр Значение Формат значения

response

Строковое представление хэша

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetCurrentTariffsHash/>
Ответ
<ns:GetCurrentTariffsHashResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>419</ax21:response>
    </ns:return>
</ns:GetCurrentTariffsHashResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusTariffListByType - Получить список тарифов с фильтрацией по типу

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить тарифы точек доступа, либо тарифы pcrf/BRAS с пагинацией. Если выполнить запрос с параметром count = 0, то можно получить в поле detail количество тарифов, подходящих под условия запроса.

  3. Начиная с версии 1.22 появилась команда RetrieveRadiusTariffListFreeSearch, которая позволяет более гибко фильтровать данные и сортировать их.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

tariffName

Название тарифного плана. Если параметр установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов)

^.{1,64}$

Текст до 64-х символов

tariffDomain

Домен, в котором находятся тарифы

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

tariffType

Тип тарифа

^(portal|pcrf)$

Portal - тарифы ТД, pcrf - тарифы pcrf и BRAS

skip

Число тарифов, которые надо пропустить

int

Целое неотрицательное число

count

Число тарифов, которые надо вернуть

int

Целое неотрицательное число

Выходные параметры

Параметр Значение Формат значения

response

Список тарифов с порталами

NbiTariffArrayWithPortals

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveRadiusTariffListByType>
    <nbi:tariffName></nbi:tariffName>
    <nbi:tariffDomain>.root</nbi:tariffDomain>
    <nbi:tariffType>portal</nbi:tariffType>
    <nbi:skip>0</nbi:skip>
    <nbi:count>10</nbi:count>
</nbi:RetrieveRadiusTariffListByType>
Ответ
<ns:RetrieveRadiusTariffListByTypeResponse>
    <ns:return xsi:type="ax21:NbiCodeTariffWithPortalsResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response xsi:type="ax21:NbiTariffArrayWithPortals">
            <ax21:item xsi:type="ax21:NbiSingleTariffWithPortals">
                <ax21:createDate>2021-04-12T04:00:47.000+00:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>default</ax21:tariffCode>
                <ax21:tariffDescr xsi:nil="true"/>
                <ax21:tariffDomain>root</ax21:tariffDomain>
                <ax21:tariffName>Hotspot Default</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-04-12 04:00:47</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-On-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>600</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Bandwidth-Max-Up-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1048576</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Bandwidth-Max-Down-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1048576</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:portals xsi:type="ax21:NbiNameArray">
                    <ax21:name>default</ax21:name>
                </ax21:portals>
            </ax21:item>
            <ax21:item xsi:type="ax21:NbiSingleTariffWithPortals">
                <ax21:createDate>2021-05-11T04:00:47.000+00:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>test</ax21:tariffCode>
                <ax21:tariffDescr/>
                <ax21:tariffDomain>test.root</ax21:tariffDomain>
                <ax21:tariffName>test</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-05-11 04:00:47</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:portals xsi:type="ax21:NbiNameArray"/>
            </ax21:item>
        </ax21:response>
    </ns:return>
</ns:RetrieveRadiusTariffListByTypeResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

281

Не указан один из обязательных параметров запроса

312

Некорректное значение для параметра 'tariffType'

441

Не настроен Elvis

494

Ошибка авторизации

506

Ошибка DOORS-NBI

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusTariffListFreeSearch - Получить список тарифов по типу тарифа и гибкому фильтру

Общая информация

  1. Команда актуальна, начиная с версии 1.22.

  2. Команда позволяет получить список тарифов с фильтрацией по типу тарифа (ТД/PCRF) и полям tariffCode, tariffName, tariffDomain с помощью гибкого фильтра.

  3. Команда позволяет отсортировать результат по полям таблицы radius.TARIFF в прямом и обратном лексикографическом порядке.

  4. Команда возвращает данные с пагинацией. По умолчанию возвращаются первые 10 записей, подходящих под условие запроса. Если выполнить запрос с параметром count = 0, то можно получить в поле detail количество тарифов, подходящих под условия запроса.

  5. С помощью этой команды можно получить количество пользователей, связанных с тарифами.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Обязательный параметр

filter

Гибкий фильтр по полям tariffCode, tariffName, tariffDomain

String

нет

domains

Список доменов, в которых находятся. Если список пуст, то домены будут взяты из роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

нет

tariffType

Тип тарифа (обязательный параметр)

^(portal|pcrf)$

Portal - тарифы ТД, pcrf - тарифы pcrf и BRAS.

да

countUsers

Считать количество пользователей, использующих тариф. Если параметр не будет указан, то пользователи не будут подсчитаны.

^(true|false)$

true или false

нет

count

Число тарифов, которые надо вернуть

int

Целое неотрицательное число. По умолчанию - 10. Параметр пагинации (число записей на одну страницу).

нет

skip

Число тарифов, которые надо пропустить

int

Целое неотрицательное число. По умолчанию - 0. Параметр пагинации.

нет

orderBy

Сортировать записи по указанному полю

String

Название поля таблицы radius.TARIFF (по умолчанию id)

нет

orderType

Порядок сортировки (по умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

нет

Выходные параметры

Параметр Значение Формат значения

response

NbiTariffArrayWithPortals

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveRadiusTariffListFreeSearch>
    <nbi:filter>test</nbi:filter>
    <nbi:domains>.test.root</nbi:domains>
    <nbi:domains>.nsk.root</nbi:domains>
    <nbi:tariffType>portal</nbi:tariffType>
    <nbi:countUsers>false</nbi:countUsers>
    <nbi:count>10</nbi:count>
    <nbi:skip>0</nbi:skip>
    <nbi:orderBy>id</nbi:orderBy>
    <nbi:orderType>ASC</nbi:orderType>
</nbi:RetrieveRadiusTariffListFreeSearch>
Ответ
<ns:RetrieveRadiusTariffListFreeSearchResponse xmlns:ns="http://nbi.radius.eltex.org">
    <ns:return xsi:type="ax23:NbiCodeTariffWithPortalsResponse">
        <ax21:code>0</ax23:code>
        <ax21:detail>Success</ax23:detail>
        <ax21:response xsi:type="ax23:NbiTariffArrayWithPortals">
            <ax21:item xsi:type="ax21:NbiSingleTariffWithPortals">
                <ax21:createDate>2021-06-22T16:34:47.000+07:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>test</ax21:tariffCode>
                <ax21:tariffDescr/>
                <ax21:tariffDomain>test.root</ax21:tariffDomain>
                <ax21:tariffName>test</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-06-22 09:34:46</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:portals xsi:type="ax21:NbiNameArray"/>
            </ax21:item>
            <ax21:item xsi:type="ax21:NbiSingleTariffWithPortals">
                <ax21:createDate>2022-03-18T21:44:00.000+07:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>bestTariffEver</ax21:tariffCode>
                <ax21:tariffDescr/>
                <ax21:tariffDomain>nsk.root</ax21:tariffDomain>
                <ax21:tariffName>best test tariff</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2022-03-18 21:43:59</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:portals xsi:type="ax21:NbiNameArray"/>
            </ax21:item>
        </ax21:response>
    </ns:return>
</ns:RetrieveRadiusTariffListFreeSearchResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на указанный домен

62

Несуществующий домен

114

Некорректное значение поля "orderBy"

281

Не указан один из обязательных параметров запроса

312

Некорректное значение для параметра 'tariffType'

441

Не настроен Elvis

494

Ошибка авторизации

506

Ошибка DOORS-NBI

999

Системная ошибка

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusTariffListForPortal - Получить список тарифов, имеющих привязки к порталу

Общая информация

  1. Команда актуальна, начиная с версии 1.23.

  2. Команда позволяет получить список тарифов, имеющих привязку к указанному порталу. Либо если портал не указан, то просто список тарифов, подходящих под условия запроса.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

portalName

Имя портала. Может быть пустым, тогда фильтрация по привязке не производится. Тариф включается в результирующий список, если он привязан к данному порталу. Проверка существования портала с данным именем при этом не производится.

^[ \w-]{1,32}$

Текст длиной до 32 символов.

domains

Список доменов, в которых будет произведен поиск тарифов (включая поддомены). Если список пуст, то домены будут взяты из роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]\{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

response

Список тарифов, с атрибутами, но без портальных привязок

NbiTariffIncludeBrasArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveRadiusTariffListForPortal>
    <nbi:portalName>default</nbi:portalName>
    <nbi:domains>root</nbi:domains>
</nbi:RetrieveRadiusTariffListForPortal>
Ответ
<ns:RetrieveRadiusTariffListForPortalResponse xmlns:ns="http://nbi.radius.eltex.org">
    <ns:return xsi:type="ax21:NbiCodeTariffIncludeBrasResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response xsi:type="ax21:NbiTariffIncludeBrasArray">
            <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                <ax21:createDate>2022-03-09T21:13:12.000+07:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>testTariff</ax21:tariffCode>
                <ax21:tariffDescr>Test tariff</ax21:tariffDescr>
                <ax21:tariffDomain>root</ax21:tariffDomain>
                <ax21:tariffName>testTarif</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2022-03-09 21:13:12</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-On-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>18000</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Traffic-Limit-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>367001600</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-On-2</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-External-Url-2</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>http://10.62.18.22:8080/eltex_portal/</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Start-Session-Before-Redirect-2</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:bras xsi:type="ax21:NbiAttrArray"/>
            </ax21:item>
            <ax21:item xsi:type="ax21:NbiSingleTariffWithBrasAttrs">
                <ax21:createDate>2021-06-12T19:57:49.000+07:00</ax21:createDate>
                <ax21:deactivated>false</ax21:deactivated>
                <ax21:tariffCode>default</ax21:tariffCode>
                <ax21:tariffDescr xsi:nil="true"/>
                <ax21:tariffDomain>root</ax21:tariffDomain>
                <ax21:tariffName>Hotspot Default</ax21:tariffName>
                <ax21:users>0</ax21:users>
                <ax21:check xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-06-12 12:57:49</ax21:value>
                    </ax21:attr>
                </ax21:groupreply>
                <ax21:portal xsi:type="ax21:NbiAttrArray">
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-On-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Start-Session-Before-Redirect-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>false</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Session-Timeout-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>600</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Bandwidth-Max-Up-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1048576</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-State-Bandwidth-Max-Down-1</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1048576</ax21:value>
                    </ax21:attr>
                    <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>true</ax21:value>
                    </ax21:attr>
                </ax21:portal>
                <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                <ax21:bras xsi:type="ax21:NbiAttrArray"/>
            </ax21:item>
        </ax21:response>
    </ns:return>
</ns:RetrieveRadiusTariffListForPortalResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на указанный домен

62

Несуществующий домен

102

Портала с таким именем не существует

103

Некорректное значение поля 'webPortal'

441

Elvis не настроен

494

Ошибка авторизации Doors

506

DOORS-NBI error

507

ELVIS-NBI error

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateDomain – Создание домена в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, команда также создаёт узел дерева (средствами EMS), если тип домена (domain_type) ap или both. Узел создается непосредственным обращением NBI в БД. Для перечитывания дерева объектов в EMS на EMS-NBI уходит команда notifyTreeChanged. Результат выполнения команды notifyTreeChanged не влияет на итоговый результат для CreateDomain.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

parentDomain

Родительский домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

name

Имя нового узла домена.

^(?!-|_|.*(__|--).*)[a-zA-Z0-9_\\-]\{1,63})$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 63-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

decsr

Описание нового узла домена.

.{0,255}$

До 255-ти любых символов.

params

Атрибуты домена, ожидается 0 или более объектов NbiParameter.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
        <nbi:CreateDomain>
            <nbi:parentDomain>root</nbi:parentDomain>
            <nbi:name>wifi</nbi:name>
            <nbi:descr></nbi:descr>
            <nbi:params>
                <xsd:parameter>
                    <xsd:name>users_limit</xsd:name>
                    <xsd:value>100</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                    <xsd:name>domain_type</xsd:name>
                    <xsd:value>service</xsd:value>
                </xsd:parameter>
                <xsd:parameter>
                    <xsd:name>profile_id</xsd:name>
                    <xsd:value>1,2,3</xsd:value>
                </xsd:parameter>
            </nbi:params>
        </nbi:CreateDomain>
Ответ
        <ns:CreateDomainResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:CreateDomainResponse>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных

3

Ошибка от сервера EMS

8

Родительский домен не соответствует правилам

10

Домен роли не имеет прав на родительский домен

18

В конфигурации неверно настроен адрес EMS NBI, или он недоступен

33

Нет обязательного поля name, или оно некорректно

62

Родительский домен не зарегистрирован

67

Создаваемый домен уже существует

74

Некорректное значение атрибута

263

Ограничение количества пользователей больше, чем у родительского домена

266

Некорректная длина полного домена

281

Не найден обязательный параметр запроса (домен)

313

Некорректное название атрибута

423

Тип создаваемого домена отличается от типа родительского домена

442

Некорректный идентификатор таймзоны

522

Профиль юрлица не найден

535

Выбранный 'hotel_id' уже существует

536

Некорректный 'hotel_id'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteDomain – Удаление домена из системы SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Удаляемый домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

2

Ошибка взаимодействия с базой данных

7

Отсутствует домен

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен

62

Домен не зарегистрирован

216

Домен уже используется и не может быть удален

281

Не найден обязательный параметр запроса
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:DeleteDomain>
            <xsd:domain>sber.enterprise.root</xsd:domain>
        </xsd:DeleteDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:DeleteDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:DeleteDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteDomainWithDependencies – Удаление домена и всех его зависимостей из системы SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. В версии 1.19 добавлены изменения в работе команды, подробности указаны в таблице ниже.

№ Имя БД Таблицы Что удаляет Политика работы с данными

1

AppsMongoStorage

MongoDB

pcrf: apps

Списки приложений для фильтрации трафика

Удаляем

2

AuthServiceStorage

MySQL

eltex-auth-service: radreply

Удалить зависимости домена, касающиеся пользователей ЛК

Удаляем

3

DomainStorage

MySQL

eltex-ems: PARAMS

Домены из ролей EMS, роли, оставшиеся без домена, и их пользователи EMS. Дополнительно обращение в EMS removeRoleWithUsers.

Удаляем, так как изменения касаются дерева объектов

4

EmsGeoStorage

MySQL

-

Ничего не удаляет. Лишнее периодически убирает EMS.

Фоновая очистка

5

EmsTreeStorage

MySQL

eltex-ems: PARAMS, ELTEX_MAIN_TREE

Удаляет из дерева узел с подузлами, соответствующий домену через обращение к EMS removeTreeObjects

Удаляем, так как изменения касаются дерева объектов

6

FiltersStorage

MongoDB

pcrf: fsfilters

Удаление списка фильтрации в pcrf

Удаляем

7

HotspotAccessListsStorage

MongoDB

pcrf: hotspotAccessLists

Удаление привязок(HotspotAccessList черно-белые списки MAC) к порталу по домену и самого списка

Удаляем

8

HotspotDefAccessListsStorage

MongoDB

pcrf: hotspotDefAccessLists

Удаление привязок(HotspotAccessDefList черно-белые списки номеров) к порталу по домену и самого списка

Удаляем

9

MacsStorage

MongoDB

pcrf: macs

Ничего не удаляет. Выполняется при удалении radius пользователя через removeRadiusUserByDomain

-

10

PcrfScriptsStorage

MySQL

radius:PCRF_SCRIPTS

Удаление скрипта в pcrf если он нигде не используется

Удаляем, так как определяет услугу на BRAS

11

PortalStorage

MySQL

wireless: SSID_PARAMS

Ничего не удаляет, просто меняет значение атрибута и сообщаем в pcrf об изменениях SSID-а

Проводим изменения

12

RadiusStorage

MySQL

radius: все используемые таблицы

Удаление группы пользователей по домену. Очистка поле тарифа для всех групп пользователей с данным доменом. Удаление NAS.

Удаляем только NAS, остальное остаётся в БД

13

SSIDStorage

MySQL

wireless: SSID, SSID_LINK

Удаление SSID с привязками.

Удаляем, так как определяет состав услуги

14

SchedulerStorage

MongoDB

wifi-customer-cab: tasks

При удалении домена, удаляем задачи из wifi-customer-cab: tasks

Автоудаление при попытке использования (реализовано в ЛК, SsidPskChanger)

15

ScriptsStorage

MongoDB

pcrf: scripts

Удаление состояния учетки в скрипте pcrf

Удаление происходит вместе с пользователем

16

ServiceStorage

MongoDB

pcrf: service

Удаляет пользователей по домену.

Не удаляем.

17

ServiceStorageMySql

MySQL

radius: service

Удаляет радиус пользователей из таблицы radius.service по домену

Удаляем, так как определяет услугу на BRAS

18

SessionStorage

MongoDB

pcrf: session

Удаление сессий

Не удаляем. Удаление происходит через PCRF

19

ShaperStorage

MongoDB

pcrf: session

Очистка шейперов по домену

Удаляем, так как определяет услугу на BRAS

20

Sorm2LinksStorage

MongoDB

sorm2: links

Удалить все элементы домена

Удаляем, так как включает пересылку сообщений

21

Sorm2ProfilesStorage

MongoDB

sorm2: profiles

Удалить все элементы домена

Удаляем

22

SubnetsStorage

MongoDB

pcrf: subnets

Удаляем профиль местоположения подсети

Удаляем, так как определяет услугу на BRAS

23

TariffStorage

MySQL

radius: TARIFF

Удаления тарифного плана и его привязок

Удаляем, так как определяет услугу

24

TechnicalProfileStorage

MySQL

eltex-ems: INIT_RULES INIT_LINK

Удаление профилей, привязок, правил инициализации, шаблонов из файловой системы

Удаляем, так как отвечает за инициализацию устройства

25

TemplateStorage

MongoDB

netconf: templates

Удаляются Netconf шаблоны

Удаляем

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Удаляемый домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:DeleteDomainWithDependenciesResponse>
            <xsd:domain>sber.enterprise.root</xsd:domain>
        </xsd:DeleteDomainWithDependenciesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:DeleteDomainWithDependenciesResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:DeleteDomainWithDependenciesResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно

3

Ошибка от сервера EMS

8

Домен не соответствует правилам

10

Домен роли не имеет прав на домен

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

62

Домен не зарегистрирован

281

Не найден обязательный параметр запроса (домен)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditDomain – Редактирование домена в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. С версии 1.19 доступно редактирование параметра profile_id

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

parentDomain

Родительский домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

name

Имя редактируемого узла домена.

^(?!-|_|.*(__|--).*)[a-zA-Z0-9_\\-]\{1,63})$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 63-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

desсr

Редактируемое описание узла домена.

.{0,255}$

До 255-ти любых символов.

params

Атрибуты домена, ожидается 0 или более объектов NbiParameter.

Если указать значение атрибута пустым или null, то после редактирования он будет удалён.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:EditDomain>
            <nbi:parentDomain>root</nbi:parentDomain>
            <nbi:name>wifi</nbi:name>
            <nbi:descr></nbi:descr>
            <nbi:params>
                <xsd:parameter>
                    <xsd:name>domain_type</xsd:name>
                    <xsd:value>both</xsd:value>
                </xsd:parameter>
            </nbi:params>
        </nbi:EditDomain>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:EditDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных

3

Ошибка от сервера EMS

7

Некорректный домен (отсутствует)

8

Домен не соответствует правилам FQDN

10

У роли нет прав на редактирование данного домена

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

33

Нет обязательного поля name или оно некорректно

62

Домен не зарегистрирован

67

Создаваемый домен уже существует

74

Некорректное значение атрибута

281

Не найден обязательный параметр запроса

313

Некорректное название атрибута

423

Тип редактируемого домена имеет тип, отличающийся от типа родительского домена.

425

Тип редактируемого домена имеет тип, отличающийся от типа его дочернего домена.

442

Некорректный идентификатор таймзоны

522

Профиль, указанный для данного домена, не существует.

527

Выбранный 'profile_id' уже установлен на родительском домене

535

Выбранный 'hotel_id' уже существует

536

Некорректный 'hotel_id'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

IsDomainUsed – Проверка на использование домена где-либо в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

parentDomain

Родительский домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

name

Имя узла домена.

^(?!-|_|.*(__|--).*)[a-zA-Z0-9_\\-]\{1,63})$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 63-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

usages

Место использования (список)

Cтрока в произвольном формате

subdomains

Список поддоменов

Cтрока в произвольном формате

Примеры команд и кодов

Код Описание ошибки

7

Нет родительского домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain></xsd:parentDomain>
            <xsd:name></xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>7</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Incorrect field 'parentDomain'</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Родительский домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>-123</xsd:parentDomain>
            <xsd:name></xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Domain '-123' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Родительский домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>rot</xsd:parentDomain>
            <xsd:name></xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Such 'rot' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно некорректно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>enterprise.root</xsd:parentDomain>
            <xsd:name></xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Incorrect field 'name'</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

67

Создаваемый домен уже существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>enterprise.root</xsd:parentDomain>
            <xsd:name>test</xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>67</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Domain 'test.enterprise.root' already exists!</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервера EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>enterprise.root</xsd:parentDomain>
            <xsd:name>sber</xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Error from EMS server: code 103, message 'null'</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на родительский домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>root</xsd:parentDomain>
            <xsd:name></xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>enterprise.root</xsd:parentDomain>
            <xsd:name>sber</xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:response>false</ns:response>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:IsDomainUsed>
            <xsd:parentDomain>enterprise.root</xsd:parentDomain>
            <xsd:name>alpha</xsd:name>
        </xsd:IsDomainUsed>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:IsDomainUsedResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ax21:subDomains>Domain 'Guest.alpha.enterprise.root'</ax21:subDomains>
                <ns:usages>EMS role</ns:usages>
                <ns:usages>EMS device</ns:usages>
                <ns:usages>RADIUS user check attributes</ns:usages>
                <ns:usages>SSID</ns:usages>
                <ns:usages>Tariff</ns:usages>
                <ns:usages>Initialization rule</ns:usages>
                <ns:usages>System role reply attributes</ns:usages>
            </ns:return>
        </ns:IsDomainUsedResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomain – Получить список атрибутов домена по имени в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Фильтр по домену. Не может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiDomain

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomain>
         <nbi:domain>?</nbi:domain>
      </nbi:RetrieveDomain>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveDomainResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>8</ax21:code>
            <ax21:detail>Domain '?' does not conform to the rules FQDN</ax21:detail>
            <ax239:response xsi:type="ax21:NbiDomain">
               <ax21:descr xsi:nil="true"/>
               <ax21:name xsi:nil="true"/>
               <ax21:params xsi:nil="true"/>
            </ax239:response>
         </ns:return>
      </ns:RetrieveDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomain>
         <nbi:domain>rt.root</nbi:domain>
      </nbi:RetrieveDomain>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveDomainResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>62</ax21:code>
            <ax21:detail>Such domain 'rt.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            <ax239:response xsi:type="ax21:NbiDomain">
               <ax21:descr xsi:nil="true"/>
               <ax21:name xsi:nil="true"/>
               <ax21:params xsi:nil="true"/>
            </ax239:response>
         </ns:return>
      </ns:RetrieveDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomain>
         <nbi:domain>root</nbi:domain>
      </nbi:RetrieveDomain>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveDomainResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>10</ax21:code>
            <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
            <ax239:response xsi:type="ax21:NbiDomain">
               <ax21:descr xsi:nil="true"/>
               <ax21:name xsi:nil="true"/>
               <ax21:params xsi:nil="true"/>
            </ax239:response>
         </ns:return>
      </ns:RetrieveDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomain>
         <nbi:domain>omsk1.omsk.root</nbi:domain>
      </nbi:RetrieveDomain>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveDomainResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax239:response xsi:type="ax21:NbiDomain">
               <ax21:descr/>
               <ax21:name>omsk1.omsk.root</ax21:name>
               <ax21:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>users_limit</ax21:name>
                     <ax21:value>100</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>domain_type</ax21:name>
                     <ax21:value>service</ax21:value>
                  </ax21:parameter>
               </ax21:params>
            </ax239:response>
         </ns:return>
      </ns:RetrieveDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainType - Получить тип домена по полному пути

Общая информация

  1. Команда актуальна, начиная с версии 1.21.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

имя домена

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Выходные параметры

Параметр Значение Формат значения

response

ap, both или service

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomainType>
         <nbi:domain>volga.ap.root</nbi:domain>
      </nbi:RetrieveDomainType>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveDomainTypeResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:response>ap</ax21:response>
         </ns:return>
      </ns:RetrieveDomainTypeResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка доступа к БД

7

Некорректный домен

217

Домен не существует

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainTimezone - Получить таймзону для домена в системе SoftWLC.

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен, для которого нужно получить таймзону

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

response

Идентификатор таймзоны, например 'Asia/Novosibirsk'

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveDomainTimezone>
         <nbi:domain>novosibirsk.enterprise.root</nbi:domain>
      </nbi:RetrieveDomainTimezone>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveDomainTimezoneResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiCodeResponse" xmlns:ax229="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax238="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax247="http://sorm2.response.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://locationHistory.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax235="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax243="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax23="http://object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://radiusUser.response.object.nbi.radius.eltex.org/xsd" xmlns:ax253="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax250="http://service.response.object.nbi.radius.eltex.org/xsd" xmlns:ax240="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response>Asia/Novosibirsk</ax21:response>
         </ns:return>
      </ns:RetrieveDomainTimezoneResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Домен задан некорректно

10

Пользователь не имеет прав на работу с данным доменом

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainsTimezone - Получить таймзону для списка доменов в системе SoftWLC.

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

список доменов

NbiStringList

Выходные параметры

Параметр Значение Формат значения

response

Массив объектов NbiDomainTimezone

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveDomainsTimezone>
         <nbi:domains>
            <xsd:str>root</xsd:str>
            <xsd:str>novosibirsk.enterprise.root</xsd:str>
         </nbi:domains>
      </nbi:RetrieveDomainsTimezone>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveDomainsTimezoneResponse>
         <ns:return xsi:type="ax21:NbiCodeResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax218:array xsi:type="ax218:NbiDomainTimezone">
               <ax218:domain>root</ax218:domain>
               <ax218:timezone>Asia/Novosibirsk</ax218:timezone>
            </ax218:array>
            <ax218:array xsi:type="ax218:NbiDomainTimezone">
               <ax218:domain>novosibirsk.enterprise.root</ax218:domain>
               <ax218:timezone>Asia/Novosibirsk</ax218:timezone>
            </ax218:array>
         </ns:return>
      </ns:RetrieveDomainsTimezoneResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Домен задан некорректно

10

Пользователь не имеет прав на работу с данным доменом

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainTree – Получить список доменов, зарегистрированных в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Фильтр по домену. Если установлен, то вывод только списка поддоменов для данного. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiNameArray

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTree>
            <xsd:domain>?</xsd:domain>
        </xsd:RetrieveDomainTree>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTree>
            <xsd:domain>re</xsd:domain>
        </xsd:RetrieveDomainTree>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 're' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTree>
            <xsd:domain>root</xsd:domain>
        </xsd:RetrieveDomainTree>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTree>
            <xsd:domain></xsd:domain>
        </xsd:RetrieveDomainTree>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>enterprise.root</ns:name>
                    <ns:name>test.enterprise.root</ns:name>
                    <ns:name>lenina.enterprise.root</ns:name>
                    <ns:name>eltex-portal.enterprise.root</ns:name>
                    <ns:name>alpha.enterprise.root</ns:name>
                    <ns:name>test.root</ns:name>
                    <ns:name>spb.test.root</ns:name>
                    <ns:name>ekb.test.root</ns:name>
                    <ns:name>barnaul.test.root</ns:name>
                    <ns:name>kemerovo.test.root</ns:name>
                    <ns:name>krasnyi.test.root</ns:name>
                    <ns:name>ems.test.root</ns:name>
                    <ns:name>hotspot.root</ns:name>
                    <ns:name>test.hotspot.root</ns:name>
                </ns:response>
            </ns:return>
        </ns:RetrieveDomainTreeResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainTreeV2 – Получить список доменов, зарегистрированных в системе SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Фильтр по домену. Если установлен, то вывод только списка поддоменов для данного. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiNameArray

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain>?</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain>re</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 're' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain>root</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain></xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>enterprise.root</ns:name>
                    <ns:descr>Eterprise domain</ns:descr>
                    <ns:name>test.enterprise.root</ns:name>
                    <ns:descr>Test Eterprise domain</ns:descr>
                    <ns:name>lenina.enterprise.root</ns:name>
                    <ns:descr>Lenina Eterprise domain</ns:descr>
                    <ns:name>eltex-portal.enterprise.root</ns:name>
                    <ns:descr>Eltex-portal domain</ns:descr>
                    <ns:name>alpha.enterprise.root</ns:name>
                    <ns:descr>Alpha Eterprise domain</ns:descr>
                    <ns:name>test.root</ns:name>
                    <ns:descr>Root test domain</ns:descr>
                    <ns:name>spb.test.root</ns:name>
                    <ns:descr>Sanktpeterbugr test domain</ns:descr>
                    <ns:name>ekb.test.root</ns:name>
                    <ns:descr>Ekat tes domain</ns:descr>
                    <ns:name>barnaul.test.root</ns:name>
                    <ns:descr>Barnaul test domain</ns:descr>
                    <ns:name>kemerovo.test.root</ns:name>
                    <ns:descr>Kemerovo test domain</ns:descr>
                    <ns:name>krasnyi.test.root</ns:name>
                    <ns:descr>Krasnyi test domain</ns:descr>
                    <ns:name>ems.test.root</ns:name>
                    <ns:descr>Ems domain</ns:descr>
                    <ns:name>hotspot.root</ns:name>
                    <ns:descr>Hostpot root</ns:descr>
                    <ns:name>test.hotspot.root</ns:name>
                    <ns:descr>Test hotspot root</ns:descr>
                </ns:response>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetFullDomainsChanged - Получить полный список доменов, если хэш дерева доменов изменился.

Общая информация

  1. Команда актуальна, начиная с версии 1.6.

  2. Система сравнивает переданный в запросе хэш со значением хэша в БД доменов. Если хэш изменился, ответ будет содержать все доступные пользователю домены. Если хэш не изменился, ответ будет пустой.

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

  4. В 1.18 появился улучшенный метод GetFullDomainsPartition.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

hash

Хэш последнего изменения дерева доменов

Целое положительное число или 0, когда список доменов запрашивается первый раз

Выходные параметры

Параметр Значение Формат значения

array

Массив объектов NbiDomain2 с описанием доменов

NbiDomain2

hash

Хэш последнего изменения дерева доменов

Integer

code

Код ответа

Integer

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetFullDomainsChanged>
         <nbi:hash>0</nbi:hash>
      </nbi:GetFullDomainsChanged>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetFullDomainsChangedResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax239:array xsi:type="ax239:NbiDomain2">
               <ax239:descr>Root domain</ax239:descr>
               <ax239:domain>root</ax239:domain>
               <ax239:type>both</ax239:type>
            </ax239:array>
            <ax239:array xsi:type="ax239:NbiDomain2">
               <ax239:descr>Anna domain</ax239:descr>
               <ax239:domain>anna.root</ax239:domain>
               <ax239:type>ap</ax239:type>
            </ax239:array>
            <ax239:array xsi:type="ax239:NbiDomain2">
               <ax239:descr>BRAS domain</ax239:descr>
               <ax239:domain>bras.root</ax239:domain>
               <ax239:type>service</ax239:type>
            </ax239:array>
            <ax239:hash>8</ax239:hash>
         </ns:return>
      </ns:GetFullDomainsChangedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных доменов.

Пример использования

Команда добавлена на кэширования списка доменов в сторонней системе (например, в Личном кабинете - ЛК).
Каждый раз, когда системе нужно отобразить список доменов, она делает запрос в NBI и в случае, когда домены не изменились, мгновенно получает пустой ответ и использует ранее построенный список доменов, который уже хранится в памяти ЛК.
Если ответ не пустой, список доменов в памяти ЛК заменяется на новый, новое значение хэша запоминается для последующих обращений.

См. также

  1. NbiDomain2

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetFullDomainsPartition - Получить полный список доменов с пагинацией

Общая информация

  1. Команда актуальна, начиная с версии 1.18. Пришла как альтернатива GetFullDomainsChanged.

  2. Особенности работы команды:

    • Выдает порцию данные по skip, count;

    • Вычитывает плоский список доменов с сортировкой по ID (select DOMAINS, join DOMAIN_PARAMS);

    • Используется новая колонка fullName в DOMAINS;

    • Не обращается к родителям. Выдает сырые данные (как в БД), тип родителя ЛК будет подтягивать самостоятельно (при пагинации нет обращений к родителям, были бы лишние запросы).

  3. В отличие от указанной выше команды, GetFullDomainsPartition не работает с параметром hash. Значение hash в БД все равно будет приложено в ответ, но на вход оно уже не передается. Причина тому, опять же, пагинация. Нет смысла как-то проверять hash, когда вычитываем данные частями.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

skip

Число доменов, которые нужно пропустить (по умолчанию 0)

int

В случае ошибки чтения, будет использоваться значение по умолчанию 0

count

Число доменов, которые нужно вернуть (по умолчанию 10)

int

В случае ошибки чтения, будет использоваться значение по умолчанию 10

Выходные параметры

Параметр Значение Формат значения

array

Массив объектов NbiDomain2 с описанием доменов

NbiDomain2

hash

Хэш последнего изменения дерева доменов

Integer

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetFullDomainsPartition>
         <nbi:skip>0</nbi:skip>
         <nbi:count>3</nbi:count>
      </nbi:GetFullDomainsPartition>
Ответ
      <ns:GetFullDomainsPartitionResponse>
         <ns:return xsi:type="ax218:NbiDomain2ArrayResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax218:array xsi:type="ax218:NbiDomain2">
               <ax218:descr>root domain</ax218:descr>
               <ax218:domain>root</ax218:domain>
               <ax218:type>both</ax218:type>
            </ax218:array>
            <ax218:array xsi:type="ax218:NbiDomain2">
               <ax218:descr>sandbox</ax218:descr>
               <ax218:domain>found.root</ax218:domain>
               <ax218:type>both</ax218:type>
            </ax218:array>
            <ax218:array xsi:type="ax218:NbiDomain2">
               <ax218:descr>OTT</ax218:descr>
               <ax218:domain>ott.root</ax218:domain>
               <ax218:type xsi:nil="true"/>
            </ax218:array>
            <ax218:hash>205262</ax218:hash>
         </ns:return>
      </ns:GetFullDomainsPartitionResponse>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных доменов

Пример использования

Пример работы кэша доменов с получением всех доменов порциями по 1000 шт на python3.

container_hash = 0
container_content = []


def get_current_domain_counter(nbiclient) -> int:
    method_response = nbiclient.service.GetCurrentDomainCounter()
    if method_response['code'] == 0:  # OK
        return int(method_response['detail'])
    else:  # Error
        print("Error of GetCurrentDomainCounter: {}".format(method_response['detail']))
        return 0


def get_full_domains_partiotion(nbiclient) -> (int, List[str]):
    count = 1000
    skip = 0
    full = []
    dbhash = 0
    start = time.time()
    while 1:
        result = nbiclient.service.GetFullDomainsPartition(skip, count)
        code = result['code']
        if code == 0:
            rhash = result['hash']
            if dbhash == 0:  # keep first selected
                dbhash = rhash
            total = len(result['array'])
            if total == 0:  # no more domains
                break
            else:
                full += result['array']
                skip += count
        else:  # Error. return error code.
            print("Error of GetFullDomainsPartition: {}".format(result['detail']))
            return -1, []
    elapsed = time.time() - start
    print("GetFullDomainsPartition {} domain (hash {}) in {} s".format(len(full), dbhash, elapsed))
    return dbhash, full


if __name__ == '__main__':
    client = softwlc_nbi.create_client()
    result = client.service.GetVersion()
    print("Current NBI version {}".format(result['response']['message']))
    while 1:
        actual = get_current_domain_counter(client)
        if actual != container_hash:  # if hash changed
            rh, rt = get_full_domains_partiotion(client)
            if rh > 0:  # check hash his valid
                print("Update container to hash {} of {} domains".format(rh, len(rt)))
                container_hash = rh
                container_content = rt
        else:
            print("Skip container update, hash doesn't changed")
        time.sleep(60)

Вывод скрипта

Current NBI version 1.18-75 (10-11-2020 06:29:00)
GetFullDomainsPartition 31917 domain (hash 205262) in 52.04143667221069 s
Update container to hash 205262 of 31917 domains
GetFullDomainsPartition 31929 domain (hash 205276) in 62.21472215652466 s
Update container to hash 205276 of 31929 domains
GetFullDomainsPartition 31935 domain (hash 205300) in 62.280704736709595 s
Update container to hash 205300 of 31935 domains
Skip container update, hash doesn't changed
Skip container update, hash doesn't changed

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetCurrentDomainCounter - Получить текущую версию дерева доменов

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда позволяет получить текущую версию (hash) дерева доменов (чтобы не отправлять лишних запросов).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Текущая версия дерева доменов

Целочисленное значение

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetCurrentDomainCounter/>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetCurrentDomainCounterResponse xmlns:ns="http://nbi.radius.eltex.org">
       <ns:return xsi:type="ax21:NbiResponse">
          <ax21:code>0</ax21:code>
          <ax21:detail>31</ax21:detail>
       </ns:return>
      </ns:GetCurrentDomainCounterResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных доменов.

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetDomainsFlat - Получить одну ветку из дерева доменов

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда позволяет получить одну ветку из дерева доменов по пути домена (root.123.456) или по его id.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

id

Идентификатор домена

^[0-9]*$

Целое неотрицательное число

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiDomainFlatArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetDomainsFlat>
        <nbi:id></nbi:id>
        <nbi:domain>root.service</nbi:domain>
      </nbi:GetDomainsFlat>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetDomainsFlatResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail>Success</ax22:detail>
            <ax22:response>
               <ax22:items>
                  <ax22:children>false</ax22:children>
                  <ax22:id>7</ax22:id>
                  <ax22:name>sber</ax22:name>
                  <ax22:type>service</ax22:type>
               </ax22:items>
               <ax22:items>
                  <ax22:children>false</ax22:children>
                  <ax22:id>8</ax22:id>
                  <ax22:name>vtb</ax22:name>
                  <ax22:type>service</ax22:type>
               </ax22:items>
               <ax22:items>
                  <ax22:children>false</ax22:children>
                  <ax22:id>9</ax22:id>
                  <ax22:name>rosbank</ax22:name>
                  <ax22:type>service</ax22:type>
               </ax22:items>
            </ax22:response>
         </ns:return>
      </ns:GetDomainsFlatResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных доменов

10

У роли нет прав на указанный домен

217

Домен не существует

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetDomainsByParams - Получить список доменов по параметрам

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

  2. Команда позволяет получить список доменов по любым параметрам, указанным на странице Атрибуты домена, за исключением users_limit. Список состоит из названий доменов, в которых параметры прописаны явно, и всех дочерних доменов, в которых параметры не переопределены на другие значения.

Входные параметры

Параметр Значение Формат значения

params

Основные параметры выборки

NbiParameterArray Поиск возможен по всем атрибутам домена, кроме users_limit, так как этот параметр не наследуется от родительского домена и зависит от совместимости квот на создание пользователей. Атрибуты домена

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiNameArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
 <nbi:GetDomainsByParams>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>personal_account</xsd:name>
               <xsd:value>123456000010</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>region_id</xsd:name>
               <xsd:value>54</xsd:value>
            </xsd:parameter>
         </nbi:params>
</nbi:GetDomainsByParams>
Ответ
<ns:GetDomainsByParamsResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiNameArray">
               <ax21:name>root</ax21:name>
               <ax21:name>testNLS.root</ax21:name>
               <ax21:name>domain31.domain3.testNLS.root</ax21:name>
            </ax21:response>
         </ns:return>
</ns:GetDomainsByParamsResponse>
Код Описание

312

Некорректный формат одного из значений параметра

313

Неизвестное название параметра

436

Не указан один из параметров вызова

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateSSID – Создание нового SSID в базе wireless

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

descr

Описание SSID

.{0,255}$

Любые символы в количестве до 255-ти.

params

Атрибуты SSID, могут отсутствовать. В противном случае ожидается один или больше объект NbiParameter. Список возможных атрибутов и их значений

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
        <xsd:CreateSSID>
            <xsd:name>test7</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:descr>TD</xsd:descr>
            <!--1 or more repetitions:-->
            <xsd:params>
                <xsd1:name>Radio</xsd1:name>
                <xsd1:value>ALL</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>Security_Type</xsd1:name>
                <xsd1:value>0</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>VAP_Status</xsd1:name>
                <xsd1:value>up</xsd1:value>
            </xsd:params>
        </xsd:CreateSSID>
Ответ
        <ns:CreateSSIDResponse>
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:CreateSSIDResponse>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен SSID

32

Поле descr содержит больше 200 символов

34

SSID уже существует

36

Некорректное имя или отсутствие атрибута

37

Некорректное значение для атрибута.

38

Нет обязательного атрибута

39

Не задан атрибут

62

Домен не зарегистрирован

227

Нет обязательного поля name или оно не соответствует правилам

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditSSID – Редактирование параметров и атрибутов SSID в базе wireless

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

descr

Новое описание SSID

.{0,255}$

Любые символы в количестве до 255-ти.

params

Атрибуты SSID, могут отсутствовать. В противном случае ожидается один или больше объект NbiParameter. Список возможных атрибутов и их значений

При редактировании атрибута Vlan_Priority необходимо, чтобы значение Priority было равным 1 (802.11p).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:EditSSID>
         <nbi:name>test7</nbi:name>
         <nbi:domain>wifi.root</nbi:domain>
         <nbi:descr/>
         <!--Zero or more repetitions:-->
         <nbi:params>
            <xsd:name>Vap_Status</xsd:name>
            <xsd:value>500000</xsd:value>
         </nbi:params>
      </nbi:EditSSID>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:EditSSIDResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditSSIDResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не соответствует правилам FQDN

10

Домен роли не имеет прав на домен SSID

16

SSID не существует

32

Поле descr содержит больше 200 символов

36

Некорректное имя или отсутствие атрибута

37

Некорректное значение для атрибута

39

Некорректное имя атрибута SSID

436

Не указан обязательный параметр

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditSSIDAndName - Редактирование параметров и атрибутов SSID и его переименование в базе wireless

Общая информация

  1. Команда актуальна, начиная с версии 1.12.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID. Уникальность SSID определяется по имени и домену.

Cтрока

newName

Новое имя SSID. Уникальность SSID определяется по имени и домену.

Строка

domain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

descr

Новое описание SSID

.{0,255}$

Любые символы в количестве до 255-ти.

params

Атрибуты SSID, могут отсутствовать. В противном случае ожидается один или больше объект NbiParameter. Список возможных атрибутов и их значений

NbiParameter

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:EditSSIDAndName>
         <nbi:name>test6</nbi:name>
         <nbi:newName>test7</nbi:newName>
         <nbi:domain>root</nbi:domain>
         <nbi:descr>descr</nbi:descr>
         <nbi:params>
            <xsd:name>WPA_Key</xsd:name>
            <xsd:value>999454315</xsd:value>
         </nbi:params>
      </nbi:EditSSIDAndName>
Ответ
       <ns:EditSSIDAndNameResponse>
          <ns:return>
             <ax22:code>0</ax22:code>
             <ax22:detail/>
          </ns:return>
       </ns:EditSSIDAndNameResponse>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не соответствует правилам FQDN

10

Домен роли не имеет прав на домен SSID

16

SSID не существует

32

Поле descr содержит больше 200 символов

34

SSID уже существует

36

Некорректное имя или отсутствие атрибута

37

Некорректное значение для атрибута

39

Некорректное имя или отсутствие атрибута

227

Поле newName не соответствует правилам

436

Не указан обязательный параметр

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAPDomainListBySSID - Получить список доменов ТД, привязанных к SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает список доменов ТД, привязанных к SSID

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

response

Список доменов ТД

Объект NbiNameArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetAPDomainListBySSID>
         <nbi:ssidName>Eltex-Gues</nbi:ssidName>
         <nbi:ssidDomain>hotspot.root</nbi:ssidDomain>
      </nbi:GetAPDomainListBySSID>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetAPDomainListBySSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNameResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiNameArray">
               <ax21:name>hotspot.root</ax21:name>
               <ax21:name>root</ax21:name>
            </ax21:response>
         </ns:return>
      </ns:GetAPDomainListBySSIDResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр запроса 'ssidDomain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

16

SSID по обязательному параметру запроса 'ssidName' не найден

227

Не указан обязательный параметр запроса 'ssidName'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsidLinkListByDomain - Получить список SSID, привязанных к указанному домену

Общая информация

  1. Метод предназначен для получения списка SSID, привязанных к конкретному домену.

  2. Возвращает все привязки к текущему или любому из родительских доменов, чтобы привязку SSID сделать только на самом верху, а использовать ее во всех вложенных офисах.

  3. Используется при настройке ограничений трафика для ТД и SSID внутри домена SetDomainShaper.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nodeDomain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Список SSID (имя, домен)

Объект типа NbiNameDomainArray.

Примеры команд и кодов

Код Описание ошибки

0

Успешно (получен список из одного SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetSsidLinkListByDomain>
            <nbi:nodeDomain>empty.mike.root</nbi:nodeDomain>
        </nbi:GetSsidLinkListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetSsidLinkListByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNameDomainArray">
                    <ax21:item xsi:type="ax21:NbiNameDomain">
                        <ax21:domain>root</ax21:domain>
                        <ax21:name>SSID77</ax21:name>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:GetSsidLinkListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (получен пустой список)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetSsidLinkListByDomain>
            <nbi:nodeDomain>mike.root</nbi:nodeDomain>
        </nbi:GetSsidLinkListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetSsidLinkListByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:GetSsidLinkListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetSsidLinkListByDomain>
            <nbi:nodeDomain>luise.root</nbi:nodeDomain>
        </nbi:GetSsidLinkListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetSsidLinkListByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'luise.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:GetSsidLinkListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден обязательный параметр запроса (домен)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetSsidLinkListByDomain>
            <nbi:nodeDomain></nbi:nodeDomain>
        </nbi:GetSsidLinkListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetSsidLinkListByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>281</ax21:code>
                <ax21:detail>Request parameter 'nodeDomain' has not specified or empty</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:GetSsidLinkListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

См. также

  1. SetDomainShaper

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsidLinkListBySSID - Получение списка привязок SSID по имени SSID’а

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID’а

^[ a-zA-Z0-9_\\-\\.!]{1,32}$

Имя SSID

domain

Домен SSID’а

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

nasKey

Ключ привязки SSID или фильтр по ключу

^([0-9a-fA-F]{2}[:-]){0,5}([0-9a-fA-F]{2})$

или

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

MAC-адрес или префикс MAC-адреса, домен или вложенный домен (например, '.test.root')

Выходные параметры

Параметр Значение Формат значения

links

Список привязок SSID

NbiSsidLink

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetSsidLinkListBySSID>
    <nbi:name>test</nbi:name>
    <nbi:domain>root</nbi:domain>
    <nbi:nasKey>.wifi.root</nbi:nasKey>
</nbi:GetSsidLinkListBySSID>
Ответ
<ns:GetSsidLinkListBySSIDResponse>
    <ns:return xsi:type="ax251:NbiSsidLinkListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax253:links xsi:type="ax253:NbiSsidLink">
            <ax253:id>3</ax253:id>
            <ax253:nasKey>test.wifi.root</ax253:nasKey>
            <ax253:ssidDomain>root</ax253:ssidDomain>
            <ax253:ssidName>test</ax253:ssidName>
        </ax253:links>
        <ax253:links xsi:type="ax253:NbiSsidLink">
            <ax253:id>4</ax253:id>
            <ax253:nasKey>test2.wifi.root</ax253:nasKey>
            <ax253:ssidDomain>root</ax253:ssidDomain>
            <ax253:ssidName>test</ax253:ssidName>
        </ax253:links>
    </ns:return>
</ns:GetSsidLinkListBySSIDResponse>
Код Описание ошибки

2

Ошибка доступа к БД

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Домен не существует

227

Некорректное имя SSID’а

521

Некорректное значение поля 'nasKey'

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveSSIDByDomain – Удаление SSID с домена ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, для удаления привязок SSID с ТД необходимо вызывать команду DesyncSSID

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasDomain

Домен Nas, определяющий группу точек доступа.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Домен ТД или домен SSID отсутствует или не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain></xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID или домен ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain>wifi</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен SSID или домен ТД не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain>test1.root</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>test1.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Имя SSID не задано или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveSSIDByDomain>
            <nbi:nasDomain>root</nbi:nasDomain>
            <nbi:ssidName>SSID12 </nbi:ssidName>
            <nbi:ssidDomain>root</nbi:ssidDomain>
        </nbi:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'test7[root]'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

42

SSID не привязано к данному домену ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain>hotspot.root</xsd:nasDomain>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>42</ns:code>
                <ns:detail>SSID 'local[enterprise.root]' contains no NAS with key hotspot.root</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByDomain>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveSSIDByIp – Удаление SSID с точки доступа по IP-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, для удаления привязок SSID с ТД необходимо вызывать команду DesyncSSID

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasIp

IP-адрес точки доступа.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255] разделенных точкой.

AP

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>test1.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Имя SSID не задано или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveSSIDByIp>
            <nbi:nasIp>127.0.0.1</nbi:nasIp>
            <nbi:ssidName>SSID12 </nbi:ssidName>
            <nbi:ssidDomain>root</nbi:ssidDomain>
        </nbi:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

30

Нет NasIp или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'nasIp'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

42

На NAS не установлен данный SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>42</ns:code>
                <ns:detail>SSID 'test7[wifi.root]' contains no NAS with ip 192.168.201.23</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>tes</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'tes[wifi.root]'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByIp>
            <xsd:nasIp>192.168.201.23</xsd:nasIp>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveSSIDByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveSSIDByMac – Удаление SSID с точки доступа по MAC-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, для удаления привязок SSID с ТД необходимо вызывать команду DesyncSSID

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasMac

MAC-адрес точки доступа.

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

AP

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>root</xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>1.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Имя SSID не задано или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveSSIDByMac>
            <nbi:nasMac>00:11:22:33:44:55</nbi:nasMac>
            <nbi:ssidName>SSID12 </nbi:ssidName>
            <nbi:ssidDomain>root</nbi:ssidDomain>
        </nbi:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

63

Нет NasMac или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac></xsd:nasMac>
            <xsd:ssidName></xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'nasMac'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

42

На NAS не установлен данный SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>42</ns:code>
                <ns:detail>SSID 'local[enterprise.root]' contains no NAS with key a8:f9:4b:1f:f3:e0</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>hotspot.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'local[hotspot.root]'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:RemoveSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveSSID – Удаление SSID из базы wireless

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSID>
            <xsd:name>1</xsd:name>
            <xsd:domain></xsd:domain>
        </xsd:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSID>
            <xsd:name>1</xsd:name>
            <xsd:domain>root</xsd:domain>
        </xsd:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveSSID>
            <nbi:name>SSID12 </nbi:name>
            <nbi:domain>root</nbi:domain>
        </nbi:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

17

SSID привязан к ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSID>
            <xsd:name>local2</xsd:name>
            <xsd:domain>hotspot.root</xsd:domain>
        </xsd:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>17</ns:code>
                <ns:detail>Can't delete SSID. SSID 'local2[hotspot.root]' is linked with 192.168.40.23 etc.</ns:detail>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSID>
            <xsd:name>1</xsd:name>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name '1[enterprise.root]'</ns:detail>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveSSID>
            <xsd:name>local3</xsd:name>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RemoveSSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveSSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveSSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDAttrList - Запрос списка возможных атрибутов SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiEntryDescr.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveSSIDAttrListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiEntryDescrArray">
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>When a wireless client connects to the AP (NAS) by using this VAP (SSID), the AP (NAS) tags all traffic from the wireless client with the VLAN ID you enter unless you enter the untagged VLAN ID or use a RADIUS server to assign a wireless client to a VLAN. The range for the VLAN ID is 1-4094. If you use RADIUS-based authentication for clients, you can optionally add the following attributes to the appropriate file in the RADIUS or AAA server to configure a VLAN for the client: The RADIUS-assigned VLAN ID overrides the VLAN ID you configure for the VAP (SSID).</ax21:descr>
                  <ax21:entry>Vlan_ID</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>VLAN priority. Available values: 0-7. Only for Priority = 802.1p</ax21:descr>
                  <ax21:entry>Vlan_Priority</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Set 'locked' if you want deactivate SSID. Otherwise set 'operational'. By default is 'operational'.</ax21:descr>
                  <ax21:entry>Ssid_Status</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Set 'up' to enable network at appointment to AP, or set 'down' to disable.</ax21:descr>
                  <ax21:entry>VAP_Status</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select one of the following Radio interface for VAP: ALL, ALL24, ALL5.</ax21:descr>
                  <ax21:entry>Radio</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select one of the following Security modes for this VAP: None - 0, WPA Personal - 1, WPA Enterprise - 2.</ax21:descr>
                  <ax21:entry>Security_Type</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Validate SSID, set 'true' to enable and 'false' to disable</ax21:descr>
                  <ax21:entry>Validate_SSID_Radius_Accounting</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select one of the following SSID types: Hotspot - 0, Enterprise - 1, Equipment - 2.</ax21:descr>
                  <ax21:entry>Ssid_Type</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>If you have a mix of clients, some of which support WPA2-AES and others which support only the original WPA-TKIP, set 'true'. This lets both WPA and WPA2 client stations associate and authenticate, but uses the more robust WPA2 for clients who support it. This WPA configuration allows more interoperability, at the expense of some security. Only for 'WAP Personal' and 'WAP Enterprise' security mode. 'true' or 'false'</ax21:descr>
                  <ax21:entry>WPA_Support</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>If all client stations on the network support WPA2, we suggest using WPA2 which provides the best security per the IEEE 802.11i standard. Only for 'WAP Personal' and 'WAP Enterprise' security mode. 'true' or 'false'</ax21:descr>
                  <ax21:entry>WPA2_Support</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>You can enable or disable a band steer mode (true|false).</ax21:descr>
                  <ax21:entry>Band_Steer</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Support 802.11k (true|false)</ax21:descr>
                  <ax21:entry>Support_80211k</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable or disable PMKSA caching (true|false). By default enable.</ax21:descr>
                  <ax21:entry>PMKSA_Caching</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Broadcast SSID, set 'true' to enable and 'false' to disable</ax21:descr>
                  <ax21:entry>Broadcast_SSID</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable or disable (true|false) wireless multicast forwarding</ax21:descr>
                  <ax21:entry>Wireless_Multicast_Forwarding</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The Pre-shared Key is the shared secret key for WPA Personal only. Enter a string of at least 8 characters to a maximum of 63 characters. Acceptable ASCII printable characters with codes in range [0x20-0x7E].</ax21:descr>
                  <ax21:entry>WPA_Key</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>You can configure a global list of MAC addresses that are allowed or denied access to the network. Select the type of MAC Authentication to use: disable - 0, local - 1, radius - 2.</ax21:descr>
                  <ax21:entry>MAC_Auth_Type</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Global MAC list management policy. Select the value: Block - All MACs that are selected will be blocked (black), if Allow - All MACs will be skipped(white)</ax21:descr>
                  <ax21:entry>Policy_Type</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Provides security for the otherwise unprotected and unencrypted 802.11 management frames. Only for 'WAP Personal' and 'WAP Enterprise' security mode. Select one of the following type: 'Not Required' - 0, 'Capable'- 1, 'Required' -2. By default 'Capable' (1) is selected.</ax21:descr>
                  <ax21:entry>MFP</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter a value to set the interval at which the broadcast (group) key is refreshed for clients associated to this VAP (SSID) (the default is 300). The valid range is 0-86400 seconds. A value of 0 indicates that the broadcast key is not refreshed. Broadcast key is not refreshed when Fast Transition Mode is enabled on the VAP (SSID). Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>Broadcast_Key_Refresh_Rate</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable (true) VLAN trunk mode. In trunk mode all tagged traffic from uplink forwards to clients without untagging. For configuring VLAN ID you need use RADIUS vendor specific option - Eltex-Additional-Vlans.</ax21:descr>
                  <ax21:entry>Vlan_Trunk</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>If you enable General Mode, tagged and untagged traffic will be transmitted through customizable VAP.</ax21:descr>
                  <ax21:entry>General_Mode</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>If you disable General Vlan Id, untagged traffic is transmitted through a custom VAP pass-through way.If you enable General Vlan Id, tagged traffic is transmitted through a custom VAP with removal/hanging of the specified VLAN-ID. The valid range is 1-4094. Default value is 1.</ax21:descr>
                  <ax21:entry>General_Vlan_Id</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter a value to set the interval at which the AP (NAS) will refresh session (unicast) keys for each client associated to the VAP (SSID). The valid range is 0-86400 seconds. A value of 0 indicates that the broadcast key is not refreshed. Only for 'WPA Enterprise' security mode.</ax21:descr>
                  <ax21:entry>Session_Key_Refresh_Rate</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Only for 'WAP Personal' and 'WAP Enterprise' security mode, you can enable pre-authentication for WPA2 clients.Set 'true' (otherwise 'false') if you want WPA2 wireless clients to send pre-authentication packet. The pre-authentication information will be relayed from the AP the client is currently using to the target AP. Enabling this feature can help speed up authentication for roaming clients who connect to multiple APs.This option does not apply if you selected WPA for WPA Versions because the original WPA does not support this feature.</ax21:descr>
                  <ax21:entry>Pre_Authentication</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The RADIUS IP address and key for up to four RADIUS servers can be configured on the AP (NAS). Select which of the four RADIUS servers the VAP (SSID) should contact to authenticate wireless clients. 0 - primary, 1 - backupone, 2 - backuptwo, 3 - backupthree.</ax21:descr>
                  <ax21:entry>Active_Server</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>By default each VAP (SSID) uses the global RADIUS settings that you define for the AP (NAS) at the top of the VAP (SSID) page. However, you can configure each VAP (SSID) to use a different set of RADIUS servers. To use the global RADIUS server settings, set to 'true'. To use a separate RADIUS server for the VAP (SSID), set to 'false'.</ax21:descr>
                  <ax21:entry>Use_Global_Radius</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the IPv4 address for the primary RADIUS server for this VAP (SSID).</ax21:descr>
                  <ax21:entry>Radius_IP_Address</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter up to three IPv4 address to use as the backup RADIUS servers for this VAP (SSID). If authentication fails with the primary server, each configured backup server is tried in sequence.</ax21:descr>
                  <ax21:entry>Radius_IP_Address_1</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter up to three IPv4 address to use as the backup RADIUS servers for this VAP (SSID). If authentication fails with the primary server, each configured backup server is tried in sequence.</ax21:descr>
                  <ax21:entry>Radius_IP_Address_2</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter up to three IPv4 address to use as the backup RADIUS servers for this VAP (SSID). If authentication fails with the primary server, each configured backup server is tried in sequence.</ax21:descr>
                  <ax21:entry>Radius_IP_Address_3</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The RADIUS Key is the shared secret key for the global RADIUS server. You can use up to 63 standard alphanumeric and special characters. The key is case sensitive, and you must configure the same key on the AP (NAS) and on your RADIUS server.</ax21:descr>
                  <ax21:entry>Radius_Key</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-1 uses RADIUS Key-1.</ax21:descr>
                  <ax21:entry>Radius_Key_1</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-2 uses RADIUS Key-2.</ax21:descr>
                  <ax21:entry>Radius_Key_2</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-3 uses RADIUS Key-3.</ax21:descr>
                  <ax21:entry>Radius_Key_3</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select this option to track and measure the resources a particular user has consumed such as system time, amount of data transmitted and received, and so on. If you enable RADIUS accounting, it is enabled for the primary RADIUS server and all backup servers. 'true' to enabled, 'false' to disabled.</ax21:descr>
                  <ax21:entry>Radius_Accounting</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Period of sending accounting messages on RADIUS server, in seconds. Minimum value is 30, maximum - 86400</ax21:descr>
                  <ax21:entry>Radius_Accounting_Period</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Port of RADIUS-server. The valid range is 1-65534. Default value is 1812.</ax21:descr>
                  <ax21:entry>Radius_Port</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>When Station Isolation is disabled (false), wireless clients can communicate with one another normally by sending traffic through the AP (NAS). When Station Isolation is enabled (true), the AP (NAS) blocks communication between wireless clients on the same VAP (SSID). The AP (NAS) still allows data traffic between its wireless clients and wired devices on the network, across a WDS link, and with other wireless clients associated with a different VAP (SSID), but not among wireless clients.</ax21:descr>
                  <ax21:entry>Station_Isolation</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>DSCP - 0 or 802.1p - 1</ax21:descr>
                  <ax21:entry>Priority</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable (true) or disable (false) QoS operation on the VAP (SSID) selected in the VAP (SSID) menu. QoS must be enabled globally (from the Client QoS Global Admin Mode field) and on the VAP (QoS Mode field) for the Client QoS settings to be applied to wireless clients.</ax21:descr>
                  <ax21:entry>Client_Qos_Mode</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select the name of the DiffServ policy applied to traffic sent to the AP (NAS) in the inbound (up) direction. Use 'RetrievePolicyMapList' to get list of policy map.</ax21:descr>
                  <ax21:entry>DiffServ_Policy_Up</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Select the name of the DiffServ policy applied to traffic from the AP (NAS) in the outbound (down) direction. Use 'RetrievePolicyMapList' to get list of policy map.</ax21:descr>
                  <ax21:entry>DiffServ_Policy_Down</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the maximum allowed transmission rate from the AP (NAS) to the wireless client in kilobits per second. The valid range is 0-1331200 Kbps. A non-zero configured value is rounded down to the nearest 64 Kbps value for use in the AP (NAS), but to no less than 64 Kbps. A value of 0 means that the bandwidth maximum limit is not enforced in this direction.</ax21:descr>
                  <ax21:entry>Bandwidth_Limit_Down</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the maximum allowed client transmission rate to the AP (NAS) in kilobits per second. The valid range is 0-1331200 Kbps. A non-zero configured value is rounded down to the nearest 64 Kbps value for use in the AP (NAS), but to no less than 64 Kbps. A value of 0 means that the bandwidth maximum limit is not enforced in this direction.</ax21:descr>
                  <ax21:entry>Bandwidth_Limit_Up</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the summary allowed transmission rate from the AP (NAS) to all wireless clients of SSID in kilobits per second. The valid range is 0-1331200 Kbps. A value of 0 means that the bandwidth maximum limit is not enforced in this direction.</ax21:descr>
                  <ax21:entry>VAP_Limit_Down</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enter the summary allowed transmission rate from all wireless clients of SSID to the AP (NAS) in kilobits per second. The valid range is 0-1331200 Kbps. A value of 0 means that the bandwidth maximum limit is not enforced in this direction.</ax21:descr>
                  <ax21:entry>VAP_Limit_Up</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable (true) or disable (false) minimum signal checking.</ax21:descr>
                  <ax21:entry>Check_Minimal_Signal</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Minimum signal level, dBm. Range: [-100...-1], default: -100</ax21:descr>
                  <ax21:entry>Minimal_Signal_Level</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Minimum signal timeout, sec. Range: [1...300]</ax21:descr>
                  <ax21:entry>Minimal_Signal_Timeout</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Fast BSS Transition mode for the VAP (SSID). Flag to indicate whether FT authentication is permitted. The FT authentication is valid for WPA2 Personal or WPA2 Enterprise security. By default FBT mode is disabled (false). Set 'true' to enable.</ax21:descr>
                  <ax21:entry>Fast_Transition_Mode</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>You can enable or disable FT Over DS Mode. Enabling indicates support for FBT using Over-The-DS mechanism. By default FT over DS is disabled (false). Set 'true' to enable. Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>FT_over_DS</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The NAS identifier to be sent in radius Access Request Message. The NAS Identifier is used as R0 Key holder ID. Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>R0_key_Holder</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The R1 key Holder ID that names the holder of PMK-R1 in the authenticator. Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>R1_key_Holder</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>This defines the Mobility Domain identifier (MDID) of the FBT VAP (SSID). The MDID is used to indicate a group of APs within an ESS, between which a STA can use fast BSS transition services. Fast BSS transitions are allowed only between APs that have the same MDID and are within the same ESS. They are not allowed between APs with different MDIDs or in different ESSs. Default value is 0. Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>MDID</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The time during which the target AP (NAS) retains the PTKSA and any resources for a station while waiting for the Re-association request from the station. Default value is 1000 time units. Only for 'WAP Personal' and 'WAP Enterprise' security mode.</ax21:descr>
                  <ax21:entry>Reassociation_Deadline</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The flag to use Captive Portal. If this flag is true than attributes apCaptivePortalVirtualPortalName, apCaptivePortalProtocolMode, apCaptivePortalVerifyMode, apCaptivePortalURLRedirectMode, apCaptivePortalRedirectURL will be available</ax21:descr>
                  <ax21:entry>CP_Admin_Mode</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Web portal name</ax21:descr>
                  <ax21:entry>CP_Web_Portal</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The protocol used. For example HTTP, HTTPS or Auto in any register</ax21:descr>
                  <ax21:entry>CP_Protocol</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Type of inspection. 'CaptivePortal' only</ax21:descr>
                  <ax21:entry>CP_Verification</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable the use of an external portal. If this flag is true than attributes apCaptivePortalExternalUrl, apCaptivePortalAwayTime, apCaptivePortalSessionTimeout will be available</ax21:descr>
                  <ax21:entry>CP_External</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>URL of external portal address.</ax21:descr>
                  <ax21:entry>CP_External_URL</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Time, in minutes, during which the information is stored on the client's TD, if the client disconnected</ax21:descr>
                  <ax21:entry>CP_Away_Time</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>The duration of the client's session, in minutes</ax21:descr>
                  <ax21:entry>CP_Session_Timeout</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Permitted IP for after authorization state</ax21:descr>
                  <ax21:entry>CP_Permitted_IP</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable ('true') or disable ('false') TLS support</ax21:descr>
                  <ax21:entry>TLS_Enable</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Roaming disconnect signal level, dBm. Range: [-100...-1], default: -100</ax21:descr>
                  <ax21:entry>Roaming_Signal_Level</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>User mobility domain for roaming service</ax21:descr>
                  <ax21:entry>User_Mobility_Domain</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable or disable (true|false) schedule of working time for current SSID</ax21:descr>
                  <ax21:entry>Schedule_Work_Time</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for monday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Monday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for tuesday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Tuesday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for wednesday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Wednesday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for thursday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Thursday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for friday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Friday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for saturday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Saturday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Schedule of working time for sunday in format '[1|0] HH:mm-HH:mm', where 1 means to work in a specified period and 0 means no work on that day. Time period must be rounded up to half an hour. For example '1 08:00-22:30' or '0 00:00-00:00'</ax21:descr>
                  <ax21:entry>Schedule_For_Sunday</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Bridge, location name at ESR</ax21:descr>
                  <ax21:entry>Bridge_Location</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Virtual Routing and Forwarding instance</ax21:descr>
                  <ax21:entry>VRF</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Switch Community at ESR</ax21:descr>
                  <ax21:entry>Switch_Community</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Traffic mode (1 tunnel, 0 local)</ax21:descr>
                  <ax21:entry>Traffic_Mode</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable/disable Accounting wait IP</ax21:descr>
                  <ax21:entry>Accounting_Wait_Ip</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>RADIUS accounting retry count</ax21:descr>
                  <ax21:entry>Ap_Bss_Radius_Acct_Retry_Count</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>RADIUS accounting retry count</ax21:descr>
                  <ax21:entry>Ap_Bss_Radius_Acct_Retry_Timeout</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>RADIUS authenticate retry count</ax21:descr>
                  <ax21:entry>Ap_Bss_Radius_Auth_Retry_Count</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>RADIUS authenticate retry count</ax21:descr>
                  <ax21:entry>Ap_Bss_Radius_Auth_Retry_Timeout</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Supplicant Timeout</ax21:descr>
                  <ax21:entry>Ap_Bss_Supp_Timeout</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Quantity Resend</ax21:descr>
                  <ax21:entry>Ap_Bss_Max_R_Eeq</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Domain, используемый при авторизации пользователей</ax21:descr>
                  <ax21:entry>Radius_Domain</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>RRB key</ax21:descr>
                  <ax21:entry>ApFbtRrbKey</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Hotspot 2.0</ax21:descr>
                  <ax21:entry>hotspot20</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>macList</ax21:descr>
                  <ax21:entry>MacList</ax21:entry>
               </ax21:entry>
               <ax21:entry xsi:type="ax21:NbiEntryDescr">
                  <ax21:descr>Enable ('true') or disable ('false') DPI Step Logic</ax21:descr>
                  <ax21:entry>DPI_Step_Logic</ax21:entry>
               </ax21:entry>
            </ax21:response>
         </ns:return>
      </ns:RetrieveSSIDAttrListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSID – Запрос списка атрибутов SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiSsid

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:RetrieveSSID>
         <nbi:name>test7</nbi:name>
         <nbi:domain>wifi.root</nbi:domain>
      </nbi:RetrieveSSID>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveSSIDResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiSsid">
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Ssid_Status</ax21:name>
                  <ax21:value>operational</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Security_Type</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Ssid_Type</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Priority</ax21:name>
                  <ax21:value>1</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Bridge_Location</ax21:name>
                  <ax21:value/>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Switch_Community</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Vlan_Priority</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Broadcast_SSID</ax21:name>
                  <ax21:value>true</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Vlan_ID</ax21:name>
                  <ax21:value>!</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>DiffServ_Policy_Up</ax21:name>
                  <ax21:value/>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Schedule_Work_Time</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Accounting_Wait_Ip</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Client_Qos_Mode</ax21:name>
                  <ax21:value>true</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Vlan_Trunk</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Radio</ax21:name>
                  <ax21:value>ALL</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>CP_Web_Portal</ax21:name>
                  <ax21:value>default</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Wireless_Multicast_Forwarding</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Bandwidth_Limit_Down</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>VRF</ax21:name>
                  <ax21:value>DPI</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>CP_Admin_Mode</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>General_Mode</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Bandwidth_Limit_Up</ax21:name>
                  <ax21:value>500000</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Station_Isolation</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>General_Vlan_Id</ax21:name>
                  <ax21:value>1</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>VAP_Status</ax21:name>
                  <ax21:value>up</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>DPI_Step_Logic</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>VAP_Limit_Down</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>VAP_Limit_Up</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Traffic_Mode</ax21:name>
                  <ax21:value>1</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>DiffServ_Policy_Down</ax21:name>
                  <ax21:value/>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Check_Minimal_Signal</ax21:name>
                  <ax21:value>false</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>Band_Steer</ax21:name>
                  <ax21:value>true</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>MAC_Auth_Type</ax21:name>
                  <ax21:value>0</ax21:value>
               </ax21:attr>
               <ax21:attr xsi:type="ax21:NbiParameter">
                  <ax21:name>hotspot20</ax21:name>
                  <ax21:value/>
               </ax21:attr>
               <ax21:createDate>2020-07-28T16:22:10.000+07:00</ax21:createDate>
               <ax21:descr/>
               <ax21:domain>wifi.root</ax21:domain>
               <ax21:name>test7</ax21:name>
            </ax21:response>
         </ns:return>
      </ns:RetrieveSSIDResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен NAS

16

SSID не существует

227

Имя SSID не задано или не удовлетворяет требованиям

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListByDomain – Запрос списка SSID, принадлежащих домену

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен SSID. Может быть пустым, тогда в ответе будет весь список SSID, доступный данной роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameDomain

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByDomain>
            <xsd:domain>?</xsd:domain>
        </xsd:RetrieveSSIDListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Роль пользователя не имеет прав на данный домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByDomain>
            <xsd:domain>root</xsd:domain>
        </xsd:RetrieveSSIDListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован в системе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByDomain>
            <xsd:domain>1.root</xsd:domain>
        </xsd:RetrieveSSIDListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByDomain>
            <xsd:domain>test.root</xsd:domain>
        </xsd:RetrieveSSIDListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>new_test</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveSSIDListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListByDomainType - Получить список SSID по типу домена и дополнительным параметрам

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда для получения списка SSID(имя + домен) по типу домена(ap|service|both) и параметрам SSID

  3. Команда не поддерживается в версиях 1.18 и выше. Все SSID лежат в service доменах, а это значит, что фильтрация по типу доменов лишняя и при этом сильно затратная при большом количестве доменов. Рекомендуется использовать команду RetrieveSSIDList

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

type

Тип домена

ap, service, both или пустое значение

params

Атрибуты SSID, могут и отсутствовать. В противном случае ожидается один или больше объект

NbiParameter

Выходные параметры

Параметр Значение Формат значения

response

Объект со списком пар имя и домен

NbiNameDomainArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveSSIDListByDomainType>
         <nbi:type>service</nbi:type>
         <nbi:params>
            <xsd:name>Ssid_Type</xsd:name>
            <xsd:value>1</xsd:value>
         </nbi:params>
      </nbi:RetrieveSSIDListByDomainType>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveSSIDListByDomainTypeResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiNameDomainArray">
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>s1</ax21:name>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>s2</ax21:name>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveSSIDListByDomainTypeResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

36

Указано пустое имя атрибута SSID

37

Указано некорректное значение атрибута SSID для данного имени

39

Указано некорректное имя атрибута SSID

283

Указан неверный тип домена

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListByNas – Запрос списка SSID, установленных на точку доступа

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidDomain

Домен SSID, если мы хотим получить не весь список, а только для данного домена. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

nasIp

IP-адрес точки доступа. Обязателен один из параметров nasIp или nasMac.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

AP

nasMac

MAC-адрес точки доступа. Обязателен один из параметров nasIp или nasMac.

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

AP

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameDomain

Примеры команд и кодов

Код Описание ошибки

10

Домен роли не имеет прав на домен SSID или на ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain>root</xsd:ssidDomain>
            <xsd:nasIp>192.168.40.23</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain>?</xsd:ssidDomain>
            <xsd:nasIp>192.168.40.23</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain>1.root</xsd:ssidDomain>
            <xsd:nasIp>192.168.40.23</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

64

Нет ни поля IP-адреса, ни поля MAC-адреса
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp></xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>64</ns:code>
                <ns:detail>No 'nasMac' and no 'nasIp'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

30

NasIp не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp>12</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'nasIp'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

6

NAS с таким IP не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp>192.123.123.123</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>6</ns:code>
                <ns:detail>No NAS with ip '192.123.123.123'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

63

NasMac некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp></xsd:nasIp>
            <xsd:nasMac>a8:f9:4b:1f:f3:e</xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'nasMac'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

65

Нет устройства с данным MAC-адресом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp></xsd:nasIp>
            <xsd:nasMac>a8:f9:4b:1f:f3:e1</xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>65</ns:code>
                <ns:detail>No device with mac'a8:f9:4b:1f:f3:e1'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

77

Нет устройства с данным IP-адресов на EMS сервисе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp>192.168.1.23</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>77</ns:code>
                <ns:detail>No device with ip in EMS service '192.168.1.23'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

78

Ошибка сервиса EMS. Зарегистрировано более одного устройства с таким IP
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp>192.168.1.23</xsd:nasIp>
            <xsd:nasMac></xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>78</ns:code>
                <ns:detail>There are more then 1 devices with ip in EMS service '192.168.1.23'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveSSIDListByNas>
            <xsd:ssidDomain></xsd:ssidDomain>
            <xsd:nasIp></xsd:nasIp>
            <xsd:nasMac>a8:f9:4b:1f:fc:80</xsd:nasMac>
        </xsd:RetrieveSSIDListByNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveSSIDListByNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:name>local</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>hotspot.root</ns:domain>
                        <ns:name>local2</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveSSIDListByNasResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListByWebPortal – Запрос списка SSID, на которые установлен Web-портал

Общая информация

  1. Команда RetrieveSSIDListByWebPortal актуальна, начиная с версии 1.5

  2. Команда RetrieveSSIDListByWebPortal2 актуальная с версии 1.10. Команда имеет идентичное API. Отличие ее в том, что факт отсутствия SSID с указанным именем портала не считает ошибкой.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameDomain

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
        <xsd:RetrieveSSIDListByWebPortal>
            <xsd:webPortal>default</xsd:webPortal>
        </xsd:RetrieveSSIDListByWebPortal>
Ответ
        <ns:RetrieveSSIDListByWebPortalResponse>
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>local2</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveSSIDListByWebPortalResponse>
Код Описание ошибки

33

Имя Web-портала отсутствует или не удовлетворяет формату

55

Web-портал не найден в настройках SSID`ов (только для RetrieveSSIDListByWebPortal)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDList – Запрос списка SSID на основе содержащихся в них атрибутов

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

0 и более объектов NbiParameter. Если установлены, то выводятся SSID, которые имеют данные атрибуты, иначе – все доступные.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameDomain

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
        <xsd:RetrieveSSIDList>
            <!--1 or more repetitions:-->
            <xsd:params>
                <xsd1:name>Radio</xsd1:name>
                <xsd1:value>ALL</xsd1:value>
            </xsd:params>
        </xsd:RetrieveSSIDList>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:RetrieveSSIDListResponse>
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>root</ns:domain>
                        <ns:name>00_htspt_root</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>test54</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>root</ns:domain>
                        <ns:name>test56</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>root</ns:domain>
                        <ns:name>test51</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>test52</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>test7</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveSSIDListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

36

Некорректное имя или отсутствие атрибута

37

Некорректное значение для атрибута

39

Некорректное имя атрибута SSID

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListV2 – Запрос списка SSID с атрибутами по имени и домену

Общая информация

  1. Команда актуальна, начиная с версии 1.5.1

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nаme

Имя SSID, если установлено, то выдается список SSID, имя которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Имя SSID

domain

Домен SSID. Может быть пустым, тогда в ответе будет весь список SSID, доступный данной роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

name

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiSsidArray

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:name>name</nbi:name>
            <nbi:domain>?</nbi:domain>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '_' does not conform to the rules FQDN</ax21:detail>
                <ax21:ssids xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Роль пользователя не имеет прав на данный домен
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:name>ssid2</nbi:name>
            <nbi:domain>root</nbi:domain>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax21:ssids xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован в системе
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:name>ssid2</nbi:name>
            <nbi:domain>1.root</nbi:domain>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain '1.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:ssids xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Значение count должно быть целым и положительным
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:name>ssid2</nbi:name>
            <nbi:domain>root</nbi:domain>
            <nbi:count>0</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>112</ax21:code>
                <ax21:detail>Count must be positive integer</ax21:detail>
                <ax21:ssids xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

114

Неверное значение поля orderBy
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:name>ssid2</nbi:name>
            <nbi:domain>root</nbi:domain>
            <nbi:count>1</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>username</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>114</ax21:code>
                <ax21:detail>Incorrect value of orderBy</ax21:detail>
                <ax21:ssids xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveSSIDListV2>
            <nbi:domain>.root</nbi:domain>
            <nbi:count>3</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>VAP_Status</nbi:orderBy>
            <nbi:orderType>asc</nbi:orderType>
        </nbi:RetrieveSSIDListV2>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveSSIDListV2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail>17</ax21:detail>
                <ax21:ssids xsi:type="ax21:NbiSsidArray">
                    <ax21:item xsi:type="ax21:NbiSsid">
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Ssid_Status</ax21:name>
                            <ax21:value>operational</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_External</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_IP_Address_3</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Wireless_Multicast_Forwarding</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Session_Timeout</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Station_Isolation</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Verification</ax21:name>
                            <ax21:value>CaptivePortal</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Broadcast_SSID</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_Key_1</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_IP_Address_2</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Schedule_Work_Time</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>VAP_Status</ax21:name>
                            <ax21:value>down</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Security_Type</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_IP_Address_1</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Away_Time</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Priority</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Up</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Band_Steer</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Priority</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Protocol</ax21:name>
                            <ax21:value>HTTP</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bridge_Location</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Switch_Community</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radio</ax21:name>
                            <ax21:value>ALL</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Use_Global_Radius</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_Key_2</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Web_Portal</ax21:name>
                            <ax21:value>default</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Down</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Down</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Up</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>User_Mobility_Domain</ax21:name>
                            <ax21:value>root</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_External_URL</ax21:name>
                            <ax21:value>http://192.168.1.1:8080/eltex_portal/</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Trunk</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_Accounting</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_Key_3</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_IP_Address</ax21:name>
                            <ax21:value>127.0.0.1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Check_Minimal_Signal</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Admin_Mode</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Permitted_IP</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_ID</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Client_Qos_Mode</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>PMKSA_Caching</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radius_Key</ax21:name>
                            <ax21:value>1111111111111</ax21:value>
                        </ax21:attr>
                        <ax21:createDate>2016-11-22T17:43:10.000+07:00</ax21:createDate>
                        <ax21:descr/>
                        <ax21:domain>root</ax21:domain>
                        <ax21:name>24</ax21:name>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiSsid">
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Ssid_Status</ax21:name>
                            <ax21:value>operational</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_External</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Session_Timeout</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Wireless_Multicast_Forwarding</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Station_Isolation</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Verification</ax21:name>
                            <ax21:value>CaptivePortal</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Broadcast_SSID</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Schedule_Work_Time</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>VAP_Status</ax21:name>
                            <ax21:value>down</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Security_Type</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Away_Time</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Priority</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Up</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Priority</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Band_Steer</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Protocol</ax21:name>
                            <ax21:value>HTTP</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radio</ax21:name>
                            <ax21:value>ALL</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Use_Global_Radius</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Web_Portal</ax21:name>
                            <ax21:value>portalNsk</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Down</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Down</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Up</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>User_Mobility_Domain</ax21:name>
                            <ax21:value>root</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Trunk</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Check_Minimal_Signal</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Admin_Mode</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Permitted_IP</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_ID</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Client_Qos_Mode</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>PMKSA_Caching</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:createDate>2016-11-18T11:47:45.000+07:00</ax21:createDate>
                        <ax21:descr/>
                        <ax21:domain>root</ax21:domain>
                        <ax21:name>ssid12</ax21:name>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiSsid">
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Ssid_Status</ax21:name>
                            <ax21:value>operational</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_External</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Session_Timeout</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Wireless_Multicast_Forwarding</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Station_Isolation</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Verification</ax21:name>
                            <ax21:value>CaptivePortal</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Broadcast_SSID</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Schedule_Work_Time</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>VAP_Status</ax21:name>
                            <ax21:value>up</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Security_Type</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Priority</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Away_Time</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Up</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Priority</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Band_Steer</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Protocol</ax21:name>
                            <ax21:value>HTTP</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Radio</ax21:name>
                            <ax21:value>ALL</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Use_Global_Radius</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Web_Portal</ax21:name>
                            <ax21:value>default</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Bandwidth_Limit_Down</ax21:name>
                            <ax21:value>0</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Down</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>DiffServ_Policy_Up</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>User_Mobility_Domain</ax21:name>
                            <ax21:value>root</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_External_URL</ax21:name>
                            <ax21:value>http://</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_Trunk</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Check_Minimal_Signal</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Admin_Mode</ax21:name>
                            <ax21:value>true</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>CP_Permitted_IP</ax21:name>
                            <ax21:value/>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Vlan_ID</ax21:name>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>Client_Qos_Mode</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiParameter">
                            <ax21:name>PMKSA_Caching</ax21:name>
                            <ax21:value>false</ax21:value>
                        </ax21:attr>
                        <ax21:createDate>2016-11-18T11:42:10.000+07:00</ax21:createDate>
                        <ax21:descr/>
                        <ax21:domain>root</ax21:domain>
                        <ax21:name>ssid11</ax21:name>
                    </ax21:item>
                </ax21:ssids>
            </ns:return>
        </ns:RetrieveSSIDListV2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveSSIDListV3 - Получить список SSID (имя, домен) с пагинацией

Общая информация

  1. Команда актуальна, начиная с версии 1.19.3

  2. Основная задача команды - ускорить выдачу списка SSID за счет поддержки пагинации и ограничения возможностей фильтрации и сортировки.

  3. Сортировка постоянная - по имени SSID в алфавитном порядке.

  4. Запросы к БД работают только с таблицей MySQL wireless.SSID, потому фильтрация доступна только по полям, содержащимся в этой таблице. Все значения параметров фильтрации должны передаваться типом строка.

Доступные параметры фильтрации:

  • name - префикс имени SSID;

  • domain_name - домен SSID. Если начинается с точки - учитывать все вложенные; если нет - выдать SSID только с точным совпадением по домену;

  • status - Статус SSID 0 (Operational), 1 (Locked);

  • security - Тип безопасности 1 (Plain text), 3 (WPA Personal), 5 (WPA Enterprise);

  • ssidtype - Тип SSID 0 (Hotspot), 1 (Enterprise), 2 (Equipment).

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

skip

Число записей, которые нужно пропустить

Integer

count

Число записей, которые нужно вернуть. Если 0 - только вернуть значение total.

Integer

params

Дополнительные параметры фильтрации (имя, значение строкой)

NbiParameter

Выходные параметры

Параметр Значение Формат значения

items

Список элементов. Может быть пустым

NbiNameDomain

total

Общее число элементов, удовлетворяющих запросу

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveSSIDListV3>
         <nbi:skip>0</nbi:skip>
         <nbi:count>2</nbi:count>
         <nbi:params>
            <xsd:name>name</xsd:name>
            <xsd:value>auto</xsd:value>
         </nbi:params>
         <nbi:params>
            <xsd:name>ssidtype</xsd:name>
            <xsd:value>0</xsd:value>
         </nbi:params>
</nbi:RetrieveSSIDListV3>
Ответ
      <ns:RetrieveSSIDListV3Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:items xsi:type="ax21:NbiNameDomain">
               <ax21:domain>root</ax21:domain>
               <ax21:name>autocreate0</ax21:name>
            </ax21:items>
            <ax21:items xsi:type="ax21:NbiNameDomain">
               <ax21:domain>root</ax21:domain>
               <ax21:name>autocreate1</ax21:name>
            </ax21:items>
            <ax21:total>0</ax21:total>
         </ns:return>
      </ns:RetrieveSSIDListV3Response>
Код Описание ошибки

2

Ошибка доступа к БД

8

Домен не соответствует правилам.

10

Нет прав на домен, указанный в дополнительных параметрах

281

Несовместимый тип одного из параметров запроса

312

Некорректное значение одного из дополнительных параметров запроса

999

Системная ошибка

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetSSIDByDomain –Установить SSID на домен ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, команда больше не создает асинхронные задачи в EMS. Идентификатор асинхронной задачи всегда равен 0. Для создания асинхронных задач исправления привязки нужно воспользоваться командой SyncSSID.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasDomain

Домен Nas, определяющий группу точек доступа.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Идентификатор связки

Целое неотрицательное число.

taskId

Идентификатор созданной асинхронной задачи

Целое положительное число (может быть несколько)

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain></xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID или домен ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain>wifi</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен SSID или домен ТД не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain>test1.root</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>test1.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetSSIDByDomain>
            <nbi:nasDomain>root</nbi:nasDomain>
            <nbi:ssidName>SSID12 </nbi:ssidName>
            <nbi:ssidDomain>root</nbi:ssidDomain>
        </nbi:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeAsyncTasksResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
                <ax23:response/>
                <ax23:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

43

SSID уже содержит связку с данным доменом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain>101.enterprise.root</xsd:nasDomain>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>43</ns:code>
                <ns:detail>SSID 'local[enterprise.root]' already contains NAS domain 101.enterprise.root</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>tes</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'tes[wifi.root]'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByDomain>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test7</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>80</ns:response>
                <ns:taskId>1</ns:taskId>
                <ns:taskId>2</ns:taskId>
                <ns:taskId>3</ns:taskId>
            </ns:return>
        </ns:SetSSIDByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetSSIDByMac – Установить SSID на точку доступа по MAC-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Начиная с версии 1.19, команда больше не создает асинхронные задачи в EMS. Идентификатор асинхронной задачи всегда равен 0. Для создания асинхронных задач исправления привязки нужно воспользоваться командой SyncSSID.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasMac

MAC-адрес точки доступа

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

AP

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Идентификатор связки

Целое неотрицательное число.

taskId

Идентификатор созданной асинхронной задачи

Целое положительное число (может быть несколько)

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>root</xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>1.root</xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

227

Имя SSID не задано или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetSSIDByMac>
            <nbi:nasMac>00:11:22:33:44:55</nbi:nasMac>
            <nbi:ssidName>SSID12 </nbi:ssidName>
            <nbi:ssidDomain>root</nbi:ssidDomain>
        </nbi:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeAsyncTasksResponse"
                xmlns:ax218="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://statistics.object.nbi.radius.eltex.org/xsd"
                xmlns:ax227="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:ax236="http://domains.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax224="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://apList.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax233="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax230="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd">
                <ax23:code>227</ax23:code>
                <ax23:detail>Incorrect SSID name</ax23:detail>
                <ax23:response/>
                <ax23:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

63

Нет NasMac или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac></xsd:nasMac>
            <xsd:ssidName></xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'nasMac'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

43

NAS уже содержит SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>43</ns:code>
                <ns:detail>SSID 'local[enterprise.root]' already contains NAS with mac a8:f9:4b:1f:f3:e0</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>hotspot.root</xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'local[hotspot.root]'</ns:detail>
                <ns:response/>
                <ns:taskId/>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetSSIDByMac>
            <xsd:nasMac>a8:f9:4b:1f:f3:e0</xsd:nasMac>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:SetSSIDByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetSSIDByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>83</ns:response>
                <ns:taskId>1</ns:taskId>
                <ns:taskId>2</ns:taskId>
                <ns:taskId>3</ns:taskId>
            </ns:return>
        </ns:SetSSIDByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsidLinkExtendedByLinkId - Получение привязки SSID’а с расширенными параметрами по id привязки

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

linkId

Уникальный идентификатор привязки SSID

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

ssidLink

Привязка SSID’а с расширенными параметрами

NbiSsidLinkExtended

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetSsidLinkExtendedByLinkId>
    <nbi:linkId>1</nbi:linkId>
</nbi:GetSsidLinkExtendedByLinkId>
Ответ
<ns:GetSsidLinkExtendedByLinkIdResponse>
    <ns:return xsi:type="ax253:NbiSsidLinkExtendedResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax253:ssidLink xsi:type="ax253:NbiSsidLinkExtended">
            <ax253:id>1</ax253:id>
            <ax253:nasKey>test.root</ax253:nasKey>
            <ax253:ssidDomain>root</ax253:ssidDomain>
            <ax253:ssidName>test</ax253:ssidName>
            <ax253:extendedParams xsi:type="ax21:NbiParameter">
                <ax21:name>Bridge_Location</ax21:name>
                <ax21:value>v11</ax21:value>
            </ax253:extendedParams>
            <ax253:extendedParams xsi:type="ax21:NbiParameter">
                <ax21:name>Vlan_ID</ax21:name>
                <ax21:value>11</ax21:value>
            </ax253:extendedParams>
        </ax253:ssidLink>
    </ns:return>
</ns:GetSsidLinkExtendedByLinkIdResponse>
Код Описание ошибки

2

Ошибка подключения к БД

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Домен не существует

302

Значение 'linkId' не может быть меньше '1'

436

Параметр 'linkId' не задан

999

Системная ошибка

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditSsidLinkExtended - Редактирование расширенных параметров привязки SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет переопределить некоторые параметры SSID’а для каждой конкретной привязки SSID. Таким образом, в рамках одного SSID’а можно кастомизировать настройки SSID для определенных доменов. Например, указать разные Vlan_ID.

  3. Команда удаляет все старые атрибуты SSID и добавляет новые атрибуты, указанные в запросе. При совпадении нового значения атрибута SSID со значением, указанным в параметрах SSID’а, атрибут не добавляется в таблицу SSID_EXTENDED.

  4. Для редактирования доступны все атрибуты SSID’а, кроме Ssid_Status, Security_Type, Ssid_Type, TLS_Enable.

Входные параметры

Параметр Значение Формат значения Ссылка

linkId

Уникальный идентификатор привязки SSID

Целое положительное число

params

Параметры SSID

Список возможных атрибутов и их значений

NbiParameter

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditSsidLinkExtended>
    <nbi:linkId>9</nbi:linkId>
    <nbi:params>
        <xsd:name>Vlan_ID</xsd:name>
        <xsd:value>13</xsd:value>
    </nbi:params>
    <nbi:params>
        <xsd:name>Bridge_Location</xsd:name>
        <xsd:value>v13</xsd:value>
    </nbi:params>
</nbi:EditSsidLinkExtended>
Ответ
<ns:EditSsidLinkExtendedResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
    </ns:return>
</ns:EditSsidLinkExtendedResponse>
Код Описание ошибки

2

Ошибка подключения к БД

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

36

Имя атрибута SSID некорректно или отсутствует

37

Значение атрибута SSID некорректно или отсутствует

39

Такого атрибута SSID не существует

62

Домен не существует

302

Значение 'linkId' не может быть меньше '1'

436

Параметр 'linkId' не задан

519

Привязка SSID не найдена по linkId

520

SSID не найден по linkId

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteSsidLinkExtended - Удаление расширенных параметров для привязки SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет удалить все переопределенные параметры SSID’а для данной привязки. После удаления этих параметров привязка SSID будет использовать параметры, указанные в SSID’е.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

linkId

Уникальный идентификатор привязки SSID

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteSsidLinkExtended>
    <nbi:linkId>9</nbi:linkId>
</nbi:DeleteSsidLinkExtended>
Ответ
<ns:DeleteSsidLinkExtendedResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
    </ns:return>
</ns:DeleteSsidLinkExtendedResponse>
Код Описание ошибки

2

Ошибка подключения к БД

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Домен не существует

302

Значение 'linkId' не может быть меньше '1'

436

Параметр 'linkId' не задан

520

SSID не найден по linkId

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SyncSSID - запустить асинхронный процесс исправления привязок в EMS.

Общая информация

  1. Команда актуальна, начиная с версии 1.19

  2. Команда предназначена для запуска асинхронных задач по исправлению привязок, на указанном SSID. При указании SSID, домена запускается синхронизация всех привязок этого SSID. Для того чтобы запустить исправление только одной привязки, необходимо указать NAS Key (ключ привязки SSID).

  3. Чтобы проверить статус процесса синхронизации в EMS, используйте команду GetAsyncProcessStatus

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID

^[ a-zA-Z0-9_\-\.!]{1,32}$

Строка соответствующая регулярному выражению из колонки формат значения

ssidDomain

Домен SSID

FQDN

Домен в формате FQDN

nasKey

Опциональный параметр, ключ привязки

Текст

Выходные параметры

Параметр Значение Формат значения

taskId

Идентификатор созданной асинхронной задачи

Положительное целое число или несколько чисел

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен SSID

62

Домен не зарегистрирован

227

Имя SSID не задано или не удовлетворяет требованиям

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

3

Ошибка от сервиса NBI EMS

16

SSID не существует

Пример использования

Запрос

Запуск синхронизации всех привязок SSID SSID_TEST_LINKS@root.

   <soapenv:Body>
      <soapenv:Body>
      <nbi:SyncSSID>
         <nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
         <nbi:ssidDomain>root</nbi:ssidDomain>
      </nbi:SyncSSID>
   </soapenv:Body>
   </soapenv:Body>
Ответ
    <soapenv:Body>
      <ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>4</ax21:taskId>
            <ax21:taskId>5</ax21:taskId>
         </ns:return>
      </ns:SyncSSIDResponse>
   </soapenv:Body>
Запрос

Запуск синхронизации привязки SSID SSID_TEST_LINKS@root в домене ap.root.

   <soapenv:Body>
      <soapenv:Body>
      <nbi:SyncSSID>
         <nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
         <nbi:ssidDomain>root</nbi:ssidDomain>
         <nbi:nasKey>ap.root</nbi:nasKey>
      </nbi:SyncSSID>
   </soapenv:Body>
   </soapenv:Body>
Ответ
   <soapenv:Body>
      <ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>9</ax21:taskId>
         </ns:return>
      </ns:SyncSSIDResponse>
   </soapenv:Body>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DesyncSSID - запустить асинхронный процесс удаления SSID с ТД в заданной привязке

Общая информация

  1. Команда актуальна, начиная с версии 1.19

  2. Команда предназначена для запуска асинхронных задач по удаления SSID с точек по привязке. Необходимо указать название SSID, домен SSID и ключ привязки SSID.

  3. Чтобы проверить статус процесса синхронизации в EMS, используйте команду GetAsyncProcessStatus

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID

^[ a-zA-Z0-9_\-\.!]{1,32}$

Строка соответствующая регулярному выражению из колонки формат значения

ssidDomain

Домен SSID

FQDN

Домен в формате FQDN

nasKey

Ключ привязки - домен, MAC-адрес или IP-адрес.

Текст

Выходные параметры

Параметр Значение Формат значения

taskId

Идентификатор созданной асинхронной задачи

Положительное целое число или несколько чисел

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

Примеры команд и кодов

Код Описание

0

Успешно

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен SSID

62

Домен не зарегистрирован

227

Имя SSID не задано или не удовлетворяет требованиям

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

3

Ошибка от сервиса NBI EMS

16

SSID не существует

521

Ключ привязки задан некорректно
Запрос
      <nbi:DesyncSSID>
         <nbi:ssidName>RT_DEV</nbi:ssidName>
         <nbi:ssidDomain>ap.root</nbi:ssidDomain>
         <nbi:nasKey>new.root</nbi:nasKey>
      </nbi:DesyncSSID>
Ответ
      <ns:DesyncSSIDResponse">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>8</ax21:taskId>
         </ns:return>
      </ns:DesyncSSIDResponse>
Запрос
      <nbi:DesyncSSID>
         <nbi:ssidName>RT_DEV</nbi:ssidName>
         <nbi:ssidDomain>ap.root</nbi:ssidDomain>
         <nbi:nasKey>region.ap.root</nbi:nasKey>
      </nbi:DesyncSSID>
Ответ
      <ns:DesyncSSIDResponse>
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>12</ax21:taskId>
            <ax21:taskId>13</ax21:taskId>
         </ns:return>
      </ns:DesyncSSIDResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateNas – Создание новой точки доступа

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

name

Имя точки

^[a-zA-Z0-9_-]{1,32}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

domain

Домен области видимости точки

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

secret

Ключ для работы с сервером RADIUS

^[a-zA-Z0-9]{0,60}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

decsr

Описание точки

.{0,200}$

До 200 любых символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Нет IP-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.300</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain></xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

31

Нет обязательного поля secret или оно некорректно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret></xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>31</ns:code>
                <ns:detail>Incorrect field 'secret'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name></xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'name'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

32

Поле descr содержит больше 200 символов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifidddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>32</ns:code>
                <ns:detail>Incorrect field 'descr'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

5

Nas уже существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>5</ns:code>
                <ns:detail>NAS with ip '192.168.201.160' already exists</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.16</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 208, message 'For action 'restartRadius' no handler.'</ns:detail>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:CreateNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:CreateNasResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Параметры команды Latitude, Longitude, для дополнительных параметров инициализации, можно получить с помощью команды Geocode, передав ей почтовый адрес в формате КЛАДР

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

keys

Объект NbiKeyArray

ruleName

Имя правила инициализации.

.*

Любые символы

ruleDomain

Домен правила.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

nodeDomain

Домен узла, в который добавляется устройство.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

deviceName

Имя устройства в дереве.

([\w-][а-яА-Я\"'`%\s]{1,64}$)

Текст длиной до 64 символов. Запрещены русские буквы, пробелы, символы " % ' `

params

Дополнительные параметры инициализации. Массив объектов NbiParameter

Допустимые имена параметров могут быть получены в GetInitLinkParamList. Значение параметра не более 255 символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiProfileLink

Дополнительные параметры инициализации и их допустимые значения

Параметр Значение Формат значения

FullName

ФИО

Текст длиной до 255-ти символов, допустимы любые символы

ActNumber

Номер заявки

Текст без спецсимволов длиной до 32-ти символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - и пробел

INN

ИНН

Представляет собой число из 10 или 12 символов, и валидируется согласно соответствующим требованиям

Zip

Почтовый индекс

Представляет собой число из 6 цифр

Region

Область

Текст без спецсимволов длиной до 64-x символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - и пробел

District

Район

Текст без спецсимволов длиной до 64-x символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - и пробел

City

Город

Текст без спецсимволов длиной до 64-x символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - . и пробел

Street

Улица

Текст без спецсимволов длиной до 64-x символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - / . и пробел

HouseNumber

Номер дома

Текст без спецсимволов длиной до 35-и символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - _ / . и пробел

Building

Корпус

Текст без спецсимволов длиной до 8 символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - / . и пробел

Floor

Этаж

Допустимы положительные или отрицательные целые числа, максимум трехзначное число

Office

Офис

Текст без спецсимволов длиной до 8 символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - / . и пробел

Latitude

Широта

Указывается вещественное число в диапазоне от -90 до 90

Longitude

Долгота

Указывается вещественное число в диапазоне от -180 до 180

OttMode

Режим OTT (Over-the-top)

None - для обычных ТД
Connected - для ТД/ESR-10, подключенных по модели OTT
ServiceProvider - для станционных ESR, которые предоставляют услугу по модели OTT (сейчас привязки инициализации для них не используются)

RegionId

Номер региона

Двухзначное число

Country

Страна

Текст без спецсимволов длиной до 64-x символов, допустимы английские и русские буквы разного регистра, символ - и пробел

CustomCfg

Индивидуальная конфигурация OTT устройства

Текст без спецсимволов длиной до 255-ти символов, допустимы английские и русские буквы разного регистра, допустим символ - и пробел

WIPS_WIDS_Service

Сервис детектирования атак на ТД. Связан с лицензией

Текст 'true' или 'false'

DpiStepLogic

DPI (Step Logic)

Текст 'true' или 'false'

Примеры команд и кодов

Код Описание ошибки

8

Домен правила или домен узла не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>32</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '32' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен правила или домен узла
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен правила или домен узла не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
            <xsd:nodeDomain>1.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

51

Ключ устройства уже привязан к правилу
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>wifi</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>51</ns:code>
                <ns:detail>Key 'a8:f9:b4:00:00:01' already linked with rule 'test2[enterprise.root]' and node domain 'test.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

53

Один из ключей устройства пустой
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key></xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>wifi</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>53</ns:code>
                <ns:detail>Device keys are missing or contains illegal value</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

54

Нет правила инициализации с таким именем и доменом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName>test1</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>54</ns:code>
                <ns:detail>No Rules with name test1[enterprise.root]</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

52

Отсутствует имя правила инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:CreateRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:06</xsd1:key>
            </xsd:keys>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>wifi</xsd:ruleDomain>
            <xsd:nodeDomain>test.root</xsd:nodeDomain>
            <xsd:deviceName>BOXX</xsd:deviceName>
            <xsd:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>Ivanov A A</xsd1:value>
            </xsd:params>
            <xsd:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </xsd:params>
        </xsd:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>52</ns:code>
                <ns:detail>Incorrect field 'ruleName'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

259

Ошибка в имени устройства
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://request.object.nbi.radius.eltex.org/xsd"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateRuleLink>
            <nbi:keys>
                <xsd:key>1.2.3.4</xsd:key>
            </nbi:keys>
            <nbi:ruleName>boxed</nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain>boxed.nsk.root</nbi:nodeDomain>
            <nbi:deviceName>@@@</nbi:deviceName>
        </nbi:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>259</ax21:code>
                <ax21:detail>Incorrect device name '@@@'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray"/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

260

Ошибка в имени дополнительного параметра привязки инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://request.object.nbi.radius.eltex.org/xsd"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateRuleLink>
            <nbi:keys>
                <xsd:key>1.2.3.4</xsd:key>
            </nbi:keys>
            <nbi:ruleName>boxed</nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain>boxed.nsk.root</nbi:nodeDomain>
            <nbi:deviceName>BOX</nbi:deviceName>
            <nbi:params>
                <xsd1:name>FullName2</xsd1:name>
                <xsd1:value></xsd1:value>
            </nbi:params>
        </nbi:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>260</ax21:code>
                <ax21:detail>Incorrect init link parameter name 'FullName2'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray"/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

261

Ошибка в значении дополнительного параметра привязки инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://request.object.nbi.radius.eltex.org/xsd"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateRuleLink>
            <nbi:keys>
                <xsd:key>1.2.5.3</xsd:key>
                <xsd:key>1.2.5.59</xsd:key>
            </nbi:keys>
            <nbi:ruleName>boxed</nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain>boxed.nsk.root</nbi:nodeDomain>
            <nbi:deviceName>123</nbi:deviceName>
            <nbi:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>moreThen255</xsd1:value>
            </nbi:params>
        </nbi:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax28="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>261</ax21:code>
                <ax21:detail>Incorrect init link parameter value 'FullName'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray"/>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://request.object.nbi.radius.eltex.org/xsd"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateRuleLink>
            <nbi:keys>
                <xsd:key>1.2.98.38</xsd:key>
            </nbi:keys>
            <nbi:ruleName>boxed</nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain>boxed.nsk.root</nbi:nodeDomain>
            <nbi:deviceName>123</nbi:deviceName>
            <nbi:params>
                <xsd1:name>FullName</xsd1:name>
                <xsd1:value>123456789</xsd1:value>
            </nbi:params>
            <nbi:params>
                <xsd1:name>ActNumber</xsd1:name>
                <xsd1:value>858585</xsd1:value>
            </nbi:params>
        </nbi:CreateRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateRuleLinkResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray">
                    <ax21:link xsi:type="ax21:NbiProfileLink">
                        <ax21:deviceKey>1.2.98.38</ax21:deviceKey>
                        <ax21:deviceName>123</ax21:deviceName>
                        <ax21:id>33</ax21:id>
                        <ax21:nodeDomain>boxed.nsk.root</ax21:nodeDomain>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>FullName</ax21:name>
                            <ax21:value>123456789</ax21:value>
                        </ax21:params>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>ActNumber</ax21:name>
                            <ax21:value>858585</ax21:value>
                        </ax21:params>
                        <ax21:ruleDomain>boxed.nsk.root</ax21:ruleDomain>
                        <ax21:ruleName>boxed</ax21:ruleName>
                    </ax21:link>
                </ax21:response>
            </ns:return>
        </ns:CreateRuleLinkResponse>
    </soapenv:Body>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateTreeObject — создать объект в дереве

Общая информация

  1. Команда актуальна, начиная с версии 1.22.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

pid

Уникальный идентификатор родительского узла в дереве

int

type

Тип объекта

String

Типы и подтипы объектов в дереве

subtype

Подтип объекта

String

Это поле необязательно для объектов, не имеющих подтипа, например узлов (NODE).

Типы и подтипы объектов в дереве

name

Имя объекта

String

В именах объектов запрещены символы %, \, ', ", `, пробелы, а также буквы кириллицы.

В именах узлов запрещены символы %, \, ', ". Также недопустимы имена, состоящие только из пробелов.

ip

IP-адрес объекта

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…255], разделённых точкой.

Если тип объекта NODE, это поле не используется и необязательно.

nodeDomain

Домен объекта

String

Необязательный параметр. Может быть указан при создании объекта типа NODE.

Если домен указан, то он должен быть дочерним по отношению к домену узла, в котором создаётся объект.

Выходные параметры

Параметр Значение Формат значения

response

ID (уникальный идентификатор) нового объекта

int

code

Код ответа

int

detail

Пояснение к ответу

String

Коды ответа

Код Описание

0

Успешно

3

Ошибка EMS-NBI

10

Нет прав на указанный домен

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

30

Некорректное значение поля ip

33

Некорректное значение поля name

45

Неизвестный ответ от EMS сервера

281

Не найден обязательный параметр запроса

304

Несовместимый домен

416

Не найден объект в дереве

540

ID родительского объекта не является числом

999

Системная ошибка

Пример использования

Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateTreeObject>
            <nbi:pid>1</nbi:pid>
            <nbi:type>WEP</nbi:type>
            <nbi:subtype>-12ac</nbi:subtype>
            <nbi:name>Test_Access_Point</nbi:name>
            <nbi:ip>10.25.96.115</nbi:ip>
        </nbi:CreateTreeObject>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<ns:CreateTreeObjectResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>5</ax21:response>
    </ns:return>
</ns:CreateTreeObjectResponse>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditTreeObject - Редактировать параметры объекта дерева

Общая информация

  1. Команда для редактирования объекта дерева по его ID.

  2. Команда актуальна, начиная с версии 1.22.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

id

Уникальный идентификатор объекта дерева

Integer

Целое неотрицательное число

params

Параметры объекта дерева

NbiParameterArray

Основные характеристики объекта (имя, тип, подтип) и параметры доступа, название которых можно посмотреть на странице со всеми параметрами объекта дерева.

NbiParameterArray

Редактируемые параметры устройства

Параметр Значение Формат значения Расшифровка формата

name

Имя объекта дерева

String

В именах объектов дерева, кроме узлов, запрещены символы %, \, ', ", `, нестандартные пробелы, разрешены только латинские буквы.
В именах узлов запрещены символы %, \, ', ".
Также недопустимы имена, состоящие только из пробелов.

type

Тип объекта

String

Редактирование типа не поддержано.

subtype

Подтип объекта

String

Редактирование подтипа не поддержано.

Также редактируются параметры доступа объекта дерева.
Список параметров доступа определяется в зависимости от типа и подтипа объекта (совпадает с тем, что отображается в EMS GUI на вкладке 'Доступ').
Корректные названия параметров можно посмотреть в разделе Атрибуты объекта дерева.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Коды ответа

Код Описание

0

Успешно

3

Ошибка от EMS сервера

10

У роли нет прав на домен редактируемого устройства или устройство с заданным ID не существует

45

Неизвестный статус ответа от EMS сервера

281

Не найден обязательный параметр запроса

502

У имени параметра в запросе пустое значение

539

Параметр ID должен быть целым положительным числом

541

Дублирующийся параметр в запросе

999

Системная ошибка

Пример использования

Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:EditTreeObject>
         <nbi:id>44</nbi:id>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>name</xsd:name>
               <xsd:value>WOP-2ac-LR5_E0:D9:E3:7B:84:C0</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>Port</xsd:name>
               <xsd:value>162</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>IpAddress</xsd:name>
               <xsd:value>10.25.96.103</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:EditTreeObject>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:EditTreeObjectResponse>
         <ns:return xsi:type="ax23:NbiResponse">
            <ax23:code>0</ax23:code>
            <ax23:detail>Success</ax23:detail>
         </ns:return>
      </ns:EditTreeObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditNas – Редактирование параметров точки доступа в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

name

Новое имя точки

^[a-zA-Z0-9_-]{1,32}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

domain

Новый домен области видимости точки

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

secret

Новый ключ для работы с сервером RADIUS

^[a-zA-Z0-9]{0,60}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

decsr

Новое описание точки

.{0,200}$

Любые символы в количестве до 200-т.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Нет IP-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.300</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain></xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

31

Нет обязательного поля secret или оно некорректно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret></xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>31</ns:code>
                <ns:detail>Incorrect field 'secret'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name></xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'name'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

32

Поле descr содержит больше 200 символов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifidddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>32</ns:code>
                <ns:detail>Incorrect field 'descr'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

6

Nas не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.161</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>pass</xsd:secret>
            <xsd:descr>TD</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>6</ns:code>
                <ns:detail>No NAS with ip '192.168.201.161'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.16</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 208, message 'For action 'restartRadius' no handler.'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditNasIp – Редактирование IP точки доступа в базе RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

oldIp

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

newIp

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Нет IP-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.300</xsd:ip>
            <xsd:ip>192.168.201.300</xsd:ip>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain></xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

31

Нет обязательного поля secret или оно некорректно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret></xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>31</ns:code>
                <ns:detail>Incorrect field 'secret'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name></xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'name'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

32

Поле descr содержит больше 200 символов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifidddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>32</ns:code>
                <ns:detail>Incorrect field 'descr'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

6

Nas не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.161</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>pass</xsd:secret>
            <xsd:descr>TD</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>6</ns:code>
                <ns:detail>No NAS with ip '192.168.201.161'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.16</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 208, message 'For action 'restartRadius' no handler.'</ns:detail>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditNas>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:name>test</xsd:name>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:secret>password</xsd:secret>
            <xsd:descr>TDwifi</xsd:descr>
        </xsd:EditNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:EditNasResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetInitLinkParamList – Получить список дополнительных параметров привязки инициализации

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiParameter

name - ключ для использования в CreateRuleLink, value - локализованное описание параметра

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:GetInitLinkParamList/>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetInitLinkParamListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiCodeParameterListResponse" xmlns:ax219="http://list.geo.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://aplist.ems.object.nbi.radius.eltex.org/xsd" xmlns:ax239="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax225="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax248="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax245="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://object.nbi.radius.eltex.org/xsd" xmlns:ax222="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:ax23="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax266="http://geo.response.object.nbi.radius.eltex.org/xsd" xmlns:ax26="http://sorm3.response.object.nbi.radius.eltex.org/xsd" xmlns:ax263="http://topactiveusers.response.object.nbi.radius.eltex.org/xsd" xmlns:ax242="http://scripts.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax260="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax228="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax214="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax236="http://locationHistory.response.object.nbi.radius.eltex.org/xsd" xmlns:ax278="http://service.response.object.nbi.radius.eltex.org/xsd" xmlns:ax257="http://sorm2.response.object.nbi.radius.eltex.org/xsd" xmlns:ax276="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax211="http://ott.object.nbi.radius.eltex.org/xsd" xmlns:ax233="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax231="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax253="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax251="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax273="http://radiusUser.response.object.nbi.radius.eltex.org/xsd" xmlns:ax270="http://profile.object.nbi.radius.eltex.org/xsd">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiParameterArray">
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>FullName</ax21:name>
                  <ax21:value>Full name</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>ActNumber</ax21:name>
                  <ax21:value>Act number</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>INN</ax21:name>
                  <ax21:value>INN</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Zip</ax21:name>
                  <ax21:value>Zip</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Region</ax21:name>
                  <ax21:value>Region</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>District</ax21:name>
                  <ax21:value>District</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>City</ax21:name>
                  <ax21:value>City</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Street</ax21:name>
                  <ax21:value>Street</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>HouseNumber</ax21:name>
                  <ax21:value>House number</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Building</ax21:name>
                  <ax21:value>Building</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Floor</ax21:name>
                  <ax21:value>Floor</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Office</ax21:name>
                  <ax21:value>Office</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Latitude</ax21:name>
                  <ax21:value>Latitude</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Longitude</ax21:name>
                  <ax21:value>Longitude</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>RegionId</ax21:name>
                  <ax21:value>Region Number</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Country</ax21:name>
                  <ax21:value>Country</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>OttMode</ax21:name>
                  <ax21:value>OTT mode: None, Connected, ServiceProvider</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>CustomCfg</ax21:name>
                  <ax21:value>OTT custom config</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>WIPS_WIDS_Service</ax21:name>
                  <ax21:value>WipsWids service</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>DpiStepLogic</ax21:name>
                  <ax21:value>DPI (Step Logic)</ax21:value>
               </ax21:parameter>
            </ax21:response>
         </ns:return>
      </ns:GetInitLinkParamListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetInitStatus – Получить статус инициализации устройства по MAC-адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес точки доступа.

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Статус инициализации устройства.

Одно из следующих состояний:
«NEVER» - устройство находится в песочнице, но инициализации не производилось;
«IN_PROGRESS» - инициализация в процессе выполнения;
«SUCCESSFUL» - инициализация успешно завершена;
«FAILED» - инициализация завершена с неуспехом;
«INTERRUPTED» - инициализация прервана;
«MAC_ALREADY_EXIST» - при инициализации обнаружено, что устройство с данным маком уже есть в системе EMS;
«UPDATE_IN_PROGRESS» - обновление уже существующего устройства;
«UPDATE_FAILED» - обновление уже существующего устройства завершено с неуспехом ;
«NO_IN_SANDBOX» - устройства нет в песочнице.

Примеры команд и кодов

Код Описание ошибки

63

MAC-адрес не задан или имеет некорректный формат
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:GetInitStatus>
            <xsd:mac>a8:f9:4b:1f:f3:e</xsd:mac>
        </xsd:GetInitStatus>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetInitStatusResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'mac'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:GetInitStatusResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:GetInitStatus>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
        </xsd:GetInitStatus>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetInitStatusResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>SUCCESSFUL</ns:response>
            </ns:return>
        </ns:GetInitStatusResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveNas – Удаление точки доступа из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Нет IP-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveNas>
            <xsd:ip>192.168.201.300</xsd:ip>
        </xsd:RemoveNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:RemoveNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

6

Nas не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveNas>
            <xsd:ip>192.168.201.161</xsd:ip>
        </xsd:RemoveNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope

    <soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
        <soapenv:Body>
            <ns:RemoveNasResponse
                xmlns:ns="http://org.eltex.radius.nbi/xsd">
                <ns:return>
                    <ns:code>6</ns:code>
                    <ns:detail>No NAS with ip '192.168.201.161'</ns:detail>
                </ns:return>
            </ns:RemoveNasResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveNas>
            <xsd:ip>192.168.201.160</xsd:ip>
        </xsd:RemoveNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi.root'. Role`s domains: 'super.root'</ns:detail>
            </ns:return>
        </ns:RemoveNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:RemoveNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 208, message 'For action 'restartRadius' no handler.'</ns:detail>
            </ns:return>
        </ns:RemoveNasResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveNas>
            <xsd:ip>192.168.201.160</xsd:ip>
        </xsd:RemoveNas>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveNasResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveNasResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRuleLinkByNodeDomain – Удалить привязки устройств и правила инициализации по домену ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен точек доступа (узла дерева EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

10

Роль пользователя не имеет прав на домен ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByNodeDomain>
            <xsd:domain>root</xsd:domain>
        </xsd:RemoveRuleLinkByNodeDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByNodeDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByNodeDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен ТД не зарегистрирован в системе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByNodeDomain>
            <xsd:domain>1.root</xsd:domain>
        </xsd:RemoveRuleLinkByNodeDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByNodeDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByNodeDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен ТД не задан или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByNodeDomain>
            <xsd:domain></xsd:domain>
        </xsd:RemoveRuleLinkByNodeDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByNodeDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByNodeDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByNodeDomain>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RemoveRuleLinkByNodeDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByNodeDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveRuleLinkByNodeDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveRuleLinkByRuleDomain – Удалить привязки устройств и правила инициализации по домену правила

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен правила инициализации

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

10

Роль пользователя не имеет прав на домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByRuleDomain>
            <xsd:domain>root</xsd:domain>
        </xsd:RemoveRuleLinkByRuleDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByRuleDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByRuleDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не задан или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByRuleDomain>
            <xsd:domain></xsd:domain>
        </xsd:RemoveRuleLinkByRuleDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByRuleDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByRuleDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован в системе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByRuleDomain>
            <xsd:domain>1.root</xsd:domain>
        </xsd:RemoveRuleLinkByRuleDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByRuleDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkByRuleDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLinkByRuleDomain>
            <xsd:domain>enterprise.root</xsd:domain>
        </xsd:RemoveRuleLinkByRuleDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveRuleLinkByRuleDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveRuleLinkByRuleDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

keys

Объект NbiKeyArray

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно. Если для некоторых ключей не было привязок, информация об этом в detail
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveRuleLink>
            <xsd:keys>
                <xsd1:key>a8:f9:b4:00:00:a1</xsd1:key>
                <xsd1:key>a8:f9:b4:00:00:a2</xsd1:key>
                <xsd1:key>a8:f9:b4:00:0a:a1</xsd1:key>
                <xsd1:key>a8:f9:b4:00:0a:a2</xsd1:key>
            </xsd:keys>
        </xsd:RemoveRuleLink>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:RemoveRuleLinkResponse>
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail>for key(s) '[a8:f9:b4:00:0a:a1, a8:f9:b4:00:0a:a2]' no links found</ns:detail>
            </ns:return>
        </ns:RemoveRuleLinkResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Удаляемая привязка связывает домен, на который у пользователя нет прав

53

Один из ключей устройства пустой

426

Для данного ключа привязка не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveNasList – Запрос списка точек доступа из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

search

Доп. поле, если установлено, то выдается список NAS, один из параметров которых содержит значение данного поля. В противном случае выводится список всех доступных NAS. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любые символы

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNas

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasList>
            <xsd:search>a8:f9:4b:b0:f0:e0</xsd:search>
        </xsd:RetrieveNasList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:nas>
                        <ns:descr>wep-20</ns:descr>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:ip>192.168.40.20</ns:ip>
                        <ns:mac>a8:f9:4b:b0:f0:e0</ns:mac>
                        <ns:name>WEP-20</ns:name>
                        <ns:secret>eltex</ns:secret>
                    </ns:nas>
                </ns:response>
            </ns:return>
        </ns:RetrieveNasListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveNasList2 - Запрос списка точек доступа (AP) из базы RADIUS c использованием фильтров и пагинации

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает спискок точек доступа (AP) из базы RADIUS c использованием фильтров и пагинации.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

search

Не используется

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

id, nasname, shortname, domain, type, ports, secret, server, community, description

Поле в таблице radius.NAS

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

ip

Ip-адрес ТД

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

domain

Домен ТД

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

descr

Описание ТД

.*

Любой текст

name

Имя ТД

.{0,255}$

Любые символы в количестве до 255-ти.

Выходные параметры

Параметр Значение Формат значения

response

Список точек доступа

Объект NbiNasArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveNasList2>
         <nbi:search></nbi:search>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>nasname</nbi:orderBy>
         <nbi:orderType>ACS</nbi:orderType>
         <nbi:ip></nbi:ip>
         <nbi:domain>root</nbi:domain>
         <nbi:descr></nbi:descr>
         <nbi:name></nbi:name>
      </nbi:RetrieveNasList2>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveNasList2Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail>2</ax21:detail>
            <ax21:response xsi:type="ax21:NbiNasArray">
               <ax21:nas xsi:type="ax21:NbiNas">
                  <ax21:descr/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:emsName xsi:nil="true"/>
                  <ax21:id>86</ax21:id>
                  <ax21:ip>1.1.1.1</ax21:ip>
                  <ax21:mac/>
                  <ax21:name>123</ax21:name>
                  <ax21:params xsi:type="ax21:NbiParameterArray"/>
                  <ax21:secret>132546</ax21:secret>
               </ax21:nas>
               <ax21:nas xsi:type="ax21:NbiNas">
                  <ax21:descr/>
                  <ax21:domain>root</ax21:domain>
                  <ax21:emsName xsi:nil="true"/>
                  <ax21:id>87</ax21:id>
                  <ax21:ip>1.1.1.2</ax21:ip>
                  <ax21:mac/>
                  <ax21:name>123</ax21:name>
                  <ax21:params xsi:type="ax21:NbiParameterArray"/>
                  <ax21:secret>123</ax21:secret>
               </ax21:nas>
            </ax21:response>
         </ns:return>
      </ns:RetrieveNasList2Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveNasListBySSID – Запрос списка точек доступа, на которых установлен SSID

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasDomain

Домен Nas, если мы хотим получить не весь список, а только для данного домена. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

ssidName

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

ssidDomain

Домен SSID. Уникальность SSID определяется по имени и домену.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNas

Примеры команд и кодов

Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test56</xsd:ssidName>
            <xsd:ssidDomain>wifi</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test56</xsd:ssidName>
            <xsd:ssidDomain></xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>test56</xsd:ssidName>
            <xsd:ssidDomain>test1.root</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Имя SSID не задано или не удовлетворяет требованиям
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName></xsd:ssidName>
            <xsd:ssidDomain>root</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'ssidName'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain>wifi.root</xsd:nasDomain>
            <xsd:ssidName>tes</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'tes[wifi.root]'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain></xsd:nasDomain>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:nas>
                        <ns:descr/>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:ip>192.168.40.23</ns:ip>
                        <ns:mac>a8:f9:4b:1f:fc:80</ns:mac>
                        <ns:name>817</ns:name>
                        <ns:secret>eltex</ns:secret>
                    </ns:nas>
                </ns:response>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrievePolicyMapList – Запрос списка имен Client QoS.PolicyMap по домену из SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен, может быть пустым. Если установлен, то ограничивает список PolicyMap.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiNameArray

Примеры команд и кодов

Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePolicyMapList>
            <xsd:domain>wifi</xsd:domain>
        </xsd:RetrievePolicyMapList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePolicyMapList>
            <xsd:domain>wifi.r</xsd:domain>
        </xsd:RetrievePolicyMapList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain 'wifi.r' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePolicyMapList>
            <xsd:domain>test1.root</xsd:domain>
        </xsd:RetrievePolicyMapList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePolicyMapList>
            <xsd:domain>wifi.root</xsd:domain>
        </xsd:RetrievePolicyMapList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePolicyMapListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>test555</ns:name>
                </ns:response>
            </ns:return>
        </ns:RetrievePolicyMapListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveProfileList – Запрос списка шаблонов конфигурации из SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

search

Доп. поле, если установлено, то выдается список шаблонов, чьи имена содержат данное поле

.*

Любые символы

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiNameArray

Примеры команд и кодов

Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveProfileListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveProfileListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveProfileListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveProfileListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveProfileList>
            <xsd:search>test</xsd:search>
        </xsd:RetrieveProfileList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveProfileListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>test45</ns:name>
                    <ns:name>test4portal</ns:name>
                    <ns:name>test55</ns:name>
                    <ns:name>test56</ns:name>
                    <ns:name>test</ns:name>
                    <ns:name>wifitest2</ns:name>
                </ns:response>
            </ns:return>
        </ns:RetrieveProfileListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

deviceKey

Поле для поиска по ключу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любые символы

ruleName

Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любые символы

ruleDomain

Поле для поиска по домену правил. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

nodeDomain

Поле для поиска по домену узла. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiProfileLink

Примеры команд и кодов

Код Описание ошибки

10

Роль пользователя не имеет прав на домен правила или домен узла
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>test.re</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'test.re'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен правила или домен узла не пустой и не удовлетворяет правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>s</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain 's' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен правила или домен узла не пустой и не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>test1.root</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRuleLinkList>
            <nbi:deviceKey></nbi:deviceKey>
            <nbi:ruleName></nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain></nbi:nodeDomain>
        </nbi:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray">
                    <ax21:link xsi:type="ax21:NbiProfileLink">
                        <ax21:deviceKey>1.2.5.3</ax21:deviceKey>
                        <ax21:deviceName>BOXX</ax21:deviceName>
                        <ax21:id>25</ax21:id>
                        <ax21:nodeDomain>boxed.nsk.root</ax21:nodeDomain>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>ActNumber</ax21:name>
                            <ax21:value>123456789</ax21:value>
                        </ax21:params>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>FullName</ax21:name>
                            <ax21:value>Ivanov A A</ax21:value>
                        </ax21:params>
                        <ax21:ruleDomain>boxed.nsk.root</ax21:ruleDomain>
                        <ax21:ruleName>boxed</ax21:ruleName>
                    </ax21:link>
                    <ax21:link xsi:type="ax21:NbiProfileLink">
                        <ax21:deviceKey>1.2.5.39</ax21:deviceKey>
                        <ax21:deviceName>BOXX</ax21:deviceName>
                        <ax21:id>26</ax21:id>
                        <ax21:nodeDomain>boxed.nsk.root</ax21:nodeDomain>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>ActNumber</ax21:name>
                            <ax21:value>123456789</ax21:value>
                        </ax21:params>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>FullName</ax21:name>
                            <ax21:value>Ivanov A A</ax21:value>
                        </ax21:params>
                        <ax21:ruleDomain>boxed.nsk.root</ax21:ruleDomain>
                        <ax21:ruleName>boxed</ax21:ruleName>
                    </ax21:link>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRuleList – Запрос списка правил инициализации из SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любые символы

domain

Поле для поиска по домену правил. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

deviceType

Поле для поиска по по типу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiProfile

Примеры команд и кодов

Код Описание ошибки

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>3 2</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '3 2' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на данный домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>wifi</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name>%</xsd:name>
            <xsd:domain></xsd:domain>
            <xsd:deviceType>W?P%</xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:rule>
                        <ns:descr>testq awerqe</ns:descr>
                        <ns:deviceType>WOP-12ac-LR</ns:deviceType>
                        <ns:domain>root</ns:domain>
                        <ns:name>test1</ns:name>
                        <ns:params>
                            <ns:name>RadiusApSecret</ns:name>
                            <ns:value>eltex</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareName</ns:name>
                            <ns:value>version-6.6.6.tgz</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareUpdateProtocol</ns:name>
                            <ns:value>HTTP</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>ConfigurationTemplate</ns:name>
                            <ns:value>profile__40.23.cluster__eltex.org.xml</ns:value>
                        </ns:params>
                    </ns:rule>
                    <ns:rule>
                        <ns:descr>test1 asdf</ns:descr>
                        <ns:deviceType>WEP-12ac</ns:deviceType>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:name>test2</ns:name>
                        <ns:params>
                            <ns:name>RadiusApSecret</ns:name>
                            <ns:value/>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareUpdateProtocol</ns:name>
                            <ns:value>TFTP</ns:value>
                        </ns:params>
                    </ns:rule>
                </ns:response>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateInitRule – Создание правила инициализации точек доступа

Общая информация

  1. Команда актуальна, начиная с версии 1.5.1

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ruleName

Имя правила инициализации

.{1.64}

Текст длиной не более 64 символов

ruleDomain

Домен области видимости правила инициализации

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

deviceType

Полный тип точки доступа производства Eltex

Список доступных значений ниже

descr

Описание правила инициализации

.*

Любой текст

parameter

0 или более параметров правил инициализации

Актуальный список доступных значений для deviceType:

  • WEP-12ac;

  • WEP-12ac-RevB;

  • WEP-12ac-RevC;

  • WEP-2ac;

  • WEP-2ac-Smart;

  • WEP-2ac-Z;

  • WEP-1L;

  • WEP-2L;

  • WEP-20L

  • WEP-20L-Z

  • WOP-2L;

  • WOP-12ac;

  • WOP-12ac-LR;

  • WOP-12ac-LR-RevB;

  • WOP-12ac-LR-RevD;

  • WOP-12ac-LR-RevD-SFP;

  • WOP-12ac-LR-RevD-GPON;

  • WOP-12ac-ER;

  • WOP-12ac-ER-SFP;

  • WOP-12ac-ER-GPON;

  • WOP-12ac-RevB;

  • WOP-12ac-RevC;

  • WOP-2ac;

  • WOP-2ac-RevB;

  • WOP-2ac-SFP;

  • WOP-2ac-GPON;

  • WOP-2ac-RevB-SFP;

  • WOP-2ac-RevB-GPON;

  • WOP-2ac-RevC;

  • WOP-2ac-LR2;

  • WOP-2ac-LR5;

  • WOP-2ac-LR5-RevB;

  • WB-15-W;

  • WB-15-W2;

  • ESR-10;

  • ESR-20;

  • ESR100;

  • ESR200.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
        <nbi:CreateInitRule>
            <nbi:ruleName>forth</nbi:ruleName>
            <nbi:ruleDomain>root</nbi:ruleDomain>
            <nbi:deviceType>WEP-2ac</nbi:deviceType>
            <nbi:descr></nbi:descr>
            <nbi:parameter>
                <xsd:name>FirmwareUpdateProtocol</xsd:name>
                <xsd:value>HTTP</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>FirmwareUpdateEnabled</xsd:name>
                <xsd:value>true</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>FirmwareUpdateOttEnabled</xsd:name>
                <xsd:value>true</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>SnmpTransportType</xsd:name>
                <xsd:value>TCP</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>SnmpReadonlyCommunity</xsd:name>
                <xsd:value>public</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>SnmpReadWriteCommunity</xsd:name>
                <xsd:value>private</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>NEED_RESET</xsd:name>
                <xsd:value>true</xsd:value>
            </nbi:parameter>
            <nbi:parameter>
                <xsd:name>RadiusApSecret</xsd:name>
                <xsd:value>eltex</xsd:value>
            </nbi:parameter>
        </nbi:CreateInitRule>
Ответ
        <ns:CreateInitRuleResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:CreateInitRuleResponse>
Код Описание ошибки

8

Домен правила не удовлетворяет правилам FQDN

10

У пользователя нет прав на данный домен

52

Некорректное имя правила инициализации

62

Домен не зарегистрирован в системе

309

Правило инициализации уже существует

311

Некорректный тип устройства

313

Некорректный параметр

312

Некорректное значение для параметра

314

Шаблона конфигурации с таким именем не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveInitRule – Удаление правила инициализации точек доступа

Общая информация

  1. Команда актуальна, начиная с версии 1.5.1

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ruleName

Имя правила инициализации

.{1.64}

Текст длиной не более 64 символов

ruleDomain

Домен области видимости правила инициализации

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

deviceType

Полный тип точки доступа производства Eltex

.*

Актуальный список доступных значений для deviceType смотрите в CreateInitRule

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

52

Некорректное имя правила инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName></nbi:ruleName>
            <nbi:ruleDomain></nbi:ruleDomain>
            <nbi:deviceType></nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>52</ax21:code>
                <ax21:detail>Incorrect rule name</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен правила не удовлетворяет правилам FQDN
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>sixth</nbi:ruleName>
            <nbi:ruleDomain>1ф</nbi:ruleDomain>
            <nbi:deviceType></nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '1ф' does not conform to the rules FQDN</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован в системе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>sixth</nbi:ruleName>
            <nbi:ruleDomain>ru</nbi:ruleDomain>
            <nbi:deviceType></nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ru' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

У пользователя нет прав на данный домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>sixth</nbi:ruleName>
            <nbi:ruleDomain>root</nbi:ruleDomain>
            <nbi:deviceType></nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

331

Некорректный тип устройства
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>sixth</nbi:ruleName>
            <nbi:ruleDomain>root</nbi:ruleDomain>
            <nbi:deviceType>qw</nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>311</ax21:code>
                <ax21:detail>Incorrect device type qw</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

310

Такого правила инициализации не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>sixth</nbi:ruleName>
            <nbi:ruleDomain>root</nbi:ruleDomain>
            <nbi:deviceType>WEP-2ac</nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>310</ax21:code>
                <ax21:detail>Init rule sixth[root] not exists for device type WEP-2ac</ax21:detail>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveInitRule>
            <nbi:ruleName>forth</nbi:ruleName>
            <nbi:ruleDomain>root</nbi:ruleDomain>
            <nbi:deviceType>WEP-2ac</nbi:deviceType>
        </nbi:RemoveInitRule>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveInitRuleResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:RemoveInitRuleResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetNasProps – Редактировать свойства RADIUS NAS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

attributes

Атрибуты пользователей, ожидается один или больше объектов NbiAttr

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Некорректно задан ip-адрес
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:SetNasProps>
            <nbi:ip>192.168.01</nbi:ip>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name></xsd1:name>
                <xsd1:oper></xsd1:oper>
                <xsd1:value></xsd1:value>
            </xsd:attributes>
        </nbi:SetNasProps>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:SetNasPropsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>30</ax21:code>
                <ax21:detail>Incorrect field 'ip'</ax21:detail>
            </ns:return>
        </ns:SetNasPropsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

31

Некорректно задан пароль(или отсутствует)
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:SetNasProps>
            <nbi:ip>192.168.0.1</nbi:ip>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name></xsd1:name>
                <xsd1:oper></xsd1:oper>
                <xsd1:value></xsd1:value>
            </xsd:attributes>
        </nbi:SetNasProps>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:SetNasPropsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>31</ax21:code>
                <ax21:detail>Incorrect field 'secret'</ax21:detail>
            </ns:return>
        </ns:SetNasPropsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

212

Адрес не существует
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:SetNasProps>
            <nbi:ip>192.168.0.4</nbi:ip>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name></xsd1:name>
                <xsd1:oper></xsd1:oper>
                <xsd1:value></xsd1:value>
            </xsd:attributes>
        </nbi:SetNasProps>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:SetNasPropsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>212</ax21:code>
                <ax21:detail>Auth-NAS doesn't exist</ax21:detail>
            </ns:return>
        </ns:SetNasPropsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:SetNasProps>
            <nbi:ip>192.168.0.1</nbi:ip>
            <!--1 or more repetitions:-->
            <xsd:attributes>
                <xsd1:name></xsd1:name>
                <xsd1:oper></xsd1:oper>
                <xsd1:value></xsd1:value>
            </xsd:attributes>
        </nbi:SetNasProps>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:SetNasPropsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetNasPropsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetProfileByDomain – Загрузка шаблона конфигурации на группу точек доступа

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен NAS, определяющий группу точек

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

profile

Имя шаблона конфигурации

(?!^.*(__).*$)(^[A-Za-z0-9-_\.]{1,40}$)

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 40-ка символов. Допускаются цифры, знаки тире и нижнее подчеркивание (подряд только одно).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Нет домена или домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByDomain>
            <xsd:domain></xsd:domain>
            <xsd:profile>test45</xsd:profile>
        </xsd:SetProfileByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:SetProfileByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByDomain>
            <xsd:domain>wifi</xsd:domain>
            <xsd:profile>test45</xsd:profile>
        </xsd:SetProfileByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'wifi'. Role`s domains: 'root'</ns:detail>
            </ns:SetProfileByDomainResponse>
        </soapenv:Body>
    </soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByDomain>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:profile>test45</xsd:profile>
        </xsd:SetProfileByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:SetProfileByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:SetProfileByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByDomain>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:profile>test45</xsd:profile>
        </xsd:SetProfileByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 1, message 'Profile contains Virtual AP settings, which should be set by SSID'</ns:detail>
            </ns:return>
        </ns:SetProfileByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByDomain>
            <xsd:domain>wifi.root</xsd:domain>
            <xsd:profile>987</xsd:profile>
        </xsd:SetProfileByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetProfileByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetProfileByIp – Загрузка шаблона конфигурации на точку доступа по IP адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

profile

Имя шаблона конфигурации

(?!^.*(__).*$)(^[A-Za-z0-9-_\.]{1,40}$)

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 40-ка символов. Допускаются цифры, знаки тире и нижнее подчеркивание (подряд только одно).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

30

Нет IP-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByIp>
            <xsd:ip>192.168.201.300</xsd:ip>
            <xsd:profile>321.192.168.201.22</xsd:profile>
        </xsd:SetProfileByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByIp>
            <xsd:ip>192.168.201.160</xsd:ip>
            <xsd:profile></xsd:profile>
        </xsd:SetProfileByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'profile'</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

6

Nas не существует
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>6</ns:code>
                <ns:detail>No NAS with ip '192.168.2.1'</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'hihi.root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByIp>
            <xsd:ip>192.168.201.22</xsd:ip>
            <xsd:profile>321.192.168.201.22</xsd:profile>
        </xsd:SetProfileByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 1, message 'Profile contains Class Map settings, which should be set by SSID'</ns:detail>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByIp>
            <xsd:ip>192.168.201.22</xsd:ip>
            <xsd:profile>987</xsd:profile>
        </xsd:SetProfileByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetProfileByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetProfileByMac – Загрузка шаблона конфигурации на точку доступа по MAC адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес точки доступа

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

profile

Имя шаблона конфигурации

(?!^.*(__).*$)(^[A-Za-z0-9-_\.]{1,40}$)

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 40-ка символов. Допускаются цифры, знаки тире и нижнее подчеркивание (подряд только одно).

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

63

Нет MAC-адреса или он не верен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByMac>
            <xsd:mac></xsd:mac>
            <xsd:profile></xsd:profile>
        </xsd:SetProfileByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'mac'</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Нет обязательного поля name или оно не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:profile></xsd:profile>
        </xsd:SetProfileByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'profile'</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

65

Nas не существует
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>65</ns:code>
                <ns:detail>No device with mac'a8:f9:4b:2f:f3:e0'</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен NAS
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: '101.root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен
Запрос
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>18</ns:code>
                <ns:detail>Failed to send http request: The host did not accept the connection within timeout of 5000 ms</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервиса NBI EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:profile>26.232.network</xsd:profile>
        </xsd:SetProfileByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 1, message 'Profile contains Class Map settings, which should be set by SSID'</ns:detail>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetProfileByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:profile>26.232.network</xsd:profile>
        </xsd:SetProfileByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetProfileByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetProfileByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetRuleByDomain – Однократное назначение правила инициализации на уже проинициализированную группу устройств с целью переконфигурации

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nasDomain

Домен точек доступа, по которому определяем группу устройств.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

ruleName

Имя правила инициализации.

.*

Любые символы

ruleDomain

Домен правила.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Домен правила или домен ТД не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain></xsd:nasDomain>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain></xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен правила или на домен ТД
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>root</xsd:nasDomain>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен роли или домен ТД не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>test1.root</xsd:nasDomain>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>test1.root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

54

Нет правила инициализации с таким именем и доменом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>root</xsd:nasDomain>
            <xsd:ruleName>test3</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>54</ns:code>
                <ns:detail>No Rules with name test3[enterprise.root]</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

52

Отсутствует имя правила инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>root</xsd:nasDomain>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>52</ns:code>
                <ns:detail>Incorrect field 'ruleName'</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервера EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>root</xsd:nasDomain>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 1, message 'No object with ip 192.168.26.131'</ns:detail>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByDomain>
            <xsd:nasDomain>root</xsd:nasDomain>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByDomainResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetRuleByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetRuleByIp – Однократное назначение правила инициализации на уже инициализированное устройство по IP-адресу с целью переконфигурации

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа.

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

ruleName

Имя правила инициализации.

.*

Любые символы

ruleDomain

Домен правила.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Домен правила или домен узла не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain></xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен правила
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>test1.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

30

IP-адрес отсутствует или не удовлетворяет формату
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip></xsd:ip>
            <xsd:ruleName>test45</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>30</ns:code>
                <ns:detail>Incorrect field 'ip'</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

54

Нет правила инициализации с таким именем и доменом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test45</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>54</ns:code>
                <ns:detail>No Rules with name test45[enterprise.root]</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

52

Отсутствует имя правила инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>52</ns:code>
                <ns:detail>Incorrect field 'ruleName'</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервера EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 1, message 'Роль пользователя не имеет прав на домен '[ DomainObj : name = 100010101; descr = ; id = 7; parentId = 1; fullName param = null; child size = 0 ]'. Домены роли: ' enterprise.root test.root hotspot.root''</ns:detail>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByIp>
            <xsd:ip>192.168.0.5</xsd:ip>
            <xsd:ruleName>test2</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByIp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByIpResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetRuleByIpResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetRuleByMac – Однократное назначение правила инициализации на уже инициализированное устройство по MAC-адресу с целью переконфигурации

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC-адрес точки доступа.

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

ruleName

Имя правила инициализации.

.*

Любые символы

ruleDomain

Домен правила.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

8

Домен правила или домен узла не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain></xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен правила
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>1.root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

63

MAC-адрес отсутствует или не удовлетворяет формату
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac></xsd:mac>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain></xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>63</ns:code>
                <ns:detail>Incorrect field 'mac'</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

54

Нет правила инициализации с таким именем и доменом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName>fake_rule</xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>54</ns:code>
                <ns:detail>No Rules with name fake_rule[enterprise.root]</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

52

Отсутствует имя правила инициализации
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>52</ns:code>
                <ns:detail>Incorrect field 'ruleName'</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

3

Ошибка от сервера EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName>MyRules</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>3</ns:code>
                <ns:detail>Error from EMS server: code 103, message 'null'</ns:detail>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:SetRuleByMac>
            <xsd:mac>a8:f9:4b:1f:f3:e0</xsd:mac>
            <xsd:ruleName>MyRules</xsd:ruleName>
            <xsd:ruleDomain>root</xsd:ruleDomain>
        </xsd:SetRuleByMac>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetRuleByMacResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:SetRuleByMacResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetInitializationApList - Получение списка неинициализированных ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

filter

Фильтр

Текст для поиска по всем полям.

count

Кол-во выводимых элементов.

Целое положительное число

startIndex

Номер страницы, порции выдаваемых элементов.

Смещение от начала таблицы (0 - выдать всё с начала)

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

type, ip, mac или status (По умолчанию type)

orderType

Поле определяющее тип сортировки.

ASC или DESC (По умолчанию ASC)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Размер списка без учета фильтров или описание ошибки

Целое неотрицательное число или текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiInitializationAp

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetInitializationApList>
         <nbi:filter>NEVER</nbi:filter>
         <nbi:count>10</nbi:count>
         <nbi:startIndex>0</nbi:startIndex>
         <nbi:orderBy>ip</nbi:orderBy>
         <nbi:orderType>DESC</nbi:orderType>
      </nbi:GetInitializationApList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetInitializationApListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>3</ax21:detail>
            <ax21:response>
               <ax21:apList>
                  <ax21:ip>192.168.0.20</ax21:ip>
                  <ax21:mac>a8:f9:4b:00:00:00</ax21:mac>
                  <ax21:status>NEVER</ax21:status>
                  <ax21:type>WEP-12ac</ax21:type>
               </ax21:apList>
               <ax21:apList>
                  <ax21:ip>192.168.0.10</ax21:ip>
                  <ax21:mac>a8:f9:4b:00:00:00</ax21:mac>
                  <ax21:status>NEVER</ax21:status>
                  <ax21:type>WEP-2ac</ax21:type>
               </ax21:apList>
            </ax21:response>
         </ns:return>
      </ns:GetInitializationApListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateNode - Создание узла

Общая информация

  1. Команда для создания узла дерева

  2. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения

parentNodeDomain

Домен родительского узла

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

newNodeName

Имя

Текст без символов: % \ ' " `

newNodeDomain

Домен

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован

281

Не найден обязательный параметр запроса

305

Дерево уже содержит узел с доменом newNodeDomain

306

Узел с доменом parentNodeDomain не найден

421

Узел с указанным именем уже существует

422

Некорректное имя узла.
Запрос
<soapenv:Envelope">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:CreateNode>
         <nbi:parentNodeDomain>ru</nbi:parentNodeDomain>
         <nbi:newNodeName>eltex</nbi:newNodeName>
         <nbi:newNodeDomain>eltex.ru</nbi:newNodeDomain>
      </nbi:CreateNode>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:CreateNodeResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:CreateNodeResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditNode - Изменить узел

Общая информация

  1. Команда для изменения узла дерева устройств

  2. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

nodeName

Имя узла

Текст без символов: % \ ' " `

newNodeName

Новое имя узла

Текст без символов: % \ ' " `

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

7

Не указан домен

8

Некорректный домен

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован

281

Не найден обязательный параметр запроса

421

Узел с указанным именем уже существует

422

Некорректное имя узла.
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:EditNode>
         <nbi:nodeName>old name</nbi:nodeName>
         <nbi:newNodeName>new name</nbi:newNodeName>
      </nbi:EditNode>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:CreateNodeResponse>
         <ns:return>
            <ax21:code>0</ax22:code>
            <ax21:detail/>
         </ns:return>
      </ns:CreateNodeResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetNodeByDomain - Получить узел дерева по имени домена

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда служит для получения узла дерева с указанным доменом.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Имя домена

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

nodeObject

Объект NbiNodeObject с описанием узла дерева

NbiNodeObject

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
        <nbi:GetNodeByDomain>
           <nbi:domainName>Ap.root</nbi:domainName>
        </nbi:GetNodeByDomain>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetNodeByDomainResponse>
        <ns:return xsi:type="ax224:NbiNodeObjectResponse">
          <ax21:code>0</ax21:code>
          <ax21:detail>Success</ax21:detail>
          <ax224:nodeObject xsi:type="ax224:NbiNodeObject">
             <ax224:domain>Ap.root</ax224:domain>
             <ax224:id>48</ax224:id>
             <ax224:type>NODE</ax224:type>
          </ax224:nodeObject>
       </ns:return>
    </ns:GetNodeByDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'domain'

8

Домен не удовлетворяет правилам FQDN

10

Нет прав на указанный в списке ключей домен

62

Указанный домен не найден в базе доменов

281

Не найден обязательный параметр запроса

305

Не найден узел по указанному домену

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetTreeObjectList - Получить список объектов в узле

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда служит для получения списка объектов из узла с указанным доменом.
    Если среди объектов есть узлы, то все их объекты так же включаются в ответ, если узел не имеет собственного домена.
    Если же узел имеет свой домен (дочерний от домена, указанного в запросе) объекты из такого узла в ответ не включаются, так как их можно получить выполнив аналогичный запрос, указав нужный домен.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

домен узла в дереве объектов

Выходные параметры

Параметр Значение Формат значения

obj

Массив объектов NbiTreeObj с описанием доменов

NbiTreeObj

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetTreeObjectList>
         <nbi:domain>root</nbi:domain>
      </nbi:GetTreeObjectList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetTreeObjectListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax221:obj xsi:type="ax221:NbiTreeObj">
               <ax221:domain>root</ax221:domain>
               <ax221:ip>192.168.26.223</ax221:ip>
               <ax221:mac>a8:f9:4b:1f:fc:80</ax221:mac>
               <ax221:subtype>-12ac</ax221:subtype>
               <ax221:type>WEP</ax221:type>
            </ax221:obj>
            <ax221:obj xsi:type="ax221:NbiTreeObj">
               <ax221:domain>reg0.root</ax221:domain>
               <ax221:ip xsi:nil="true"/>
               <ax221:mac xsi:nil="true"/>
               <ax221:subtype/>
               <ax221:type>NODE</ax221:type>
            </ax221:obj>
         </ns:return>
      </ns:GetTreeObjectListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'domain'

10

Нет прав на указанный в списке ключей домен

62

Домен не зарегистрирован

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

FindObjectsIdsByParam - Найти ID объектов дерева по параметру

Общая информация

  1. Команда служит для поиска объектов дерева по заданному параметру

  2. Существует ограничение по параметрам, по которым доступен поиск. Запрещенные параметры для поиска

  3. Значение параметра поиска можно задать пустым

  4. Команда актуальна, начиная с версии 1.22

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

parameter

Параметр для поиска

Основные параметры или атрибуты объекта дерева

NbiParameter

Выходные параметры

Параметр Значение Формат значения

ids

Массив идентификаторов объектов в дереве

Integer

code

Код ответа

int

detail

Пояснение к ответу

String

Основные параметры для поиска

Параметр Значение Формат значения

name

Имя устройства/узла

String

type

Тип

String

subtype

Подтип устройства

String

Запрещенные параметры для поиска

Параметр Значение

AuthPassword

Write community / Password v3

AuthProtocol

Протокол аутентификации

NetconfPassword

Netconf Password

password

Пароль для автоматического подключения по Telnet/SSH

PrivacyPassword

Ключ шифрования

WebPassword

Пароль для автоматического подключения по Web

Коды ответа

Код Описание

0

Успешно

2

Ошибка с БД

29

Пустой параметр

538

Запрещенный параметр

Пример использования

Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:FindObjectsIdsByParam>
         <nbi:parameter>
            <xsd:name>IpAddress</xsd:name>
            <xsd:value>10.25.96.115</xsd:value>
         </nbi:parameter>
      </nbi:FindObjectsIdsByParam>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:FindObjectsIdsByParamResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:ids>352982</ax21:ids>
         </ns:return>
      </ns:FindObjectsIdsByParamResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveTreeObjectById — Удалить объект дерева по ID

Общая информация

  1. Команда актуальна, начиная с версии 1.22.

  2. Команда удаляет объект из дерева EMS по его id в базе данных. Если тип удаляемого объекта - узел, то вместе с узлом будут удалены все объекты, находящиеся в узле. В любом другом случае удаляется только этот объект.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

ID удаляемого объекта

int

Целое число больше нуля

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Коды ответа

Код Описание

0

Успешно

3

Ошибка EMS-NBI

10

У роли нет прав на домен

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

45

Неизвестный ответ от EMS сервера

416

Не найден объект в дереве

436

Не указан обязательный параметр id

539

Параметр id должен быть целым положительным числом

999

Системная ошибка

Пример использования

Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RemoveTreeObjectById>
         <nbi:id>46575</nbi:id>
      </nbi:RemoveTreeObjectById>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RemoveTreeObjectByIdResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
         </ns:return>
      </ns:RemoveTreeObjectByIdResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveTreeObjects - Удалить устройства из дерева по ключу

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для удаления произвольного числа объектов из дерева EMS.
    Идентификатором объекта может быть MAC адрес, IP адрес или домен. В случае указания домена, удаляется узел дерева со всеми вложенными объектами.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

keys

массив ключей, идентификаторов устройств (IP, MAC, домен)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RemoveTreeObjects>
         <nbi:keys>
            <xsd:key>192.168.26.110</xsd:key>
            <xsd:key>a8:f9:4b:1f:fc:80</xsd:key>
            <xsd:key>reg0.root</xsd:key>
         </nbi:keys>
      </nbi:RemoveTreeObjects>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RemoveTreeObjectsResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:RemoveTreeObjectsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Нет прав на указанный в списке ключей домен

18

Ошибка обращения в EMS NBI

281

Параметр запроса 'keys' не найден или пустой

413

Неизвестный формат ключа (ключ не является IP, MAC или доменом)

416

Не найден объект в дереве ''{0}'', ''{1}''

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAccessParamNamesList - Список имен параметров доступа и ицициализации с вкладки Доступ из EMS

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для получения списка идентификаторов и названий параметров доступа и ицициализации с вкладки Доступ из EMS.

Выходные параметры

Параметр Значение Формат значения

response

Массив объектов NbiParameter. Содержит идентификатор параметра и его имя.

NbiParameterArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetAccessParamNamesList/>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetAccessParamNamesListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiParameterArray">
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Name</ax21:name>
                  <ax21:value>Device name</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Domain</ax21:name>
                  <ax21:value>Domain</ax21:value>
               </ax21:parameter>
            </ax21:response>
         </ns:return>
      </ns:GetAccessParamNamesListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetApAccessParamList - Запрос списка параметров с вкладки Доступ из EMS для конкретного устройства

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда служит для получения списка идентификаторов и значений параметров с вкладки Доступ из EMS для конкретного устройства.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

Ip-адрес устройства

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

Выходные параметры

Параметр Значение Формат значения

response

Массив объектов NbiParameter Содержит идентификатор параметра и его значение.

NbiParameterArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetApAccessParamList>
         <nbi:ip>127.0.0.1</nbi:ip>
      </nbi:GetApAccessParamList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetApAccessParamListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiParameterArray">
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>Description</ax21:name>
                  <ax21:value>SNMP объект EMS сервер</ax21:value>
               </ax21:parameter>
               <ax21:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>IpAddress</ax21:name>
                  <ax21:value>127.0.0.1</ax21:value>
               </ax21:parameter>
            </ax21:response>
         </ns:return>
      </ns:GetApAccessParamListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

279

Устройство не найдено по IP-адресу

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoObjects - Получить список объектов вкладки Карты ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

  2. Команда добавлена для получения информации вкладки Карты ТД Личного кабинета.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

wsLatitude

Широта Юго-западного угла карты

Double

wsLongitude

Долгота Юго-западного угла карты

Double

neLatitude

Широта северо-восточного угла карты

Double

neLongitude

Долгота северо-восточного угла карты

Double

params

Дополнительные параметры выборки

NbiParameterArray

В качестве дополнительных параметров можно указывать:

  • range - 24, 50, если нужно конкретизировать Wi-Fi диапазон;
    по умолчанию выборка ведется по всем диапазонам;

  • types - типы устройств (в системе EMS, разделенные запятой) для отображения на карте;
    по умолчанию 'WEP,WOP,GenericAp,WB';

  • latn - число сегментов по широте (по вертикальной стороне карты);
    по умолчанию 6;

  • lonn - число сегментов по долготе (по горизонтальной стороне карты);
    по умолчанию 6;

  • domain - домен ТД (domain.root) или диапазон доменов со всеми дочерними (.domain.root); по умолчанию пустое значение, в этом случае фильтруются все доступные пользователю домены;

  • available - статус доступности -1 (все), 0 или 1 (доступно);
    по умолчанию -1;

  • status - список расширенных статусов (цифр через запятую), в которых могут находиться объекты, отображаемые на карте;
    по умолчанию пустая строка;
    разрешены значения: 0 - все хорошо, 1 - есть аварии, 2 - недоступность, 3 - выведено из обслуживания, 4 - нет синхронизации, 5 - нет IP.

  • esrmode - режим, в котором находится ESR (используется только для ESR устройств);
    по умолчанию 0;
    разрешены значения: 0 - Station, 1 - Client, 2 - StationCE.

  • ott - режим OTT, в котором могут находиться объекты, отображаемые на карте;
    по умолчанию -1;
    разрешены значения: -1 - All, 0 - Not OTT, 1 - OTT Connected (Client), 2 - OTT ServiceProvider.

Выходные параметры

Параметр Значение Формат значения

total

Сводная информация по видимой области

NbiGeoAp

objects

Массив объектов (ТД или групп ТД) для отображения на карте

NbiGeoAp

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetGeoObjects>
         <nbi:wsLatitude>50</nbi:wsLatitude>
         <nbi:wsLongitude>80</nbi:wsLongitude>
         <nbi:neLatitude>55</nbi:neLatitude>
         <nbi:neLongitude>85</nbi:neLongitude>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>latn</xsd:name>
               <xsd:value>3</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>lonn</xsd:name>
               <xsd:value>3</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetGeoObjects>
Ответ
      <ns:GetGeoObjectsResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:type="ax235:NbiApInfo">
                  <ax235:actNumber xsi:nil="true"/>
                  <ax235:available>false</ax235:available>
                  <ax235:building xsi:nil="true"/>
                  <ax235:city xsi:nil="true"/>
                  <ax235:domain>8558-0021_ul_Pervomaiskaya_4A.Sberbank.Ust-Kan_Selo.Altay_Respublika.Altayskiy_filial.Sibir.Ap.root</ax235:domain>
                  <ax235:emsObjectId>14861</ax235:emsObjectId>
                  <ax235:floor xsi:nil="true"/>
                  <ax235:fullAddress xsi:nil="true"/>
                  <ax235:fullName xsi:nil="true"/>
                  <ax235:fwVersion xsi:nil="true"/>
                  <ax235:house xsi:nil="true"/>
                  <ax235:integralStatus xsi:nil="true"/>
                  <ax235:integralStatusCause xsi:nil="true"/>
                  <ax235:ip xsi:nil="true"/>
                  <ax235:mac xsi:nil="true"/>
                  <ax235:maxUplinkLoad>0</ax235:maxUplinkLoad>
                  <ax235:maxUsers>0</ax235:maxUsers>
                  <ax235:name>sberbank_Sibir_8558-0021_a8-f9-4b-b1-7d-60</ax235:name>
                  <ax235:office xsi:nil="true"/>
                  <ax235:outOfService>false</ax235:outOfService>
                  <ax235:ssids xsi:nil="true"/>
                  <ax235:state xsi:nil="true"/>
                  <ax235:street xsi:nil="true"/>
                  <ax235:type xsi:nil="true"/>
                  <ax235:usersCount>0</ax235:usersCount>
                  <ax235:workTime>0</ax235:workTime>
               </ax267:apInfo>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>1</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>50</ax267:latD>
               <ax267:latitude>50.928361</ax267:latitude>
               <ax267:lonD>50</ax267:lonD>
               <ax267:longitude>84.763557</ax267:longitude>
               <ax267:maxTraffic>595995.0</ax267:maxTraffic>
               <ax267:maxUsers>12</ax267:maxUsers>
               <ax267:userOnline24>4</ax267:userOnline24>
               <ax267:userOnline50>0</ax267:userOnline50>
               <ax267:vapOn24>1</ax267:vapOn24>
               <ax267:vapOn50>0</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>1</ax267:apOffline>
               <ax267:apOnline>17</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>51</ax267:latD>
               <ax267:latitude>51.43310094444444</ax267:latitude>
               <ax267:lonD>48</ax267:lonD>
               <ax267:longitude>81.23505083333333</ax267:longitude>
               <ax267:maxTraffic>643435.0</ax267:maxTraffic>
               <ax267:maxUsers>60</ax267:maxUsers>
               <ax267:userOnline24>93</ax267:userOnline24>
               <ax267:userOnline50>13</ax267:userOnline50>
               <ax267:vapOn24>17</ax267:vapOn24>
               <ax267:vapOn50>9</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>11</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>51</ax267:latD>
               <ax267:latitude>51.55095327272727</ax267:latitude>
               <ax267:lonD>49</ax267:lonD>
               <ax267:longitude>82.22934599999999</ax267:longitude>
               <ax267:maxTraffic>536175.0</ax267:maxTraffic>
               <ax267:maxUsers>19</ax267:maxUsers>
               <ax267:userOnline24>28</ax267:userOnline24>
               <ax267:userOnline50>13</ax267:userOnline50>
               <ax267:vapOn24>11</ax267:vapOn24>
               <ax267:vapOn50>9</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>8</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>51</ax267:latD>
               <ax267:latitude>51.98950400000001</ax267:latitude>
               <ax267:lonD>50</ax267:lonD>
               <ax267:longitude>84.96968624999998</ax267:longitude>
               <ax267:maxTraffic>3873549.0</ax267:maxTraffic>
               <ax267:maxUsers>47</ax267:maxUsers>
               <ax267:userOnline24>58</ax267:userOnline24>
               <ax267:userOnline50>9</ax267:userOnline50>
               <ax267:vapOn24>8</ax267:vapOn24>
               <ax267:vapOn50>8</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>2</ax267:apOffline>
               <ax267:apOnline>11</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>52</ax267:latD>
               <ax267:latitude>52.57580076923078</ax267:latitude>
               <ax267:lonD>48</ax267:lonD>
               <ax267:longitude>81.02908538461537</ax267:longitude>
               <ax267:maxTraffic>859818.0</ax267:maxTraffic>
               <ax267:maxUsers>20</ax267:maxUsers>
               <ax267:userOnline24>16</ax267:userOnline24>
               <ax267:userOnline50>14</ax267:userOnline50>
               <ax267:vapOn24>11</ax267:vapOn24>
               <ax267:vapOn50>9</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>9</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>52</ax267:latD>
               <ax267:latitude>52.45143333333334</ax267:latitude>
               <ax267:lonD>49</ax267:lonD>
               <ax267:longitude>82.90911799999999</ax267:longitude>
               <ax267:maxTraffic>667097.0</ax267:maxTraffic>
               <ax267:maxUsers>32</ax267:maxUsers>
               <ax267:userOnline24>38</ax267:userOnline24>
               <ax267:userOnline50>6</ax267:userOnline50>
               <ax267:vapOn24>9</ax267:vapOn24>
               <ax267:vapOn50>3</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>10</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>52</ax267:latD>
               <ax267:latitude>52.37339250000001</ax267:latitude>
               <ax267:lonD>50</ax267:lonD>
               <ax267:longitude>84.3451532</ax267:longitude>
               <ax267:maxTraffic>533514.0</ax267:maxTraffic>
               <ax267:maxUsers>14</ax267:maxUsers>
               <ax267:userOnline24>14</ax267:userOnline24>
               <ax267:userOnline50>7</ax267:userOnline50>
               <ax267:vapOn24>10</ax267:vapOn24>
               <ax267:vapOn50>6</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>11</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>53</ax267:latD>
               <ax267:latitude>53.63157936363637</ax267:latitude>
               <ax267:lonD>48</ax267:lonD>
               <ax267:longitude>81.16732981818183</ax267:longitude>
               <ax267:maxTraffic>700400.0</ax267:maxTraffic>
               <ax267:maxUsers>55</ax267:maxUsers>
               <ax267:userOnline24>47</ax267:userOnline24>
               <ax267:userOnline50>31</ax267:userOnline50>
               <ax267:vapOn24>11</ax267:vapOn24>
               <ax267:vapOn50>10</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>6</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>53</ax267:latD>
               <ax267:latitude>53.40608616666666</ax267:latitude>
               <ax267:lonD>49</ax267:lonD>
               <ax267:longitude>82.48237216666668</ax267:longitude>
               <ax267:maxTraffic>695900.0</ax267:maxTraffic>
               <ax267:maxUsers>24</ax267:maxUsers>
               <ax267:userOnline24>31</ax267:userOnline24>
               <ax267:userOnline50>6</ax267:userOnline50>
               <ax267:vapOn24>6</ax267:vapOn24>
               <ax267:vapOn50>2</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>18</ax267:apOffline>
               <ax267:apOnline>185</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>53</ax267:latD>
               <ax267:latitude>53.37612365024629</ax267:latitude>
               <ax267:lonD>50</ax267:lonD>
               <ax267:longitude>83.89091266995067</ax267:longitude>
               <ax267:maxTraffic>2886736.0</ax267:maxTraffic>
               <ax267:maxUsers>241</ax267:maxUsers>
               <ax267:userOnline24>625</ax267:userOnline24>
               <ax267:userOnline50>365</ax267:userOnline50>
               <ax267:vapOn24>183</ax267:vapOn24>
               <ax267:vapOn50>156</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:type="ax235:NbiApInfo">
                  <ax235:actNumber xsi:nil="true"/>
                  <ax235:available>false</ax235:available>
                  <ax235:building xsi:nil="true"/>
                  <ax235:city xsi:nil="true"/>
                  <ax235:domain>8047-0536_ul_Sovetskaya_26.Sberbank.Kochki_Selo.Novosibirskaya_Oblast.Novosibirskiy_filial.Sibir.Ap.root</ax235:domain>
                  <ax235:emsObjectId>13359</ax235:emsObjectId>
                  <ax235:floor xsi:nil="true"/>
                  <ax235:fullAddress xsi:nil="true"/>
                  <ax235:fullName xsi:nil="true"/>
                  <ax235:fwVersion xsi:nil="true"/>
                  <ax235:house xsi:nil="true"/>
                  <ax235:integralStatus xsi:nil="true"/>
                  <ax235:integralStatusCause xsi:nil="true"/>
                  <ax235:ip xsi:nil="true"/>
                  <ax235:mac xsi:nil="true"/>
                  <ax235:maxUplinkLoad>0</ax235:maxUplinkLoad>
                  <ax235:maxUsers>0</ax235:maxUsers>
                  <ax235:name>sberbank_Sibir_8047-0536_a8-f9-4b-b1-b9-a0</ax235:name>
                  <ax235:office xsi:nil="true"/>
                  <ax235:outOfService>false</ax235:outOfService>
                  <ax235:ssids xsi:nil="true"/>
                  <ax235:state xsi:nil="true"/>
                  <ax235:street xsi:nil="true"/>
                  <ax235:type xsi:nil="true"/>
                  <ax235:usersCount>0</ax235:usersCount>
                  <ax235:workTime>0</ax235:workTime>
               </ax267:apInfo>
               <ax267:apOffline>0</ax267:apOffline>
               <ax267:apOnline>1</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>54</ax267:latD>
               <ax267:latitude>54.330502</ax267:latitude>
               <ax267:lonD>48</ax267:lonD>
               <ax267:longitude>80.486426</ax267:longitude>
               <ax267:maxTraffic>442427.0</ax267:maxTraffic>
               <ax267:maxUsers>18</ax267:maxUsers>
               <ax267:userOnline24>6</ax267:userOnline24>
               <ax267:userOnline50>0</ax267:userOnline50>
               <ax267:vapOn24>1</ax267:vapOn24>
               <ax267:vapOn50>0</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>27</ax267:apOffline>
               <ax267:apOnline>181</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>54</ax267:latD>
               <ax267:latitude>54.92258559134609</ax267:latitude>
               <ax267:lonD>49</ax267:lonD>
               <ax267:longitude>82.88892680769216</ax267:longitude>
               <ax267:maxTraffic>1.7149588E7</ax267:maxTraffic>
               <ax267:maxUsers>145</ax267:maxUsers>
               <ax267:userOnline24>428</ax267:userOnline24>
               <ax267:userOnline50>195</ax267:userOnline50>
               <ax267:vapOn24>184</ax267:vapOn24>
               <ax267:vapOn50>157</ax267:vapOn50>
            </ax267:objects>
            <ax267:objects xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>2</ax267:apOffline>
               <ax267:apOnline>4</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>54</ax267:latD>
               <ax267:latitude>54.30489983333334</ax267:latitude>
               <ax267:lonD>50</ax267:lonD>
               <ax267:longitude>83.64980333333332</ax267:longitude>
               <ax267:maxTraffic>1583162.0</ax267:maxTraffic>
               <ax267:maxUsers>70</ax267:maxUsers>
               <ax267:userOnline24>22</ax267:userOnline24>
               <ax267:userOnline50>3</ax267:userOnline50>
               <ax267:vapOn24>4</ax267:vapOn24>
               <ax267:vapOn50>3</ax267:vapOn50>
            </ax267:objects>
            <ax267:total xsi:type="ax267:NbiGeoAp">
               <ax267:apInfo xsi:nil="true"/>
               <ax267:apOffline>50</ax267:apOffline>
               <ax267:apOnline>455</ax267:apOnline>
               <ax267:geoHash xsi:nil="true"/>
               <ax267:latD>0</ax267:latD>
               <ax267:latitude>0.0</ax267:latitude>
               <ax267:lonD>0</ax267:lonD>
               <ax267:longitude>0.0</ax267:longitude>
               <ax267:maxTraffic>1.7149588E7</ax267:maxTraffic>
               <ax267:maxUsers>241</ax267:maxUsers>
               <ax267:userOnline24>1410</ax267:userOnline24>
               <ax267:userOnline50>662</ax267:userOnline50>
               <ax267:vapOn24>456</ax267:vapOn24>
               <ax267:vapOn50>372</ax267:vapOn50>
            </ax267:total>
         </ns:return>
      </ns:GetGeoObjectsResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

8

Некорректный формат домен

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoObjectsList - Получить список объектов для вкладки Список ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

  2. Служит для быстрого получения данных вкладки Список ТД без обращения в EMS (как это было в RetrieveAPListExtended). Данные берутся напрямую из eltex_ems.ELTEX_OBJ_GEO.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

request

Условия выборки

GetGeoObjectListRequest

Выходные параметры

Параметр Значение Формат значения

portion

Список объектов с информаицей о ТД

NbiGeoApList

total

Общее число объектов, удовлетворяющих условию поиска

Long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetGeoObjectsList>
         <nbi:request>
            <xsd:domains>
               <xsd:name>root</xsd:name>
               <xsd:nested>true</xsd:nested>
            </xsd:domains>
            <xsd:freeSearch>
               <xsd:fields>name</xsd:fields>
               <xsd:searchString>MIKE</xsd:searchString>
            </xsd:freeSearch>
            <xsd:params>
               <xsd1:parameter>
                  <xsd1:name>available</xsd1:name>
                  <xsd1:value>0</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>offset</xsd1:name>
                  <xsd1:value>0</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>limit</xsd1:name>
                  <xsd1:value>10</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>orderFields</xsd1:name>
                  <xsd1:value>name</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>orderType</xsd1:name>
                  <xsd1:value>ASC</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>status</xsd1:name>
                  <xsd1:value>1,2,3,4</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>types</xsd1:name>
                  <xsd1:value>WEP</xsd1:value>
               </xsd1:parameter>
            </xsd:params>
         </nbi:request>
      </nbi:GetGeoObjectsList>
Ответ
      <ns:GetGeoObjectsListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax278:portion xsi:type="ax278:NbiGeoApList">
               <ax278:items xsi:type="ax278:NbiGeoApListItem">
                  <ax278:actNumber>123456</ax278:actNumber>
                  <ax278:available>0</ax278:available>
                  <ax278:building>2</ax278:building>
                  <ax278:city>City</ax278:city>
                  <ax278:country>Russia</ax278:country>
                  <ax278:district>District</ax278:district>
                  <ax278:domain>ap1.root</ax278:domain>
                  <ax278:emsId>13</ax278:emsId>
                  <ax278:floor>3</ax278:floor>
                  <ax278:fullName>mike</ax278:fullName>
                  <ax278:house>1</ax278:house>
                  <ax279:inn/>
                  <ax278:ip>192.168.40.50</ax278:ip>
                  <ax278:lat>55.039642</ax278:lat>
                  <ax278:lon>82.89415<ax278:lon>
                  <ax278:mac>E0:D9:E3:72:AD:A0<ax278:mac>
                  <ax278:maxTraffic>0.0</ax278:maxTraffic>
                  <ax278:maxUsers>1</ax278:maxUsers>
                  <ax278:name>BOX_MIKE-192.168.26.102</ax278:name>
                  <ax278:office>4</ax278:office>
                  <ax278:region>Nsk</ax278:region>
                  <ax279:startTime>1999-12-31T00:00:00.000</ax279:startTime>
                  <ax278:status>3</ax278:status>
                  <ax278:statusCause>Out of service</ax278:statusCause>
                  <ax278:street>Street</ax278:street>
                  <ax278:type>WEP</ax278:type>
                  <ax278:subtype>-2ac</ax278:subtype>
                  <ax278:serialNumber>WP12009408</ax278:serialNumber>
                  <ax278:uptime>0</ax278:uptime>
                  <ax278:user24>0</ax278:user24>
                  <ax278:user50>0</ax278:user50>
                  <ax278:zip>630005</ax278:zip>
               </ax278:items>
            </ax278:portion>
            <ax278:total>1</ax278:total>
         </ns:return>
      </ns:GetGeoObjectsListResponse>
Код Описание ошибки

2

Ошибка взаимодействия с БД eltex_ems.ELTEX_OBJ_GEO

7

Пустой домен в списке

8

Некорректный формат домен

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

436

Не найден объект с условиями выборки

Пример использования

См. также

  1. RetrieveAPListExtended - Запрос списка ТД с информацией по SSID

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveApGraphic - Получить RRD статистику в виде графика

Общая информация

  1. Команда актуальна, начиная с версии 1.11.

  2. Предназначена для получения графика RRD статистики в ЛК. Изображение создается на сервере EMS, и передается в NBI, ЛК в base64 кодировке.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

Домены разделенные запятой. Могут быть null.

String

emsObjId

ID устройства, для которого получаем RRD статистику

Integer

code

Код статистики

String

users - число клиентов на точке доступа
uplink_load - загрузка аплинка
ping - опрос доступности

dataView

Тип графика: min, max (по умолчанию), avg…​

String

timePeriod

Диапазон, в сек, от текущего времени.

Integer

subtype

Дополнительный параметр для ping: snmp, icmp.

String

Выходные параметры

Параметр Значение Формат значения

response

Ответ EMS-NBI в виде XML.

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveApGraphic>
         <nbi:domains>root</nbi:domains>
         <nbi:emsObjId>13</nbi:emsObjId>
         <nbi:code>ping</nbi:code>
         <nbi:dataView>min</nbi:dataView>
         <nbi:timePeriod>36000</nbi:timePeriod>
         <nbi:subtype>icmp</nbi:subtype>
      </nbi:RetrieveApGraphic>
Ответ
----      <ns:RetrieveApGraphicResponse>
             <ns:return>
                <ax22:code>0</ax22:code>
                <ax22:detail/>
                <ax22:response><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
    <getApGraphic>
    <code>0</code>
    <msg>OK</msg>
    <base64>bla-bla-bla</base64>
    </getApGraphic>]]></ax22:response>
             </ns:return>
          </ns:RetrieveApGraphicResponse>
----
Код Описание ошибки

3

Ошибка взаимодействия с EMS-NBI

8

Некорректный формат домен

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SyncDevice - Запрос синхронизации выбранного устройства

Общая информация

  1. Команда не поддерживается, начиная с версии 1.21

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

IP

ip-адрес устройства

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

Текст с ip-адресом

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Строка

Текст xml ответа

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля IP
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SyncDevice>
            <nbi:ip>192.168.40.30</nbi:ip>
        </nbi:SyncDevice>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>18</ax21:code>
                <ax21:detail>Failed to send http request: Read timed out</ax21:detail>
                <ax21:response></ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <nbi:SyncDevice>
        <nbi:ip>192.168.26.233</nbi:ip>
    </nbi:SyncDevice>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>
                    <SyncDevice>
                        <code0>
                        </code>
                        <msgOK>
                        </msg>
                    </SyncDevice>
                </ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainsIntegralStatus - Получить интегральный статус узла дерева объектов

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Используется в ЛК для отображения статуса регионов, площадок, каждом из которых соответствует узел в дереве объектов, однозначно идентифицирующийся по домену.

  3. В версии 1.18 данные начали выбираться из БД. Теперь разрешено передавать только один домен и этот параметр является обязательным.

  4. Для запроса порции данных и числа записей используются разные запросы.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

домен, внутри которого искать

String

Обязательно указывать один домен. Точка в начале домена означает Со всеми вложенными.

count

число записей, он же limit.

Integer

0, чтобы запросить только подсчет числа записей.

page

страница (для пагинации)

Integer

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

startIndex

пропустить N записей с начала, он же offset

Integer

locale

null

String

Выходные параметры

Параметр Значение Формат значения

domains

Список данных по узлам

NbiDomainIntegralStatus

totalSize

Общее число записей, удовлетворяющих условиям фильтрации

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос порции данных
      <nbi:RetrieveDomainsIntegralStatus>
         <nbi:domains>.root</nbi:domains>
         <nbi:count>3</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>100</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatus>
Ответ
      <ns:RetrieveDomainsIntegralStatusResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>8619-00770_Chernomorskiy_Yubileynaya_77a.Sberbank.Severskaya.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>2</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>0</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>8619-0766_ul_Lenina_184.Sberbank.Ilskiy.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>0</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>3</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>1806-0165_ul_Sovetskaya_2A.Sberbank.Dzhubga.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>2</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>0</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:totalSize>0</ax229:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusResponse>
Запрос общего числа записей
      <nbi:RetrieveDomainsIntegralStatus>
         <nbi:domains>.root</nbi:domains>
         <nbi:count>0</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>100</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatus>
Ответ
      <ns:RetrieveDomainsIntegralStatusResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax211:domains xsi:nil="true"/>
            <ax211:totalSize>10996</ax229:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainsIntegralStatusV2 - Получить интегральный статус узла дерева объектов

Общая информация

  1. Команда актуальна, начиная с версии 1.12. Данные выбирались из EMS-NBI, из контейнера объектов. Можно было передавать несколько доменов, разделенных запятой. В этой реализации была поддержка filters objtype, который позже был признан бесполезным.

  2. Используется в ЛК для отображения статуса регионов, площадок, каждом из которых соответствует узел в дереве объектов, однозначно идентифицирующийся по домену.

  3. В версии 1.18 данные начали выбираться из БД (без обращения в EMS). Теперь разрешено передавать только один домен и этот параметр является обязательным. Фильтры не поддерживаются.

  4. Для запроса порции данных и числа записей используются разные запросы.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

домен, внутри которого искать

String

Обязательно указывать один домен. Точка в начале домена означает Со всеми вложенными.

filters

NbiParameterArray Список фильтров

На данный момент фильтры не поддерживаются

NbiParameterArray

count

число записей, он же limit.

Integer

0, чтобы запросить только подсчет числа записей.

page

страница (для пагинации)

Integer

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

startIndex

пропустить N записей с начала, он же offset

Integer

locale

null

String

Выходные параметры

Параметр Значение Формат значения

domains

Список данных по узлам

NbiDomainIntegralStatus

totalSize

Общее число записей, удовлетворяющих условиям фильтрации

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос порции данных
      <nbi:RetrieveDomainsIntegralStatusV2>
         <nbi:domains>.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>2</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>1000</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatusV2>
Ответ
      <ns:RetrieveDomainsIntegralStatusV2Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax230:domains xsi:type="ax230:NbiDomainIntegralStatus">
               <ax230:domainName>8621-0437_ul_Pokalchuka_25.Sberbank.Kletskaya.Volgogradskaya_obl.Volgogradskiy_filial.Ug.Ap.root</ax230:domainName>
               <ax230:grayStatusCount>0</ax230:grayStatusCount>
               <ax230:greenStatusCount>2</ax230:greenStatusCount>
               <ax230:orangeStatusCount>0</ax230:orangeStatusCount>
               <ax230:pinkStatusCount>0</ax230:pinkStatusCount>
               <ax230:redStatusCount>0</ax230:redStatusCount>
               <ax230:yellowStatusCount>0</ax230:yellowStatusCount>
            </ax230:domains>
            <ax230:domains xsi:type="ax230:NbiDomainIntegralStatus">
               <ax230:domainName>Centr_Kulturnogo_Razvitiya_Lihacheva_6a.Shebekino.Bekgorodskaya_obl.Centr.Zapad.OTT.root</ax230:domainName>
               <ax230:grayStatusCount>0</ax230:grayStatusCount>
               <ax230:greenStatusCount>1</ax230:greenStatusCount>
               <ax230:orangeStatusCount>0</ax230:orangeStatusCount>
               <ax230:pinkStatusCount>0</ax230:pinkStatusCount>
               <ax230:redStatusCount>0</ax230:redStatusCount>
               <ax230:yellowStatusCount>0</ax230:yellowStatusCount>
            </ax230:domains>
            <ax230:totalSize>0</ax230:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusV2Response>
Запрос общего числа записей
      <nbi:RetrieveDomainsIntegralStatusV2>
         <nbi:domains>.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>0</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>1000</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatusV2>
Ответ
      <ns:RetrieveDomainsIntegralStatusV2Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax211:domains xsi:nil="true"/>
            <ax211:totalSize>10996</ax230:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusV2Response>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainsIntegralStatusV3 - Получить интегральный статус узлов дерева объектов

Общая информация

  1. Команда актуальна, начиная с версии 1.23.

  2. Используется в ЛК для отображения статуса регионов, площадок.

  3. Основное отличие от версии V2 - возможность запросить статистику сразу для нескольких доменов.

  4. Если список доменов (domains) оставить пустым (не указывать вообще), будет получен интегральный статус узлов дерева для всех доменов роли.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

domains

Список доменов, для которых будет получен интегральный статус

String

Список доменов для поиска. Пустой список будет означать запрос по всем доменам роли

nested

Вложенность доменов

Boolean

true - включая дочерние домены, false - без дочерних доменов. Если не указать параметр, по умолчанию будет true

count

Число записей, он же limit.

Integer

0, чтобы получить количество записей, подходящих под условия запроса

skip

Пропустить N записей с начала

Integer

filters

NbiParameterArray Список фильтров

На данный момент фильтры не поддерживаются

Выходные параметры

Параметр Значение Формат значения

domains

Список данных по узлам

NbiDomainIntegralStatus

totalSize

Общее число записей, удовлетворяющих условиям фильтрации

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:RetrieveDomainsIntegralStatusV3>
         <nbi:domains>building-1.root</nbi:domains>
         <nbi:domains>building-2.root</nbi:domains>
         <nbi:nested>true</nbi:nested>
         <nbi:count>10</nbi:count>
         <nbi:skip>0</nbi:skip>
      </nbi:RetrieveDomainsIntegralStatusV3>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveDomainsIntegralStatusV3Response>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax215:domains>
               <ax215:domainName>floor-0.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>4</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-4.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-2.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-1.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>5</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-5.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>1</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-1.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>0</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>6</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-4.building-2.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>15</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-0.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>2</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:domains>
               <ax215:domainName>floor-3.building-1.root</ax215:domainName>
               <ax215:grayStatusCount>0</ax215:grayStatusCount>
               <ax215:greenStatusCount>7</ax215:greenStatusCount>
               <ax215:orangeStatusCount>0</ax215:orangeStatusCount>
               <ax215:pinkStatusCount>0</ax215:pinkStatusCount>
               <ax215:redStatusCount>0</ax215:redStatusCount>
               <ax215:yellowStatusCount>0</ax215:yellowStatusCount>
            </ax215:domains>
            <ax215:totalSize>0</ax215:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusV3Response>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Данный домен не зарегистрирован в системе SoftWLC

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoObjectCommonDomain - Получить общий домен для одной агрегации вкладки Карты ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Команда добавлена для выполнения нажатия на ссылку "перейти к локации" в подсказке к выбранной локации ТД на вкладке Карты ТД Личного кабинета.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

wsLatitude

Широта Юго-западного угла карты

Double

wsLongitude

Долгота Юго-западного угла карты

Double

neLatitude

Широта северо-восточного угла карты

Double

neLongitude

Долгота северо-восточного угла карты

Double

latD

Номер квадрата агрегации карты по широте

Integer

lonD

Номер квадрата агрегации карты по долготе

Integer

params

Дополнительные параметры выборки

NbiParameterArray

В качестве дополнительных параметров можно указывать:

  • range - 24, 50, если нужно конкретизировать Wi-Fi диапазон;
    по умолчанию выборка ведется по всем диапазонам;

  • types - типы устройств (в системе EMS, разделенные запятой) для отображения на карте;
    по умолчанию 'WEP,WOP,GenericAp,WB';

  • domain - домен ТД (domain.root) или диапазон доменов со всеми дочерними (.domain.root); по умолчанию пустое значение, в этом случае фильтруются все доступные пользователю домены;

  • available - статус доступности -1 (все), 0 или 1 (доступно);
    по умолчанию -1;

  • status - список расширенных статусов (цифр через запятую), в которых могут находиться объекты, отображаемые на карте;
    по умолчанию пустая строка;
    разрешены значения: 0 - все хорошо, 1 - есть аварии, 2 - недоступность, 3 - выведено из обслуживания, 4 - нет синхронизации, 5 - нет IP.

  • esrmode - режим, в котором находится ESR (используется только для ESR устройств);
    по умолчанию 0;
    разрешены значения: 0 - Station, 1 - Client, 2 - StationCE.

  • ott - режим OTT, в котором могут находиться объекты, отображаемые на карте;
    по умолчанию -1;
    разрешены значения: -1 - All, 0 - Not OTT, 1 - OTT Connected (Client), 2 - OTT ServiceProvider.

Выходные параметры

Параметр Значение Формат значения

response

Общий домен для всех, выбранных запросом, ТД (включая поддомены либо не включая)

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetGeoObjectCommonDomain>
         <nbi:wsLatitude>54.93700517131387</nbi:wsLatitude>
         <nbi:wsLongitude>82.64122027343751</nbi:wsLongitude>
         <nbi:neLatitude>55.10332014659432</nbi:neLatitude>
         <nbi:neLongitude>83.24546875781251</nbi:neLongitude>
         <nbi:latD>1365</nbi:latD>
         <nbi:lonD>1232</nbi:lonD>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>range</xsd:name>
               <xsd:value>0</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
             <xsd:name>lonn</xsd:name>
             <xsd:value>9</xsd:value>
         </xsd:parameter>
         <xsd:parameter>
            <xsd:name>types</xsd:name>
            <xsd:value>WEP,WOP,GenericAP,WB,ESR</xsd:value>
         </xsd:parameter>
         <xsd:parameter>
            <xsd:name>esrmode</xsd:name>
            <xsd:value>-1</xsd:value>
         </xsd:parameter>
        <xsd:parameter>
           <xsd:name>status</xsd:name>
           <xsd:value>0,1,2,4,5</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
           <xsd:name>available</xsd:name>
           <xsd:value>1</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
           <xsd:name>ott</xsd:name>
           <xsd:value>-1</xsd:value>
        </xsd:parameter>
         </nbi:params>
      </nbi:GetGeoObjectCommonDomain>
Ответ
    <ns:GetGeoObjectCommonDomain>
        <ns:return>
           <ax22:code>0</ax22:code>
           <ax22:detail/>
           <ax21:response>toor.stneilCllA.lacoL.ribiS.tsalbO_ayaksribisovoN.doroG_ksribisovoN.401ayannoicnatS_RSE_rtnecopsxE.</ax21:response>
        </ns:return>
    </ns:GetGeoObjectCommonDomain>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Некорректный домен

8

Некорректный формат домена

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoApListWithOutOfService - Получить список объектов напрямую из eltex_ems.ELTEX_OBJ_GEO и eltex_ems.ELTEX_OBJ_PROP

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

  2. Служит для получения списка ТД без обращения в EMS (как GetGeoObjectsList). Данные берутся напрямую из eltex_ems.ELTEX_OBJ_GEO и eltex_ems.ELTEX_OBJ_PROP.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

request

Условия выборки

GetGeoApListWithOutOfServiceRequest

Выходные параметры

Параметр Значение Формат значения

portion

Список объектов с информаицей о ТД

NbiGeoApListWithOutOfService

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetGeoApListWithOutOfService>
         <nbi:request>
            <xsd:domains>
               <xsd:name>root</xsd:name>
               <xsd:nested>true</xsd:nested>
            </xsd:domains>
            <xsd:freeSearch>
               <xsd:fields>name</xsd:fields>
               <xsd:searchString>MIKE</xsd:searchString>
            </xsd:freeSearch>
            <xsd:params>
               <xsd1:parameter>
                  <xsd1:name>available</xsd1:name>
                  <xsd1:value>1</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>orderFields</xsd1:name>
                  <xsd1:value>name</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>orderType</xsd1:name>
                  <xsd1:value>ASC</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>status</xsd1:name>
                  <xsd1:value>0,1,2,3,4</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>types</xsd1:name>
                  <xsd1:value>WEP</xsd1:value>
               </xsd1:parameter>
               <xsd1:parameter>
                  <xsd1:name>outOfService</xsd1:name>
                  <xsd1:value>false</xsd1:value>
               </xsd1:parameter>
            </xsd:params>
         </nbi:request>
      </nbi:GetGeoApListWithOutOfService>
Ответ
        <ns:GetGeoApListWithOutOfServiceResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax279:array xsi:type="ax279:NbiGeoApListWithOutOfService">
               <ax279:items xsi:type="ax279:NbiGeoApListItemWithOutOfService">
                  <ax279:actNumber>123456</ax278:actNumber>
                  <ax279:available>1</ax279:available>
                  <ax279:building/>
                  <ax279:city/>
                  <ax279:country/>
                  <ax279:district/>
                  <ax279:domain>toor</ax279:domain>
                  <ax279:emsId>10037</ax279:emsId>
                  <ax279:floor>0</ax279:floor>
                  <ax279:fullName/>
                  <ax279:house/>
                  <ax279:initTime>2020-03-04 09:41:34.0</ax279:initTime>
                  <ax279:inn/>
                  <ax279:ip>192.168.40.50</ax279:ip>
                  <ax279:lat>55.039642</ax279:lat>
                  <ax279:lon>82.89415</ax279:lon>
                  <ax279:mac>A8:F9:4B:B0:3F:80</ax279:mac>
                  <ax279:maxTraffic>0.0</ax279:maxTraffic>
                  <ax279:maxUsers>0</ax279:maxUsers>
                  <ax279:name>BOX_MIKE-192.168.26.102</ax279:name>
                  <ax279:office/>
                  <ax279:outOfService>false</ax279:outOfService>
                  <ax279:outOfServiceDate/>
                  <ax279:region/>
                  <ax279:serialNumber>WP01000408</ax279:serialNumber>
                  <ax279:startTime>2020-03-05 05:00:04.0</ax279:startTime>
                  <ax279:status>0</ax279:status>
                  <ax279:statusCause/>
                  <ax279:street/>
                  <ax279:subtype>-12ac</ax279:subtype>
                  <ax279:type>WEP</ax279:type>
                  <ax279:uptime>2182285</ax279:uptime>
                  <ax279:user24>0</ax279:user24>
                  <ax279:user50>0</ax279:user50>
                  <ax279:zip/>
               </ax279:items>
            </ax279:array>
         </ns:return>
      </ns:GetGeoApListWithOutOfServiceResponse>
Код Описание ошибки

2

Ошибка взаимодействия с БД eltex_ems

7

Пустой домен в списке

8

Некорректный формат домена

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

436

Не найден объект с условиями выборки

Пример использования

См. также

  1. GetGeoObjectsList - Получить список объектов для вкладки Список ТД

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetDynamicTunnelsStationsByClient - Получить информацию о станционных ESR

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

  2. Информация об узле построения GRE туннелей синхронизируется EMS’ом и хранится в MySQL eltex_ems.DYNAMIC_TUNNELS_CFG. Данная команда позволяет получить от NBI ответ на вопрос В какой узел дерева объектов клиентские устройства должны строить туннели, и получить список всех станционных ESR в этом узле.

  3. Команда используется для заполнения справочника СОРМ3 WRL, где нужна информация о MAC адресе станционного ESR.

  4. API является служебным, права дступа к объекту (узлу клиентского устройства, узлу станционного ESR) не проверяются с целью ускорения обработки команды.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

client

ID клиентского устройства (ESR-10, AP) в дереве

int

Выходные параметры

Параметр Значение Формат значения

stations

Список объектов с информацией о станционном ESR

DynamicTunnelsStation

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetDynamicTunnelsStationsByClient>
    <nbi:client>2</nbi:client>
</nbi:GetDynamicTunnelsStationsByClient>
Ответ
<ax21:code>0</ax21:code>
<ax21:detail/>
<ax289:stations xsi:type="ax289:DynamicTunnelsStation">
    <ax289:domain>MRF_DV.Interop.root</ax289:domain>
    <ax289:id>34821</ax289:id>
    <ax289:mac>A8:F9:4B:AC:86:80</ax289:mac>
    <ax289:name>wifi-dv-esr02-1</ax289:name>
    <ax289:node>22329</ax289:node>
</ax289:stations>
<ax289:stations xsi:type="ax289:DynamicTunnelsStation">
    <ax289:domain>MRF_DV.Interop.root</ax289:domain>
    <ax289:id>34825</ax289:id>
    <ax289:mac>A8:F9:4B:AC:8F:20</ax289:mac>
    <ax289:name>wifi-dv-esr02-2</ax289:name>
    <ax289:node>22329</ax289:node>
</ax289:stations>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

436

Не указан один из параметров вызова

999

Системная ошибка (приведение типа аргументов, необработанные исключения)

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DynamicTunnelsStation - Параметры станционного ESR

Общая информация

  1. Структура актуальна, начиная с версии 1.17.

  2. Используется в GetDynamicTunnelsStationsByClient для отображения информации о станционном ESR и узле, в котором он расположен.

Параметры объекта

Параметр Значение Формат значения

node

ID узла

int

id

ID станционного ESR

int

name

Имя станционного ESR

String

mac

MAC адрес станционного ESR

String

domain

Домен станционного ESR (домен узла)

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Geocode - Получение геокоординат по заданному почтовому адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.18

  2. Команда используется для подстановки полученных геокоординат в команду CreateRuleLink

Входные параметры

Параметр Значение Формат значения Расшифровка формата

parameters

Почтовый адрес в формате КЛАДР

Массив объектов NbiParameter

Параметры адреса в формате КЛАДР и их допустимые значения

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

coordinates

Массив объектов GeoCoordinateItem

match

Флаг однозначно определенных геокоординат

true/false

Параметры адреса в формате КЛАДР и их допустимые значения

Параметр Значение Формат значения Расшифровка формата Обязательный параметр

Country

Страна

^[ \-a-zA-Zа-яА-ЯёЁ]{1,64}$

Текст до 64-х символов

Нет

Region

Область

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

District

Район

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

City

Город

^[ .\-a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

Street

Улица

^[ .\-/a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

HouseNumber

Номер дома

^[ _.\-/a-zA-Zа-яА-ЯёЁ0-9]{1,35}$

Текст до 35-и символов

Да

Примеры команд и кодов

Код Описание ошибки

0

Успешно

3

Ошибка ответа от EMS NBI

45

Неизвестный ответ от EMS сервера

312

Некорректное значение для параметра

313

Неизвестное название параметра

436

Не указан обязательный параметр
Запрос
    <nbi:geocode>
        <nbi:parameters>
            <xsd:parameter>
                <xsd:name>Region</xsd:name>
                <xsd:value>Новосибирская</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>City</xsd:name>
                <xsd:value>Новосибирск</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>Street</xsd:name>
                <xsd:value>Окружная</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>HouseNumber</xsd:name>
                <xsd:value>13</xsd:value>
            </xsd:parameter>
        </nbi:parameters>
    </nbi:geocode>
Ответ
    <ns:geocode>
       <ns:return>
          <ax21:code>0</ax21:code>
          <ax21:detail/>
          <ax292:coordinates xsi:type="ax292:GeoCoordinateItem">
             <ax292:address>Новосибирская обл, Новосибирск г, Окружная ул, д 13</ax292:address>
             <ax292:latitude>55.0859138</ax292:latitude>
             <ax292:longitude>82.9357454</ax292:longitude>
          </ax292:coordinates>
          <ax292:match>true</ax292:match>
       </ns:return>
    </ns:geocode>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetMacCellList - Получить информацию о GenericAP

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Служит для получения данных о сторонних точках доступа. Данные берутся из eltex_ems.ELTEX_OBJ_CELL

Входные параметры

Параметр Значение Формат значения

count

Количество записей

int

offset

Смещение по записям

int

Выходные параметры

Параметр Значение Формат значения

macCellList

Список объектов

NbiMacCellItem

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetMacCellList>
    <nbi:count>10</nbi:count>
    <nbi:offset>0</nbi:offset>
</nbi:GetMacCellList>
Ответ
<ns:GetMacCellListResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail/>
        <ax268:macCellList xsi:type="ax268:NbiMacCellItem">
            <ax268:cell>61da2e333e873417fb04407189719b8b</ax268:cell>
            <ax268:domain>test.ap.root</ax268:domain>
            <ax268:nasMac>aa:bb:cc:dd:ee:ff</ax268:nasMac>
            <ax268:pid>15</ax268:pid>
        </ax268:macCellList>
    </ns:return>
</ns:GetMacCellListResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

436

Не указан один из параметров вызова

999

Системная ошибка (приведение типа аргументов, необработанные исключения)

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetNbiApDevice - Получить список точек доступа в узле

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

  2. Служит для получения данных о точках доступа из узла с указанным доменом.
    Данные берутся напрямую из eltex_ems.ELTEX_OBJ_GEO

Входные параметры

Параметр Значение Формат значения

domain

Домен узла

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

nbiApDeviceItems

Список точек доступа

NbiApDeviceItem

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetNbiApDevice>
    <nbi:domain>test.root</nbi:domain>
</nbi:GetNbiApDevice>
Ответ
<ns:GetNbiApDeviceResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax238:nbiApDeviceItems xsi:type="ax238:NbiApDeviceItem">
           <ax238:domain>toor.tset</ax238:domain>
           <ax238:ip>10.25.96.115</ax238:ip>
           <ax238:name>UNBOX_MIKE-10.25.96.115</ax238:name>
           <ax238:subtype>-12ac</ax238:subtype>
           <ax238:type>WEP</ax238:type>
        </ax238:nbiApDeviceItems>
        <ax238:nbiApDeviceItems xsi:type="ax238:NbiApDeviceItem">
           <ax238:domain>toor.tset</ax238:domain>
           <ax238:ip>10.25.96.107</ax238:ip>
           <ax238:name>WOP-2ac-LR2-10.25.96.107</ax238:name>
           <ax238:subtype>-2ac-LR2</ax238:subtype>
           <ax238:type>WOP</ax238:type>
        </ax238:nbiApDeviceItems>
    </ns:return>
</ns:GetNbiApDeviceResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Не указан обязательный параметр запроса 'domain'

62

Домен не зарегистрирован

999

Системная ошибка (приведение типа аргументов, необработанные исключения)

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ChangeEsrDomain – Редактирование значения Домен Station ESR

Общая информация

  1. Команда актуальна, начиная с версии 1.19

  2. Данная команда позволяет (средствами EMS) отредактировать параметр "Домен Station ESR" узла, характеризуемого доменом nodeDomain на значение esrDomain. Сам процесс перестроения туннелей при выполнении этой команды не инициируется.

  3. При выполнении команды NBI проверяет только существование и доступность доменов пользователю.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

nodeDomain

Имя домена в редактируемом узле.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

esrDomain

Новый Домен Station ESR.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос

Пример использования: Для узла, характеризуемого доменом Center.Local.AllClients.root (где установлены точки) поменять Домен Station ESR на значение Center.Ap.root (где установлены ESR).

<nbi:ChangeEsrDomain>
    <nbi:nodeDomain>Center.Local.AllClients.root</nbi:nodeDomain>
    <nbi:esrDomain>Center.Ap.root</nbi:esrDomain>
</nbi:ChangeEsrDomain>
Ответ
<ns:ChangeEsrDomainResponse>
   <ns:return xsi:type="ax21:NbiResponse"
      <ax21:code>0</ax21:code>
      <ax21:detail>Success</ax21:detail>
   </ns:return>
</ns:ChangeEsrDomainResponse>
Код Описание ошибки

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

281

Не найден обязательный параметр запроса

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddTariffToPortal - Добавить тарифный план для виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст до 32-х символов.

tariff

Массив объектов NbiEntryDescr, где entry - код тарифного плана, descr - этикетка, отображаемая для пользователя. Если descr будет пустым, в качестве этикетки будет установлено описание тарифного плана или, если описания нет, имя.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

300

У пользователя нет прав на данную операцию
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:AddTariffToPortal>
            <nbi:webPortal>default</nbi:webPortal>
            <nbi:tariff>
                <xsd:descr>Бесплатно</xsd:descr>
                <xsd:entry>free</xsd:entry>
            </nbi:tariff>
        </nbi:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>300</ax21:code>
                <ax21:detail>No rights on operation</ax21:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

101

Код тарифного плана некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry></xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'entry' with value ''.</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>No Tariff with code 'test'</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

102

Web портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>102</ns:code>
                <ns:detail>No Web portal with name 'portald'</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

103

Некорректное имя Web портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal></xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>103</ns:code>
                <ns:detail>Incorrect field 'webPortal'.</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

226

Тарифный план не является портальным.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:AddTariffToPortal>
            <nbi:webPortal>default</nbi:webPortal>
            <nbi:tariff>
                <xsd:descr>1</xsd:descr>
                <xsd:entry>maksi</xsd:entry>
            </nbi:tariff>
        </nbi:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax22:NbiResponse"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax22:code>226</ax22:code>
                <ax22:detail>Tariff 'maksi' is not portal</ax22:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

108

Дублируются этикетки для тарифных планов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal>default</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>qwer</xsd1:descr>
                <xsd1:entry>black</xsd1:entry>
            </xsd:tariff>
            <xsd:tariff>
                <xsd1:descr>qwer</xsd1:descr>
                <xsd1:entry>white</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>108</ns:code>
                <ns:detail>Tariff title 'qwer' duplicate for some tariffs.</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

237

Некорректные тарифные планы в запросе
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>>
            <xsd:webPortal>default</xsd:webPortal>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>237</ns:code>
                <ns:detail>Illegal tariffs for portal!</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

109

Тарифный план уже привязан к виртуальному порталу
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>>
            <xsd:webPortal>default</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>Бесплатный тариф с ограничением скорости</xsd1:descr>
                <xsd1:entry>black</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>109</ns:code>
                <ns:detail>Portal 'default' already contains tariff 'black'</ns:detail>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:AddTariffToPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>Тариф 2</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
            <xsd:tariff>
                <xsd1:descr>Тариф 1</xsd1:descr>
                <xsd1:entry>test1</xsd1:entry>
            </xsd:tariff>
        </xsd:AddTariffToPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:AddTariffToPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:AddTariffToPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateHotspotAccessList - Создать белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда для создания белых или черных списков пользователей.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

listType

тип списка

WHITE или BLACK

list

список mac

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:CreateHotspotAccessList>
         <nbi:name>nameWhiteList</nbi:name>
         <nbi:domain>enterprise.root</nbi:domain>
         <nbi:listType>WHITE</nbi:listType>
         <nbi:list>
            <xsd:str>aa:aa:aa:aa:aa:aa</xsd:str>
         </nbi:list>
      </nbi:CreateHotspotAccessList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:CreateHotspotAccessListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:CreateHotspotAccessListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

431

Список с таким именем и доменом уже существует

10

У роли нет прав создавать список с указанным доменом

428

Некорректное значение listType

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateHotspotDefAccessList - Создать белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

String

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

listType

тип списка WHITE/BLACK

String

list

список номеров

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:CreateHotspotDefAccessList>
         <nbi:name>nameWhiteList</nbi:name>
         <nbi:domain>enterprise.root</nbi:domain>
         <nbi:listType>WHITE</nbi:listType>
         <nbi:list>
            <xsd:str>79101234567</xsd:str>
            <xsd:str>79101234568</xsd:str>
         </nbi:list>
      </nbi:CreateHotspotDefAccessList>
   </soap:Body>
</soap:Envelope>
Ответ
                        <ns:CreateHotspotDefAccessListResponse>
                            <ns:return>
                                <ax21:code>0</ax21:code>
                                <ax21:detail>
                                </ax21:detail>
                            </ns:return>
                        </ns:CreateHotspotDefAccessListResponse>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

431

Список с таким именем уже существует

10

У роли нет прав создавать список с указанным доменом

428

Некорректное значение listType

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteHotspotAccessList - Удалить белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда для удаления белых или черных списков пользователей. Входные параметры ^^^^^^^

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
       <nbi:DeleteHotspotAccessList>
          <nbi:name>1</nbi:name>
          <nbi:domain>root</nbi:domain>
       </nbi:DeleteHotspotAccessList>
    </soapenv:Body>
 </soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DeleteHotspotAccessListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteHotspotAccessListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

10

У роли нет прав удалять список с указанным доменом

427

Списка с таким именем и доменом не существует

446

Список привязан к порталу

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteHotspotDefAccessList - Удалить белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

String

domain

домен списка

String

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
       <nbi:DeleteHotspotDefAccessList>
          <nbi:name>1</nbi:name>
          <nbi:domain>root</nbi:domain>
       </nbi:DeleteHotspotDefAccessList>
    </soapenv:Body>
 </soapenv:Envelope>
Ответ
<ns:DeleteHotspotDefAccessListResponse>
    <ax21:code>0</ax21:code>
    <ax21:detail></ax21:detail>
    </ns:return>
</ns:DeleteHotspotDefAccessListResponse>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

10

У роли нет прав удалять список с указанным доменом

427

Списка с таким именем не существует

475

Данный список привязан к одному из порталов

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditHotspotAccessList - Редактировать белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда для редактирования белых или черных списков пользователей.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

domain

Домен списка

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

newDomain

Новый домен списка(если не изменяется, требуется ввести старое значение)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

listType

тип списка

WHITE или BLACK

list

список mac или login

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Header/>
   <soapenv:Body>
      <nbi:EditHotspotAccessList>
         <nbi:name>23</nbi:name>
         <nbi:domain>service.root</nbi:domain>
         <nbi:newDomain>root</nbi:newDomain>
         <nbi:listType>WHITE</nbi:listType>
         <nbi:list>
            <xsd:str>11:11:11:11:11:11</xsd:str>
         </nbi:list>
      </nbi:EditHotspotAccessList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:EditHotspotAccessListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditHotspotAccessListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

427

Списка с таким именем не существует

10

У роли нет прав создавать список с указанным доменом

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditHotspotDefAccessList - Редактировать белый или черный список пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

String

domain

домен

String

newDomain

новый домен списка

String

listType

тип списка WHITE/BLACK

String

list

список номеров

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:EditHotspotDefAccessList>
         <nbi:name>23</nbi:name>
         <nbi:domain>service.root</nbi:domain>
         <nbi:newDomain>root</nbi:newDomain>
         <nbi:listType>WHITE</nbi:listType>
         <nbi:list>
            <xsd:str>79101234567</xsd:str>
            <xsd:str>79101234562</xsd:str>
            <xsd:str>79101234562</xsd:str>
         </nbi:list>
      </nbi:EditHotspotDefAccessList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<ns:EditHotspotDefAccessListResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail></ax21:detail>
    </ns:return>
</ns:EditHotspotDefAccessListResponse>
Код Описание ошибки

281

В запросе не указан обязательный атрибут

427

Списка с таким именем и доменом не существует

10

У роли нет прав создавать список с указанным доменом

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditTariffTitleForPortal - Редактировать этикетку для тарифного плана на виртуальном портале

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст до 32-х символов.

tariff

Массив объектов NbiEntryDescr, где entry - код тарифного плана, descr - новая этикетка, отображаемая для пользователя. Если descr будет пустым, в качестве этикетки будет установлено описание тарифного плана или, если описания нет, имя.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

300

У пользователя нет прав на данную операцию
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditTariffTitleForPortal>
            <nbi:webPortal>default</nbi:webPortal>
            <nbi:tariff>
                <xsd:descr>Огого</xsd:descr>
                <xsd:entry>free</xsd:entry>
            </nbi:tariff>
        </nbi:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>297</ax21:code>
                <ax21:detail>No rights on operation</ax21:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

101

Код тарифного плана некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry></xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'entry' with value ''.</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

100

Тарифного плана с таким кодом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>100</ns:code>
                <ns:detail>No Tariff with code 'test'</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

102

Web портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>102</ns:code>
                <ns:detail>No Web portal with name 'portald'</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

103

Некорректное имя Web портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal></xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>103</ns:code>
                <ns:detail>Incorrect field 'webPortal'.</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

108

Дублируются этикетки для тарифных планов
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>default</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>qwer</xsd1:descr>
                <xsd1:entry>black</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>108</ns:code>
                <ns:detail>Tariff title 'qwer' duplicate for some tariffs.</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

111

Данного тарифного плана на портале не установлено
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>default
</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>sonoras imperio</xsd1:descr>
                <xsd1:entry>red</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>111</ns:code>
                <ns:detail>No tariff with code 'red' on portal 'default'</ns:detail>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:EditTariffTitleForPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariff>
                <xsd1:descr>Тариф 2</xsd1:descr>
                <xsd1:entry>test</xsd1:entry>
            </xsd:tariff>
        </xsd:EditTariffTitleForPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditTariffTitleForPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:EditTariffTitleForPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RemoveTariffFromPortal - Удалить тарифный план с виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст до 32-х символов.

tariffCode

Один или более код удаляемого тарифного плана.

.{0,64}

Текст до 64-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

300

У пользователя нет прав на данную операцию
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveTariffFromPortal>
            <nbi:webPortal>default</nbi:webPortal>
            <nbi:tariffCode>free</nbi:tariffCode>
        </nbi:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>300</ax21:code>
                <ax21:detail>No rights on operation</ax21:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

101

Код тарифного плана некорректен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveTariffFromPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariffCode></xsd:tariffCode>
        </xsd:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>101</ns:code>
                <ns:detail>Incorrect field 'tariffCode' with value ''.</ns:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

102

Web портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveTariffFromPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariffCode>test</xsd:tariffCode>
        </xsd:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>102</ns:code>
                <ns:detail>No Web portal with name 'portald'</ns:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

103

Некорректное имя Web портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveTariffFromPortal>
            <xsd:webPortal></xsd:webPortal>
            <xsd:tariffCode>test</xsd:tariffCode>
        </xsd:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>103</ns:code>
                <ns:detail>Incorrect field 'webPortal'.</ns:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

111

К виртуальному порталу не привязано тарифов с таким кодом
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveTariffFromPortal>
            <xsd:webPortal>default</xsd:webPortal>
            <xsd:tariffCode>red</xsd:tariffCode>
        </xsd:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>111</ns:code>
                <ns:detail>No tariff with code 'red' on portal 'default'</ns:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

307

Нельзя отвязать все тарифные планы от виртуального портала. Это приведет к неработоспособности системы.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RemoveTariffFromPortal>
            <nbi:webPortal>new_portal</nbi:webPortal>
            <nbi:tariffCode>free</nbi:tariffCode>
        </nbi:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax225="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax215="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax220="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax217="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>307</ax21:code>
                <ax21:detail>Can not delete all tariffs from virtual portal</ax21:detail>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RemoveTariffFromPortal>
            <xsd:webPortal>portald</xsd:webPortal>
            <xsd:tariffCode>red</xsd:tariffCode>
            <xsd:tariffCode>green</xsd:tariffCode>
        </xsd:RemoveTariffFromPortal>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RemoveTariffFromPortalResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
            </ns:return>
        </ns:RemoveTariffFromPortalResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveAvailablePortalParams - Запрос списка всех возможных параметров для настройки виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiEntryDescr

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveAvailablePortalParams/>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveAvailablePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeEntryDescrResponse"
                xmlns:ax214="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax220="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax217="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiEntryDescrArray">
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address of advertising platform. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>advertising.host</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address of advertising platform. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>advertising.host.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address of advertising platform. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>advertising.host.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address of advertising platform. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>advertising.host.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on input invalid phone number. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>phone.invalid.message</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on input invalid phone number. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>phone.invalid.message.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on input invalid phone number. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>phone.invalid.message.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on input invalid phone number. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>phone.invalid.message.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Footer of virtual portal. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.descr</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Footer of virtual portal. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.descr.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Footer of virtual portal. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>site.descr.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Footer of virtual portal. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>site.descr.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on successful registration. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.success.message</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on successful registration. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.success.message.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on successful registration. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>site.success.message.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Message on successful registration. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>site.success.message.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Title of virtual portal. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.title</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Title of virtual portal. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.title.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Title of virtual portal. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>site.title.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Title of virtual portal. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>site.title.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Template of sending sms. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>sms.msg.template</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Template of sending sms. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>sms.msg.template.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Template of sending sms. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>sms.msg.template.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Template of sending sms. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>sms.msg.template.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address for redirect after successful registration. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.redirect</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address for redirect after successful registration. Depends from 'site.edit.lang'. For 'ru' language</ax21:descr>
                        <ax21:entry>site.redirect.ru</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address for redirect after successful registration. Depends from 'site.edit.lang'. For 'en' language</ax21:descr>
                        <ax21:entry>site.redirect.en</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Url address for redirect after successful registration. Depends from 'site.edit.lang'. For 'kk' language</ax21:descr>
                        <ax21:entry>site.redirect.kk</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Use captcha</ax21:descr>
                        <ax21:entry>site.captcha</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Number of symbols in captcha</ax21:descr>
                        <ax21:entry>captcha.length</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Default locale for clients</ax21:descr>
                        <ax21:entry>default.locale</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Deny self registration on virtual portal</ax21:descr>
                        <ax21:entry>deny.self.registration</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Placeholder in phone input field</ax21:descr>
                        <ax21:entry>phone.placeholder</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Prefix before phone input field</ax21:descr>
                        <ax21:entry>phone.prefix</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Regular expression for checking full phone number</ax21:descr>
                        <ax21:entry>phone.regexp</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable additional page 1</ax21:descr>
                        <ax21:entry>redirect.page1</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable additional page 2</ax21:descr>
                        <ax21:entry>redirect.page2</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable additional page 3</ax21:descr>
                        <ax21:entry>redirect.page3</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable additional page 4</ax21:descr>
                        <ax21:entry>redirect.page4</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable additional page 5</ax21:descr>
                        <ax21:entry>redirect.page5</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Add additional fields on registration</ax21:descr>
                        <ax21:entry>site.additional.auth.params</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Email field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.email</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Required email field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.email.required</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Second name field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.family</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Required second name field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.family.required</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>First name field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.name</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Required first name field on registration</ax21:descr>
                        <ax21:entry>site.auth.param.name.required</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable sms restrict</ax21:descr>
                        <ax21:entry>site.restrict.sms</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Number of attempts</ax21:descr>
                        <ax21:entry>site.restrict.sms.attempts</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Number of seconds between attempts</ax21:descr>
                        <ax21:entry>site.restrict.sms.seconds.between.attempts</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Number of seconds for ban</ax21:descr>
                        <ax21:entry>site.restrict.sms.seconds.for.ban</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Cut sms if it to big</ax21:descr>
                        <ax21:entry>sms.cut.ssid</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Using sms gate for current virtual portal</ax21:descr>
                        <ax21:entry>sms.gate</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Number of symbols in generated password</ax21:descr>
                        <ax21:entry>wifi.password.length</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable payment service</ax21:descr>
                        <ax21:entry>tune.payment.service</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Use demo mode of payment</ax21:descr>
                        <ax21:entry>demo.payment</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable YaPurse payment</ax21:descr>
                        <ax21:entry>payment.yapurse</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable webmoney payment</ax21:descr>
                        <ax21:entry>payment.webmoney</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable terminal payment</ax21:descr>
                        <ax21:entry>payment.terminal</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable Sberbank Online payment</ax21:descr>
                        <ax21:entry>payment.sber</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable Qiwi payment</ax21:descr>
                        <ax21:entry>payment.qiwi</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable PromSvyazBank payment</ax21:descr>
                        <ax21:entry>payment.promsvyazbank</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable payment from phone account</ax21:descr>
                        <ax21:entry>payment.mobile</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable masterpass payment</ax21:descr>
                        <ax21:entry>payment.masterpass</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable cards payment</ax21:descr>
                        <ax21:entry>payment.cards</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Enable aclick payment</ax21:descr>
                        <ax21:entry>payment.aclick</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Ya scid</ax21:descr>
                        <ax21:entry>payments.scid</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Phones of support</ax21:descr>
                        <ax21:entry>payments.phonePaymentsSupport</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Secret key</ax21:descr>
                        <ax21:entry>payments.secret</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Ya shopId</ax21:descr>
                        <ax21:entry>payments.shopId</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Domain of virtual portal</ax21:descr>
                        <ax21:entry>site.domain</ax21:entry>
                    </ax21:entry>
                    <ax21:entry xsi:type="ax21:NbiEntryDescr">
                        <ax21:descr>Only for editing portal: new name of virtual portal</ax21:descr>
                        <ax21:entry>site.new.name</ax21:entry>
                    </ax21:entry>
                </ax21:response>
            </ns:return>
        </ns:RetrieveAvailablePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveHotspotAccessLists - Получить списки пользователей с учетом фильтрации и пагинации

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда для получения белых или черных списков пользователей или и тех и других.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

filter

текст фильтра

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

count

количество возвращаемых записей

page

номер страницы (пачки записей)

orderBy

сортировать по этому полю

orderType

тип сортировки (ASC|DESC)

Выходные параметры

Параметр Значение Формат значения

usersListArray

Массив объектов NbiHotspotAccessList со списками

NbiHotspotAccessListArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
          <nbi:RetrieveHotspotAccessLists>
           <nbi:filter>1</nbi:filter>
           <nbi:domain>.root</nbi:domain>
           <nbi:count>10</nbi:count>
           <nbi:page>1</nbi:page>
           <nbi:orderBy>list_type</nbi:orderBy>
           <nbi:orderType></nbi:orderType>
        </nbi:RetrieveHotspotAccessLists>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveHotspotAccessListsResponse>
                 <ns:return>
                    <ax21:code>0</ax21:code>
                    <ax21:detail>2</ax21:detail>
                    <ax248:profiles>
                       <ax248:profiles>
                          <ax248:domain>root</ax248:domain>
                          <ax248:idList>
                             <ax242:str>?</ax242:str>
                          </ax248:idList>
                          <ax248:listType>WHITE</ax248:listType>
                          <ax248:name>1</ax248:name>
                       </ax248:profiles>
                       <ax248:profiles>
                          <ax248:domain>notroot.root</ax248:domain>
                          <ax248:idList>
                             <ax242:str>aa:aa:aa:aa:aa:11</ax242:str>
                          </ax248:idList>
                          <ax248:listType>WHITE</ax248:listType>
                          <ax248:name>1</ax248:name>
                       </ax248:profiles>
                    </ax248:profiles>
                 </ns:return>
              </ns:RetrieveHotspotAccessListsResponse>
           </soapenv:Body>
        </soapenv:Envelope>
Код Описание ошибки

112

Значение поля count должно быть целым и положительным числом

113

Значение поля page должно быть целым и положительным числом

427

Списка с таким именем не существует

10

У роли нет прав создавать список с указанным доменом

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveHotspotDefAccessLists - Получить списки пользователей с учетом фильтрации("гибкий фильтр") и пагинации

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

filter

текст фильтра

String

domain

домен для фильтрации

String

count

количество возвращаемых записей

Integer

page

номер страницы (пачки записей)

Integer

orderBy

сортировать по этому полю

String

orderType

тип сортировки (ASC|DESC)

String

Выходные параметры

Параметр Значение Формат значения

usersListArray

Массив объектов NbiHotspotAccessList со списками

NbiHotspotAccessListArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
          <nbi:RetrieveHotspotDefAccessLists>
           <nbi:filter>1</nbi:filter>
           <nbi:domain>root</nbi:domain>
           <nbi:count>10</nbi:count>
           <nbi:page>1</nbi:page>
           <nbi:orderBy>list_type</nbi:orderBy>
           <nbi:orderType></nbi:orderType>
        </nbi:RetrieveHotspotDefAccessLists>
   </soap:Body>
</soap:Envelope>
Ответ
<ns:RetrieveHotspotDefAccessListsResponse>
    <ax21:code>0</ax21:code>
    <ax21:detail>7</ax21:detail>
    <ax251:profiles><ax251:profiles>
            <ax251:domain>root</ax251:domain>
            <ax251:idList>
                <ax248:str>79101234567</ax248:str>
            </ax251:idList>
            <ax251:listType>WHITE</ax251:listType>
            <ax251:name></ax251:name>
            </ax251:profiles>
            <ax251:profiles>
                <ax251:domain>root</ax251:domain>
                <ax251:idList>
                    <ax248:str>79101234567</ax248:str>
                    <ax248:str>79101234568</ax248:str>
                </ax251:idList>
                <ax251:listType>BLACK</ax251:listType>
                <ax251:name>test_1</ax251:name>
                </ax251:profiles>
            <ax251:profiles>
                <ax251:domain>root</ax251:domain>
                <ax251:idList>
                    <ax248:str>79101234567</ax248:str>
                    <ax248:str>79101234562</ax248:str>
                    </ax251:idList><ax251:listType>WHITE</ax251:listType>
                <ax251:name>test2</ax251:name>
                </ax251:profiles>
            </ax251:profiles>
        </ns:return>
</ns:RetrieveHotspotDefAccessListsResponse>
Код Описание ошибки

112

Значение поля count должно быть целым и положительным числом

113

Значение поля page должно быть целым и положительным числом

427

Списка с таким именем и доменом не существует

10

У роли нет прав создавать список с указанным доменом

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveHotspotAccessList - Получить информацию о списке пользователей по имени и домену

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

usersListArray

Массив объектов NbiHotspotAccessList со списками

NbiHotspotAccessListArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveHotspotAccessList>
         <nbi:name>1</nbi:name>
         <nbi:domain>root</nbi:domain>
      </nbi:RetrieveHotspotAccessList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveHotspotAccessListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>1</ax21:detail>
            <ax217:profiles>
               <ax217:profiles>
                  <ax217:domain>root</ax217:domain>
                  <ax217:idList>
                     <ax219:str>11:11:11:11:11:11</ax219:str>
                     <ax219:str>11:11:11:11:11:11</ax219:str>
                     <ax219:str>22:22:22:22:22:22</ax219:str>
                  </ax217:idList>
                  <ax217:listType>WHITE</ax217:listType>
                  <ax217:name>1</ax217:name>
               </ax217:profiles>
            </ax217:profiles>
         </ns:return>
      </ns:RetrieveHotspotAccessListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

У роли нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveHotspotDefAccessList - Получить информацию о списке номеров пользователей по имени и домену

Общая информация

  1. Команда актуальна, начиная с версии 1.10.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

имя списка

String

domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

usersListArray

Массив объектов NbiHotspotAccessList со списками

NbiHotspotAccessListArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveHotspotDefAccessList>
         <nbi:name>1</nbi:name>
         <nbi:domain>root</nbi:domain>
      </nbi:RetrieveHotspotDefAccessList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<ns:RetrieveHotspotDefAccessListResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail>1</ax21:detail>
        <ax251:profiles>
            <ax251:profiles>
                <ax251:domain>root</ax251:domain>
                <ax251:idList>
                    <ax248:str>79101234567</ax248:str>
                    <ax248:str>79101234568</ax248:str>
                </ax251:idList>
                <ax251:listType>BLACK</ax251:listType>
                <ax251:name>test_1</ax251:name>
            </ax251:profiles>
        </ax251:profiles>
    </ns:return>
</ns:RetrieveHotspotDefAccessListResponse>
Код Описание ошибки

427

Списка с таким именем и доменом не существует

10

У роли нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrievePortalList – Запрос списка виртуальных порталов

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

dummy

Не используется

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов с именами порталов

Имена порталов — это текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

Примеры команд и кодов

Код Описание ошибки

999

Системная ошибка
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalList>
            <xsd:dummy></xsd:dummy>
        </xsd:RetrievePortalList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>999</ns:code>
                <ns:detail>Failed to read 'portals' from file system</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalList>
            <xsd:dummy></xsd:dummy>
        </xsd:RetrievePortalList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>mcdonalds</ns:name>
                    <ns:name>eltex</ns:name>
                    <ns:name>default</ns:name>
                    <ns:name>dns</ns:name>
                </ns:response>
            </ns:return>
        </ns:RetrievePortalListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrievePortalParams - Получить параметры виртуального портала

Общая информация

  1. Команда добавлена в версии 1.5

  2. Начиная с версии 1.18 не поддерживается, вместо нее нужно использовать GetPortalParams

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст до 32-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiParameterArray

Примеры команд и кодов

Код Описание ошибки

103

Некорректное значение поля 'webPortal'
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal></nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>103</ax21:code>
                <ax21:detail>Incorrect field 'webPortal'.</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

102

Портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal>notexists</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>102</ax21:code>
                <ax21:detail>No Web portal with name 'notexists'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

118

Пользователь не имеет прав на редактирование портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>118</ax21:code>
                <ax21:detail>User has no rights on portal test</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax214="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax220="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax217="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiParameterArray">
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.title.kk</ax21:name>
                        <ax21:value>Біздің сайта Wi-Fi Ростелеком тіркелу</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>advertising.host.en</ax21:name>
                        <ax21:value>http://dev.wififix.ru/index.php</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.invalid.message.kk</ax21:name>
                        <ax21:value>Телефон нөмірін енгізгеннен Қате, қайтадан көріңіз</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>advertising.host.kk</ax21:name>
                        <ax21:value>http://dev.wififix.ru/index.php</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.title.en</ax21:name>
                        <ax21:value>Registration on Wi-Fi Rostelecom portal</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.descr.en</ax21:name>
                        <ax21:value>© 2015 OJSC 'Rostelecom'. All rights reserved.</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.success.message.en</ax21:name>
                        <ax21:value>Congratulations, you have successfully connected to the Internet!</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.msg.template.kk</ax21:name>
                        <ax21:value>қол '%ssid%'. кіру: %phone%. пароль : %password%</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.redirect.en</ax21:name>
                        <ax21:value>http://www.rostelecom.ru/</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.redirect.kk</ax21:name>
                        <ax21:value>http://www.rostelecom.ru/</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.descr.kk</ax21:name>
                        <ax21:value>© 2015 ААҚ «Ростелеком». Барлық құқықтар сақталған.</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.invalid.message.en</ax21:name>
                        <ax21:value>Phone number entered is incorrect, please try again</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.success.message.kk</ax21:name>
                        <ax21:value>Құттықтаймыз, сіз табысты Интернетке қосылған жоқ!</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.msg.template.en</ax21:name>
                        <ax21:value>Access to'%ssid%'. Login: %phone%. Pwd: %password%</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.captcha</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>default.locale</ax21:name>
                        <ax21:value>ru</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>deny.self.registration</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.placeholder</ax21:name>
                        <ax21:value>4841250</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.regexp</ax21:name>
                        <ax21:value>^7913\d{7}$</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.additional.auth.params</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.restrict.sms</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.cut.ssid</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.gate</ax21:name>
                        <ax21:value>none</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>wifi.password.length</ax21:name>
                        <ax21:value>4</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>tune.payment.service</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>demo.payment</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.yapurse</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.webmoney</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.terminal</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.sber</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.qiwi</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.promsvyazbank</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.mobile</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.masterpass</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.cards</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.aclick</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.scid</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.phonePaymentsSupport</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.secret</ax21:name>
                        <ax21:value>1265</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.shopId</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                </ax21:response>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrievePortalTariffList - Вывести список тарифных планов для виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст до 32-х символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiEntryDescr, где entry - код тарифного плана, а descr - этикетка для пользователей

Примеры команд и кодов

Код Описание ошибки

102

Web портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalTariffList>
            <xsd:webPortal>portald</xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>102</ns:code>
                <ns:detail>No Web portal with name 'portald'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

103

Некорректное имя Web портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalTariffList>
            <xsd:webPortal></xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>103</ns:code>
                <ns:detail>Incorrect field 'webPortal'.</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

118

У пользователя нет прав на просмотр данного портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalTariffList>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeEntryDescrResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax23:code>118</ax23:code>
                <ax23:detail>User has no rights on portal 'test'</ax23:detail>
                <ax23:response xsi:type="ax23:NbiEntryDescrArray"/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

300

У пользователя нет прав на данную операцию
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalTariffList>
            <nbi:webPortal>default</nbi:webPortal>
        </nbi:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeEntryDescrResponse"
                xmlns:ax27="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>300</ax21:code>
                <ax21:detail>No rights on operation</ax21:detail>
                <ax21:response xsi:type="ax21:NbiEntryDescrArray"/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalTariffList>
            <xsd:webPortal>default</xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:entry>
                        <ns:descr>Бесплатный тариф с ограничением трафика</ns:descr>
                        <ns:entry>white</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Бесплатный тариф с ограничением скорости</ns:descr>
                        <ns:entry>black</ns:entry>
                    </ns:entry>
                </ns:response>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetPortalParams - Получить параметры виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

portalName

Имя Web портала

^[ a-zA-Z0-9_\-\.!]{1,32}$

Текст до 32-х символов

Выходные параметры

Параметр Значение Формат значения

portalDomain

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

String

portalProperties

Параметры виртуального портала

PortalEditProperties

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetPortalParams>
         <nbi:portalName>portalName</nbi:portalName>
      </nbi:GetPortalParams>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetPortalParamsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax215:NbiPortalPropertiesResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax215:portalDomain>root</ax215:portalDomain>
            <ax215:portalProperties xsi:type="ax215:PortalEditProperties">
               <ax215:advertisingAllowed>true</ax215:advertisingAllowed>
               <ax215:advertisingRequired>true</ax215:advertisingRequired>
               <ax215:authMethodDemo>true</ax215:authMethodDemo>
               <ax215:authMethodEsia>true</ax215:authMethodEsia>
               <ax215:authMethodFanId>true</ax215:authMethodFanId>
               <ax215:authMethodStats>true</ax215:authMethodStats>
               <ax215:authParamsEmail>true</ax215:authParamsEmail>
               <ax215:authParamsEmailRequired>true</ax215:authParamsEmailRequired>
               <ax215:authParamsFamily>true</ax215:authParamsFamily>
               <ax215:authParamsFamilyRequired>true</ax215:authParamsFamilyRequired>
               <ax215:authParamsName>true</ax215:authParamsName>
               <ax215:authParamsNameRequired>true</ax215:authParamsNameRequired>
               <ax215:captchaEnabled>true</ax215:captchaEnabled>
               <ax215:captchaLength>10</ax215:captchaLength>
               <ax215:countryCodeDefault>ru</ax215:countryCodeDefault>
               <ax215:countryCodePreferred>ru</ax215:countryCodePreferred>
               <ax215:countryCodePreferred>en</ax215:countryCodePreferred>
               <ax215:countryCodeSelectionAllowed>true</ax215:countryCodeSelectionAllowed>
               <ax215:loginDisable>false</ax215:loginDisable>
               <ax215:macStorePeriod>3650</ax215:macStorePeriod>
               <ax215:notificationCallInbound>true</ax215:notificationCallInbound>
               <ax215:notificationCallOutbound>false</ax215:notificationCallOutbound>
               <ax215:notificationSmsInbound>false</ax215:notificationSmsInbound>
               <ax215:notificationSmsOutbound>false</ax215:notificationSmsOutbound>
               <ax215:openTimeout>100</ax215:openTimeout>
               <ax215:redirectParamSessionId>false</ax215:redirectParamSessionId>
               <ax215:registrationDisable>true</ax215:registrationDisable>
               <ax215:smsAttemptsMax>3</ax215:smsAttemptsMax>
               <ax215:smsBanSeconds>60</ax215:smsBanSeconds>
               <ax215:smsCutSsid>true</ax215:smsCutSsid>
               <ax215:smsRestrict>false</ax215:smsRestrict>
               <ax215:smsSecondsBetweenAttempts>20</ax215:smsSecondsBetweenAttempts>
               <ax215:wifiPasswordLength>8</ax215:wifiPasswordLength>
            </ax215:portalProperties>
         </ns:return>
      </ns:GetPortalParamsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

1

Неизвестная ошибка

102

Не существует Web портала с именем 'имя портала'

103

Некорректное поле "webPortal"

441

'Elvis' не настроен. Проверьте 'elvis.url' в NBI config file.

494

Ошибка авторизации

506

Ошибка DOORS-NBI: 'подробное сообщение об ошибке'

507

Ошибка ELVIS-NBI: 'подробное сообщение об ошибке'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditPortalParams - Редактировать параметры виртуального портала

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. При редактировании параметров стоит учитывать, что у портала хотя бы один из параметров аутентификации (registrationEnabled, loginEnabled, authMethodEsia) должен быть установлен в true.

  3. Параметры notificationCallInbound, notificationCallOutbound, notificationSmsInbound, notificationSmsOutbound, authMethodDemo - параметры регистрации, необходимы для установки registrationEnabled в true.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

portalName

Имя Web портала

^[ a-zA-Z0-9_\-\.!]{1,32}$

Текст до 32-х символов

portalProperties

Параметры для редактирования

Объект PortalEditProperties

PortalEditProperties

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://portal.response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:EditPortalParams>
         <nbi:portalName>testPortal</nbi:portalName>
         <nbi:portalProperties>
            <xsd:advertisingAllowed>true</xsd:advertisingAllowed>
            <xsd:advertisingRequired>true</xsd:advertisingRequired>
            <xsd:authMethodDemo>true</xsd:authMethodDemo>
            <xsd:authMethodEsia>true</xsd:authMethodEsia>
            <xsd:authMethodFanId>false</xsd:authMethodFanId>
            <xsd:authMethodSats>true</xsd:authMethodSats>
            <xsd:authParamsEmail>true</xsd:authParamsEmail>
            <xsd:authParamsEmailRequired>true</xsd:authParamsEmailRequired>
            <xsd:authParamsFamily>true</xsd:authParamsFamily>
            <xsd:authParamsFamilyRequired>true</xsd:authParamsFamilyRequired>
            <xsd:authParamsName>true</xsd:authParamsName>
            <xsd:authParamsNameRequired>true</xsd:authParamsNameRequired>
            <xsd:captchaEnabled>true</xsd:captchaEnabled>
            <xsd:captchaLength>5</xsd:captchaLength>
            <xsd:countryCodeDefault>Russia/7</xsd:countryCodeDefault>
            <xsd:countryCodePreferred>Russia/7</xsd:countryCodePreferred>
            <xsd:countryCodePreferred>Hong-Kong/852</xsd:countryCodePreferred>
            <xsd:outboundCallTimeout>60</xsd:outboundCallTimeout>
            <xsd:countryCodeSelectionAllowed>true</xsd:countryCodeSelectionAllowed>
            <xsd:loginEnabled>true</xsd:loginEnabled>
            <xsd:macStorePeriod>100</xsd:macStorePeriod>
            <xsd:notificationCallInbound>true</xsd:notificationCallInbound>
            <xsd:notificationCallOutbound>true</xsd:notificationCallOutbound>
            <xsd:notificationSmsInbound>true</xsd:notificationSmsInbound>
            <xsd:notificationSmsOutbound>true</xsd:notificationSmsOutbound>
            <xsd:openTimeout>10</xsd:openTimeout>
            <xsd:redirectParamSessionId>true</xsd:redirectParamSessionId>
            <xsd:registrationEnabled>true</xsd:registrationEnabled>
            <xsd:smsAttemptsMax>2</xsd:smsAttemptsMax>
            <xsd:smsBanSeconds>60</xsd:smsBanSeconds>
            <xsd:smsCutSsid>true</xsd:smsCutSsid>
            <xsd:smsRestrict>true</xsd:smsRestrict>
            <xsd:smsSecondsBetweenAttempts>10</xsd:smsSecondsBetweenAttempts>
            <xsd:wifiPasswordLength>10</xsd:wifiPasswordLength>
            <xsd:welcomeEnabled>true</xsd:welcomeEnabled>
         </nbi:portalProperties>
      </nbi:EditPortalParams>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:EditPortalParamsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:EditPortalParamsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

1

Неизвестная ошибка

102

Не существует Web портала с именем 'имя портала'

103

Некорректное поле "webPortal"

441

'Elvis' не настроен. Проверьте 'elvis.url' в NBI config file.

494

Ошибка авторизации

505

Отсутствует обязательный объект параметров портала

506

Ошибка DOORS-NBI: 'подробное сообщение об ошибке'

507

Ошибка ELVIS-NBI: 'подробное сообщение об ошибке'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ClonePortal - Клонировать портал

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Клонирует портал с параметрами уже существующего базового портала, новым доменом и именем

Входные параметры

Параметр Значение Формат значения

copiedPortalName

Имя копируемого портала

String

resultPortalName

Имя нового портала

String

resultPortalDomain

Домен нового портала

String

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:ClonePortal>
         <nbi:copiedPortalName>portal1</nbi:copiedPortalName>
         <nbi:resultPortalName>newPortal</nbi:resultPortalName>
         <nbi:resultPortalDomain>sub.root</nbi:resultPortalDomain>
      </nbi:ClonePortal>
Ответ
      <ns:ClonePortalResponse>
         <ns:return xsi:type="ax21:NbiResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:ClonePortalResponse>
Код Описание ошибки

1

Неизвестная ошибка

62

Несуществующий домен 'домен'

102

Не существует Web портала с именем 'имя портала'

103

Некорректное поле "webPortal"

441

'Elvis' не настроен. Проверьте 'elvis.url' в NBI config file.

494

Ошибка авторизации

506

Ошибка DOORS-NBI: 'подробное сообщение об ошибке'

507

Ошибка ELVIS-NBI: 'подробное сообщение об ошибке'

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateAuthUser – Создать пользователя в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Полный список параметров можно получить на странице Атрибуты системного пользователя и роли

  3. После создания учетной записи пользователю можно отправить уведомление, используя SendEmailRequest

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Логин пользователя

[\w \.-]{1,64}

Не пустая строка длиной 64 латинских символа. Символы могут быть разделены точкой, дефисом или пробелом.

role

Роль пользователя

Любая не пустая строка

attributes

Атрибуты пользователя, ожидается один или более

NbiAttr

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthUser

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:CreateAuthUser>
            <nbi:user>tester8</nbi:user>
            <nbi:role>MyRole</nbi:role>
            <nbi:attributes>
                <xsd:name>Cleartext-Password</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>12345</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Operator-Name</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>Иван Иванович</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Operator-Family</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>Иван</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Operator-Phone</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>79131111111</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Operator-Email</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>example@example.com</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Operator-Description</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>Auth-пользователь с необязательными атрибутами</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Eltex-User-Timezone</xsd:name>
                <xsd:oper>:=</xsd:oper>
                <xsd:value>Europe/Moscow</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Eltex-Domain</xsd:name>
                <xsd:oper>+=</xsd:oper>
                <xsd:value>root</xsd:value>
            </nbi:attributes>
        </nbi:CreateAuthUser>
Ответ
        <ns:CreateAuthUserResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax27:response xsi:type="ax27:NbiAuthUser">
                    <ax27:check xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Cleartext-Password</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>12345</ax21:value>
                        </ax21:attr>
                    </ax27:check>
                    <ax27:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Operator-Name</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>Иван Иванович</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Operator-Family</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>Иван</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Operator-Phone</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>79131111111</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Operator-Email</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>example@example.com</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Operator-Description</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>Auth-пользователь с необязательными атрибутами</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-10-19 11:34:41</ax21:value>
                        </ax21:attr>
                    </ax27:common>
                    <ax27:reply xsi:type="ax21:NbiAttrArray"/>
                    <ax27:rolePrioArray xsi:type="ax27:NbiAuthRolePrioArray"/>
                    <ax27:user>tester8</ax27:user>
                </ax27:response>
            </ns:return>
        </ns:CreateAuthUserResponse>
Код Описание ошибки

7

Некорректный домен (отсутствует)

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

21

Нет ожидаемых атрибутов пользователя

22

Отсутствует имя атрибута пользователя RADIUS

24

Некорректный оператор атрибута пользователя

25

Такого оператора атрибута пользователя не существует

26

Атрибут пользователя не содержит оператора

27

Некорректное значение атрибута

28

Не указаны обязательные атрибуты пользователя

62

Домен не зарегистрирован в системе

203

Пользователь уже существует

204

Некорректный auth-пользователь

207

Неизвестный атрибут auth-пользователя

209

Роль не существует

222

Невозможно создать пользователя без домена

281

Параметр запроса 'AUTH_ROLE' не указан или пуст

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteAuthUser – Удалить пользователя в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Логин пользователя, ожидается один или более

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:DeleteAuthUser>
            <!--Zero or more repetitions:-->
            <nbi:user>user7</nbi:user>
            <nbi:user>user9</nbi:user>
        </nbi:DeleteAuthUser>
Ответ
        <ns:DeleteAuthUserResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:DeleteAuthUserResponse>
Код Описание ошибки

206

Пользователь не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditAuthUser – Редактировать пользователя в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Полный список параметров можно получить на странице Атрибуты системного пользователя и роли

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Логин пользователя

attributes

Атрибуты пользователя, ожидается один или более.

NbiAttr

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthUser

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:EditAuthUser>
            <nbi:user>tester7</nbi:user>
            <!--Zero or more repetitions:-->
            <nbi:attributes>
                <xsd:name>Eltex-Domain</xsd:name>
                <xsd:oper>+=</xsd:oper>
                <xsd:value>test.root</xsd:value>
            </nbi:attributes>
        </nbi:EditAuthUser>
Ответ
        <ns:EditAuthUserResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax27:response xsi:type="ax27:NbiAuthUser">
                    <ax27:check xsi:type="ax21:NbiAttrArray"/>
                    <ax27:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-05-11 17:19:52</ax21:value>
                        </ax21:attr>
                    </ax27:common>
                    <ax27:reply xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-Domain</ax21:name>
                            <ax21:oper>+=</ax21:oper>
                            <ax21:value>test.root</ax21:value>
                        </ax21:attr>
                    </ax27:reply>
                    <ax27:rolePrioArray xsi:type="ax27:NbiAuthRolePrioArray">
                        <ax27:rolePrio xsi:type="ax27:NbiAuthRolePrio">
                            <ax27:priority>1</ax27:priority>
                            <ax27:role>MyRole1</ax27:role>
                        </ax27:rolePrio>
                    </ax27:rolePrioArray>
                    <ax27:user>tester7</ax27:user>
                </ax27:response>
            </ns:return>
        </ns:EditAuthUserResponse>
Код Описание ошибки

23

Дата создания не может быть изменена

62

Домен не зарегистрирован в системе

206

Пользователь не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthUser – Получить информацию о пользователе из базы eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Имя пользователя

.*

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

NbiAuthUser

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthUser>
            <nbi:user>tester</nbi:user>
        </nbi:GetAuthUser>
Ответ
        <ns:GetAuthUserResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax27:response xsi:type="ax27:NbiAuthUser">
                    <ax27:check xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Cleartext-Password</ax21:name>
                            <ax21:oper>:=</ax21:oper>
                            <ax21:value>1234</ax21:value>
                        </ax21:attr>
                    </ax27:check>
                    <ax27:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-05-11 10:52:27</ax21:value>
                        </ax21:attr>
                    </ax27:common>
                    <ax27:reply xsi:type="ax21:NbiAttrArray"/>
                    <ax27:rolePrioArray xsi:type="ax27:NbiAuthRolePrioArray">
                        <ax27:rolePrio xsi:type="ax27:NbiAuthRolePrio">
                            <ax27:priority>12</ax27:priority>
                            <ax27:role>MyRole1</ax27:role>
                        </ax27:rolePrio>
                    </ax27:rolePrioArray>
                    <ax27:user>tester</ax27:user>
                </ax27:response>
            </ns:return>
        </ns:GetAuthUserResponse>
Код Описание ошибки

206

Пользователь не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthUserList – Получение списка пользователей в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Если count == 0, будет получено количество пользователей size, а список в ответе NBI response будет пустым. При count > 0, наоборот, NBI сформирует список пользователей, и значение size будет равно нулю.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

role

Роль пользователя

.*

groupname

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthUserArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос числа пользователей
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAuthUserList>
         <nbi:domain>root</nbi:domain>
         <nbi:role>default_client_admin</nbi:role>
         <nbi:user/>
         <nbi:count>0</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>username</nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
      </nbi:GetAuthUserList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ с числом пользователей
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAuthUserListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax228:NbiAuthUserArrayResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax228:response xsi:type="ax228:NbiAuthUserArray"/>
            <ax228:size>4</ax228:size>
         </ns:return>
      </ns:GetAuthUserListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Запрос списка пользователей
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAuthUserList>
         <nbi:domain>root</nbi:domain>
         <nbi:role>default_client_admin</nbi:role>
         <nbi:user/>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>username</nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
      </nbi:GetAuthUserList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ со списком пользователей
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAuthUserListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax228:NbiAuthUserArrayResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax228:response xsi:type="ax228:NbiAuthUserArray">
               <ax228:attr xsi:type="ax228:NbiAuthUser">
                  <ax228:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1</ax21:value>
                     </ax21:attr>
                  </ax228:check>
                  <ax228:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-01-26 04:55:56</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Name</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Ivan Ivanovich</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Phone</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>79123456789</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Family</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Ivanov</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Timezone</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Europe/Moscow</ax21:value>
                     </ax21:attr>
                  </ax228:common>
                  <ax228:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Domain</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>root</ax21:value>
                     </ax21:attr>
                  </ax228:reply>
                  <ax228:rolePrioArray xsi:type="ax228:NbiAuthRolePrioArray">
                     <ax228:rolePrio xsi:type="ax228:NbiAuthRolePrio">
                        <ax228:priority>1</ax228:priority>
                        <ax228:role>default_client_admin</ax228:role>
                     </ax228:rolePrio>
                  </ax228:rolePrioArray>
                  <ax228:user>1</ax228:user>
               </ax228:attr>
               <ax228:attr xsi:type="ax228:NbiAuthUser">
                  <ax228:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>2</ax21:value>
                     </ax21:attr>
                  </ax228:check>
                  <ax228:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-01-26 04:56:20</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Name</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Pyotr Petrovich</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Phone</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>79123456789</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Family</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Petrov</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Timezone</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Europe/Moscow</ax21:value>
                     </ax21:attr>
                  </ax228:common>
                  <ax228:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Domain</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>root</ax21:value>
                     </ax21:attr>
                  </ax228:reply>
                  <ax228:rolePrioArray xsi:type="ax228:NbiAuthRolePrioArray">
                     <ax228:rolePrio xsi:type="ax228:NbiAuthRolePrio">
                        <ax228:priority>1</ax228:priority>
                        <ax228:role>default_client_admin</ax228:role>
                     </ax228:rolePrio>
                  </ax228:rolePrioArray>
                  <ax228:user>2</ax228:user>
               </ax228:attr>
            </ax228:response>
            <ax228:size>0</ax228:size>
         </ns:return>
      </ns:GetAuthUserListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка доступа к БД

8

Домен не соответствует правилам

62

Домен не зарегистрирован

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthUserSize - Возвращает количество системных пользователей из базы eltex-auth-service

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает количество системных пользователей из базы eltex-auth-service. Для учета лицензионных ограничений.

Выходные параметры

Параметр Значение Формат значения

response

Не используется

NbiAuthUserArray

size

Количество системных пользователей

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetAuthUserSize/>
Ответ
      <ns:GetAuthUserSizeResponse>
            <ns:return>
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax25:response xsi:type="ax25:NbiAuthUserArray">
               <ax25:attr xsi:nil="true"/>
            </ax25:response>
            <ax25:size>5</ax25:size>
         </ns:return>
      </ns:GetAuthUserSizeResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

MergeAuthUser – Получить информацию о ролях и их приоритетах у конкретного пользователя из базы eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Имя пользователя

.*

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthUser

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:MergeAuthUser>
            <nbi:user>tester6</nbi:user>
        </nbi:MergeAuthUser>
Ответ
            <ns:MergeAuthUserResponse>
                <ns:return>
                    <ax21:code>0</ax21:code>
                    <ax21:detail/>
                    <ax27:response xsi:type="ax27:NbiAuthUser">
                        <ax27:check xsi:type="ax21:NbiAttrArray"/>
                        <ax27:common xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2016-05-11 13:16:38</ax21:value>
                            </ax21:attr>
                        </ax27:common>
                        <ax27:reply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Domain</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>test.root</ax21:value>
                            </ax21:attr>
                        </ax27:reply>
                        <ax27:rolePrioArray xsi:type="ax27:NbiAuthRolePrioArray">
                            <ax27:rolePrio xsi:type="ax27:NbiAuthRolePrio">
                                <ax27:priority>2</ax27:priority>
                                <ax27:role>role2</ax27:role>
                            </ax27:rolePrio>
                            <ax27:rolePrio xsi:type="ax27:NbiAuthRolePrio">
                                <ax27:priority>1</ax27:priority>
                                <ax27:role>MyRole1</ax27:role>
                            </ax27:rolePrio>
                        </ax27:rolePrioArray>
                        <ax27:user>tester6</ax27:user>
                    </ax27:response>
                </ns:return>
            </ns:MergeAuthUserResponse>
Код Описание ошибки

206

Пользователь не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateAuthRole – Создать роль в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Полный список параметров можно получить на странице Атрибуты системного пользователя и роли

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

role

Название роли

attributes

Атрибуты пользователя, ожидается один или более.

NbiAttr

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthRole

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:CreateAuthRole>
            <!--Optional:-->
            <nbi:role>TestRole</nbi:role>
            <!--Zero or more repetitions:-->
            <nbi:attributes>
                <xsd:name>Eltex-User-Wi-Fi-Password-Digit-Only</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>1</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Eltex-User-Wi-Fi-Password-Length</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>8</xsd:value>
            </nbi:attributes>
            <nbi:attributes>
                <xsd:name>Eltex-User-Wi-Fi-Show-Tariff</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>1</xsd:value>
            </nbi:attributes>
        </nbi:CreateAuthRole>
Ответ
        <ns:CreateAuthRoleResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax28:response xsi:type="ax28:NbiAuthRole">
                    <ax28:check xsi:type="ax21:NbiAttrArray"/>
                    <ax28:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2020-08-27 14:16:28</ax21:value>
                        </ax21:attr>
                    </ax28:common>
                    <ax28:reply xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Wi-Fi-Password-Digit-Only</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>1</ax21:value>
                        </ax21:attr>
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Wi-Fi-Password-Length</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>8</ax21:value>
                        </ax21:attr>
                      <ax21:attr xsi:type="ax21:NbiAttr">
                         <ax21:name>Eltex-User-Wi-Fi-Show-Tariff</ax21:name>
                         <ax21:oper>=</ax21:oper>
                         <ax21:value>1</ax21:value>
                      </ax21:attr>
                    </ax28:reply>
                    <ax28:role>TestRole</ax28:role>
                </ax28:response>
            </ns:return>
        </ns:CreateAuthRoleResponse>
Код Описание ошибки

2

Ошибка доступа к БД

208

Роль уже существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditAuthRole – Редактировать роль в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Полный список параметров можно получить на странице Атрибуты системного пользователя и роли

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

role

Роль пользователя

attributes

Атрибуты роли, ожидается один или более.

NbiAttr

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthRole

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
     <nbi:EditAuthRole>
         <!--Optional:-->
         <nbi:role>TestRole</nbi:role>
         <!--Zero or more repetitions:-->
         <nbi:attributes>
            <xsd:name>Eltex-User-Wi-Fi-Password-Length</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>9</xsd:value>
         </nbi:attributes>
      </nbi:EditAuthRole>
Ответ
      <ns:EditAuthRoleResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax28:response xsi:type="ax28:NbiAuthRole">
               <ax28:check xsi:type="ax21:NbiAttrArray"/>
               <ax28:common xsi:type="ax21:NbiAttrArray"/>
               <ax28:reply xsi:type="ax21:NbiAttrArray">
                  <ax21:attr xsi:type="ax21:NbiAttr">
                     <ax21:name>Eltex-User-Wi-Fi-Password-Length</ax21:name>
                     <ax21:oper>=</ax21:oper>
                     <ax21:value>9</ax21:value>
                  </ax21:attr>
               </ax28:reply>
               <ax28:role>TestRole</ax28:role>
            </ax28:response>
         </ns:return>
      </ns:EditAuthRoleResponse>
Код Описание ошибки

209

Роль не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteAuthRole – Удалить роль в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

role

Роль пользователя, ожидается одна или более

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:DeleteAuthRole>
            <!--Zero or more repetitions:-->
            <nbi:role>MyRole3</nbi:role>
        </nbi:DeleteAuthRole>
Ответ
        <ns:DeleteAuthRoleResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:DeleteAuthRoleResponse>
Код Описание ошибки

209

Роль не существует

220

Невозможно удалить роль, так как она привязана к пользователю

443

Невозможно удалить дефолтную роль

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthRole – Получить информацию о роли из базы eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

role

Роль пользователя

.*

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAuthRole

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthRole>
            <nbi:role>MyRole1</nbi:role>
        </nbi:GetAuthRole>
Ответ
        <ns:GetAuthRoleResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax27:response xsi:type="ax27:NbiAuthRole">
                    <ax27:check xsi:type="ax21:NbiAttrArray"/>
                    <ax27:common xsi:type="ax21:NbiAttrArray">
                        <ax21:attr xsi:type="ax21:NbiAttr">
                            <ax21:name>Eltex-User-Create-Date</ax21:name>
                            <ax21:oper>=</ax21:oper>
                            <ax21:value>2016-05-11 10:49:22</ax21:value>
                        </ax21:attr>
                    </ax27:common>
                    <ax27:reply xsi:type="ax21:NbiAttrArray"/>
                    <ax27:role>MyRole1</ax27:role>
                </ax27:response>
            </ns:return>
        </ns:GetAuthRoleResponse>
Код Описание ошибки

209

Роль не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthRoleList – Получение списка ролей в базе eltex_auth_service (устар.)

Общая информация

Important
 Команда больше не поддерживается.
Рекомендуется использовать аналогичную команду GetAuthRoleListAll.

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

groupname

orderCount

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthRoleArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthRoleList>
            <nbi:domain>root</nbi:domain>
            <nbi:count>1</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:GetAuthRoleList>
Ответ
      <ns:GetAuthRoleListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax221:response xsi:type="ax221:NbiAuthRoleArray">
               <ax221:attr xsi:type="ax221:NbiAuthRole">
                  <ax221:check xsi:type="ax21:NbiAttrArray"/>
                  <ax221:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2017-09-22 17:25:53</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Built-In</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1</ax21:value>
                     </ax21:attr>
                  </ax221:common>
                  <ax221:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-PC-Gallery</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-PC-Management</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>1</ax21:value>
                     </ax21:attr>
                     <!-- more attr -->
                  </ax221:reply>
                  <ax221:role>default_client_admin</ax221:role>
               </ax221:attr>
            </ax221:response>
            <ax221:size>6</ax221:size>
         </ns:return>
      </ns:GetAuthRoleListResponse>
Код Описание ошибки

2

Ошибка доступа к БД

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthRoleListAll – Получение списка ролей в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.8

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

groupname

orderCount

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAuthRoleArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthRoleListAll>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:GetAuthRoleListAll>
Ответ
----                                                                                                                                         </soapenv:Envelope>
      <ns:GetAuthRolesListAllResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax27:response xsi:type="ax27:NbiAuthRoleArray">
               <ax27:attr xsi:type="ax27:NbiAuthRole">
                  <ax27:check xsi:type="ax21:NbiAttrArray"/>
                  <ax27:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2017-12-07 15:35:22</ax21:value>
                     </ax21:attr>
                     <!-- ... -->
                  </ax27:common>
                  <ax27:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-PC-Gallery</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2</ax21:value>
                     </ax21:attr>
                     <!-- ... -->
                  </ax27:reply>
                  <ax27:role>default_client_admin</ax27:role>
               </ax27:attr>
            <!-- ... -->
            </ax27:response>
            <ax27:size>6</ax27:size>
         </ns:return>
      </ns:GetAuthRolesListAllResponse>
----
Код Описание ошибки

2

Ошибка доступа к БД

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddAuthRoleToAuthUser – Назначить роль нескольким пользователям

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

rolePrio

Роли пользователя с приоритетами RolePrio

user

Логин пользователя ожидается один или более

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:AddAuthRoleToAuthUser>
            <nbi:rolePrio>
                <xsd:priority>2</xsd:priority>
                <xsd:role>role2</xsd:role>
            </nbi:rolePrio>
            <!--Zero or more repetitions:-->
            <nbi:user>tester6</nbi:user>
        </nbi:AddAuthRoleToAuthUser>
Ответ
        <ns:AddAuthRoleToAuthUserResponse>
            <ns:return>
                <ax23:code>0</ax23:code>
                <ax23:detail/>
            </ns:return>
        </ns:AddAuthRoleToAuthUserResponse>
Код Описание ошибки

206

Пользователь не существует

209

Роль не существует

221

Нельзя присвоить роль с приоритетом, который есть уже у одной из ролей этого пользователя

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetAuthRolesToAuthUser – Установить пользователю роли

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

user

Логин пользователя

rolePrio

Роли пользователя с приоритетами, ожидается одна или более RolePrio.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:SetAuthRolesToAuthUser>
            <nbi:user>tester</nbi:user>
            <!--Zero or more repetitions:-->
            <nbi:rolePrio>
                <xsd:priority>1</xsd:priority>
                <xsd:role>rol125</xsd:role>
            </nbi:rolePrio>
            <nbi:rolePrio>
                <xsd:priority>2</xsd:priority>
                <xsd:role>role4</xsd:role>
            </nbi:rolePrio>
        </nbi:SetAuthRolesToAuthUser>
Ответ
        <ns:SetAuthRolesToAuthUserResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetAuthRolesToAuthUserResponse>
Код Описание ошибки

206

Пользователь не существует

209

Роль не существует

221

Нельзя привязать роли с одинаковым приоритетом

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddAuthNas – Добавить серверный адрес в базу eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. В версии 1.21.0 пакет eltex-auth-service больше не используется. Связь с хостом eltex-auth-service удалена. Команда теперь управляют только содержимым базы данных.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

AP

name

Имя точки

^[a-zA-Z0-9_-]{1,32}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

sectet

Ключ для работы с сервером RADIUS

^[a-zA-Z0-9]{0,60}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

descr

Описание точки

.{0,200}$

До 200 любых символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:AddAuthNas>
            <nbi:ip>192.168.0.1</nbi:ip>
            <nbi:name>name</nbi:name>
            <nbi:descr>descr</nbi:descr>
            <nbi:secret>secret</nbi:secret>
        </nbi:AddAuthNas>
Ответ
        <ns:AddAuthNasResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:AddAuthNasResponse>
Код Описание ошибки

30

Некорректно задан ip-адрес

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteAuthNas – Удалить в базе eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. В версии 1.21.0 пакет eltex-auth-service больше не используется. Связь с хостом eltex-auth-service удалена. Команда теперь управляют только содержимым базы данных.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

AP

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:DeleteAuthNas>
            <!--Zero or more repetitions:-->
            <nbi:ip>192.168.0.2</nbi:ip>
            <nbi:ip>192.168.0.1</nbi:ip>
        </nbi:DeleteAuthNas>
Ответ
        <ns:DeleteAuthNasResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:DeleteAuthNasResponse>
Код Описание ошибки

221

Адрес не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthNas – Получить информацию по серверному адресу из базы eltex-auth-service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

AP

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserGItem

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthNas>
            <nbi:ip>192.168.0.1</nbi:ip>
        </nbi:GetAuthNas>
Ответ
        <ns:GetAuthNasResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNasArray">
                    <ax21:nas xsi:type="ax21:NbiNas">
                        <ax21:descr>descr</ax21:descr>
                        <ax21:domain/>
                        <ax21:ip>192.168.0.1</ax21:ip>
                        <ax21:mac/>
                        <ax21:name>name4</ax21:name>
                        <ax21:secret>1111</ax21:secret>
                    </ax21:nas>
                </ax21:response>
            </ns:return>
        </ns:GetAuthNasResponse>
Код Описание ошибки

30

Некорректно задан ip-адрес

212

Ip-адрес не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthNasList – Получить список серверныx адресов из базы eltex-auth-service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

nasname

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNasArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthNasList>
            <nbi:count>2</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>nasname</nbi:orderBy>
            <nbi:orderType>desc</nbi:orderType>
        </nbi:GetAuthNasList>
Ответ
        <ns:GetAuthNasListResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNasArray">
                    <ax21:nas xsi:type="ax21:NbiNas">
                        <ax21:descr/>
                        <ax21:domain/>
                        <ax21:ip>192.168.0.2</ax21:ip>
                        <ax21:mac/>
                        <ax21:name>newName</ax21:name>
                        <ax21:secret>1111</ax21:secret>
                    </ax21:nas>
                    <ax21:nas xsi:type="ax21:NbiNas">
                        <ax21:descr>descr</ax21:descr>
                        <ax21:domain/>
                        <ax21:ip>192.168.0.1</ax21:ip>
                        <ax21:mac/>
                        <ax21:name>name4</ax21:name>
                        <ax21:secret>1111</ax21:secret>
                    </ax21:nas>
                </ax21:response>
            </ns:return>
        </ns:GetAuthNasListResponse>
Код Описание ошибки

112

Поле count должно быть целым и положительным

113

Поле page должно быть целым и положительным

114

Некорректное значение поля orderBy

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetAuthNas – Редактировать серверный адрес в базе eltex-auth-service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. В версии 1.21.0 пакет eltex-auth-service больше не используется. Связь с хостом eltex-auth-service удалена. Команда теперь управляют только содержимым базы данных.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP-адрес точки доступа

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой.

AP

name

Имя точки

^[a-zA-Z0-9_-]{1,32}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

secret

Ключ для работы с сервером RADIUS

^[a-zA-Z0-9]{0,60}$

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

descr

Описание точки

.{0,200}$

До 200 любых символов.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:SetAuthNas>
            <nbi:ip>192.168.0.1</nbi:ip>
            <nbi:name>name4</nbi:name>
            <nbi:descr>descr</nbi:descr>
            <nbi:secret>1111</nbi:secret>
        </nbi:SetAuthNas>
Ответ
        <ns:SetAuthNasResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetAuthNasResponse>
Код Описание ошибки

30

Некорректно задан ip-адрес

31

Некорректно задан пароль(или отсутствует)

212

Адрес не существует

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthAttrGroupList – Получить список групп атрибутов в базе eltex-auth-service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNameArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetAuthAttrGroupList/>
Ответ
        <ns:GetAuthAttrGroupListResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNameArray">
                    <ax21:name>portal-constructor</ax21:name>
                    <ax21:name>auth-user</ax21:name>
                    <ax21:name>wifi-personal-office</ax21:name>
                </ax21:response>
            </ns:return>
        </ns:GetAuthAttrGroupListResponse>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthAttrList – Получить список атрибутов в базы eltex_auth_service

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Список параметров также доступен в документации на странице Атрибуты системного пользователя и роли.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

attrGroup

Название группы атрибутов

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAuthAttrArray

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
        <nbi:GetAuthAttrList>
            <nbi:attrGroup>auth-user</nbi:attrGroup>
        </nbi:GetAuthAttrList>
Ответ
        <ns:GetAuthAttrListResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax27:response xsi:type="ax27:NbiAuthAttrArray">
                    <ax27:attr xsi:type="ax27:NbiAuthAttr">
                        <ax27:description>The user's password in clear text (for MD5, PEAP), no more than 253 characters.</ax27:description>
                        <ax27:editable>1</ax27:editable>
                        <ax27:exist>user</ax27:exist>
                        <ax27:label>Password</ax27:label>
                        <ax27:name>Cleartext-Password</ax27:name>
                        <ax27:operator>:=</ax27:operator>
                        <ax27:regex>.{0,253}</ax27:regex>
                        <ax27:type>string</ax27:type>
                    </ax27:attr>
                    <ax27:attr xsi:type="ax27:NbiAuthAttr">
                        <ax27:description>Auth-user/role domain</ax27:description>
                        <ax27:editable>1</ax27:editable>
                        <ax27:exist>both</ax27:exist>
                        <ax27:label>Domain</ax27:label>
                        <ax27:name>Eltex-Domain</ax27:name>
                        <ax27:operator>+=</ax27:operator>
                        <ax27:regex>.{0,253}</ax27:regex>
                        <ax27:type>domain</ax27:type>
                    </ax27:attr>
                    <ax27:attr xsi:type="ax27:NbiAuthAttr">
                        <ax27:description>Auth-user ser create date</ax27:description>
                        <ax27:editable>0</ax27:editable>
                        <ax27:exist>both</ax27:exist>
                        <ax27:label>Create date</ax27:label>
                        <ax27:name>Eltex-User-Create-Date</ax27:name>
                        <ax27:operator>=</ax27:operator>
                        <ax27:regex xsi:nil="true"/>
                        <ax27:type>string</ax27:type>
                    </ax27:attr>
                </ax27:response>
                <ax27:size>0</ax27:size>
            </ns:return>
        </ns:GetAuthAttrListResponse>
Код Описание ошибки

202

Неизвестная группа атрибута

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAuthAttrListV2 - Получить список атрибутов из базы eltex_auth_service c указанием локали

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда возвращает список RADIUS атрибутов сервиса Auth-service.

  3. Список параметров также доступен в документации на странице Атрибуты системного пользователя и роли.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

locale

Локаль

"ru", "ru_RU", "en", "en_GB" …​

Текст произвольной длины

attrGroup

Группа требуемых RADIUS атрибутов. При пустом значении будут возвращены атрибуты, принадлежащие всем группам

^.{1,256}$

Текст до 256-х символов

Выходные параметры

Параметр Значение Формат значения

response

Список атрибутов

Объект NbiAuthAttrArray

size

Количество атрибутов

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetAuthAttrListV2>
         <nbi:locale>ru_RU</nbi:locale>
         <nbi:attrGroup>portal-constructor</nbi:attrGroup>
      </nbi:GetAuthAttrListV2>
Ответ
      <ns:GetAuthAttrListV2Response>
            <ns:return>
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax25:response xsi:type="ax25:NbiAuthAttrArray">
               <ax25:attr xsi:type="ax25:NbiAuthAttr">
                  <ax25:description>Разрешить просмотр виртуальных порталов</ax25:description>
                  <ax25:editable>1</ax25:editable>
                  <ax25:exist>role</ax25:exist>
                  <ax25:label>Просмотр виртуальных порталов</ax25:label>
                  <ax25:name>Eltex-Portal-Constructor-Read-Only</ax25:name>
                  <ax25:operator>=</ax25:operator>
                  <ax25:regex>0|1</ax25:regex>
                  <ax25:strict>1</ax25:strict>
                  <ax25:type>boolAllow</ax25:type>
                  <ax25:valueHelp>0,1</ax25:valueHelp>
               </ax25:attr>
               <ax25:attr xsi:type="ax25:NbiAuthAttr">
                  <ax25:description>Разрешить изменение виртуальных порталов</ax25:description>
                  <ax25:editable>1</ax25:editable>
                  <ax25:exist>role</ax25:exist>
                  <ax25:label>Изменение виртуальных порталов</ax25:label>
                  <ax25:name>Eltex-Portal-Constructor-Read-Write</ax25:name>
                  <ax25:operator>=</ax25:operator>
                  <ax25:regex>0|1</ax25:regex>
                  <ax25:strict>1</ax25:strict>
                  <ax25:type>boolAllow</ax25:type>
                  <ax25:valueHelp>0,1</ax25:valueHelp>
               </ax25:attr>
            </ax25:response>
            <ax25:size>2</ax25:size>
         </ns:return>
      </ns:GetAuthAttrListV2Response>
Код Описание ошибки

201

Auth-service атрибуты пользователя не были загружены

202

Неизвестная роль auth-атрибутов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetNbiMethodsAllowedList - Запрос списка методов NBI доступных для пользователя

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

  2. Команда возвращает клиенту список доступных ему методов

  3. Из списка методов исключены устаревшие (возвращают код 449). Так же есть методы, которые доступны всегда (GetVersion и GetNbiMethodsAllowedList)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAllowedMethod

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetNbiMethodsAllowedList/>
Ответ
<ns:GetNbiMethodsAllowedList>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail></ax21:detail>
                <ax26:allowedMethods xsi:type="ax26:NbiAllowedMethod">
                    <ax26:alwaysAllowed>false</ax26:alwaysAllowed>
                    <ax26:methodName>AddAuthNas</ax26:methodName>
                </ax26:allowedMethods>
                <ax26:allowedMethods xsi:type="ax26:NbiAllowedMethod">
                    <ax26:alwaysAllowed>false</ax26:alwaysAllowed>
                    <ax26:methodName>AddAuthRoleToAuthUser</ax26:methodName>
                </ax26:allowedMethods>
                <ax26:allowedMethods xsi:type="ax26:NbiAllowedMethod">
                    <ax26:alwaysAllowed>false</ax26:alwaysAllowed>
                    <ax26:methodName>AddLocationSubnet</ax26:methodName>
                </ax26:allowedMethods>
                <ax26:allowedMethods xsi:type="ax26:NbiAllowedMethod">
                    <ax26:alwaysAllowed>false</ax26:alwaysAllowed>
                    <ax26:methodName>AddOttBlack</ax26:methodName>
                </ax26:allowedMethods>
                <ax26:allowedMethods xsi:type="ax26:NbiAllowedMethod">
                    <ax26:alwaysAllowed>false</ax26:alwaysAllowed>
                    <ax26:methodName>AddPCRFScript</ax26:methodName>
                </ax26:allowedMethods>
            </ns:return>
        </ns:GetNbiMethodsAllowedList>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddSsoUser - Добавить пользователя в SSO

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Добавляет пользователя в SSO

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username

Имя пользователя

^(?=.{1,50}$)[a-z]{1}[a-z0-9_.-]+()$

Строка с символами длинной до 50 символов

password

Пароль

.{1,255}$

Любые символы в количестве до 255-ти

email (необязательный при условии что есть phone)

Электронная почта

^([0-9A-Za-z]{1}[-0-9A-z\.]{1,}[0-9A-Za-z]{1})|([0-9А-Яа-я]{1}[-0-9А-я\.]{1,}[0-9А-Яа-я]{1}@([-A-Za-z]{1,}\.){1,2}[-A-Za-z]{2,})$

Адрес электронной почты

phone (необязательный при условии что есть email)

Номер телефона

^79([0-9]{9})$

Строка с номером мобильного телефона

description (необязательный)

Описание

.{1,255}$

Любые символы в количестве до 255-ти

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:AddSsoUser>
        <nbi:username>qwe</nbi:username>
        <nbi:password>qwe</nbi:password>
        <nbi:phone>79133336699</nbi:phone>
    </nbi:AddSsoUser>
Ответ
    <ns:AddSsoUserResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
    </ns:AddSsoUserResponse>
Код Описание ошибки

0

Успешно

20

Некорректное поле username (отсутствует)

434

Пароль не указан, либо указано пустое значение

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

496

Ошибка при создании пользователя

497

Ошибка при работе сервера

498

Не указан email или телефон

500

Неверно задан email ''email''

501

Неверно задан номер телефона ''телефон''

504

SSO пользователь с ''параметр'' (''значение'') уже существует

513

Невозможно найти контейнер привязок в профиле пользователя SSO: 'имя контейнера'

511

Профиль пользователя SSO содержит множественную привязку. Список привязок: 'привязки'

512

Пользователь имеет привязку к другому локальному кабинету. Привязка: 'имя привязки'

514

Пользователь с именем 'имя' и e-mail 'e-mail' уже создан и имеет привязку к локальному кабинету 'имя'

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteSsoUser - Удалить пользователя в SSO

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Удаляет пользователя в SSO с указанным username (Актуально для SSO 1.0)

  3. Удаляет привязки к локальному пользователю (Актуально для SSO 2.0)

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username

Имя пользователя

^(?=.{1,50}$)[a-z]{1}[a-z0-9_.-]+()$

Строка с символами длинной до 50 символов

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:DeleteSsoUser>
        <nbi:username>Test</nbi:username>
    </nbi:DeleteSsoUser>
Ответ
    <ns:DeleteSsoUserResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
    </ns:DeleteSsoUserResponse>
Код Описание ошибки

0

Успешно

20

Некорректное поле username (отсутствует)

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

497

Ошибка при работе сервера

498

Данные не найдены

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsoUserByEmail - Получить информацию о пользователе по известному email пользователя в SSO

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда актуальна только для SSO версии 2.0

Входные параметры

Параметр Значение Формат значения Расшифровка формата

email (Обязательно)

Email пользователя в SSO

^([0-9A-Za-z]{1}[-0-9A-z\.]{1,}[0-9A-Za-z]{1})|([0-9А-Яа-я]{1}[-0-9А-я\.]{1,}[0-9А-Яа-я]{1}@([-A-Za-z]{1,}\.){1,2}[-A-Za-z]{2,})$

Адрес электронной почты

Выходные параметры

Параметр Значение Формат значения

users

Массив профилей пользователей SSO: SsoUser

SsoUser

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:GetSsoUserByEmail>
        <nbi:email>1492o@bar.com</nbi:email>
    </nbi:GetSsoUserByEmail>
Ответ
    <ns:GetSsoUserByEmailResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax295:user xsi:type="ax295:SsoUser">
               <ax295:description>admin</ax295:description>
               <ax295:email>1492o@bar.com</ax295:email>
               <ax295:enabled>true</ax295:enabled>
               <ax295:id>f:be17da0d-1933-4f43-be63-ef158a2868b2:35481</ax295:id>
               <ax295:password/>
               <ax295:phone>79094341492</ax295:phone>
               <ax295:username>a1540</ax295:username>
            </ax295:user>
         </ns:return>
    </ns:GetSsoUserByEmailResponse>
Код Описание ошибки

0

Успешно

200

(SSO v1.0): Эта функция не реализована

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

497

Ошибка при работе сервера

498

Данные не найдены

500

Некорректное поле email (отсутствует)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsoUserByName - Получить информацию о пользователе по известному username пользователя в SSO

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username (Обязательно)

Имя пользователя (login пользователя в SSO)

^(?=.{1,50}$)[a-z]{1}[a-z0-9_.-]+()$

Строка с символами длинной до 50 символов

Выходные параметры

Параметр Значение Формат значения

users

Массив профилей пользователей SSO: SsoUser

SsoUser

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:GetSsoUserByName>
        <nbi:username>qwe</nbi:username>
    </nbi:GetSsoUserByName>
Ответ
    <ns:GetSsoUserByNameResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax295:user xsi:type="ax295:SsoUser">
               <ax295:description>Описание</ax295:description>
               <ax295:email>1492o@bar.com</ax295:email>
               <ax295:enabled>true</ax295:enabled>
               <ax295:id>f:be17da0d-1933-4f43-be63-ef158a2868b2:35481</ax295:id>
               <ax295:password/>
               <ax295:phone>79094341492</ax295:phone>
               <ax295:username>a1540</ax295:username>
            </ax295:user>
         </ns:return>
    </ns:GetSsoUserByNameResponse>
Код Описание ошибки

0

Успешно

20

Некорректное поле username (отсутствует)

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

497

Ошибка при работе сервера

498

Данные не найдены

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSsoUserByParam - Получить список пользователей SSO, имеющих привязку к указанному личному кабинету

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Получить список пользователей SSO, имеющих привязку к указанному личному кабинету

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username (Обязательно)

Имя пользователя (Имя привязки к ЛК в профиле SSO)

^(?=.{1,50}$)[a-z]{1}[a-z0-9_.-]+()$

Строка с символами длинной до 50 символов

Выходные параметры

Параметр Значение Формат значения

users

Массив профилей пользователей SSO: SsoUser

SsoUser

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:GetUserByParam>
        <nbi:username>a1540</nbi:username>
    </nbi:GetUserByParam>
Ответ
    <ns:GetUserByParamResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax289:users xsi:type="ax289:SsoUser">
               <ax289:description>Описание</ax289:description>
               <ax289:email>1492o@bar.com</ax289:email>
               <ax289:enabled>true</ax289:enabled>
               <ax289:id>f:be17da0d-1933-4f43-be63-ef158a2868b2:35483</ax289:id>
               <ax289:password/>
               <ax289:phone>79094341493</ax289:phone>
               <ax289:username>a1541</ax289:username>
            </ax289:users>
            <ax289:users xsi:type="ax289:SsoUser">
               <ax289:description>Описание</ax289:description>
               <ax289:email>1492o@bar.com</ax289:email>
               <ax289:enabled>true</ax289:enabled>
               <ax289:id>f:be17da0d-1933-4f43-be63-ef158a2868b2:35481</ax289:id>
               <ax289:password/>
               <ax289:phone>79094341492</ax289:phone>
               <ax289:username>a1540</ax289:username>
            </ax289:users>
         </ns:return>
    </ns:GetUserByParamResponse>
Код Описание ошибки

0

Успешно

20

Некорректное поле username (отсутствует)

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

497

Ошибка при работе сервера

498

Данные не найдены

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateAPGroupShaperDown - Задать среднее и пиковое ограничение передачи данных для входящего потока на группу точек доступа по домену

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateAPGroupShaperDown>
            <nbi:apDomain>lenina6.nsk.ru</nbi:apDomain>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:CreateAPGroupShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateAPGroupShaperDownResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:CreateAPGroupShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateAPGroupShaperUp - Задать среднее и пиковое ограничение передачи данных для исходящего потока на группу точек доступа по домену

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateAPGroupShaperUp>
            <nbi:apDomain>lenina6.nsk.ru</nbi:apDomain>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:CreateAPGroupShaperUp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateAPGroupShaperUpResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:CreateAPGroupShaperUpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteAPGroupShaperDown, DeleteAPGroupShaperUp - Удалить ограничения передачи данных для группы точек доступа по домену

Общая информация

  1. Полностью удаляет ограничения для указанного домена (up, down-команды работают одинаково)

  2. Для удаления ограничения, но сохранения связки SSID и домена для ESR, необходимо использовать EditAPGroupShaperDown с указанием нулевых значений ограничения.

  3. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:DeleteAPGroupShaperDown>
            <nbi:apDomain>office46.SBERBANK.EKT.root</nbi:apDomain>
        </nbi:DeleteAPGroupShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:DeleteAPGroupShaperDownResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:DeleteAPGroupShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB. Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditAPGroupShaperDown - Изменить среднее и пиковое ограничение передачи данных для входящего потока для группы точек доступа по домену

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditAPGroupShaperDown>
            <nbi:apDomain>lenina6.nsk.ru</nbi:apDomain>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:EditAPGroupShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditAPGroupShaperDownResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:EditAPGroupShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditAPGroupShaperUp - Изменить среднее и пиковое ограничение передачи данных для исходящего потока для группы точек доступа по домену

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditAPGroupShaperUp>
            <nbi:apDomain>lenina6.nsk.ru</nbi:apDomain>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:EditAPGroupShaperUp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditAPGroupShaperUpResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:EditAPGroupShaperUpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

eak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateVlanShaperDown - Задать среднее и пиковое ограничение передачи данных для входящего потока для SSID на группе точек доступа

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

ssid

Имя и домен SSID. Объект NbiNameDomain.

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateVlanShaperDown>
            <nbi:apDomain>enterprise.root</nbi:apDomain>
            <nbi:ssid>
                <xsd:domain>enterprise.root</xsd:domain>
                <xsd:name>Eltex</xsd:name>
            </nbi:ssid>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:CreateVlanShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateVlanShaperDownResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:CreateVlanShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateVlanShaperUp - Задать среднее и пиковое ограничение передачи данных для исходящего потока на SSID на группе точек доступа

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

ssid

Имя и домен SSID. Объект NbiNameDomain.

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateVlanShaperUp>
            <nbi:apDomain>enterprise.root</nbi:apDomain>
            <nbi:ssid>
                <xsd:domain>enterprise.root</xsd:domain>
                <xsd:name>Eltex</xsd:name>
            </nbi:ssid>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:CreateVlanShaperUp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:CreateVlanShaperUpResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:CreateVlanShaperUpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteVlanShaperDown, DeleteVlanShaperUp - Удалить ограничения передачи данных на группу виртуальных сетей по домену

Общая информация

  1. Полностью удаляет ограничения для указанного SSID в домене (up, down-команды работают одинаково)

  2. Для удаления ограничения, но сохранения связки SSID и домена для ESR, необходимо использовать EditVlanShaperDown с указанием нулевых значений ограничения.

  3. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

ssid

Имя и домен SSID. Объект NbiNameDomain.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:DeleteVlanShaperDown>
            <nbi:apDomain>mike.root</nbi:apDomain>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>ssid</xsd:name>
            </nbi:ssid>
        </nbi:DeleteVlanShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:DeleteVlanShaperDownResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:DeleteVlanShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditVlanShaperDown - Редактировать среднее и пиковое ограничение передачи данных для входящего потока для SSID на группе точек доступа

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

ssid

Имя и домен SSID. Объект NbiNameDomain.

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditVlanShaperDown>
            <nbi:apDomain>enterprise.root</nbi:apDomain>
            <nbi:ssid>
                <xsd:domain>enterprise.root</xsd:domain>
                <xsd:name>Eltex</xsd:name>
            </nbi:ssid>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:EditVlanShaperDown>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditVlanShaperDownResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:EditVlanShaperDownResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditVlanShaperUp - Редактировать среднее и пиковое ограничение передачи данных для исходящего потока для SSID на группе точек доступа

Общая информация

  1. Значение peak ограничения должны быть больше или равна average

  2. Значение peak не может назначаться при пустом average.

  3. Значения всех ограничений по трафику лежат в диапазоне [64..10 000 000], Kbps.
    Значение 0 или null означаются отсутствие ограничения.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен группы точек доступа (офиса, узла в дереве EMS)

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

ssid

Имя и домен SSID. Объект NbiNameDomain.

averageShaperValue

Ограничение средней скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

peakShaperValue

Ограничение пиковой скорости в Kбит/с

^[1-9]\d*$

Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

1

Функционал не реализован
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:EditVlanShaperUp>
            <nbi:apDomain>enterprise.root</nbi:apDomain>
            <nbi:ssid>
                <xsd:domain>enterprise.root</xsd:domain>
                <xsd:name>Eltex</xsd:name>
            </nbi:ssid>
            <nbi:averageShaperValue>512</nbi:averageShaperValue>
            <nbi:peakShaperValue>1024</nbi:peakShaperValue>
        </nbi:EditVlanShaperUp>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditVlanShaperUpResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>1</ax21:code>
                <ax21:detail>Not implemented</ax21:detail>
            </ns:return>
        </ns:EditVlanShaperUpResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

302

Peak ограничение меньше average См. пример в SetDomainShaper(302)
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено См. пример в SetDomainShaper(303)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ClearDomainShaper - Стереть все ограничения для указанного домена и SSID, привязанных к нему

Общая информация

  1. Команда предназначена для удаления всех ограничений по трафику для указанного домена и включенных в него SSID.

  2. Для удаления ограничений только для ТД или одного из SSID нужно использовать команду SetDomainShaper с указанием актуального состава ограничений.

  3. Для удаления ограничений для указанного и всех дочерних доменов используется recursive=true

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

recursive

Удалить все дочерние домены

bool

true/false

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:ClearDomainShaper>
            <nbi:apDomain>empty.mike.root</nbi:apDomain>
            <nbi:recursive>false</nbi:recursive>
        </nbi:ClearDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:ClearDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:ClearDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

282

Не найдены ограничения для указанного домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:ClearDomainShaper>
            <nbi:apDomain>mike.root</nbi:apDomain>
            <nbi:recursive>false</nbi:recursive>
        </nbi:ClearDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:ClearDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>282</ax21:code>
                <ax21:detail>Shaper profile doesn't exist for 'mike.root'</ax21:detail>
            </ns:return>
        </ns:ClearDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:ClearDomainShaper>
            <nbi:apDomain>mik.root</nbi:apDomain>
            <nbi:recursive>false</nbi:recursive>
        </nbi:ClearDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:ClearDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'mik.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:ClearDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден обязательный параметр запроса (домен)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:ClearDomainShaper>
            <nbi:apDomain></nbi:apDomain>
            <nbi:recursive>false</nbi:recursive>
        </nbi:ClearDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:ClearDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>281</ax21:code>
                <ax21:detail>Request parameter 'apDomain' has not specified or empty</ax21:detail>
            </ns:return>
        </ns:ClearDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

280

В файле конфигурации /etc/eltex-radius-nbi/radius_nbi_config.txt отключена MongoDB См. пример в GetDomainShaper
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper

См. также

  1. GetDomainShaper

  2. SetDomainShaper

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ClearSsidShaper - Удалить указанный SSID из всех ограничений

Общая информация

  1. Команда предназначена для удаления SSID из всех профилей ограничений по доменам.

  2. Для удаления SSID только из одного профиля (домена ТД) нужно использовать команду DeleteVlanShaperDown.

  3. После RemoveSSID выполняется автоматически. Вызывать отдельно эту команду не нужно.

  4. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssid

Имя и домен SSID. Объект NbiNameDomain.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:ClearSsidShaper>
            <nbi:ssid>
                <xsd:domain>SBER-portal.Sberbank.root</xsd:domain>
                <xsd:name>SSID_GUEST</xsd:name>
            </nbi:ssid>
        </nbi:ClearSsidShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:ClearSsidShaperResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:ClearSsidShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper

См. также

  1. GetDomainShaper

  2. SetDomainShaper

  3. DeleteVlanShaperDown

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetDomainShaper - Получить список ограничений для указанного домена и SSID, привязанных к нему

Общая информация

  1. Команда служит для получения полного списка ограничений по трафику на ТД в домене и SSID, привязанных к нему

  2. Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

profile

Профиль - все ограничения на ТД внутри домена и SSID, привязанные к домену

Объект NbiDomainShaperProfile

Примеры команд и кодов

Код Описание ошибки

0

Успешно (ограничения только на ТД в домене)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>box.mike.root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax219:profile xsi:type="ax219:NbiDomainShaperProfile">
                    <ax219:averageDown>10</ax219:averageDown>
                    <ax219:averageUp>10</ax219:averageUp>
                    <ax219:domain>box.mike.root</ax219:domain>
                    <ax219:peakDown>30</ax219:peakDown>
                    <ax219:peakUp>20</ax219:peakUp>
                </ax219:profile>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (ограничения на ТД в домене и на SSID, привязанные к домену)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>unbox.mike.root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax219:profile xsi:type="ax219:NbiDomainShaperProfile">
                    <ax219:averageDown>100</ax219:averageDown>
                    <ax219:averageUp>200</ax219:averageUp>
                    <ax219:domain>unbox.mike.root</ax219:domain>
                    <ax219:peakDown>8800</ax219:peakDown>
                    <ax219:peakUp>9900</ax219:peakUp>
                    <ax219:ssid xsi:type="ax219:NbiSsidShaperProfile">
                        <ax219:averageDown>335</ax219:averageDown>
                        <ax219:averageUp>115</ax219:averageUp>
                        <ax219:domain>unbox.mike.root</ax219:domain>
                        <ax219:name>SSIDUNBOX</ax219:name>
                        <ax219:peakDown>4555</ax219:peakDown>
                        <ax219:peakUp>225</ax219:peakUp>
                    </ax219:ssid>
                    <ax219:ssid xsi:type="ax219:NbiSsidShaperProfile">
                        <ax219:averageDown>0</ax219:averageDown>
                        <ax219:averageUp>0</ax219:averageUp>
                        <ax219:domain>unbox.mike.root</ax219:domain>
                        <ax219:name>SSIDUNBOX2</ax219:name>
                        <ax219:peakDown>0</ax219:peakDown>
                        <ax219:peakUp>0</ax219:peakUp>
                    </ax219:ssid>
                </ax219:profile>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (ограничения только на SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>empty.mike.root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax29:profile xsi:type="ax29:NbiDomainShaperProfile">
                    <ax29:averageDown>0</ax29:averageDown>
                    <ax29:averageUp>0</ax29:averageUp>
                    <ax29:domain>empty.mike.root</ax29:domain>
                    <ax29:peakDown>0</ax29:peakDown>
                    <ax29:peakUp>0</ax29:peakUp>
                    <ax29:ssid xsi:type="ax29:NbiSsidShaperProfile">
                        <ax29:averageDown>60</ax29:averageDown>
                        <ax29:averageUp>30</ax29:averageUp>
                        <ax29:domain>root</ax29:domain>
                        <ax29:name>SSID77</ax29:name>
                        <ax29:peakDown>120</ax29:peakDown>
                        <ax29:peakUp>60</ax29:peakUp>
                    </ax29:ssid>
                </ax29:profile>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

282

Не заданы ограничения для домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>282</ax21:code>
                <ax21:detail>Shaper profile doesn't exist for 'root'</ax21:detail>
                <ax219:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>de.root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'de.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax219:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден обязательный параметр запроса (домен)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain></nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>281</ax21:code>
                <ax21:detail>Request parameter 'apDomain' has not specified or empty</ax21:detail>
                <ax219:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

280

В файле конфигурации /etc/eltex-radius-nbi/radius_nbi_config.txt отключена MongoDB
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>280</ax21:code>
                <ax21:detail>MongoDB disabled at configuration. Check out 'radius_nbi_config.txt', please.</ax21:detail>
                <ax219:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>999</ax21:code>
                <ax21:detail>Timed out after 10000 ms while waiting to connect. Client view of cluster state is {type=Unknown, servers=[{address=192.168.26.233:27017, type=Unknown, state=Connecting, exception={com.mongodb.MongoException$Network: Exception opening the socket}, caused by {java.net.NoRouteToHostException: No route to host}}]</ax21:detail>
                <ax219:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>

См. также

  1. SetDomainShaper

  2. ClearDomainShaper

  3. NbiDomainShaperProfile

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetDomainShaperMerged - Получить суммарный список ограничений для указанного домена и SSID, привязанных к нему

Общая информация

  1. Команда служит для получения суммарного списка ограничений по трафику на ТД в домене и SSID, привязанных к нему

  2. Команда актуальна, начиная с версии 1.7

  3. В версии 1.11 у SSID появился признак Traffic mode (tunnel, local). BRAS должен получать от PCRF только tunnel SSID, потому при выполнении GetDomainShaperMerged local SSID исключаются.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

profile

Профиль - все ограничения на ТД внутри домена и SSID, привязанные к домену

Объект NbiDomainShaperProfileMerged

Примеры команд и кодов

Код Описание ошибки

0

Успешно (ограничения только на ТД в домене)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>box.mike.root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax222:profile xsi:type="ax222:NbiDomainShaperProfileMerged">
                    <ax222:averageDown>10</ax222:averageDown>
                    <ax222:averageUp>10</ax222:averageUp>
                    <ax222:domain>box.mike.root</ax222:domain>
                    <ax222:peakDown>30</ax222:peakDown>
                    <ax222:peakUp>20</ax222:peakUp>
                </ax222:profile>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (ограничения на ТД в домене и на SSID, привязанные к домену)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>unbox.mike.root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax222:profile xsi:type="ax222:NbiDomainShaperProfileMerged">
                    <ax222:averageDown>100</ax222:averageDown>
                    <ax222:averageUp>200</ax222:averageUp>
                    <ax222:domain>unbox.mike.root</ax222:domain>
                    <ax222:peakDown>8800</ax222:peakDown>
                    <ax222:peakUp>9900</ax222:peakUp>
                    <ax222:ssid xsi:type="ax222:NbiSsidShaperProfileMerged">
                        <ax222:averageDown>335</ax222:averageDown>
                        <ax222:averageUp>115</ax222:averageUp>
                        <ax222:bridgeLocation>esr1</ax222:bridgeLocation>
                        <ax222:switchCommunity>false</ax222:switchCommunity>
                        <ax222:domain>unbox.mike.root</ax222:domain>
                        <ax222:name>SSIDUNBOX</ax222:name>
                        <ax222:peakDown>4555</ax222:peakDown>
                        <ax222:peakUp>225</ax222:peakUp>
                        <ax222:vlanPriority>3</ax222:vlanid>
                        <ax222:vlanid>1</ax222:vlanid>
                    </ax222:ssid>
                    <ax222:ssid xsi:type="ax222:NbiSsidShaperProfileMerged">
                        <ax222:averageDown>0</ax222:averageDown>
                        <ax222:averageUp>0</ax222:averageUp>
                        <ax222:bridgeLocation>esr2</ax222:bridgeLocation>
                        <ax222:switchCommunity>true</ax222:switchCommunity>
                        <ax222:domain>unbox.mike.root</ax222:domain>
                        <ax222:name>SSIDUNBOX2</ax222:name>
                        <ax222:peakDown>0</ax222:peakDown>
                        <ax222:peakUp>0</ax222:peakUp>
                        <ax222:vlanPriority>3</ax222:vlanid>
                        <ax222:vlanid>2</ax222:vlanid>
                    </ax222:ssid>
                </ax222:profile>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (ограничения только на SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>empty.mike.root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax29:profile xsi:type="ax29:NbiDomainShaperProfileMerged">
                    <ax29:averageDown>0</ax29:averageDown>
                    <ax29:averageUp>0</ax29:averageUp>
                    <ax29:domain>empty.mike.root</ax29:domain>
                    <ax29:peakDown>0</ax29:peakDown>
                    <ax29:peakUp>0</ax29:peakUp>
                    <ax29:ssid xsi:type="ax29:NbiSsidShaperProfileMerged">
                        <ax29:averageDown>60</ax29:averageDown>
                        <ax29:averageUp>30</ax29:averageUp>
                        <ax29:bridgeLocation>esr</ax29:bridgeLocation>
                        <ax29:domain>root</ax29:domain>
                        <ax29:name>SSID77</ax29:name>
                        <ax29:peakDown>120</ax29:peakDown>
                        <ax29:peakUp>60</ax29:peakUp>
                        <ax29:vlanPriority>3</ax29:vlanid>
                        <ax29:vlanid>1</ax29:vlanid>
                    </ax29:ssid>
                </ax29:profile>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

282

Не заданы ограничения для домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>282</ax21:code>
                <ax21:detail>Shaper profile doesn't exist for 'root'</ax21:detail>
                <ax222:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>de.root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'de.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax222:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден обязательный параметр запроса (домен)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain></nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>281</ax21:code>
                <ax21:detail>Request parameter 'apDomain' has not specified or empty</ax21:detail>
                <ax222:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

280

В файле конфигурации /etc/eltex-radius-nbi/radius_nbi_config.txt отключена MongoDB
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>280</ax21:code>
                <ax21:detail>MongoDB disabled at configuration. Check out 'radius_nbi_config.txt', please.</ax21:detail>
                <ax222:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaperMerged>
            <nbi:apDomain>root</nbi:apDomain>
        </nbi:GetDomainShaperMerged>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperMergedResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>999</ax21:code>
                <ax21:detail>Timed out after 10000 ms while waiting to connect. Client view of cluster state is {type=Unknown, servers=[{address=192.168.26.233:27017, type=Unknown, state=Connecting, exception={com.mongodb.MongoException$Network: Exception opening the socket}, caused by {java.net.NoRouteToHostException: No route to host}}]</ax21:detail>
                <ax222:profile xsi:nil="true"/>
            </ns:return>
        </ns:GetDomainShaperMergedResponse>
    </soapenv:Body>
</soapenv:Envelope>

См. также

  1. NbiDomainShaperProfileMerged

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetDomainShaper, SetDomainShaperAutoCreated - Установить ограничения для указанного домена и SSID, привязанных к нему

Общая информация

  1. Команда служит для установки ограничений по трафику на домен (группу ТД и SSID, привязанных к домену) и все входящие.
    При выдаче данных по запросу ESR из Eltex.PCRF ограничения по трафику могут быть получены как из текущего домена, где присутствует ТД, так и из родительского домена. Это позволяет настраивать ограничения на целый регион или населенный пункт.
    Если для домена установлены свои ограничения, то обращений за информацией к родительскому домену не будет.

  2. Для установки ограничений на SSID внутри домена все SSID должны быть предварительно привязаны к данному домену через систему EMS или NBI.
    Привязка SSID к домену: SetSSIDByDomain.
    Просмотр списка SSID, привязанных к домену: GetSsidLinkListByDomain.

  3. Одновременно с этим данные используются для поднятия нужных VLAN на ESR при инициализации канала. Потому команда может использоваться без указания ограничений, с указанием только нужных привязок SSID.

  4. Команда SetDomainShaper актуальна, начиная с версии 1.5

  5. Команда SetDomainShaperAutoCreated актуальна с версии 1.8. Имеет идентичное API. Отличается тем, что используется в EMS для автоматического создания профиля шейпера при осуществлении привязки SSID к домену. В этом случае в профиль сохраняется признак auto_created = true. Для удаления автоматически созданных профилей может быть использована команда ClearAutoCreatedDomainShaper

Условия валидации профиля шейпера

  1. Значения peakUp/peakDown должны быть больше или равны значениям averageUp/averageDown.

  2. Значения peakUp/peakDown не могут назначаться при пустых значениях averageUp/averageDown.

  3. Значения peakUp/peakDown можно задать безлимитными (отсутствие ограничения) при любых значениях averageUp/averageDown.
    Отсутствие ограничения задается значениями 0 или null.

  4. Значения всех ограничений по трафику лежат в диапазоне [64..10 000000], Kbps.

  5. Значения peakUp/peakDown, заданные в SSID, не должны превышать значения peakUp/peakDown, заданные в домене.

  6. Сумма значений averageUp/averageDown, заданных в SSID, не должна превышать значения averageUp/averageDown, заданные в домене. Для SSID с безлимитным значением (отсутствие ограничения) значение считается за минимальное, т.е. 64Kbps.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profile

Профиль ограничений NbiDomainShaperProfile

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно (ограничения и на группу ТД и на SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain>mike.root</xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
                <xsd:ssid>
                    <xsd:averageDown>500</xsd:averageDown>
                    <xsd:averageUp>300</xsd:averageUp>
                    <xsd:domain>root</xsd:domain>
                    <xsd:name>SSID223</xsd:name>
                    <xsd:peakDown>1000</xsd:peakDown>
                    <xsd:peakUp>600</xsd:peakUp>
                </xsd:ssid>
                <xsd:ssid>
                    <xsd:averageDown>600</xsd:averageDown>
                    <xsd:averageUp>400</xsd:averageUp>
                    <xsd:domain>root</xsd:domain>
                    <xsd:name>SSID226</xsd:name>
                    <xsd:peakDown>1200</xsd:peakDown>
                    <xsd:peakUp>800</xsd:peakUp>
                </xsd:ssid>
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (ограничения только на группу ТД без привязок SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain>mike.root</xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно (указаны только имя и домен SSID)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain>root</xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
                <xsd:ssid>
                    <xsd:averageDown></xsd:averageDown>
                    <xsd:averageUp></xsd:averageUp>
                    <xsd:domain>root</xsd:domain>
                    <xsd:name>SSID2</xsd:name>
                    <xsd:peakDown></xsd:peakDown>
                    <xsd:peakUp></xsd:peakUp>
                </xsd:ssid>
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не найден
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain>mik.root</xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'mik.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Нет прав на управление в указанном домене
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain>mike.root</xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'mike.root'</ax21:detail>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Некорректное значение домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>5000</xsd:averageDown>
                <xsd:averageUp>3000</xsd:averageUp>
                <xsd:domain></xsd:domain>
                <xsd:peakDown>10000</xsd:peakDown>
                <xsd:peakUp>6000</xsd:peakUp>
                <!--Zero or more repetitions:-->
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:SetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '' does not conform to the rules FQDN</ax21:detail>
            </ns:return>
        </ns:SetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

280

В файле конфигурации /etc/eltex-radius-nbi/radius_nbi_config.txt отключена MongoDB См. пример в GetDomainShaper
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper
Код Описание ошибки

302

Peak ограничение меньше average
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>700</xsd:averageDown>
                <xsd:averageUp>100</xsd:averageUp>
                <xsd:domain>empty.mike.root</xsd:domain>
                <xsd:peakDown>600</xsd:peakDown>
                <xsd:peakUp>100</xsd:peakUp>
                <xsd:ssid>
                    <xsd:averageDown>500</xsd:averageDown>
                    <xsd:averageUp>100</xsd:averageUp>
                    <xsd:domain>TEST_TEST.root</xsd:domain>
                    <xsd:name>testetste</xsd:name>
                    <xsd:peakDown>100</xsd:peakDown>
                    <xsd:peakUp>100</xsd:peakUp>
                </xsd:ssid>
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:SetDomainShaperResponse>
            <ax21:code>302</ax21:code>
            <ax21:detail>Value of 'peakDown' can't be less than 'averageDown'</ax21:detail>
        </ns:return>
    </ns:SetDomainShaperResponse>
</soapenv:Body>undefined</soapenv:Envelope>
Код Описание ошибки

303

Peak ограничение не может быть назначено если average не назначено
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>0</xsd:averageDown>
                <xsd:averageUp>0</xsd:averageUp>
                <xsd:domain>empty.mike.root</xsd:domain>
                <xsd:peakDown>0</xsd:peakDown>
                <xsd:peakUp>100</xsd:peakUp>
                <xsd:ssid>
                    <xsd:averageDown>500</xsd:averageDown>
                    <xsd:averageUp>100</xsd:averageUp>
                    <xsd:domain>TEST_TEST.root</xsd:domain>
                    <xsd:name>testetste</xsd:name>
                    <xsd:peakDown>100</xsd:peakDown>
                    <xsd:peakUp>100</xsd:peakUp>
                </xsd:ssid>
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:SetDomainShaperResponse>
            <ax21:code>303</ax21:code>
            <ax21:detail>Value of 'peakUp' can't be assigned when 'averageUp' not assigned</ax21:detail>
        </ns:return>
    </ns:SetDomainShaperResponse>
</soapenv:Body>undefined</soapenv:Envelope>

Пример использования

1.1. Создать SSID0

Используется CreateSSID. SSID обязательно должны иметь разные VLAN, так как именно по ним ESR будет устанавливать ограничения.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateSSID>
            <nbi:name>SSID0</nbi:name>
            <nbi:domain>mike.root</nbi:domain>
            <nbi:descr>SSID 0</nbi:descr>
            <nbi:params>
                <xsd:name>Radio</xsd:name>
                <xsd:value>ALL</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>Security_Type</xsd:name>
                <xsd:value>0</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>Vlan_ID</xsd:name>
                <xsd:value>11</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>VAP_Status</xsd:name>
                <xsd:value>up</xsd:value>
            </nbi:params>
        </nbi:CreateSSID>
    </soapenv:Body>
</soapenv:Envelope>
1.2. Создать SSID1
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:CreateSSID>
            <nbi:name>SSID1</nbi:name>
            <nbi:domain>mike.root</nbi:domain>
            <nbi:descr>SSID 1</nbi:descr>
            <nbi:params>
                <xsd:name>Radio</xsd:name>
                <xsd:value>ALL</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>Security_Type</xsd:name>
                <xsd:value>0</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>Vlan_ID</xsd:name>
                <xsd:value>12</xsd:value>
            </nbi:params>
            <nbi:params>
                <xsd:name>VAP_Status</xsd:name>
                <xsd:value>up</xsd:value>
            </nbi:params>
        </nbi:CreateSSID>
    </soapenv:Body>
</soapenv:Envelope>
2.1. Добавить привязку SSID0 к домену

Используется SetSSIDByDomain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetSSIDByDomain>
            <nbi:nasDomain>mike.root</nbi:nasDomain>
            <nbi:ssidName>SSID0</nbi:ssidName>
            <nbi:ssidDomain>mike.root</nbi:ssidDomain>
        </nbi:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
2.2. Добавить привязку SSID1 к домену
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetSSIDByDomain>
            <nbi:nasDomain>mike.root</nbi:nasDomain>
            <nbi:ssidName>SSID1</nbi:ssidName>
            <nbi:ssidDomain>mike.root</nbi:ssidDomain>
        </nbi:SetSSIDByDomain>
    </soapenv:Body>
</soapenv:Envelope>
3. Проверить, чтоб привязки установлены

Используется GetSsidLinkListByDomain Во внешней системе управления эта команда должна использоваться для получения списка SSID для установки ограничений в домене
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetSsidLinkListByDomain>
            <nbi:nodeDomain>mike.root</nbi:nodeDomain>
        </nbi:GetSsidLinkListByDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetSsidLinkListByDomainResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNameDomainArray">
                    <ax21:item xsi:type="ax21:NbiNameDomain">
                        <ax21:domain>mike.root</ax21:domain>
                        <ax21:name>SSID0</ax21:name>
                    </ax21:item>
                    <ax21:item xsi:type="ax21:NbiNameDomain">
                        <ax21:domain>mike.root</ax21:domain>
                        <ax21:name>SSID1</ax21:name>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:GetSsidLinkListByDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
4. Добавить ограничения на домен и SSID в нем

Используется SetDomainShaper
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:SetDomainShaper>
            <nbi:profile>
                <xsd:averageDown>1000</xsd:averageDown>
                <xsd:averageUp>200</xsd:averageUp>
                <xsd:domain>mike.root</xsd:domain>
                <xsd:peakDown>5000</xsd:peakDown>
                <xsd:peakUp>1000</xsd:peakUp>
                <!--Zero or more repetitions:-->
                <xsd:ssid>
                    <xsd:averageDown>500</xsd:averageDown>
                    <xsd:averageUp>100</xsd:averageUp>
                    <xsd:domain>mike.root</xsd:domain>
                    <xsd:name>SSID0</xsd:name>
                    <xsd:peakDown>5000</xsd:peakDown>
                    <xsd:peakUp>1000</xsd:peakUp>
                </xsd:ssid>
                <xsd:ssid>
                    <xsd:averageDown>400</xsd:averageDown>
                    <xsd:averageUp>80</xsd:averageUp>
                    <xsd:domain>mike.root</xsd:domain>
                    <xsd:name>SSID1</xsd:name>
                    <xsd:peakDown>5000</xsd:peakDown>
                    <xsd:peakUp>1000</xsd:peakUp>
                </xsd:ssid>
            </nbi:profile>
        </nbi:SetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
5. Просмотр установленных ограничений

Используется GetDomainShaper
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetDomainShaper>
            <nbi:apDomain>mike.root</nbi:apDomain>
        </nbi:GetDomainShaper>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetDomainShaperResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax29:profile xsi:type="ax29:NbiDomainShaperProfile">
                    <ax29:averageDown>1000</ax29:averageDown>
                    <ax29:averageUp>200</ax29:averageUp>
                    <ax29:domain>mike.root</ax29:domain>
                    <ax29:peakDown>5000</ax29:peakDown>
                    <ax29:peakUp>1000</ax29:peakUp>
                    <ax29:ssid xsi:type="ax29:NbiSsidShaperProfile">
                        <ax29:averageDown>500</ax29:averageDown>
                        <ax29:averageUp>100</ax29:averageUp>
                        <ax29:domain>mike.root</ax29:domain>
                        <ax29:name>SSID0</ax29:name>
                        <ax29:peakDown>5000</ax29:peakDown>
                        <ax29:peakUp>1000</ax29:peakUp>
                    </ax29:ssid>
                    <ax29:ssid xsi:type="ax29:NbiSsidShaperProfile">
                        <ax29:averageDown>400</ax29:averageDown>
                        <ax29:averageUp>80</ax29:averageUp>
                        <ax29:domain>mike.root</ax29:domain>
                        <ax29:name>SSID1</ax29:name>
                        <ax29:peakDown>5000</ax29:peakDown>
                        <ax29:peakUp>1000</ax29:peakUp>
                    </ax29:ssid>
                </ax29:profile>
            </ns:return>
        </ns:GetDomainShaperResponse>
    </soapenv:Body>
</soapenv:Envelope>
6. Дальнейшая обработка

Дальнейшая установка ограничений на ESR выполняется при участии Eltex.EMS и Eltex.PCRF в момент включения (появления в сети) точки доступа

См. также

  1. GetDomainShaper

  2. ClearDomainShaper

  3. NbiDomainShaperProfile

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RenameSsidShaperDomain - Переименовать домен SSID в профилях шейпера

Общая информация

  1. Служебная команда для обновления домена SSID в профилях шейперов. 2 Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssid

Имя и домен SSID. Объект NbiNameDomain.

newDomain

Новый домен SSID.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope>
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RenameSsidShaperDomain>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>BABY</xsd:name>
            </nbi:ssid>
            <nbi:newDomain>mike.root</nbi:newDomain>
        </nbi:RenameSsidShaperDomain>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
        <ns:RenameSsidShaperDomainResponse>
            <ns:return>
                <ax21:code>0</ax21:code>
                <ax21:detail/>
            </ns:return>
        </ns:RenameSsidShaperDomainResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

999

Нет доступа до MongoDB Идет под индексом системной ошибки. Отдельного кода не имеет. См. пример в GetDomainShaper

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ClearAutoCreatedDomainShaper - Удаление автоматически созданного профиля шейпера

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Предназначена для удаления из БД шейперов профилей, созданных автоматически. В этом случае в профиле содержится параметр auto_created = true.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен

String

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:ClearAutoCreatedDomainShaper>
         <nbi:apDomain>root</nbi:apDomain>
      </nbi:ClearAutoCreatedDomainShaper>
Ответ
      <ns:ClearAutoCreatedDomainShaperResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:ClearAutoCreatedDomainShaperResponse>
Код Описание ошибки

7

Не найден обязательный параметр запроса 'apDomain'

8

Домен не соответствует правилам

62

Домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddPCRFScript - Добавить PCRF сценарий.

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для добавления PCRF сценариев.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

title

Название PCRF сценария.

^.{1,64}$

Текст до 64-х символов

Название сценария

domain

Домен PCRF сценария.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

services

Список сценариев, расположенных в порядке выполнения

^.{1,64}$

Текст до 64-х символов

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:AddPCRFScript>
         <nbi:title>NewTitle</nbi:title>
         <nbi:domain>enterprise.root</nbi:domain>
         <nbi:services>xzbuxtfmcf</nbi:services>
         <nbi:services>tiqobexnnq</nbi:services>
      </nbi:AddPCRFScript>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserTimeStatisicsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeAcctResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:AddPCRFScriptResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

271

Не указан обязательный параметр запроса 'title'

272

Сценарий с именем 'title' уже существует

273

Ошибка чтения сценария с именем 'title'

268

Не указан обязательный параметр запроса 'services'

269

Неверный список сценариев. Маркер 'again' не может быть на первом месте

270

Не удается найти сценарий, указанный в параметре запроса 'services'

404

PCRF сценарий 'title' не может иметь имя существующего PCRF сценария

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditPCRFScript - Редактировать PCRF сценарий.

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для редактирования PCRF сценариев.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

title

Название PCRF сценария.

^.{1,64}$

Текст до 64-х символов

Название сценария

domain

Домен PCRF сценария.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

services

Список сервисов, расположенных в порядке выполнения

^.{1,64}$

Текст до 64-х символов

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
          <nbi:EditPCRFScript>
             <nbi:title>NewTitle</nbi:title>
             <nbi:domain>enterprise.root</nbi:domain>
             <nbi:services>tiqobexnnq</nbi:services>
             <nbi:services>xzbuxtfmcf</nbi:services>
          </nbi:EditPCRFScript>
       </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:EditPCRFScriptResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditPCRFScriptResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

271

Не указан обязательный параметр запроса 'title'

273

Ошибка чтения сценария с именем 'title'

274

Не удается найти сценарий с именем 'title'

268

Не указан обязательный параметр запроса 'services'

269

Неверный список сервисов. Маркер 'again' не может быть на первом месте

270

Не удается найти сервис, указанный в параметре запроса 'services'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeletePCRFScript - Удалить PCRF сценарий.

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для удаления PCRF сценариев.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

title

Название PCRF сценария.

^.{1,64}$

Текст до 64-х символов

Название сценария

domain

Домен PCRF сценария.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:DeletePCRFScript>
           <nbi:title>NewTitle</nbi:title>
           <nbi:domain>enterprise.root</nbi:domain>
        </nbi:DeletePCRFScript>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:DeletePCRFScriptResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeletePCRFScriptResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

271

Не указан обязательный параметр запроса 'title'

273

Ошибка чтения сценария с именем 'title'

274

Не удается найти сценарий с именем 'title'

276

Нельзя удалить сценарий, так как он используется в PCRF тарифе

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetPCRFScriptsList - Получить список PCRF сценариев.

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для получения списка PCRF сценариев.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

title

Название PCRF сценария. При пустом значении будут возвращены сценарии с любым названием.

^.{1,64}$

Текст до 64-х символов

Название сценария

domain

Домен PCRF сценария. При пустом значении будут возвращены сценарии с любым доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiPCRFScriptArray

NbiPCRFScriptArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetPCRFScriptsList>
         <nbi:title></nbi:title>
         <nbi:domain></nbi:domain>
      </nbi:GetPCRFScriptsList>
    </soap:Body
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetPCRFScriptsListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiPCRFScriptArrayResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiPCRFScriptArray">
                 <ax21:parameter xsi:type="ax21:NbiPCRFScript">
                  <ax21:domain>enterprise.root</ax21:domain>
                  <ax21:steps xsi:type="ax21:NbiParameterArray">
                      <ax21:parameter xsi:type="ax21:NbiParameter">
                         <ax21:name>xzbuxtfmcf</ax21:name>
                         <ax21:value>0</ax21:value>
                      </ax21:parameter>
                      <ax21:parameter xsi:type="ax21:NbiParameter">
                         <ax21:name>tiqobexnnq</ax21:name>
                         <ax21:value>1</ax21:value>
                      </ax21:parameter>
                  </ax21:steps>
                  <ax21:title>NewTitle</ax21:title>
                 </ax21:parameter>
                 <ax21:parameter xsi:type="ax21:NbiPCRFScript">
                   <ax21:domain>enterprise.root</ax21:domain>
                   <ax21:steps xsi:type="ax21:NbiParameterArray">
                      <ax21:parameter xsi:type="ax21:NbiParameter">
                         <ax21:name>xzbuxtfmcf</ax21:name>
                         <ax21:value>0</ax21:value>
                      </ax21:parameter>
                      <ax21:parameter xsi:type="ax21:NbiParameter">
                         <ax21:name>tiqobexnnq</ax21:name>
                         <ax21:value>1</ax21:value>
                      </ax21:parameter>
                   </ax21:steps>
                   <ax21:title>script2</ax21:title>
                 </ax21:parameter>
                </ax21:response>
            </ns:return>
      </ns:GetPCRFScriptsListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetPCRFScriptsListCached - Получить список PCRF сценариев, если изменился

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Команда предназначена для получения списка сценариев, если они изменились. Для фиксации фактв изменения используется hash.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

hash

хэш последнего обновления списка сценариев

Integer

Выходные параметры

Параметр Значение Формат значения

response

Объект со списком сценариев

NbiPCRFScriptArray

hash

Текущее значение хэша списка сценариев

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetPCRFScriptsListCached>
         <nbi:hash>1</nbi:hash>
      </nbi:GetPCRFScriptsListCached>
Ответ если сценарии изменились
      <ns:GetPCRFScriptsListCachedResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:hash>4</ax21:hash>
            <ax21:response xsi:type="ax21:NbiPCRFScriptArray">
               <ax21:parameter xsi:type="ax21:NbiPCRFScript">
                  <ax21:domain>root</ax21:domain>
                  <ax21:steps xsi:type="ax21:NbiParameterArray">
                     <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>srv1</ax21:name>
                        <ax21:value>0</ax21:value>
                     </ax21:parameter>
                     <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>srv2</ax21:name>
                        <ax21:value>1</ax21:value>
                     </ax21:parameter>
                     <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>again</ax21:name>
                        <ax21:value>2</ax21:value>
                     </ax21:parameter>
                  </ax21:steps>
                  <ax21:title>scn1</ax21:title>
               </ax21:parameter>
            </ax21:response>
         </ns:return>
      </ns:GetPCRFScriptsListCachedResponse>
Ответ если сценарии не изменились
      <ns:GetPCRFScriptsListCachedResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:hash>4</ax21:hash>
            <ax21:response xsi:nil="true"/>
         </ns:return>
      </ns:GetPCRFScriptsListCachedResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetLocationSubnetList - Получить список подсетей для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для получения списка PCRF подсетей.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество выводимых элементов, обязательно

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно

^[1-9][0-9]*$

Целое положительное число

filters

Список фильтров

NbiParameterArray

Список доступных имен фильтров 'filters':

  • subnet_name - имя подсети;

  • vrf - VRF;

  • location - местоположение;

  • user_domain - домен пользователя;

  • portal_id - идентификатор портала;

  • nas_ip - IP-адрес NAS;

  • ap_domain - домен точки доступа;

  • subnet_type - тип подсети, целочисленное значение (SERVICE(0), AP_DYNAMIC(1), AP_STATIC(2)).

Выходные параметры

Параметр Значение Формат значения

service

Массив объектов NbiLocationSubnetProfile с описанием подсетей

NbiLocationSubnetProfile

totalAmount

Количество подсетей

Long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetLocationSubnetList>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:filters>
            <xsd:parameter>
               <xsd:name>location</xsd:name>
               <xsd:value>fff</xsd:value>
            </xsd:parameter>
         </nbi:filters>
      </nbi:GetLocationSubnetList>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetLocationSubnetListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiLocationSubnetProfileListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax230:service xsi:type="ax230:NbiLocationSubnetProfile">
               <ax230:apDomain xsi:nil="true"/>
               <ax230:apId/>
               <ax230:location>fff</ax230:location>
               <ax230:nasIp>2.2.2.2</ax230:nasIp>
               <ax230:portalId>ere</ax230:portalId>
               <ax230:ssid/>
               <ax230:subnetName>gcb</ax230:subnetName>
               <ax230:subnetType>0</ax230:subnetType>
               <ax230:userDomain>root</ax230:userDomain>
               <ax230:vrf>ff</ax230:vrf>
            </ax230:service>
            <ax230:totalAmount>1</ax230:totalAmount>
         </ns:return>
      </ns:GetLocationSubnetListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден один из параметров запроса

112

Количество записей на станице должно быть целым и положительным

113

Номер страницы должен быть целым и положительным

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddLocationSubnet - Добавить подсеть для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для добавления PCRF подсетей.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profile

Профиль подсети

NbiLocationSubnetProfile

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:AddLocationSubnet>
         <nbi:profile>
            <xsd:apDomain>enterprise.root</xsd:apDomain>
            <xsd:apId>343</xsd:apId>
            <xsd:location>location</xsd:location>
            <xsd:nasIp>192.168.2.3</xsd:nasIp>
            <xsd:portalId>34</xsd:portalId>
            <xsd:ssid>ssidName</xsd:ssid>
            <xsd:subnetName>subnet</xsd:subnetName>
            <xsd:userDomain>enterprise.root</xsd:userDomain>
            <xsd:vrf>vrf</xsd:vrf>
         </nbi:profile>
      </nbi:AddLocationSubnet>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:AddLocationSubnetResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:AddLocationSubnetResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден один из параметров запроса

284

Объект по vrf, location уже существует

281

Не найден один из обязательных параметров подсети - location, portalId, userDomain, vrf

10

Домен добавляемого объекта не принадлежит роли

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditLocationSubnet - Редактировать подсеть для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для редактирования PCRF подсетей.

  3. Начиная с версии 1.12, добавились подсети типа MAC Static. Для них ключевым параметром является MAC вместо IP. Поэтому в поле oldNasIp можно указывать два варианта значения.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

oldVrf

VRF

^.{1,256}$

Текст до 256-х символов

oldLocation

Местоположение интерфейса на ESR

^.{1,256}$

Текст до 256-х символов

oldNasIp

IP-адрес или MAC-адрес

IP или MAC

profile

Профиль подсети

NbiLocationSubnetProfile

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:EditLocationSubnet>
         <nbi:oldVrf>vrf</nbi:oldVrf>
         <nbi:oldLocation>location</nbi:oldLocation>
         <nbi:oldNasIp>192.168.2.3</nbi:oldNasIp>
         <nbi:profile>
            <xsd:apDomain>enterprise.root</xsd:apDomain>
            <xsd:apId>343</xsd:apId>
            <xsd:location>location</xsd:location>
            <xsd:nasIp>192.168.2.5</xsd:nasIp>
            <xsd:portalId>34</xsd:portalId>
            <xsd:ssid>ssidName</xsd:ssid>
            <xsd:subnetName>subnet44</xsd:subnetName>
            <xsd:userDomain>enterprise.root</xsd:userDomain>
            <xsd:vrf>vrf</xsd:vrf>
         </nbi:profile>
      </nbi:EditLocationSubnet>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:EditLocationSubnetResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditLocationSubnetResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден один из параметров запроса

285

Не найден объект по vrf, location, nasIp

281

Не найден один из обязательных параметров подсети

10

Старый домен подсети не принадлежит роли

284

При изменении vrf или location по новым значениям подсеть уже существует

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteLocationSubnet - Удалить подсеть для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда предназначена для удаления PCRF подсетей.

  3. Начиная с версии 1.12, добавились подсети типа MAC Static. Для них ключевым параметром является MAC вместо IP. Поэтому в поле nasIp можно указывать два варианта значения.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

vrf

VRF

^.{1,256}$

Текст до 256-х символов

location

Местоположение интерфейса на ESR

^.{1,256}$

Текст до 256-х символов

nasIp

IP-адрес или MAC-адрес

IP или MAC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:DeleteLocationSubnet>
         <nbi:vrf>vrf</nbi:vrf>
         <nbi:location>location</nbi:location>
         <nbi:nasIp>192.168.2.5</nbi:nasIp>
      </nbi:DeleteLocationSubnet>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:DeleteLocationSubnetResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteLocationSubnetResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Не найден один из параметров запроса

285

Не найден объект по vrf, location, nasIp

10

Нет прав на указанный в списке ключей домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteLocationSubnetByNode - Удалить автоматически созданную подсеть по ID устройства в дереве

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда для очистки подсетей после удаления объекта из дерева EMS.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

id

Индекс устройства в дереве EMS

Integer

vlan

VLAN SSID

Integer

VLAN или 0, если нужно удалить все

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DeleteLocationSubnetByNode>
         <nbi:id>39</nbi:id>
         <nbi:vlan>0</nbi:vlan>
      </nbi:DeleteLocationSubnetByNode>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DeleteLocationSubnetByNodeResponse>
         <ns:return>
            <ax23:code>0</ax23:code>
            <ax23:detail/>
         </ns:return>
      </ns:DeleteLocationSubnetByNodeResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Недопустимое значение входного параметра

10

Нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetVrf - Получить информацию по VRF для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда предназначена для получения информации о VRF

Входные параметры

Параметр Значение Формат значения Расшифровка формата

vrf

Уникальный идентификатор VRF

^[A-Za-z][A-Za-z0-9_-]{0,30}$

Строка длиной до 31 символа, удовлетворяющая регулярному выражению, либо '1'

Выходные параметры

Параметр Значение Формат значения

response

Объект VRF

NbiVrf

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetVrf>
    <nbi:vrf>DPI</nbi:vrf>
</nbi:GetVrf>
Ответ
<ns:GetVrfResponse>
    <ns:return xsi:type="ax284:NbiVrfResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail/>
        <ax284:response xsi:type="ax284:NbiVrf">
            <ax284:port>30800</ax284:port>
            <ax284:secret>testing123</ax284:secret>
            <ax284:vrf>DPI</ax284:vrf>
        </ax284:response>
    </ns:return>
</ns:GetVrfResponse>
Код Описание ошибки

281

Параметр не должен отсутствовать или быть пустым

489

Имя VRF не соответствует принятому формату

491

VRF с таким именем не найден

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetVrfList - Получить список VRF для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда предназначена для получения списка всех VRF

Выходные параметры

Параметр Значение Формат значения

vrfArray

Массив объектов NbiVrf

NbiVrfArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetVrfList/>
Ответ
<ns:GetVrfListResponse>
    <ns:return xsi:type="ax284:NbiVrfListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail/>
        <ax284:vrfArray xsi:type="ax284:NbiVrfArray">
            <ax284:vrfs xsi:type="ax284:NbiVrf">
                <ax284:port>30799</ax284:port>
                <ax284:secret>testing123</ax284:secret>
                <ax284:vrf>DPI</ax284:vrf>
            </ax284:vrfs>
            <ax284:vrfs xsi:type="ax284:NbiVrf">
                <ax284:port>30800</ax284:port>
                <ax284:secret>testing123</ax284:secret>
                <ax284:vrf>DPI1</ax284:vrf>
            </ax284:vrfs>
        </ax284:vrfArray>
    </ns:return>
</ns:GetVrfListResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddVrf - Добавить VRF для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда предназначена для создания VRF.

Структура MongoDB-коллекции pcrf.vrf

Поле Формат значения Описание

vrf

String

Уникальный идентификатор VRF

port

int

Порт CoA

secret

String

Ключ для работы с сервером RADIUS

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

vrf

Уникальный идентификатор VRF

^[A-Za-z][A-Za-z0-9_-]{0,30}$

Строка длиной до 31 символа, удовлетворяющая регулярному выражению, либо '1'

params

Параметры VRF

NbiParameterArray

Список параметров:

  • port - Порт CoA

  • secret - Ключ для работы с сервером RADIUS

Описание формата параметров можно посмотреть в NbiVrf

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:AddVrf>
    <nbi:vrf>DPI</nbi:vrf>
    <nbi:params>
        <xsd:parameter>
            <xsd:name>port</xsd:name>
            <xsd:value>30799</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
            <xsd:name>secret</xsd:name>
            <xsd:value>testing123</xsd:value>
        </xsd:parameter>
    </nbi:params>
</nbi:AddVrf>
Ответ
<ns:AddVrfResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail/>
    </ns:return>
</ns:AddVrfResponse>
Код Описание ошибки

281

Параметр не должен отсутствовать или быть пустым

489

Имя VRF не соответствует принятому формату

490

VRF с таким именем уже содержится в БД

492

Недостаточно параметров для создания нового VRF. Необходимо: {0}

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditVrf - Редактировать VRF для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда предназначена для редактирования VRF.

  3. Команда заменяет параметры VRF, указанные в запросе. Остальные параметры данного VRF останутся неизменными.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

vrf

Уникальный идентификатор VRF

^[A-Za-z][A-Za-z0-9_-]{0,30}$

Строка длиной до 31 символа, удовлетворяющая регулярному выражению, либо '1'

params

Параметры VRF

NbiParameterArray

Список доступных параметров:

  • port - Порт CoA

  • secret - Ключ для работы с сервером RADIUS

Описание формата параметров можно посмотреть в NbiVrf

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditVrf>
    <nbi:vrf>DPI</nbi:vrf>
    <nbi:params>
        <xsd:parameter>
            <xsd:name>secret</xsd:name>
            <xsd:value>testing321</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
            <xsd:name>port</xsd:name>
            <xsd:value>30800</xsd:value>
        </xsd:parameter>
    </nbi:params>
</nbi:EditVrf>
Ответ
<ns:EditVrfResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail/>
    </ns:return>
</ns:EditVrfResponse>
Код Описание ошибки

281

Параметр не должен отсутствовать или быть пустым

489

Имя VRF не соответствует принятому формату

491

VRF с таким именем не найден

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteVrf - Удалить VRF для PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда предназначена для удаления VRF.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

vrf

Уникальный идентификатор VRF

^[A-Za-z][A-Za-z0-9_-]{0,30}$

Строка длиной до 31 символа, удовлетворяющая регулярному выражению, либо '1'

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteVrf>
    <nbi:vrf>DPI</nbi:vrf>
</nbi:DeleteVrf>
Ответ
<ns:DeleteVrfResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail/>
    </ns:return>
</ns:DeleteVrfResponse>
Код Описание ошибки

281

Параметр не должен отсутствовать или быть пустым

489

Имя VRF не соответствует принятому формату

493

Удаление VRF ''{0}'' не разрешено. VRF используется в {1} SSID’ах

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiVrf. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.18

Параметры объекта

Параметр Значение Формат значения

vrf

Уникальный идентификатор VRF

Значение соответствует регулярному выражению "^[A-Za-z][A-Za-z0-9_-]{0,30}$", либо является "1"

port

Порт CoA

Число в диапазоне [1..65535]

secret

Ключ для работы с сервером RADIUS

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiVrfArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.18

Параметры объекта

Параметр Значение Формат значения

vrfs

Массив объектов, содержащих информацию о VRF

NbiVrf

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveAPDomainTimeStatistics - Запрос статистики по "географическим" доменам ТД

Общая информация

  1. Команда актуальна, начиная с версии 1.20

  2. Команда позволяет получить статистику по аккаунтингу для "географических" доменов ТД. На вход команде подается домен или домен с поддоменами (для этого указывается точка '.' перед доменом), для которого требуется получить статистику. Результатом выполнения запроса, в случае включения поддоменов, будет oбогащенный статистическими данными домен и непосредственные дети этого домена типа 'both' или 'ap'. В ином случае - только обогащенный статистическими данными домен.

  3. В случае включения поддоменов значения статистики для домена рассчитываются как сумма соответствующих значений для этого домена и всех его поддоменов. В противном случае значения статистики рассчитываются без учета поддоменов.

  4. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен, для которого запрашивается статистика. Если домен начинается с '.', то в результат запроса включается статистика только по поддоменам первого уровня. В нее включаются только домены типа 'both' или 'ap'.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

ssid

Имя и домен SSID. Объект NbiNameDomain.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiApDomainStatistics

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveAPDomainTimeStatistics>
            <nbi:domain>.root</nbi:domain>
            <nbi:timeStart>2020-03-10T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2020-03-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:name>name</xsd:name>
                <xsd:domain>root</xsd:domain>
            </nbi:ssid>
        </nbi:RetrieveAPDomainTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveAPDomainTimeStatisticsResponse xmlns:ns="http://nbi.radius.eltex.org">
             <ns:return xsi:type="ax21:NbiCodeApDomainStatisticsResponse">
                <ax21:code>0</ax21:code>
                <ax21:detail>Success</ax21:detail>
                <ax21:response xsi:type="ax21:NbiApDomainStatisticsArray">
                   <ax21:statistics xsi:type="ax21:NbiApDomainStatistics">
                      <ax23:apCount>1</ax23:apCount>
                      <ax23:connections>902</ax23:connections>
                      <ax23:domain>root</ax23:domain>
                      <ax23:inputOctets>477626368000</ax23:inputOctets>
                      <ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
                         <ax23:apCount>1</ax23:apCount>
                         <ax23:connections>3</ax23:connections>
                         <ax23:domain>rt.root</ax23:domain>
                         <ax23:inputOctets>1572864000</ax23:inputOctets>
                         <ax23:leaf xsi:nil="true"/>
                         <ax23:lostPackets>150</ax23:lostPackets>
                         <ax23:outputOctets>3145728000</ax23:outputOctets>
                         <ax23:peakConnections xsi:nil="true"/>
                         <ax23:peakTime xsi:nil="true"/>
                         <ax23:uniqueAccount>3</ax23:uniqueAccount>
                         <ax23:uniqueMAC>3</ax23:uniqueMAC>
                      </ax23:leaf>
                      <ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
                         <ax23:apCount>1</ax23:apCount>
                         <ax23:connections>2</ax23:connections>
                         <ax23:domain>Ap.root</ax23:domain>
                         <ax23:inputOctets>4194304000</ax23:inputOctets>
                         <ax23:leaf xsi:nil="true"/>
                         <ax23:lostPackets>100</ax23:lostPackets>
                         <ax23:outputOctets>8388608000</ax23:outputOctets>
                         <ax23:peakConnections xsi:nil="true"/>
                         <ax23:peakTime xsi:nil="true"/>
                         <ax23:uniqueAccount>1</ax23:uniqueAccount>
                         <ax23:uniqueMAC>1</ax23:uniqueMAC>
                      </ax23:leaf>
                      <ax23:leaf xsi:type="ax23:NbiApDomainStatistics">
                         <ax23:apCount>0</ax23:apCount>
                         <ax23:connections>0</ax23:connections>
                         <ax23:domain>Er.root</ax23:domain>
                         <ax23:inputOctets>0</ax23:inputOctets>
                         <ax23:leaf xsi:nil="true"/>
                         <ax23:lostPackets>0</ax23:lostPackets>
                         <ax23:outputOctets>0</ax23:outputOctets>
                         <ax23:peakConnections xsi:nil="true"/>
                         <ax23:peakTime xsi:nil="true"/>
                         <ax23:uniqueAccount>0</ax23:uniqueAccount>
                         <ax23:uniqueMAC>0</ax23:uniqueMAC>
                      </ax23:leaf>
                      <ax23:lostPackets>45100</ax23:lostPackets>
                      <ax23:outputOctets>955252736000</ax23:outputOctets>
                      <ax23:peakConnections xsi:nil="true"/>
                      <ax23:peakTime xsi:nil="true"/>
                      <ax23:uniqueAccount>890</ax23:uniqueAccount>
                      <ax23:uniqueMAC>889</ax23:uniqueMAC>
                   </ax21:statistics>
                </ax21:response>
             </ns:return>
          </ns:RetrieveAPDomainTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

7

Не указан домен

8

Домен не удовлетворяет правилам FQDN

10

Пользователь не имеет прав на данный домен или домен SSID

16

SSID не существует

62

Домен для поиска или домен SSID не зарегистрирован в системе

107

Домен не удовлетворяет правилам FQDN

227

Имя SSID не удовлетворяет требованиям

281

Неверный параметр в запросе

477

Выполнение запроса заняло слишком много времени. Требуется выбрать домен нижнего уровня, с меньшим количеством точек доступа

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveNasTimeStatistics - Запрос статистики по группе точек доступа по домену

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

domain

Домен ТД.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

[multiblock cell omitted]

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

[multiblock cell omitted]

ssid

Имя и домен SSID. Объект NbiNameDomain.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiNasStatistics

[multiblock cell omitted]

Примеры команд и кодов

Код Описание ошибки

62

Домен для поиска или домен SSID не зарегистрирован в системе.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>NSK.root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-12-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain>NSK.root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such 'NSK.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Пользователь не имеет прав на данный домен или домен SSID.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-12-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>test</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>The role of the user does not have rights to this domain: 'root'. Role`s domains: 'enterprise.root'</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

33

Некорректное имя SSID
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-12-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>Сеть Wi-Fi</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>33</ax21:code>
                <ax21:detail>Incorrect SSID name</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не удовлетворяет правилам FQDN.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-12-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain></xsd:domain>
                <xsd:name>Wi-Fi</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

16

Такого SSID не существует.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-12-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>Wi-Fi</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>16</ax21:code>
                <ax21:detail>No SSID with name 'Wi-Fi[root]'</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной промежуток
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>RT.root</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2008-10-15T22:52:58+03:00</nbi:timeEnd>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Incorrect time period. Time start must be before time end.</ax21:detail>
                <ax21:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveNasTimeStatistics>
            <nbi:domain>13019013.KL.RT.root</nbi:domain>
            <nbi:timeStart>2015-12-31T23:59:59+03:00</nbi:timeStart>
            <nbi:timeEnd>2016-03-01T23:59:59+03:00</nbi:timeEnd>
        </nbi:RetrieveNasTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNasStatisticsResponse"
                xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiNasStatisticsArray">
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>0</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets xsi:nil="true"/>
                        <ax21:lostPackets>0</ax21:lostPackets>
                        <ax21:nas>192.168.208.15</ax21:nas>
                        <ax21:outputOctets xsi:nil="true"/>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>0</ax21:uniqueAccount>
                        <ax21:uniqueMAC>0</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>8104</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>2250352407</ax21:inputOctets>
                        <ax21:lostPackets>97581</ax21:lostPackets>
                        <ax21:nas>192.168.209.8</ax21:nas>
                        <ax21:outputOctets>5951744690</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>53</ax21:uniqueAccount>
                        <ax21:uniqueMAC>53</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>3119</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>855900678</ax21:inputOctets>
                        <ax21:lostPackets>20342</ax21:lostPackets>
                        <ax21:nas>192.168.209.6</ax21:nas>
                        <ax21:outputOctets>7581498387</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>31</ax21:uniqueAccount>
                        <ax21:uniqueMAC>31</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>7013</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>3060651709</ax21:inputOctets>
                        <ax21:lostPackets>136165</ax21:lostPackets>
                        <ax21:nas>192.168.209.5</ax21:nas>
                        <ax21:outputOctets>11194415480</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>9</ax21:uniqueAccount>
                        <ax21:uniqueMAC>9</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>8714</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>1267635351</ax21:inputOctets>
                        <ax21:lostPackets>88962</ax21:lostPackets>
                        <ax21:nas>192.168.208.20</ax21:nas>
                        <ax21:outputOctets>10194476147</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>57</ax21:uniqueAccount>
                        <ax21:uniqueMAC>57</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>3270</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>1242435486</ax21:inputOctets>
                        <ax21:lostPackets>85396</ax21:lostPackets>
                        <ax21:nas>192.168.208.13</ax21:nas>
                        <ax21:outputOctets>23818277852</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>22</ax21:uniqueAccount>
                        <ax21:uniqueMAC>22</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>9670</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>1315745328</ax21:inputOctets>
                        <ax21:lostPackets>150733</ax21:lostPackets>
                        <ax21:nas>192.168.209.244</ax21:nas>
                        <ax21:outputOctets>9337914504</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>27</ax21:uniqueAccount>
                        <ax21:uniqueMAC>27</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>0</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets xsi:nil="true"/>
                        <ax21:lostPackets>0</ax21:lostPackets>
                        <ax21:nas>192.168.209.10</ax21:nas>
                        <ax21:outputOctets xsi:nil="true"/>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>0</ax21:uniqueAccount>
                        <ax21:uniqueMAC>0</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>10007</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>2490055868</ax21:inputOctets>
                        <ax21:lostPackets>87514</ax21:lostPackets>
                        <ax21:nas>192.168.208.17</ax21:nas>
                        <ax21:outputOctets>9490396728</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>54</ax21:uniqueAccount>
                        <ax21:uniqueMAC>54</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>735</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>188059797</ax21:inputOctets>
                        <ax21:lostPackets>32454</ax21:lostPackets>
                        <ax21:nas>192.168.208.21</ax21:nas>
                        <ax21:outputOctets>863635061</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>51</ax21:uniqueAccount>
                        <ax21:uniqueMAC>51</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>0</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets xsi:nil="true"/>
                        <ax21:lostPackets>0</ax21:lostPackets>
                        <ax21:nas>192.168.208.243</ax21:nas>
                        <ax21:outputOctets xsi:nil="true"/>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>0</ax21:uniqueAccount>
                        <ax21:uniqueMAC>0</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>0</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets xsi:nil="true"/>
                        <ax21:lostPackets>0</ax21:lostPackets>
                        <ax21:nas>192.168.208.242</ax21:nas>
                        <ax21:outputOctets xsi:nil="true"/>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>0</ax21:uniqueAccount>
                        <ax21:uniqueMAC>0</ax21:uniqueMAC>
                    </ax21:statistics>
                    <ax21:statistics xsi:type="ax21:NbiNasStatistics">
                        <ax21:connections>1601</ax21:connections>
                        <ax21:domain>13019013.KL.RT.root</ax21:domain>
                        <ax21:inputOctets>909080809</ax21:inputOctets>
                        <ax21:lostPackets>33816</ax21:lostPackets>
                        <ax21:nas>192.168.208.245</ax21:nas>
                        <ax21:outputOctets>12248819121</ax21:outputOctets>
                        <ax21:peakConnections xsi:nil="true"/>
                        <ax21:peakTime xsi:nil="true"/>
                        <ax21:uniqueAccount>55</ax21:uniqueAccount>
                        <ax21:uniqueMAC>55</ax21:uniqueMAC>
                    </ax21:statistics>
                </ax21:response>
            </ns:return>
        </ns:RetrieveNasTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusSSIDGroupStatistics - Запрос статистики группы SSID по домену

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusSSIDStatisticsItem

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDGroupStatistics>
            <nbi:domain>Плохой@домен</nbi:domain>
            <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
            <nbi:timeEnd>2015-12-31T07:31:29</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDGroupStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDGroupStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'Плохой@домен' does not conform to the rules FQDN</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDGroupStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной период. timeStart больше timeEnd
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDGroupStatistics>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
            <nbi:timeEnd>2015-11-31T07:31:29</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDGroupStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDGroupStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Incorrect time period. Time start must be before time end.</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDGroupStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

244

Недостаточно памяти
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDGroupStatistics>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
            <nbi:timeEnd>2015-12-31T07:31:29</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDGroupStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDGroupStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>244</ax21:code>
                <ax21:detail>Out of memory. Try to alter request parameters.</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDGroupStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDGroupStatistics>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
            <nbi:timeEnd>2015-12-31T07:31:29</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDGroupStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDGroupStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDStatisticsArray">
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDStatisticsItem">
                        <ax210:activeAPs>24</ax210:activeAPs>
                        <ax210:connectionsCount>8209</ax210:connectionsCount>
                        <ax210:mBytesIn>4859571328</ax210:mBytesIn>
                        <ax210:mBytesOut>35020560065</ax210:mBytesOut>
                        <ax210:pcktsLost>243601</ax210:pcktsLost>
                        <ax210:ssidName>Eltex-Local</ax210:ssidName>
                        <ax210:summary>false</ax210:summary>
                        <ax210:uniqMacCount>103</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>82</ax210:uniqUsersCount>
                    </ax210:item>
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDStatisticsItem">
                        <ax210:activeAPs>1</ax210:activeAPs>
                        <ax210:connectionsCount>1</ax210:connectionsCount>
                        <ax210:mBytesIn>1162383</ax210:mBytesIn>
                        <ax210:mBytesOut>16624121</ax210:mBytesOut>
                        <ax210:pcktsLost>352</ax210:pcktsLost>
                        <ax210:ssidName>test_dhcp</ax210:ssidName>
                        <ax210:summary>false</ax210:summary>
                        <ax210:uniqMacCount>1</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>1</ax210:uniqUsersCount>
                    </ax210:item>
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDStatisticsItem">
                        <ax210:activeAPs>25</ax210:activeAPs>
                        <ax210:connectionsCount>8210</ax210:connectionsCount>
                        <ax210:mBytesIn>4860733711</ax210:mBytesIn>
                        <ax210:mBytesOut>35037184186</ax210:mBytesOut>
                        <ax210:pcktsLost>243953</ax210:pcktsLost>
                        <ax210:ssidName>summary</ax210:ssidName>
                        <ax210:summary>true</ax210:summary>
                        <ax210:uniqMacCount>103</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>82</ax210:uniqUsersCount>
                    </ax210:item>
                </ax210:response>
            </ns:return>
        </ns:RetrieveRadiusSSIDGroupStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusSSIDIntervalStatistics - Запрос статистики SSID разделённой по временным промежуткам

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

ssid

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

intervalLength

Продолжительность (в минутах) периода дискретизации статистики

.*

Целое число от 1 до 2147483647

[multiblock cell omitted]

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusSSIDIntervalStatisticsItem

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDIntervalStatistics>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>Плохой@домен</nbi:domain>
            <nbi:intervalLength>60</nbi:intervalLength>
            <nbi:timeStart>2015-08-03T00:00:00</nbi:timeStart>
            <nbi:timeEnd>2015-08-04T00:00:00</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDIntervalStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDIntervalStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'Плохой@домен' does not conform to the rules FQDN</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDIntervalStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

223

Некорректное значение поля intervalLength
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDIntervalStatistics>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:intervalLength>0</nbi:intervalLength>
            <nbi:timeStart>2015-08-03T00:00:00</nbi:timeStart>
            <nbi:timeEnd>2015-08-04T00:00:00</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDIntervalStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDIntervalStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>223</ax21:code>
                <ax21:detail>Time interval not specified or have incorrect value</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDIntervalStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной период. timeStart больше timeEnd
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDIntervalStatistics>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:intervalLength>60</nbi:intervalLength>
            <nbi:timeStart>2015-08-05T00:00:00</nbi:timeStart>
            <nbi:timeEnd>2015-08-04T00:00:00</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDIntervalStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDIntervalStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Incorrect time period. Time start must be before time end.</ax21:detail>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsArray"/>
            </ns:return>
        </ns:RetrieveRadiusSSIDIntervalStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusSSIDIntervalStatistics>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
            <nbi:intervalLength>60</nbi:intervalLength>
            <nbi:timeStart>2015-08-03T05:00:00</nbi:timeStart>
            <nbi:timeEnd>2015-08-03T08:00:00</nbi:timeEnd>
        </nbi:RetrieveRadiusSSIDIntervalStatistics>
    </soapenv:Body>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusSSIDIntervalStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax210:response xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsArray">
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsItem">
                        <ax210:bytesIn>0</ax210:bytesIn>
                        <ax210:bytesOut>0</ax210:bytesOut>
                        <ax210:connectionsCount>0</ax210:connectionsCount>
                        <ax210:intervalStart>2015-08-03T05:00:00.000+06:00</ax210:intervalStart>
                        <ax210:pcktsLost>0</ax210:pcktsLost>
                        <ax210:summary>false</ax210:summary>
                        <ax210:uniqMacCount>0</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>0</ax210:uniqUsersCount>
                    </ax210:item>
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsItem">
                        <ax210:bytesIn>2158000</ax210:bytesIn>
                        <ax210:bytesOut>2014706</ax210:bytesOut>
                        <ax210:connectionsCount>8</ax210:connectionsCount>
                        <ax210:intervalStart>2015-08-03T06:00:00.000+06:00</ax210:intervalStart>
                        <ax210:pcktsLost>0</ax210:pcktsLost>
                        <ax210:summary>false</ax210:summary>
                        <ax210:uniqMacCount>2</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>2</ax210:uniqUsersCount>
                    </ax210:item>
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsItem">
                        <ax210:bytesIn>95868</ax210:bytesIn>
                        <ax210:bytesOut>297031</ax210:bytesOut>
                        <ax210:connectionsCount>9</ax210:connectionsCount>
                        <ax210:intervalStart>2015-08-03T07:00:00.000+06:00</ax210:intervalStart>
                        <ax210:pcktsLost>0</ax210:pcktsLost>
                        <ax210:summary>false</ax210:summary>
                        <ax210:uniqMacCount>6</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>5</ax210:uniqUsersCount>
                    </ax210:item>
                    <ax210:item xsi:type="ax210:NbiRadiusSSIDIntervalStatisticsItem">
                        <ax210:bytesIn>2253868</ax210:bytesIn>
                        <ax210:bytesOut>2311737</ax210:bytesOut>
                        <ax210:connectionsCount>17</ax210:connectionsCount>
                        <ax210:intervalStart xsi:nil="true"/>
                        <ax210:pcktsLost>0</ax210:pcktsLost>
                        <ax210:summary>true</ax210:summary>
                        <ax210:uniqMacCount>8</ax210:uniqMacCount>
                        <ax210:uniqUsersCount>7</ax210:uniqUsersCount>
                    </ax210:item>
                </ax210:response>
            </ns:return>
        </ns:RetrieveRadiusSSIDIntervalStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetRadioState - Запрос информации по радиоинтерфейсам Wi-Fi устройства

Общая информация

  1. Команда не поддерживается, начиная с версии 1.21

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

IP

ip-адрес устройства

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

Текст с ip-адресом

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Строка

Текст xml ответа

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля IP
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetRadioState>
            <nbi:ip>192.168.40.30</nbi:ip>
        </nbi:GetRadioState>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>18</ax21:code>
                <ax21:detail>Failed to send http request: Read timed out</ax21:detail>
                <ax21:response></ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <nbi:GetRadioState>
        <nbi:ip>192.168.26.233</nbi:ip>
    </nbi:GetRadioState>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>
                    <GetRadioState>
                        <code>0</code>
                        <msg>OK</msg>
                        <radios>
                            <radio>
                               <index>Radio 1</index>
                               <Status>Up</Status>
                               <Mode>IEEE 802.11b/g/n</Mode>
                               <ChannelBandwidth>20 MHz</ChannelBandwidth>
                               <WDS>false</WDS>
                               <TxPower>10</TxPower>
                               <channel>11</channel>
                               <frequency>2462</frequency>
                            </radio>
                            <radio>
                               <index>Radio 2</index>
                               <Status>Up</Status>
                               <Mode>IEEE 802.11a/n/ac</Mode>
                               <ChannelBandwidth>20 MHz</ChannelBandwidth>
                               <WDS>false</WDS>
                               <TxPower>10</TxPower>
                               <channel>36</channel>
                               <frequency>5180</frequency>
                            </radio>
                        </radios>
                    </GetRadioState>
                </ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetRadiusCountValue - Возвращает статистику в виде вещественного числа

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда возвращает статистику в виде вещественного числа.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

apDomain

Домен точки доступа

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Начало временного интервала. Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Конец временного интервала. Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

action

Действие

TOTAL_UNIQUE_USERS_AT_RADACCT, TOTAL_UNIQUE_USERS_RETURNED, UNIQUE_MACS_AT_RADACCT, TOTAL_TRAFFIC, AVERAGE_SESSION_TRAFFIC, AVERAGE_USER_TRAFFIC_PER_HOUR, AVERAGE_USER_TRAFFIC_PER_DAY, AVERAGE_SESSION_TIME, AVERAGE_USER_TIME_PER_HOUR, AVERAGE_USER_TIME_PER_DAY, TOTAL_USER_MAYBE_RETURN, TOTAL_USER_RETURN, AVERAGE_USER_RETURN_PER_DAY

params

Список параметров

NbiParameterArray

Расшифровка значений типа действия 'action':

  • TOTAL_UNIQUE_USERS_AT_RADACCT - Уникальных пользователей. Используется параметр client_type

  • TOTAL_UNIQUE_USERS_RETURNED - Повторных пользователей. Используются параметры client_type, return_period_s

  • UNIQUE_MACS_AT_RADACCT - Уникальных MAC. Используется параметр client_type

  • TOTAL_TRAFFIC - Суммарный трафик, Б. Используются параметры client_type, traffic_type

  • AVERAGE_SESSION_TRAFFIC - Средний трафик за сессию, Б. Используются параметры client_type, traffic_type

  • AVERAGE_USER_TRAFFIC_PER_HOUR - Средний трафик пользователя в час, Б. Используются параметры client_type, traffic_type

  • AVERAGE_USER_TRAFFIC_PER_DAY - Средний трафик пользователя в день, Б. Используются параметры client_type, traffic_type

  • AVERAGE_SESSION_TIME - Средняя продолжительность сессий. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_HOUR - Среднее время пользователя в сети в час. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_DAY - Среднее время пользователя в сети в день. Используется параметр client_type

  • TOTAL_USER_MAYBE_RETURN - Всего уникальных посещений. Используются параметры client_type, return_period_s

  • TOTAL_USER_RETURN - Всего повторных пользователей. Используются параметры client_type, return_period_s

  • AVERAGE_USER_RETURN_PER_DAY - Среднее число повторных посещений в день. Используются параметры client_type, return_period_s

Список доступных имен параметров выборки 'param':

  • client_type - Тип клиента. Возможные значения: [hotspot|enterprise]

  • traffic_type - Тип трафика. Возможные значения: [in|out]

  • return_period_s - Период повторного посещения. Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

value

Double

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetRadiusCountValue>
         <nbi:apDomain>root</nbi:apDomain>
         <nbi:timeStart>2015-11-15T22:52:58+03:00</nbi:timeStart>
         <nbi:timeEnd>2017-11-15T22:52:58+03:00</nbi:timeEnd>
         <nbi:action>TOTAL_UNIQUE_USERS_AT_RADACCT</nbi:action>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>client_type</xsd:name>
               <xsd:value>enterprise</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetRadiusCountValue>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetRadiusCountValueResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiDoubleValueResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax210:value>3.0</ax210:value>
         </ns:return>
      </ns:GetRadiusCountValueResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

281

Не найден один из параметров запроса

419

Некорректный параметр запроса 'function'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetRadiusKeyValueDiagram - Возвращает статистику вида ключ-значение для показа на диаграммах и в таблицах

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда возвращает статистику вида ключ-значение для показа на диаграммах и в таблицах.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен точки доступа

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Начало временного интервала. Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Конец временного интервала. Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

action

Функция сбора статистики, обязательно.

AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK, AVERAGE_ONLINE_USERS_BY_HOUR_OF_DAY, AVERAGE_CREATED_USERS_BY_DAY_OF_WEEK, AVERAGE_UPDATED_USERS_BY_DAY_OF_WEEK, AVERAGE_CREATED_USERS_BY_HOUR_OF_DAY, AVERAGE_UPDATED_USERS_BY_HOUR_OF_DAY, TOTAL_CREATED_USERS_BY_DEV_TYPE, TOTAL_UPDATED_USERS_BY_DEV_TYPE, TOTAL_CREATED_USERS_BY_OS, TOTAL_UPDATED_USERS_BY_OS, TOTAL_CREATED_USERS_BY_BROWSER, TOTAL_UPDATED_USERS_BY_BROWSER, TOTAL_CREATED_USERS_BY_VENDOR, TOTAL_UPDATED_USERS_BY_VENDOR, TOTAL_CREATED_USERS_BY_LANGUAGE, TOTAL_UPDATED_USERS_BY_LANGUAGE, TOTAL_USER_BY_AUTH_TYPE, TOTAL_UPDATED_USER_BY_AUTH_TYPE, AVERAGE_SESSIONS_BY_DAY_OF_WEEK, AVERAGE_SESSIONS_BY_HOUR_OF_DAY, TOP_TOTAL_SESSIONS_BY_APDOMAIN, AVERAGE_SESSION_TRAFFIC_BY_DAY_OF_WEEK, AVERAGE_USER_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_SESSION_TRAFFIC_BY_HOUR_OF_DAY, AVERAGE_USER_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY, AVERAGE_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY, AVERAGE_SESSION_TIME_BY_DAY_OF_WEEK, AVERAGE_USER_TIME_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_SESSION_TIME_BY_HOUR_OF_DAY, AVERAGE_USER_TIME_PER_HOUR_BY_HOUR_OF_DAY, TOP_TOTAL_SESSION_TRAFFIC_BY_APDOMAIN, AVERAGE_USER_RETURN_BY_DAY_OF_WEEK, AVERAGE_USER_RETURN_BY_HOUR_OF_DAY, USER_RETURN_COUNT_STAT, TOP_TOTAL_USER_RETURN_BY_APDOMAIN

params

Параметры статистики, обязательно.

NbiParameterArray

Расшифровка значений типа действия 'action':

  • AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK - Среднее число пользователей онлайн по дням недели. Используется параметр client_type

  • AVERAGE_ONLINE_USERS_BY_HOUR_OF_DAY - Среднее число пользователей онлайн по часам суток. Используется параметр client_type

  • AVERAGE_CREATED_USERS_BY_DAY_OF_WEEK - Среднее число новых пользователей по дням недели. Используется параметр client_type

  • AVERAGE_UPDATED_USERS_BY_DAY_OF_WEEK - Среднее число обновленных пользователей по дням недели. Используется параметр client_type

  • AVERAGE_CREATED_USERS_BY_HOUR_OF_DAY - Среднее число новых пользователей по часам суток. Используется параметр client_type

  • AVERAGE_UPDATED_USERS_BY_HOUR_OF_DAY - Среднее число обновленных пользователей по часам суток. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_DEV_TYPE - Статистика по типам устройств, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_DEV_TYPE - Статистика по типам устройств, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_OS - Статистика по ОС, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_OS - Статистика по ОС, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_BROWSER - Статистика по браузерам, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_BROWSER - Статистика по браузерам, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_VENDOR - Статистика по производителям устройств, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_VENDOR - Статистика по производителям устройств, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_LANGUAGE - Статистика по выбранному на портале языку, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_LANGUAGE - Статистика по выбранному на портале языку, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_USER_BY_AUTH_TYPE - Статистика по типу аутентификации. Используется параметр client_type

  • TOTAL_UPDATED_USER_BY_AUTH_TYPE - Статистика по типу аутентификации, по дате обновления пользователя. Используется параметр client_type

  • AVERAGE_SESSIONS_BY_DAY_OF_WEEK - Среднее число сессий по дням недели. Используется параметр client_type

  • AVERAGE_SESSIONS_BY_HOUR_OF_DAY - Среднее число сессий по часам суток. Используется параметр client_type

  • TOP_TOTAL_SESSIONS_BY_APDOMAIN - Топ площадок по числу сессий. Используется параметр client_type

  • AVERAGE_SESSION_TRAFFIC_BY_DAY_OF_WEEK - Средний трафик за сессию по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK - Средний трафик пользователя по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK - Средний суммарный трафик по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_SESSION_TRAFFIC_BY_HOUR_OF_DAY - Средний трафик за сессию по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY - Средний трафик пользователя по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY - Средний суммарный трафик по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_SESSION_TIME_BY_DAY_OF_WEEK - Средняя продолжительность сессии по дням старта сессии. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_DAY_BY_DAY_OF_WEEK - Среднее время пользователя в сети по дням старта сессии. Используется параметр client_type

  • AVERAGE_SESSION_TIME_BY_HOUR_OF_DAY - Средняя продолжительность сессии по часам старта сессии. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_HOUR_BY_HOUR_OF_DAY - Среднее время пользователя в сети по часам старта сессии. Используется параметр client_type

  • TOP_TOTAL_SESSION_TRAFFIC_BY_APDOMAIN - Топ площадок по суммарному трафику, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_RETURN_BY_DAY_OF_WEEK - Среднее число повторных по дням недели. Используются параметры client_type и return_period_s

  • AVERAGE_USER_RETURN_BY_HOUR_OF_DAY - Среднее число повторных по часам суток. Используются параметры client_type и return_period_s

  • USER_RETURN_COUNT_STAT - Статистика по числу повторных посещений. Используются параметры client_type и return_period_s

  • TOP_TOTAL_USER_RETURN_BY_APDOMAIN - Топ площадок по числу повторных посещений. Используются параметры client_type и return_period_s

Список доступных имен параметров выборки 'param':

  • client_type - Тип клиента. Возможные значения: [hotspot|enterprise]

  • traffic_type - Тип трафика. Возможные значения: [in|out]

  • return_period_s - Период повторного посещения. Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

array

Объект NbiRadiusItemGraphArray со списком запрошенных величин

NbiRadiusItemGraphArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetRadiusKeyValueDiagram>
         <nbi:domain>root</nbi:domain>
         <nbi:timeStart>2015-11-15T22:52:58+03:00</nbi:timeStart>
         <nbi:timeEnd>2017-11-15T22:52:58+03:00</nbi:timeEnd>
         <nbi:action>AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK</nbi:action>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>client_type</xsd:name>
               <xsd:value>enterprise</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetRadiusKeyValueDiagram>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetRadiusKeyValueDiagramResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiGraphItemResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax216:array xsi:type="ax21:NbiRadiusItemGraphArray">
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>1</ax21:name>
                  <ax21:value>1.0</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>2</ax21:name>
                  <ax21:value>9.2857</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>3</ax21:name>
                  <ax21:value>11.8333</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>4</ax21:name>
                  <ax21:value>10.4286</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>5</ax21:name>
                  <ax21:value>9.1429</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>6</ax21:name>
                  <ax21:value>7.7143</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>7</ax21:name>
                  <ax21:value>2.5</ax21:value>
               </ax21:item>
            </ax216:array>
         </ns:return>
      </ns:GetRadiusKeyValueDiagramResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

281

Не найден один из параметров запроса

419

Некорректный параметр запроса 'action'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveApInfo - Запрос общей информации по Wi-Fi устройствам

Общая информация

  1. Команда не поддерживается начиная с версии 1.20

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

Фильтр по доменам. Допускается задавать несколько доменов, разделенных запятыми.

.*

Любой текст

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

Имя поля, по которому будет выполняться сортировка

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

filters

Список фильтров, применяемых к результату операции

Объект NbiParameterArray

deviceType

Тип устройства

.*

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Строка

Текст xml ответа

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domains
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>wrong@domain</nbi:domains>
            <nbi:filters></nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>name</nbi:orderBy>
            <nbi:orderType>ACS</nbi:orderType>
            <nbi:deviceType>dev/wifi/ap</nbi:deviceType>
        </nbi:RetrieveApInfo>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:NbiCodeResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'wrong@domain' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:NbiCodeResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

408

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть невложенными.
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>235000047535.VL.RT.root, .VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType></nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>408</ax21:code>
                <ax21:detail>All domains from list should be unnested</ax21:detail>
                <ax21:response/>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

407

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть вложенными
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>.235000047535.VL.RT.root, VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType></nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>407</ax21:code>
                <ax21:detail>All domains from list should be nested</ax21:detail>
                <ax21:response/>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApInfo>
            <nbi:domains>.VL.RT.root</nbi:domains>
            <nbi:filters>
                <xsd:parameter>
                    <xsd:name></xsd:name>
                    <xsd:value></xsd:value>
                </xsd:parameter>
            </nbi:filters>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
            <nbi:deviceType>dev/wifi/ap/eltex/wep/-12ac</nbi:deviceType>
            <nbi:locale></nbi:locale>
        </nbi:RetrieveApInfo>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveApInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax23:code>0</ax23:code>
                <ax23:detail/>
                <ax23:response>
                    <![CDATA[
                    <?xml version="1.0" encoding="UTF-8"?><getDeviceList><code>0</code><msg>OK</msg><total>1</total><devices><device><name>192.168.26.223</name><ip>192.168.26.223</ip><type>dev/wifi/ap/eltex/wep/-12ac</type><typeName>WEP-12ac</typeName><domain>12036628.VL.RT.root</domain><state>Пользователи: 1. Принято 998.6 KB, передано 105.7 MB. Скорость средняя 2.0 Kb/s, суммарная 2.0 Kb/s. (27.01.17 10:00)</state><workTime>93433</workTime><fwVersion>1.10.0.81</fwVersion><mac>a8:f9:4b:1f:fc:80</mac><initAddress></initAddress><actNumber></actNumber><users>1</users><recieved>998.6 KB</recieved><transmitted>105.7 MB</transmitted><avgrate>2.0 Kb/s</avgrate><sum>2.0 Kb/s</sum><date>27.01.17 10:00</date></device></devices></getDeviceList>]]>
                </ax23:response>
            </ns:return>
        </ns:RetrieveApInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserAccountsTimeStatistics - Запрос статистики по учетным записям Wi-Fi клиентов по временному интервалу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Фильтр по логину аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любой текст

Wi-Fi пользователь

domain

Фильтр по домену аккаунта Wi-Fi пользователя. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). Если домен начинается с символа '.' и не использует специальных символов, то статистика будет по всем УЗ для данного домена и его поддоменов.

.*

Любой текст

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

count

Кол-во выводимых элементов, обязательно. По запросу count = 0 выдается кол-во всех записей

[0-9]+$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

^(username|domain)$

username или domain

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiAccountStatistics. Поля inputPacketsDrop, outputPacketsDrop, inputBytesDrop, outputBytesDrop, mac не используются.

Примеры команд и кодов

Код Описание ошибки

114

Указано некорректное поле сортировки
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>?</nbi:username>
            <nbi:domain>?</nbi:domain>
            <nbi:timeStart></nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>10</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>?</nbi:orderBy>
            <nbi:orderType>?</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax213:NbiCodeAccountsStatisticsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>114</ax21:code>
                <ax21:detail>Incorrect value of orderBy</ax21:detail>
                <ax213:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной промежуток
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart>2008-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2007-11-15T22:52:58+03:00</nbi:timeEnd>
            <nbi:count>100</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy>username</nbi:orderBy>
            <nbi:orderType>ASC</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax213:NbiCodeAccountsStatisticsResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Time start must be before time end.</ax21:detail>
                <ax213:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountsTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>10</nbi:count>
            <nbi:page>22</nbi:page>
            <nbi:orderBy>username</nbi:orderBy>
            <nbi:orderType>ASC</nbi:orderType>
        </nbi:RetrieveRadiusUserAccountsTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountsTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax219:NbiCodeAccountsStatisticsResponse"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax219:response xsi:type="ax219:NbiAccountStatisticsArray">
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets xsi:nil="true"/>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop xsi:nil="true"/>
                        <ax219:outputOctets xsi:nil="true"/>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime xsi:nil="true"/>
                        <ax219:sessionsCount>0</ax219:sessionsCount>
                        <ax219:username>79003544789</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>8387662</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>7814</ax219:outputBytesDrop>
                        <ax219:outputOctets>50492311</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>2732</ax219:sessionTime>
                        <ax219:sessionsCount>5</ax219:sessionsCount>
                        <ax219:username>79003545038</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>7999383</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>209</ax219:outputBytesDrop>
                        <ax219:outputOctets>19461643</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>4951</ax219:sessionTime>
                        <ax219:sessionsCount>9</ax219:sessionsCount>
                        <ax219:username>79003545385</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>1814531</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>43577689</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>531</ax219:sessionTime>
                        <ax219:sessionsCount>4</ax219:sessionsCount>
                        <ax219:username>79003545920</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>73487</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>393558</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>670</ax219:sessionTime>
                        <ax219:sessionsCount>2</ax219:sessionsCount>
                        <ax219:username>79003546820</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>7493754</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>126517821</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>1323</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003548237</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>6401792</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>3185</ax219:outputBytesDrop>
                        <ax219:outputOctets>125952405</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>1710</ax219:sessionTime>
                        <ax219:sessionsCount>3</ax219:sessionsCount>
                        <ax219:username>79003548433</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>4717269</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>2</ax219:outputBytesDrop>
                        <ax219:outputOctets>61893344</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>913</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003548495</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>11439846</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>883</ax219:outputBytesDrop>
                        <ax219:outputOctets>197535662</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>8007</ax219:sessionTime>
                        <ax219:sessionsCount>154</ax219:sessionsCount>
                        <ax219:username>79003549631</ax219:username>
                    </ax219:account>
                    <ax219:account xsi:type="ax219:NbiAccountStatistics">
                        <ax219:domain>guest.13019013.KL.RT.root</ax219:domain>
                        <ax219:inputBytesDrop xsi:nil="true"/>
                        <ax219:inputOctets>1677636</ax219:inputOctets>
                        <ax219:inputPacketsDrop xsi:nil="true"/>
                        <ax219:mac xsi:nil="true"/>
                        <ax219:outputBytesDrop>0</ax219:outputBytesDrop>
                        <ax219:outputOctets>52415616</ax219:outputOctets>
                        <ax219:outputPacketLost xsi:nil="true"/>
                        <ax219:outputPacketsDrop xsi:nil="true"/>
                        <ax219:sessionTime>810</ax219:sessionTime>
                        <ax219:sessionsCount>1</ax219:sessionsCount>
                        <ax219:username>79003549722</ax219:username>
                    </ax219:account>
                    <ax219:summaryInputBytesDrop xsi:nil="true"/>
                    <ax219:summaryInputOctets xsi:nil="true"/>
                    <ax219:summaryInputPacketsDrop xsi:nil="true"/>
                    <ax219:summaryOutputBytesDrop xsi:nil="true"/>
                    <ax219:summaryOutputOctets xsi:nil="true"/>
                    <ax219:summaryOutputPacketLost xsi:nil="true"/>
                    <ax219:summaryOutputPacketsDrop xsi:nil="true"/>
                    <ax219:summarySessionCount xsi:nil="true"/>
                    <ax219:summarySessionTime xsi:nil="true"/>
                    <ax219:totalCount>0</ax219:totalCount>
                </ax219:response>
            </ns:return>
        </ns:RetrieveRadiusUserAccountsTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountsTimeStatistics>
            <nbi:username>%</nbi:username>
            <nbi:domain>%</nbi:domain>
            <nbi:timeStart></nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
            <nbi:count>0</nbi:count>
            <nbi:page>1</nbi:page>
            <nbi:orderBy></nbi:orderBy>
            <nbi:orderType></nbi:orderType>
        </nbi:RetrieveRadiusUserAccountsTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveRadiusUserAccountsTimeStatisticsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax224:NbiCodeAccountsStatisticsResponse"
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax224:response xsi:type="ax224:NbiAccountStatisticsArray">
               <ax224:account xsi:nil="true"/>
               <ax224:summaryInputBytesDrop xsi:nil="true"/>
               <ax224:summaryInputOctets xsi:nil="true"/>
               <ax224:summaryInputPacketsDrop xsi:nil="true"/>
               <ax224:summaryOutputBytesDrop xsi:nil="true"/>
               <ax224:summaryOutputOctets xsi:nil="true"/>
               <ax224:summaryOutputPacketLost xsi:nil="true"/>
               <ax224:summaryOutputPacketsDrop xsi:nil="true"/>
               <ax224:summarySessionCount xsi:nil="true"/>
               <ax224:summarySessionTime xsi:nil="true"/>
               <ax224:totalCount>123</ax224:totalCount>
            </ax224:response>
         </ns:return>
      </ns:RetrieveRadiusUserAccountsTimeStatisticsResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserAccountTimeStatistics - Запрос статистики по учетной записи Wi-Fi клиента по временному интервалу

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Логин аккаунта Wi-Fi пользователя.

^.{1,64}$

Текст до 64-х символов

Wi-Fi пользователь

domain

Домен аккаунта Wi-Fi пользователя.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiAccountStatistics. Поля inputPacketsDrop, inputBytesDrop, outputBytesDrop не используются.

Примеры команд и кодов

Код Описание ошибки

20

Некорректный логин аккаунта
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>???</nbi:username>
            <nbi:domain>guest.13019013.KL.RT.root</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>20</ax21:code>
                <ax21:detail>Incorrect username</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Некорректный домен аккаунта
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>??</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain '??' does not conform to the rules FQDN</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Данный домен не зарегистрирован в системе ELTEX_EMS
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>ru</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'ru' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

У пользователя нет прав на просмотр аккаунта из данного домена
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

11

Аккаунта с таким логином и доменом не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>11</ax21:code>
                <ax21:detail>No such RADIUS user '79003545038' [ 'root' ]</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

107

Некорректный временной промежуток
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>guest.13019013.KL.RT.root</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd>2014-10-15T22:52:58+03:00</nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>107</ax21:code>
                <ax21:detail>Time start must be before time end.</ax21:detail>
                <ax26:response xsi:nil="true"/>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRadiusUserAccountTimeStatistics>
            <nbi:username>79003545038</nbi:username>
            <nbi:domain>guest.13019013.KL.RT.root</nbi:domain>
            <nbi:timeStart>2014-11-15T22:52:58+03:00</nbi:timeStart>
            <nbi:timeEnd></nbi:timeEnd>
        </nbi:RetrieveRadiusUserAccountTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserAccountTimeStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax26:NbiCodeAccountStatisticsResponse"
                xmlns:ax215="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax212="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax221="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax218="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax26:response xsi:type="ax26:NbiAccountStatistics">
                    <ax26:domain>guest.13019013.KL.RT.root</ax26:domain>
                    <ax26:inputBytesDrop xsi:nil="true"/>
                    <ax26:inputOctets>8387662</ax26:inputOctets>
                    <ax26:inputPacketsDrop xsi:nil="true"/>
                    <ax26:mac>D8-55-A3-D7-AB-65</ax26:mac>
                    <ax26:mac>A0-8D-16-77-B4-5B</ax26:mac>
                    <ax26:outputBytesDrop>7814</ax26:outputBytesDrop>
                    <ax26:outputOctets>50492311</ax26:outputOctets>
                    <ax26:outputPacketLost xsi:nil="true"/>
                    <ax26:outputPacketsDrop xsi:nil="true"/>
                    <ax26:sessionTime>2732</ax26:sessionTime>
                    <ax26:sessionsCount>5</ax26:sessionsCount>
                    <ax26:username>79003545038</ax26:username>
                </ax26:response>
            </ns:return>
        </ns:RetrieveRadiusUserAccountTimeStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveOnlineUsersCount - Запрос количества пользователей онлайн

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

ssid

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект BigInteger

Целое число

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveOnlineUsersCount>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>bad@domain</nbi:domain>
        </nbi:RetrieveOnlineUsersCount>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveOnlineUsersCountResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeOneBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'bad@domain' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:RetrieveOnlineUsersCountResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveOnlineUsersCount>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
        </nbi:RetrieveOnlineUsersCount>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveOnlineUsersCountResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeOneBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>22</ax21:response>
            </ns:return>
        </ns:RetrieveOnlineUsersCountResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTodayDownstreamTraffic - Запрос трафика в downstream за сегодняшний день

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Входные параметры

ssid

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект BigInteger

Целое число

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTodayDownstreamTraffic>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>bad@domain</nbi:domain>
        </nbi:RetrieveTodayDownstreamTraffic>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayDownstreamTrafficResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeOneBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'bad@domain' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:RetrieveTodayDownstreamTrafficResponse>
    </soapenv:Body>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTodayDownstreamTraffic>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
        </nbi:RetrieveTodayDownstreamTraffic>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayDownstreamTrafficResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeOneBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>4772338596</ax21:response>
            </ns:return>
        </ns:RetrieveTodayDownstreamTrafficResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTodayNewUsersCount - Запрос количества новых пользователей за сегодня

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

ssid

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект BigInteger

Целое число

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTodayNewUsersCount>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise@root</nbi:domain>
        </nbi:RetrieveTodayNewUsersCount>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayNewUsersCountResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'enterprise@root' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:RetrieveTodayNewUsersCountResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Header/>
<soapenv:Body>
    <nbi:RetrieveTodayNewUsersCount>
        <nbi:ssid>Eltex-Local</nbi:ssid>
        <nbi:domain>enterprise.root</nbi:domain>
    </nbi:RetrieveTodayNewUsersCount>
</soapenv:Body>undefined</soapenv:Envelope>
Ответ
<soapenv:Body>
    <ns:RetrieveTodayNewUsersCountResponse
        xmlns:ns="http://nbi.radius.eltex.org">
        <ns:return xsi:type="ax22:NbiCodeBigIntegerResponse"
            xmlns:ax212="http://request.object.nbi.radius.eltex.org/xsd"
            xmlns:ax29="http://object.nbi.radius.eltex.org/xsd"
            xmlns:ax26="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
            xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd"
            xmlns:ax21="http://authService.object.nbi.radius.eltex.org/xsd"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response>9</ax22:response>
        </ns:return>
    </ns:RetrieveTodayNewUsersCountResponse>
</soapenv:Body>undefined</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTodayUsersCount - Запрос количества пользователей за сегодня

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

ssid

Имя SSID. Уникальность SSID определяется по имени и домену.

Имя SSID

domain

Домен SSID.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект BigInteger

Целое число

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domain
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTodayUsersCount>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>wrong@domain</nbi:domain>
        </nbi:RetrieveTodayUsersCount>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayUsersCountResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain 'wrong@domain' does not conform to the rules FQDN</ax21:detail>
                <ax21:response>0</ax21:response>
            </ns:return>
        </ns:RetrieveTodayUsersCountResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTodayUsersCount>
            <nbi:ssid>Eltex-Local</nbi:ssid>
            <nbi:domain>enterprise.root</nbi:domain>
        </nbi:RetrieveTodayUsersCount>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayUsersCountResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeBigIntegerResponse"
                xmlns:ax28="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>33</ax21:response>
            </ns:return>
        </ns:RetrieveTodayUsersCountResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveAPListExtended - Запрос списка ТД с информацией по SSID

Общая информация

  1. Команда не поддерживается, начиная с версии 1.21

  2. В версии 1.10 команда больше не используется для получения Списка ТД в ЛК. Для обеспечения работоспособности на большом числе точек данные перенесены в БД MySQL eltex_ems.ELTEX_OBJ_GEO, а для выборки добавлена новая команда GetGeoObjectsList.

  3. При обработке запроса NBI обращается в EMS-NBI по URL 'getAPListExtended'.

  4. Использовать команду стоит только в случае крайней необходимости получить оперативные данные EMS, например, состав активных SSID на точке.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

Фильтр по доменам. Допускается задавать несколько доменов, разделенных запятыми.

.*

Любой текст

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

Имя поля, по которому будет выполняться сортировка

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

filters

Список фильтров, применяемых к результату операции

Объект NbiParameterArray

requestSSIDs

Запрашивать или нет списки SSID ТД

true/false

Текст 'true' или 'false'

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiApInfo

Примеры команд и кодов

Код Описание ошибки

8

Некорректное значение поля domains
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>wrong@domaint</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>8</ax22:code>
            <ax22:detail>Domain 'wrong@domaint' does not conform to the rules FQDN</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

408

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть невложенными.
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>235000047535.VL.RT.root, .VL.RT.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>408</ax22:code>
            <ax22:detail>All domains from list should be unnested</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

407

Некорректный формат задания доменов. Формат определяется первым доменом из списка. Все домены в списке должны быть вложенными
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>.235000047535.VL.RT.root, VL.RT.root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>407</ax22:code>
            <ax22:detail>All domains from list should be nested</ax22:detail>
            <ax220:infos xsi:nil="true"/>
            <ax220:totalCount>0</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveApListExtended>
         <nbi:domains>root</nbi:domains>
         <nbi:filters>
         </nbi:filters>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>?</nbi:orderBy>
         <nbi:orderType>?</nbi:orderType>
         <nbi:locale>?</nbi:locale>
      </nbi:RetrieveApListExtended>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:RetrieveApListExtendedResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax220:NbiApListExtendedResponse" xmlns:ax229="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax217="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax226="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax223="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax234="http://object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax220="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax220:infos xsi:type="ax220:NbiApInfoArray">
               <ax220:infos xsi:type="ax220:NbiApInfo">
                  <ax220:actNumber xsi:nil="true"/>
                  <ax220:building xsi:nil="true"/>
                  <ax220:city xsi:nil="true"/>
                  <ax220:domain xsi:nil="true"/>
                  <ax220:floor xsi:nil="true"/>
                  <ax220:fullName xsi:nil="true"/>
                  <ax220:fwVersion xsi:nil="true"/>
                  <ax220:house xsi:nil="true"/>
                  <ax220:ip>192.168.0.9</ax220:ip>
                  <ax220:mac xsi:nil="true"/>
                  <ax220:name>wep-fake</ax220:name>
                  <ax220:office xsi:nil="true"/>
                  <ax220:ssids xsi:type="ax220:NbiApSSIDInfoArray"/>
                  <ax220:state>Данные не получены. Устройство недоступно с 14.02.2017 19:13:01!</ax220:state>
                  <ax220:street xsi:nil="true"/>
                  <ax220:type>dev/wifi/ap/eltex/wep/-12ac</ax220:type>
                  <ax220:workTime>0</ax220:workTime>
               </ax220:infos>
               <ax220:infos xsi:type="ax220:NbiApInfo">
                  <ax220:actNumber xsi:nil="true"/>
                  <ax220:building>1</ax220:building>
                  <ax220:city>Городище</ax220:city>
                  <ax220:domain xsi:nil="true"/>
                  <ax220:floor>5</ax220:floor>
                  <ax220:fullName>Иванов Иван Иваныч</ax220:fullName>
                  <ax220:fwVersion>1.10.0.110</ax220:fwVersion>
                  <ax220:house>75</ax220:house>
                  <ax220:ip>192.168.15.7</ax220:ip>
                  <ax220:mac>a8:f9:4b:b0:21:60</ax220:mac>
                  <ax220:name>wep-15.7</ax220:name>
                  <ax220:office>501</ax220:office>
                  <ax220:ssids xsi:type="ax220:NbiApSSIDInfoArray">
                     <ax220:SSIDs xsi:type="ax220:NbiApSSIDInfo">
                        <ax220:domain>root</ax220:domain>
                        <ax220:name>_15.7__open</ax220:name>
                        <ax220:portalName>eltex</ax220:portalName>
                        <ax220:portalTariffs>test_port@root,123@root,321@12.root,222@12.root,1112@223.12.root,test_ru@root,test_sdd213@root,12.root@12.root</ax220:portalTariffs>
                        <ax220:security>plainText</ax220:security>
                     </ax220:SSIDs>
                     <ax220:SSIDs xsi:type="ax220:NbiApSSIDInfo">
                        <ax220:domain>root</ax220:domain>
                        <ax220:name>_15.7__enter_5_1</ax220:name>
                        <ax220:portalName xsi:nil="true"/>
                        <ax220:portalTariffs/>
                        <ax220:security>wpaEnterprise</ax220:security>
                     </ax220:SSIDs>
                  </ax220:ssids>
                  <ax220:state>Пользователи: 0. Принято 1,9 GB, передано 2,3 GB. Скорость средняя 0b/s, суммарная 0b/s. (16.02.2017 10:00:00)</ax220:state>
                  <ax220:street>Улицыще</ax220:street>
                  <ax220:type>dev/wifi/ap/eltex/wep/-12ac</ax220:type>
                  <ax220:workTime>1113062</ax220:workTime>
               </ax220:infos>
            </ax220:infos>
            <ax220:totalCount>-1</ax220:totalCount>
         </ns:return>
      </ns:RetrieveApListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

  1. GetGeoObjectsList - Получить список объектов для вкладки Список ТД

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUsersStatCounters - Получить статистические показатели по пользователям wi-fi по таблице radstat

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

домен

categories

категории пользователя в системе SOftWLC

enterprise, hotspot, voucher, bras, service, voucher_bras

Выходные параметры

Параметр Значение Формат значения

response

Объект с показателями статистики по пользователям

NbiRadiusUsersStatCounters

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveRadiusUsersStatCounters>
         <nbi:domain>root</nbi:domain>
         <nbi:categories>hotspot</nbi:categories>
      </nbi:RetrieveRadiusUsersStatCounters>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveRadiusUsersStatCountersResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax23:response xsi:type="ax23:NbiRadiusUsersStatCounters">
               <ax23:addedTodayCount>0</ax23:addedTodayCount>
               <ax23:totalCount>12</ax23:totalCount>
            </ax23:response>
         </ns:return>
      </ns:RetrieveRadiusUsersStatCountersResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр пользователя 'domain'

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetPcrfSessionsStat - Статистика по сессиям на BRAS/PCRF

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда добавлена для отображения открытых на BRAS/PCRF сессиях согласно данным из MongoDB pcrf.session.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

type

Типы сессий

total_stored,
expired,
closed_await_delete,
rejected,
accepted,
active,
opened

param

Параметры выборки

NbiParameter

Расшифровка значений типа сессии 'type':

  • total_stored - всего сессий в БД;

  • expired - сессии, время которых (session_timeout) с момента авторизации (auth_date) уже истекло;

  • closed_await_delete - закрытые сессий (stop_date уже известна); сохранены в БД на небольшой срок только для возможности обработать связанный аккаунтинг;

  • rejected - сессии, получившие reject (auth_status = 2) при попытке авторизации;

  • accepted - сессии, получившие accept (auth_status = 1) при авторизации;

  • active - активные сессии (auth_status = 1, stop_date = null);

  • opened - открытые сессии, на которых еще не было попытки авторизации (auth_status = null или auth_status = 0).

Список доступных имен параметров выборки 'param':

  • ap_domain - домен ТД;

  • ap_id - идентификатор ТД;

  • ssid_name - имя SSID;

  • user_name - имя пользователя, используемое при авторизации;

  • user_domain - домен пользователя;

  • nas_ip - IP адрес ESR, обслуживающего сессию;

  • mac - MAC адрес абонента в формате aa:00:99:00:00:ff;

  • tariff - имя тарифа;

  • tariff_domain - домен тарифа;

  • ignore_empty_domain = true - игнорировать отсутствие фильтра ap_domain и не заполнять его значением из роли.

Выходные параметры

Параметр Значение Формат значения

array

Количество сессий по каждому запрошенному типу

NbiRadiusItemGraphArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetPcrfSessionsStat>
         <nbi:type>active</nbi:type>
         <nbi:type>opened</nbi:type>
         <nbi:param>
            <xsd:name>ap_domain</xsd:name>
            <xsd:value>.root</xsd:value>
         </nbi:param>
         <nbi:param>
            <xsd:name>ssid_name</xsd:name>
            <xsd:value>TEST</xsd:value>
         </nbi:param>
      </nbi:GetPcrfSessionsStat>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetPcrfSessionsStatResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax221:array>
               <ax21:item>
                  <ax21:name>active</ax21:name>
                  <ax21:value>10.0</ax21:value>
               </ax21:item>
               <ax21:item>
                  <ax21:name>opened</ax21:name>
                  <ax21:value>20.0</ax21:value>
               </ax21:item>
            </ax221:array>
         </ns:return>
      </ns:GetPcrfSessionsStatResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Нет прав на указанный в списке ключей домен

37

Недопустимые значения параметров из списков 'type', 'param'

281

Недопустимые имена параметров 'type', 'param'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTimeStatistic - Запрос статистики для отображения на графике или в таблице

Общая информация

  1. Команда актуальна, начиная с версии 1.3.

  2. Команда служит для получения статистики, отображаемой на графике или в таблице.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

function

Типы статистики

SESSTIME_RADIUS_STAT, TRAFFIC_RADIUS_STAT, TRAFFIC_RADIUS_STAT_DASHBOARD, TRAFFIC_RADIUS_STAT_DASHBOARD_STRICT, USER_RADIUS_STAT, USER_RADIUS_PRESENT, CLIENT_RADIUS_PRESENT, COMMON_RADIUS_STATISTIC, TOTAL_ONLINE_USERS_TIME_STAT, TOTAL_CREATED_USERS_TIME_STAT, TOTAL_UPDATED_USERS_TIME_STAT, TOTAL_SESSION_TIME_STAT, TOTAL_TRAFFIC_TIME_STAT, TOTAL_USER_RETURN_TIME_STAT, TOTAL_AUTH_TYPE_TIME_STAT

params

Параметры выборки

NbiParameterArray

locale

Локаль

"ru", "ru_RU", "en", "en_GB" …​

Текст произвольной длины

Расшифровка значений типа функции 'function':

  • SESSTIME_RADIUS_STAT - Статистика продолжительности сесcий. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT - Статистика пользовательского трафика. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT_DASHBOARD - Статистика трафика с укороченными названями рядов и без учёта неавторизованных пользователей для отображения в dashboard. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TRAFFIC_RADIUS_STAT_DASHBOARD_STRICT - Статистика трафика с укороченными названями рядов и без учёта неавторизованных пользователей для отображения в dashboard. Возвращается трафик точно в указанных временнЫх границах.. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • USER_RADIUS_STAT - Статистика количества подключений. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • USER_RADIUS_PRESENT - Статистика количества пользователей. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • CLIENT_RADIUS_PRESENT - Статистика количества клиентов. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • COMMON_RADIUS_STATISTIC - Статистика количества пользовательских устройств. Используются параметры: filter_ssid, filter_user, filter_nas_ip, filter_ap_domain, filter_ap_id.

  • TOTAL_ONLINE_USERS_TIME_STAT - Всего пользователей онлайн. Используются параметры: filter_ap_domain, client_type.

  • TOTAL_CREATED_USERS_TIME_STAT - Всего новых пользователей. Используются параметры: filter_ap_domain, client_type.

  • TOTAL_UPDATED_USERS_TIME_STAT - Всего обновленных пользователей. Используются параметры: filter_ap_domain, client_type.

  • TOTAL_SESSION_TIME_STAT - Суммарно сессий. Используются параметры: filter_ap_domain, client_type.

  • TOTAL_TRAFFIC_TIME_STAT - Суммарный трафик, Б. Используются параметры: filter_ap_domain, client_type, traffic_type.

  • TOTAL_USER_RETURN_TIME_STAT - Всего повторных пользователей. Используются параметры: filter_ap_domain, client_type, return_period_s.

  • TOTAL_AUTH_TYPE_TIME_STAT - Статистика по типам авторизации из radstat. Используются параметры: filter_ap_domain, client_type.

Список доступных имен параметров выборки 'param':

  • from - Время начала сбора статистики в формате «yyyy-MM-dd HH:mm:ss».

  • to - Время окончания сбора статистики в формате «yyyy-MM-dd HH:mm:ss».

  • step - Шаг графика.

  • filter_ssid - Имя SSID-а.

  • filter_user - Имя пользователя.

  • filter_nas_ip - IP-адрес NAS.

  • filter_ap_domain - Домен точки доступа.

  • filter_ap_id - Идентификатор точки доступа.

  • client_type - Тип клиента. Возможные значения: [hotspot|enterprise]

  • traffic_type - Тип трафика. Возможные значения: [in|out]

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiRadiusStatisticArray

NbiRadiusStatisticArray

statistic

Текстовое представление статистики

String

title

Описание собранной статистики

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveTimeStatistic>
                 <nbi:function>SESSTIME_RADIUS_STAT</nbi:function>
                 <nbi:params>
                    <xsd:parameter>
                       <xsd:name>from</xsd:name>
                       <xsd:value>2015-12-24 07:31:28</xsd:value>
                    </xsd:parameter>
                    <xsd:parameter>
                       <xsd:name>to</xsd:name>
                       <xsd:value>2017-12-31 07:31:29</xsd:value>
                    </xsd:parameter>
                 </nbi:params>
                 <nbi:locale>ru_RU</nbi:locale>
              </nbi:RetrieveTimeStatistic>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTimeStatisticResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeRadiusTimeStatisticResponce"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiRadiusStatisticArray">
                   <ax21:item xsi:type="ax21:NbiRadiusStatisticItemArray">
                      <ax21:item xsi:type="ax21:NbiRadiusItemGraphArray">
                         <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                            <ax21:name>Среднее время сессии, сек</ax21:name>
                            <ax21:value>0.0</ax21:value>
                         </ax21:item>
                      </ax21:item>
                      <ax21:time>1450917088000</ax21:time>
                   </ax21:item>
                   <ax21:item xsi:type="ax21:NbiRadiusStatisticItemArray">
                      <ax21:item xsi:type="ax21:NbiRadiusItemGraphArray">
                         <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                            <ax21:name>Среднее время сессии, сек</ax21:name>
                            <ax21:value>0.0</ax21:value>
                         </ax21:item>
                      </ax21:item>
                      <ax21:time>1451421600000</ax21:time>
                   </ax21:item>
                </ax21:response>
                <ax21:statistic xsi:nil="true"/>
                <ax21:title>Среднее время сессий</ax21:title>
             </ns:return>
          </ns:RetrieveTimeStatisticResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

419

Некорректный параметр запроса 'function'

107

Начало временного интервала не должно превышать конец временного интервала.

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveApTimeStatistics - Запрос статистики по точке доступа в указанном временном интервале

Общая информация

  1. Команда актуальна, начиная с версии 1.6.

  2. Команда предназначена для получения статистики по точке доступа в указанном временном интервале.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен точки доступа

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

timeStart

Начало временного интервала. Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Конец временного интервала. Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

ssid

NbiNameDomain Фильтр по SSID (имя + домен)

Выходные параметры

Параметр Значение Формат значения

stats

Объект NbiApStatsEntry

NbiApStatsEntry

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:nbi="http://nbi.radius.eltex.org">
        <soapenv:Header/>
        <soapenv:Body>
        <nbi:RetrieveApTimeStatistics>
            <nbi:domain>root</nbi:domain>
            <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
            <nbi:timeEnd>2017-12-31T07:31:29</nbi:timeEnd>
            <nbi:ssid>
                <xsd:domain>root</xsd:domain>
                <xsd:name>Vova_test</xsd:name>
            </nbi:ssid>
        </nbi:RetrieveApTimeStatistics>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
      <ns:RetrieveApTimeStatisticsResponse
                  xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax218:NbiApStatisticsResponse"
             xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
             xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
             xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax218:stats xsi:type="ax218:NbiApStatsEntry">
               <ax218:ap xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>WEP-2ac-192.168.15.80</ax21:name>
               </ax218:ap>
               <ax218:stats xsi:type="ax232:AcctStats">
                  <ax232:connections>0</ax232:connections>
                  <ax232:inputOctets>0</ax232:inputOctets>
                  <ax232:lostPackets>0</ax232:lostPackets>
                  <ax232:outputOctets>0</ax232:outputOctets>
                  <ax232:uniqueAccounts>0</ax232:uniqueAccounts>
                  <ax232:uniqueMac>0</ax232:uniqueMac>
               </ax218:stats>
            </ax218:stats>
            <ax218:stats xsi:type="ax218:NbiApStatsEntry">
               <ax218:ap xsi:type="ax21:NbiNameDomain">
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>WEP-12ac-192.168.42.48</ax21:name>
               </ax218:ap>
               <ax218:stats xsi:type="ax232:AcctStats">
                  <ax232:connections>0</ax232:connections>
                  <ax232:inputOctets>0</ax232:inputOctets>
                  <ax232:lostPackets>0</ax232:lostPackets>
                  <ax232:outputOctets>0</ax232:outputOctets>
                  <ax232:uniqueAccounts>0</ax232:uniqueAccounts>
                  <ax232:uniqueMac>0</ax232:uniqueMac>
               </ax218:stats>
            </ax218:stats>
         </ns:return>
      </ns:RetrieveApTimeStatisticsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

69

Некорректный параметр запроса 'username'

107

Начало временного интервала не должно превышать конец временного интервала.

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

227

Обязательный параметр запроса 'ssid' не указан или не соответствует формату SSID-а

16

SSID по обязательному параметру запроса 'ssid' не найден

18

Ошибка обращения в EMS NBI

45

Неизвестный ответ от EMS сервера

3

Ошибка от EMS-NBI

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveRadiusUserTimeStatisics - Запрос статистики по учётной записи пользователя в указанном временном интервале

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

  2. Команда предназначена для получения статистики по учётной записи пользователя в указанном временном интервале.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

  4. Проверка существования домена не выполняется.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

username

Имя пользователя

^.{1,64}$

Текст до 64-х символов

Wi-Fi пользователь

domain

Домен пользователя

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Начало временного интервала в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Конец временного интервала в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiAcctArray

NbiAcctArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soap:Body>
      <nbi:RetrieveRadiusUserTimeStatisics>
         <nbi:username>syrefs</nbi:username>
         <nbi:domain>enterprise.root</nbi:domain>
         <nbi:timeStart>2015-12-24T07:31:28</nbi:timeStart>
         <nbi:timeEnd>2017-12-31T07:31:29</nbi:timeEnd>
      </nbi:RetrieveRadiusUserTimeStatisics>
   </soap:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRadiusUserTimeStatisicsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeAcctResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                           <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiAcctArray">
               <ax22:acct xsi:type="ax22:NbiAcct">
                  <ax22:authentic xsi:nil="true"/>
                  <ax22:connectionInfoStart xsi:nil="true"/>
                  <ax22:connectionInfoStop xsi:nil="true"/>
                  <ax22:domain>enterprise.root</ax22:domain>
                  <ax22:framedAddress/>
                  <ax22:framedProtocol xsi:nil="true"/>
                  <ax22:groupname/>
                  <ax22:inputBytesDrop>0</ax22:inputBytesDrop>
                  <ax22:inputOctets>0</ax22:inputOctets>
                  <ax22:inputPacketsDrop>0</ax22:inputPacketsDrop>
                  <ax22:nasDomain xsi:nil="true"/>
                  <ax22:nasIP/>
                  <ax22:nasMac>AB-CD-EF-12-34-56:Eltex-Local</ax22:nasMac>
                  <ax22:nasPortId xsi:nil="true"/>
                  <ax22:nasPortType xsi:nil="true"/>
                  <ax22:nasSecret xsi:nil="true"/>
                  <ax22:outputBytesDrop>0</ax22:outputBytesDrop>
                  <ax22:outputOctets>0</ax22:outputOctets>
                  <ax22:outputPacketLost>0</ax22:outputPacketLost>
                  <ax22:outputPacketsDrop>0</ax22:outputPacketsDrop>
                  <ax22:realm/>
                  <ax22:serviceType xsi:nil="true"/>
                  <ax22:sessionId/>
                  <ax22:sessionTime>0</ax22:sessionTime>
                  <ax22:startDelay>0</ax22:startDelay>
                  <ax22:startTime>2017-03-26T15:59:04.000+07:00</ax22:startTime>
                  <ax22:stopDelay>0</ax22:stopDelay>
                  <ax22:stopTime>2017-03-26T16:59:04.000+07:00</ax22:stopTime>
                  <ax22:terminateCause/>
                  <ax22:uniqueId/>
                  <ax22:userMAC>12-34-56-AB-CD-EF</ax22:userMAC>
                  <ax22:username>syrefs</ax22:username>
                  <ax22:xascendSessionSvrKey xsi:nil="true"/>
               </ax22:acct>
               <ax22:acct xsi:type="ax22:NbiAcct">
                  <ax22:authentic xsi:nil="true"/>
                  <ax22:connectionInfoStart xsi:nil="true"/>
                  <ax22:connectionInfoStop xsi:nil="true"/>
                  <ax22:domain>enterprise.root</ax22:domain>
                  <ax22:framedAddress/>
                  <ax22:framedProtocol xsi:nil="true"/>
                  <ax22:groupname/>
                  <ax22:inputBytesDrop>0</ax22:inputBytesDrop>
                  <ax22:inputOctets>0</ax22:inputOctets>
                  <ax22:inputPacketsDrop>0</ax22:inputPacketsDrop>
                  <ax22:nasDomain xsi:nil="true"/>
                  <ax22:nasIP/>
                  <ax22:nasMac>C0-41-F6-C0-41-F6:Eltex-Local</ax22:nasMac>
                  <ax22:nasPortId xsi:nil="true"/>
                  <ax22:nasPortType xsi:nil="true"/>
                  <ax22:nasSecret xsi:nil="true"/>
                  <ax22:outputBytesDrop>0</ax22:outputBytesDrop>
                  <ax22:outputOctets>0</ax22:outputOctets>
                  <ax22:outputPacketLost>0</ax22:outputPacketLost>
                  <ax22:outputPacketsDrop>0</ax22:outputPacketsDrop>
                  <ax22:realm/>
                  <ax22:serviceType xsi:nil="true"/>
                  <ax22:sessionId/>
                  <ax22:sessionTime>0</ax22:sessionTime>
                  <ax22:startDelay>0</ax22:startDelay>
                  <ax22:startTime>2017-03-26T15:59:04.000+07:00</ax22:startTime>
                  <ax22:stopDelay>0</ax22:stopDelay>
                  <ax22:stopTime>2017-03-26T16:59:04.000+07:00</ax22:stopTime>
                  <ax22:terminateCause/>
                  <ax22:uniqueId/>
                  <ax22:userMAC>C0-41-F6-AB-CD-EF</ax22:userMAC>
                  <ax22:username>syrefs</ax22:username>
                  <ax22:xascendSessionSvrKey xsi:nil="true"/>
               </ax22:acct>
            </ax22:response>
         </ns:return>
      </ns:RetrieveRadiusUserTimeStatisicsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

7

Не указан обязательный параметр запроса 'domain'

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

69

Некорректный параметр запроса 'username'

107

Начало временного интервала не должно превышать конец временного интервала.

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveTodayTraffic - Выдать сумму входящего и исходящего трафика за сегодня по ssid и домену

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда служит для получения суммы входящего и исходящего трафика за сегодня по ssid и домену.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssid

Название ssid. При пустом значении будет рассчитано по всем SSID-ам.

^.{1,64}$

Текст до 64-х символов

domain

Домен ssid. При пустом значении будет использоваться домен роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

response

Сумма входящего и исходящего трафика за сегодня

BigInteger

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveTodayTraffic>
         <nbi:ssid></nbi:ssid>
         <nbi:domain></nbi:domain>
      </nbi:RetrieveTodayTraffic>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveTodayTrafficResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeBigIntegerResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response>34451514754</ax21:response>
         </ns:return>
      </ns:RetrieveTodayTrafficResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveApSummary - Выдать общую информацию по точкам доступа в сети.

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда служит для получения общей информации по точкам доступа в сети.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен, по которому будет собрана статистика. При пустом значении будет использоваться домен роли.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

Выходные параметры

Параметр Значение Формат значения

count

Количество точек доступа

int

online

Точек доступа online

int

disabled

Выключенных точек доступа

int

uninitialized

Неинициализированных точек доступа

int

wifiUsers

Количество пользователей

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveApSummary>
            <nbi:domain>enterprise.root</nbi:domain>
        </nbi:RetrieveApSummary>
    </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveApSummaryResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiApSummary"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:count>0</ax21:count>
            <ax21:disabled>0</ax21:disabled>
            <ax21:online>0</ax21:online>
            <ax21:uninitialized>0</ax21:uninitialized>
            <ax21:wifiUsers>0</ax21:wifiUsers>
         </ns:return>
      </ns:RetrieveApSummaryResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveGuestStatistics - Выдать статистику по подключениям неавторизованных пользователей.

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда служит для получения статистики по подключениям неавторизованных пользователей.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssid

SSID, подключения к которому будут учитываться. При пустом значении будет рассчитано по всем SSID-ам.)

^.{1,256}$

Текст до 256-х символов

Выходные параметры

Параметр Значение Формат значения

online

Неавторизованных пользователей в сети

long

sessions

Всего сессий неавторизованных пользователей

long

downstreamTraffic

Исходящий трафик, б

BigInteger

upstreamTraffic

Входящий трафик, б

BigInteger

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:RetrieveGuestStatistics>
         <nbi:ssid></nbi:ssid>
      </nbi:RetrieveGuestStatistics>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:RetrieveGuestStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiGuestStatistics"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:downstreamTraffic>0</ax21:downstreamTraffic>
            <ax21:online>0</ax21:online>
            <ax21:sessions>0</ax21:sessions>
            <ax21:upstreamTraffic>0</ax21:upstreamTraffic>
         </ns:return>
      </ns:RetrieveGuestStatisticsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Только в корневом домене можно не задавать фильтр по SSID

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveUserLocationHistory - Запрос статистики пользователя по перемещению между ТД по логину

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. До версии 1.17 при обработке запроса данные ТД получались из EMS. NBI обращался в EMS-NBI по URL 'getAPListExtended'.

  3. Начиная с версии 1.17 от этого отказались, и данные NBI получает сам из MySQL eltex_ems.ELTEX_OBJ_GEO. Поведение аналогично обработке команды GetGeoObjectsList

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

trackingObjectType

Тип объекта, по которому будет показана история перемещения ("ap" либо "ssid"), обязательно

^(ap|ssid)$

ap либо ssid

username

Имя пользователя

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

mac

MAC-адрес устройства пользователя

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 двузначных шестнадцатеричных чисел, разделенных ':'.

APDomain

Фильтр по домену. Если домен начинается с символа '.' , то статистика будет по всем ТД для данного домена и его поддоменов.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN (за исключением варианта с точкой в начале)

Domain

startTime

Начальный момент активности пользователя

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ssZ», например "2007-12-03T10:15:30Z"

endTime

Конечный момент активности пользователя

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ssZ», например "2008-12-03T10:15:30Z

pauseBetweenSessions

Минимальное время между сессиями

PnDTnHnMn.nS

Есть четыре раздела, каждый из которых состоит из числа и суффикса. Разделы имеют суффиксы в ASCII «D», «H», «M» и «S» для дней, часов, минут и секунд, принимаемых в верхнем или нижнем регистре. Должен присутствовать хотя бы один из четырех разделов. Например: 'PT20.345S' - 20.345 секунд, 'PT15M' - 15 минут

ssidType

Тип SSID, обязательно

^(hotspot|enterprise|equipment)$

hotspot (0), enterprise (1) или equipment (2). Можно указывать цифрами

count

Число записей, обязательно

^[1-9][0-9]*$

Целое положительное число

offset

Сдвиг по записям, обязательно

^[0-9]*$

Целое положительное число или ноль

orderBy

Поле для сортировки (рекомендуется "minAcctStartTime")

^(minAcctStartTime| maxAcctStopTime| sumAcctSessionTime)$

minAcctStartTime - время начала первой сессии на ТД/ssid, maxAcctStopTime - время окончания последней сессии на ТД/ssid, sumAcctSessionTime - суммарное время всех сессий на ТД/ssid

orderType

Поле определяющее тип сортировки. (По умолчанию ASC), обязательно

^(ASC|DESC)$

ASC или DESC

queryTotalCount

Сделать запрос общего количества записей, обязательно

^(true|false)$

true - получить значение total, false - не получать значение total (будет равен -1)

Выходные параметры

Параметр Значение Формат значения

array

Массив объектов NbiLocationArrayItem

NbiLocationArrayItem

total

Общее число объектов

Целое число

code

Код ответа

Целое число

detail

Пояснение к ответу

Строка

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveUserLocationHistory>
 <nbi:trackingObjectType>ssid</nbi:trackingObjectType>
 <nbi:username>favarish</nbi:username>
 <nbi:mac>1A-6d-c5-ba-09-01</nbi:mac>
 <nbi:APDomain>root</nbi:APDomain>
 <nbi:startTime>2007-12-03T10:15:30Z</nbi:startTime>
 <nbi:endTime>2021-10-03T10:15:30Z</nbi:endTime>
 <nbi:pauseBetweenSessions>PT15M</nbi:pauseBetweenSessions>
 <nbi:ssidType>enterprise</nbi:ssidType>
 <nbi:count>2</nbi:count>
 <nbi:offset>1</nbi:offset>
 <nbi:orderBy>minAcctStartTime</nbi:orderBy>
 <nbi:orderType>ASC</nbi:orderType>
 <nbi:queryTotalCount>true</nbi:queryTotalCount>
</nbi:RetrieveUserLocationHistory>
Ответ
<ns:RetrieveUserLocationHistoryResponse>
 <ns:return>
    <ax23:code>0</ax23:code>
    <ax23:detail>Success</ax23:detail>
    <ax241:array>
       <ax241:items>
          <ax241:acct>
             <ax241:SSID>ent</ax241:SSID>
             <ax241:apDomain>root</ax241:apDomain>
             <ax241:clientDomain>root</ax241:clientDomain>
             <ax241:clientIP>10.25.96.51</ax241:clientIP>
             <ax241:clientMAC>1A-6D-C5-BA-09-01</ax241:clientMAC>
             <ax241:clientName>favarish</ax241:clientName>
             <ax241:inputOctets>98093</ax241:inputOctets>
             <ax241:nasIP>10.25.96.115</ax241:nasIP>
             <ax241:nasMAC>A8-F9-4B-B2-48-E0</ax241:nasMAC>
             <ax241:outputOctets>433589</ax241:outputOctets>
             <ax241:startTime>2021-04-19T01:33:29Z</ax241:startTime>
             <ax241:stopTime>2021-04-19T01:46:45Z</ax241:stopTime>
             <ax241:summarySessionTime>PT13M16S</ax241:summarySessionTime>
             <ax241:timeSinceLastSession>PT71H13M38S</ax241:timeSinceLastSession>
          </ax241:acct>
          <ax241:ap>
             <ax241:building/>
             <ax241:city/>
             <ax241:domain/>
             <ax241:floor/>
             <ax241:house/>
             <ax241:ip/>
             <ax241:mac/>
             <ax241:name/>
             <ax241:office/>
             <ax241:street/>
             <ax241:type/>
          </ax241:ap>
       </ax241:items>
       <ax241:items>
          <ax241:acct>
             <ax241:SSID>ent</ax241:SSID>
             <ax241:apDomain>root</ax241:apDomain>
             <ax241:clientDomain>root</ax241:clientDomain>
             <ax241:clientIP>10.25.96.51</ax241:clientIP>
             <ax241:clientMAC>1A-6D-C5-BA-09-01</ax241:clientMAC>
             <ax241:clientName>favarish</ax241:clientName>
             <ax241:inputOctets>42480</ax241:inputOctets>
             <ax241:nasIP>10.25.96.115</ax241:nasIP>
             <ax241:nasMAC>A8-F9-4B-B2-48-E0</ax241:nasMAC>
             <ax241:outputOctets>128132</ax241:outputOctets>
             <ax241:startTime>2021-05-04T06:38:11Z</ax241:startTime>
             <ax241:stopTime>2021-05-04T06:39:53Z</ax241:stopTime>
             <ax241:summarySessionTime>PT1M42S</ax241:summarySessionTime>
             <ax241:timeSinceLastSession>PT364H51M26S</ax241:timeSinceLastSession>
          </ax241:acct>
          <ax241:ap>
             <ax241:building/>
             <ax241:city/>
             <ax241:domain/>
             <ax241:floor/>
             <ax241:house/>
             <ax241:ip/>
             <ax241:mac/>
             <ax241:name/>
             <ax241:office/>
             <ax241:street/>
             <ax241:type/>
          </ax241:ap>
       </ax241:items>
    </ax241:array>
    <ax241:total>3</ax241:total>
 </ns:return>
</ns:RetrieveUserLocationHistoryResponse>
Код Описание ошибки

2

Ошибка взаимодействия с базой данных MySQL

8

Некорректный домен

10

У роли нет прав на данный домен

13

Клиент заблокирован

62

Несуществующий домен

63

Некорректный формат MAC-адреса пользовательского устройства.

105

Некорректный формат поля startTime

106

Некорректный формат поля endTime

107

Некорректно указан период времени (startTime позже endTime)

112

Некорректно указан параметр count (должно быть указано положительное число)

131

Некорректно указан параметр offset (должно быть указано положительное число или ноль)

312

Некорректное значение параметра

436

Не указан обязательный параметр

437

Некорректный тип сортировки (параметр запроса 'orderType')

438

Некорректный тип объекта для показа истории перемещения (параметр запроса 'trackingObjectType')

439

Не корректный формат паузы между сессиями

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetTopActiveUsers - Получить список самых активных пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Допустимые поля для упорядочивания выборки

    • octets_total - Суммарное число входящего и исходящего трафика в байтах

    • octets_in - Входящий трафик в байтах

    • octets_out - Исходящий трафик в байтах

    • octets_total_avg - Среднее число суммарного входящего и исходящего трафика (байт/сек)

    • octets_in_avg - Среднее число входящего трафика (байт/сек)

    • octets_out_avg - Среднее число исходящего трафика (байт/сек)

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

  4. Начиная с версии 1.17 исключен входной параметр deactivated. Поэтому полученные пользователи больше не будет содержать значения в полях deactivated, deactivationUntil, family, name, lastVisit, tariffName

Входные параметры

Параметр Значение Формат значения

startTime

Время старта отрезка для поиска активности. Опциональный параметр.

Время по стандарту "ISO 8601" в формате yyyy-MM-ddTHH:mm:ss±HH:MM, например "2008-11-15T22:52:58+03:00"

endTime

Время конца отрезка для поиска активности. Опциональный параметр.

Время по стандарту "ISO 8601" в формате yyyy-MM-ddTHH:mm:ss±HH:MM, например "2008-11-15T22:52:58+03:00"

deactivated

Deprecated. Включение в результат только деактивированных либо деактивированных пользователей. Опциональный параметр.

true либо false

orderBy

Поле, по которому следует выполнять упорядовачивание

См. раздел Общая информация (п.2)

APDomain

Домен ТД

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

offset

Смещение относительно начала выборки

Целое положительное число

count

Кол-во записей выборки

Целое положительное число

userCategories

Категория пользователя (1 и более повторений)

Возможные значения: hotspot,enterprise

Выходные параметры

Параметр Значение Формат значения

total

Общее число найденных пользователей

long

usersArray

Объект со списком пользователей NbiTopActiveUsersArray

NbiTopActiveUsersArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetTopActiveUsers>
         <nbi:orderBy>octets_total</nbi:orderBy>
         <nbi:offset>0</nbi:offset>
         <nbi:count>1</nbi:count>
         <nbi:userCategories>enterprise</nbi:userCategories>
      </nbi:GetTopActiveUsers>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetTopActiveUsersResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax261:total>31</ax261:total>
            <ax261:usersArray xsi:type="ax261:NbiTopActiveUsersArray">
               <ax261:users xsi:type="ax261:NbiActiveUser">
                  <ax261:deactivated/>
                  <ax261:deactivationUntil/>
                  <ax261:domain>toor.esirpretne</ax261:domain>
                  <ax261:family/>
                  <ax261:lastVisit/>
                  <ax261:name/>
                  <ax261:octetsIn>6820471925</ax261:octetsIn>
                  <ax261:octetsInAvg>1996.23014934</ax261:octetsInAvg>
                  <ax261:octetsOut>49177979219</ax261:octetsOut>
                  <ax261:octetsOutAvg>10432.16958253</ax261:octetsOutAvg>
                  <ax261:octetsTotal>55998451144</ax261:octetsTotal>
                  <ax261:octetsTotalAvg>12428.39973187</ax261:octetsTotalAvg>
                  <ax261:tariffName/>
                  <ax261:username>vladimir.shishmarev</ax261:username>
               </ax261:users>
            </ax261:usersArray>
         </ns:return>
      </ns:GetTopActiveUsersResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

454

Недопустимое значение флага деактивации

455

Некорректный список категорий пользователя

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAPInfoByMacList - Поиск информации о точках по списку MAC-адресов

Общая информация

  1. Команда актуальна, начиная с версии 1.17.

Входные параметры

Параметр Значение Формат значения Ссылка

macs

Список мак-адресов для поиска

Каждый мак-адрес - строка, удовлетворяющая регулярному выражению
^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

NbiStringList

Выходные параметры

Параметр Значение Формат значения

responseArray

Массив элементов информации по точкам

NbiApInfoByMacItem

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAPInfoByMacList>
         <!--Optional:-->
         <nbi:macs>
            <!--Zero or more repetitions:-->
            <xsd:str>00:14:22:01:23:45</xsd:str>
            <xsd:str>e0:d9:e3:72:ad:a0</xsd:str>
         </nbi:macs>
      </nbi:GetAPInfoByMacList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAPInfoByMacListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax285:NbiApInfoByMacResponse" xmlns:ax218="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax238="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax245="http://radiusUser.response.object.nbi.radius.eltex.org/xsd" xmlns:ax267="http://geo.response.object.nbi.radius.eltex.org/xsd" xmlns:ax224="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax29="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax221="http://scripts.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax243="http://object.nbi.radius.eltex.org/xsd" xmlns:ax241="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax26="http://sorm3.response.object.nbi.radius.eltex.org/xsd" xmlns:ax285="http://apListByMac.response.object.nbi.radius.eltex.org/xsd" xmlns:ax264="http://topactiveusers.response.object.nbi.radius.eltex.org/xsd" xmlns:ax261="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax22="http://response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:ax282="http://reports.geo.response.object.nbi.radius.eltex.org/xsd" xmlns:ax227="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax249="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax258="http://sorm2.response.object.nbi.radius.eltex.org/xsd" xmlns:ax215="http://locationHistory.response.object.nbi.radius.eltex.org/xsd" xmlns:ax212="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax235="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax279="http://list.geo.response.object.nbi.radius.eltex.org/xsd" xmlns:ax232="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax254="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax276="http://aplist.ems.object.nbi.radius.eltex.org/xsd" xmlns:ax230="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax251="http://service.response.object.nbi.radius.eltex.org/xsd" xmlns:ax273="http://profile.object.nbi.radius.eltex.org/xsd" xmlns:ax271="http://ott.object.nbi.radius.eltex.org/xsd">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax285:responseArray xsi:type="ax285:NbiApInfoByMacItem">
               <ax285:building>0</ax285:building>
               <ax285:city>Новосибирск</ax285:city>
               <ax285:domain>toor.1-gnidliub.5-roolf</ax285:domain>
               <ax285:floor>0</ax285:floor>
               <ax285:house>29В</ax285:house>
               <ax285:ip>192.168.40.50</ax285:ip>
               <ax285:mac>e0:d9:e3:72:ad:a0</ax285:mac>
               <ax285:name>WEP-50</ax285:name>
               <ax285:office>0</ax285:office>
               <ax285:street>Окружная</ax285:street>
               <ax285:type>WEP</ax285:type>
            </ax285:responseArray>
         </ns:return>
      </ns:GetAPInfoByMacListResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

436

Не передан список MAC-адресов

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveUserSessions - Получить сессии пользователей

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

username

Логин пользователя, может быть пустым

^.{1,64}$

Строка до 64-х символов

mac

MAC-адрес пользователя, может быть пустым

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

Значение подходящее под шаблон MAC-адреса, например, aa:bb:cc:dd:ee:ff

apDomain

Домен ТД

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

startTime

Начало интервала для поиска сессий

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

endTime

Конец интервала для поиска сессий

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

ssidType

Тип сети (Hotspot/Enterprise/Equipment)

^(hotspot|enterprise|equipment)$

hotspot или enterprise

orderType

Тип сортировки (ASC/DESC). По умолчанию ASC

^(ASC|DESC)$

ASC или DESC

count

Количество выводимых записей

^[1-9][0-9]*$

Целое положительное число

offset

Сдвиг от начала списка

^[1-9][0-9]*$

Целое положительное число

queryTotal

Запрашивать ли общее количество записей

^(true|false)$

true или false

Выходные параметры

Параметр Значение Формат значения

items

Список сессий, подходящий под условия запроса

NbiUserSessionItem

total

Общее количество записей

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:RetrieveUserSessions>
    <nbi:apDomain>root</nbi:apDomain>
    <nbi:startTime>2020-02-29T00:00:00Z</nbi:startTime>
    <nbi:endTime>2020-03-05T00:00:00Z</nbi:endTime>
    <nbi:ssidType>hotspot</nbi:ssidType>
    <nbi:orderType>ASC</nbi:orderType>
    <nbi:count>2</nbi:count>
    <nbi:offset>0</nbi:offset>
    <nbi:queryTotal>true</nbi:queryTotal>
</nbi:RetrieveUserSessions>
Ответ
<ns:RetrieveUserSessionsResponse>
    <ns:return>
        <ax21:code>0</ax21:code>
        <ax21:detail/>
        <ax290:items>
            <ax290:apDomain>toor</ax290:apDomain>
            <ax290:endTime>2020-03-01T00:09:06Z</ax290:endTime>
            <ax290:inputOctets>243860</ax290:inputOctets>
            <ax290:nasIp>10.204.170.160</ax290:nasIp>
            <ax290:nasMac>E0-D9-E3-8E-F4-20</ax290:nasMac>
            <ax290:outputOctets>112041</ax290:outputOctets>
            <ax290:sessionTime>460</ax290:sessionTime>
            <ax290:ssid>Test-Guest</ax290:ssid>
            <ax290:startTime>2020-03-01T00:01:24Z</ax290:startTime>
            <ax290:userIp>100.123.85.14</ax290:userIp>
            <ax290:userMac>F4-AF-E7-C0-45-0A</ax290:userMac>
            <ax290:username>79123456789</ax290:username>
        </ax290:items>
            <ax290:items>
            <ax290:apDomain>toor</ax290:apDomain>
            <ax290:endTime>2020-03-01T00:12:04Z</ax290:endTime>
            <ax290:inputOctets>76421</ax290:inputOctets>
            <ax290:nasIp>10.204.24.186</ax290:nasIp>
            <ax290:nasMac>E0-D9-E3-4E-ED-40</ax290:nasMac>
            <ax290:outputOctets>22631</ax290:outputOctets>
            <ax290:sessionTime>9</ax290:sessionTime>
            <ax290:ssid>Test_Guest_FREE</ax290:ssid>
            <ax290:startTime>2020-03-01T00:11:55Z</ax290:startTime>
            <ax290:userIp>100.64.197.204</ax290:userIp>
            <ax290:userMac>CC-66-0A-A7-74-F9</ax290:userMac>
            <ax290:username>79876543210</ax290:username>
        </ax290:items>
        <ax2104:total>549</ax2104:total>
    </ns:return>
</ns:RetrieveUserSessionsResponse>
Код Описание ошибки

2

Ошибка доступа к БД

63

Некорректный формат поля mac

105

Некорректный формат поля 'startTime'

106

Некорректный формат поля 'endTime'

107

Время старта должно быть раньше времени окончания

436

Не указан обязательный параметр

437

Неверный тип сортировки

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RetrieveDomainSsidTypeStatistic - Получить статистику по трафику для одного домена по типу сети

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда позволяет получить статистику по входящему трафику в байтах, исходящему трафику в байтах, числу уникальных МАС-адресов, числу уникальных логинов пользователей, группировка выполняется по типам SSID.

  3. Параметр apDomain является обязательным для заполнения. Если значение параметров startTime и endTime не задано, то endTime вычисляется как текущее время, а startTime равно значению endTime минус 30 дней. Если только значение параметра startTime не задано, то startTime равно значению endTime минус 30 дней. Если только значение параметра endTime не задано, то endTime равно значению startTime плюс 30 дней.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

apDomain

Домен ТД

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

startTime

Начало интервала для поиска статистики

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

endTime

Конец интервала для поиска статистики

yyyy-MM-ddTHH:mm:ss±HH:MM

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

items

Массив объектов

NbiDomainSsidTypeStatisticItem

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveDomainSsidTypeStatistic>
         <nbi:apDomain>root</nbi:apDomain>
         <nbi:startTime>2020-01-10T00:00:00Z</nbi:startTime>
         <nbi:endTime>2020-02-10T03:59:59Z</nbi:endTime>
      </nbi:RetrieveDomainSsidTypeStatistic>
Ответ
   <soapenv:Body>
      <ns:RetrieveDomainSsidTypeStatisticResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail>Success</ax22:detail>
            <ax2116:items xsi:type="ax2116:NbiDomainSsidTypeStatisticItem">
               <ax2116:countUnicLogin>1</ax2116:countUnicLogin>
               <ax2116:countUnicMac>1</ax2116:countUnicMac>
               <ax2116:inputOctets>2608226</ax2116:inputOctets>
               <ax2116:outputOctets>1170461</ax2116:outputOctets>
               <ax2116:ssidType>0</ax2116:ssidType>
            </ax2116:items>
            <ax2116:items xsi:type="ax2116:NbiDomainSsidTypeStatisticItem">
               <ax2116:countUnicLogin>204</ax2116:countUnicLogin>
               <ax2116:countUnicMac>64</ax2116:countUnicMac>
               <ax2116:inputOctets>557984303478</ax2116:inputOctets>
               <ax2116:outputOctets>317731214287</ax2116:outputOctets>
               <ax2116:ssidType>1</ax2116:ssidType>
            </ax2116:items>
         </ns:return>
      </ns:RetrieveDomainSsidTypeStatisticResponse>
Код Описание ошибки

2

Ошибка доступа к БД

8

Домен не соответствует правилам FQDN

62

Несуществующий домен

105

Некорректный формат поля 'startTime'

106

Некорректный формат поля 'endTime'

107

Время старта должно быть раньше времени окончания

281

Параметр запроса не указан или пуст

436

Не указан обязательный параметр

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddSorm2Profile - Добавить СОРМ-2 съемник

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Доступно редактирование всех параметров кроме ID, который генерится автоматически.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profile

Параметры съемника NbiSorm2Profile

NbiSorm2Profile

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:AddSorm2Profile>
 <nbi:profile>
    <xsd:description>xxx profile</xsd:description>
    <xsd:domain>test.root</xsd:domain>
    <xsd:id>vostok1</xsd:id>
    <xsd:ip>1.1.2.3</xsd:ip>
    <xsd:name>Vostok2 SORM</xsd:name>
    <xsd:port>1812</xsd:port>
    <xsd:secret></xsd:secret>
 </nbi:profile>
</nbi:AddSorm2Profile>
Ответ
<ns:AddSorm2ProfileResponse>
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
 </ns:return>
</ns:AddSorm2ProfileResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

483

Профиль с таким именем уже существует

281

Не указан параметр 'ip'

7

Не указан обязательный параметр 'domain'

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSorm2Profile - Получить параметры СОРМ-2 профиля съемника

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Идентификатор съемника

String

Выходные параметры

Параметр Значение Формат значения

profiles

Массив объектов NbiSorm2Profile, содержащий параметры СОРМ-2 съемников

NbiSorm2Profile

total

Общее число записей, удовлетворяющих условиям выборки

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetSorm2Profile>
 <nbi:name>Vostok SORN</nbi:name>
</nbi:GetSorm2Profile>
Ответ
<ns:GetSorm2ProfileResponse>
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
    <ax258:profiles>
       <ax258:description/>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5def736861832a8ca998540a</ax258:id>
       <ax258:ip>1.1.2.2</ax258:ip>
       <ax258:name>Vostok SORN</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:total>1</ax258:total>
 </ns:return>
</ns:GetSorm2ProfileResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

281

Не указан обязательный параметр пользователя 'name'

10

Нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetSorm2ProfileList - Получить список СОРМ-2 съемников и их параметров

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Используется для получения списка СОРМ-2 съемников и их параметров для указанного домена. При использовании точки в начале домена в ответе придет список съемников для всех вложенных доменов.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен установки съемника.

String

params

Дополнительные параметры выборки и фильтрации.

NbiParameterArray

В качестве дополнительных параметров (params) можно передать:

  • limit - максимальное число записей в выборке (по умолчанию 100)

  • offset - число записей, которые необходимо пропустить (для пагинации, по умолчанию 0)

Выходные параметры

Параметр Значение Формат значения

profiles

Массив объектов NbiSorm2Profile, содержащий параметры СОРМ-2 съемников

NbiSorm2Profile

total

общее число записей, удовлетворяющих условиям выборки

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetSorm2ProfileList>
 <nbi:domain>.root</nbi:domain>
 <nbi:params>
    <xsd:parameter>
       <xsd:name>limit</xsd:name>
       <xsd:value>10</xsd:value>
    </xsd:parameter>
    <xsd:parameter>
       <xsd:name>offset</xsd:name>
       <xsd:value>0</xsd:value>
    </xsd:parameter>
 </nbi:params>
</nbi:GetSorm2ProfileList>
Ответ
<ns:GetSorm2ProfileListResponse >
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5def736861832a8ca998540a</ax258:id>
       <ax258:ip>1.1.2.2</ax258:ip>
       <ax258:name>Vostok SORN</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5df0acb272f1fd2afabb6eb3</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok2 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5df0afdf72f1fd2afabb7394</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok3 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test2.test.root</ax258:domain>
       <ax258:id>5df0b21072f1fd2afabb7754</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok4 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:total>4</ax258:total>
 </ns:return>
</ns:GetSorm2ProfileListResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditSorm2Profile - Редактировать СОРМ-2 съемник

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Доступно редактирование всех параметров кроме ID, который генерится автоматически.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profile

Параметры съемника NbiSorm2Profile

NbiSorm2Profile

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditSorm2Profile>
 <nbi:profile>
    <xsd:description></xsd:description>
    <xsd:domain>test.root</xsd:domain>
    <xsd:id></xsd:id>
    <xsd:ip>1.1.2.2</xsd:ip>
    <xsd:name>Vostok SORN</xsd:name>
    <xsd:port>1812</xsd:port>
    <xsd:secret></xsd:secret>
 </nbi:profile>
</nbi:EditSorm2Profile>
Ответ
      <ns:EditSorm2ProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:EditSorm2ProfileResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

484

Профиля с таким именем не существует

281

Параметр запроса 'ip' или 'port' пустой или отсутствует

7

Не указан обязательный параметр 'domain'

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteSorm2Profile - Удалить параметры СОРМ-2 съемника

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Используется для удаления профилей по их именам.

  3. Если профиль привязан к какому-либо региону, удалять его запрещено. Сначала надо удалить связку, потом сам профиль.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Список идентификаторов съемников, которые нужно удалить.

String

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteSorm2Profile>
 <nbi:name>Vostok2 SORM</nbi:name>
</nbi:DeleteSorm2Profile>
Ответ
      <ns:DeleteSorm2ProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteSorm2ProfileResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

281

Не указан обязательный параметр 'name'

485

Профиль имеет привязку

10

Нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

LinkSorm2Profile - Установить, разорвать связь между СОРМ-2 съемниками и доменами

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Команда LinkSorm2Profile используется для того, чтобы связать произвольное число регионов (доменов) с произвольным числом съемников (профилей). Заданная таким образом настройка распростаняется как на сам регион, так и на все регионы, входящие в него (дочерние домены), если не будет переопределена в каком-то домене отдельно.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Список идентификаторов съемников.

String

domain

Список доменов

String

action

int

Тип действия
1. привязать,
2. отвязать

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос

Пример задачи: настроить отправку трафика регионов Волга (volga.rt) и Дон (don.rt) на два съемника, установленные в Москве (основной msk1, резервный msk2)

<nbi:LinkSorm2Profile>
 <nbi:name>msk1</nbi:name>
 <nbi:name>msk2</nbi:name>
 <nbi:domain>volga.rt</nbi:domain>
 <nbi:domain>don.rt</nbi:domain>
 <nbi:action>1</nbi:action>
</nbi:LinkSorm2Profile>
Ответ
<ns:LinkSorm2ProfileResponse>
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
 </ns:return>
</ns:LinkSorm2ProfileResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

281

Параметр запроса 'domain' пустой или отсутствует

481

Ошибка связывания неопределенного профиля

8

Значение 'domain' не удовлетворяет правилам FQDN

10

Нет прав на указанный домен

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Используется для получения списка привязок СОРМ-2 съемников для указанного домена. При использовании точки в начале домена в ответе придет список привязок для всех вложенных доменов.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен ТД.

String

params

Дополнительные параметры выборки и фильтрации.

NbiParameterArray

В качестве дополнительных параметров (params) можно передать:

  • limit - максимальное число записей в выборке (по умолчанию 100)

  • offset - число записей, которые необходимо пропустить (для пагинации, по умолчанию 0)

Выходные параметры

Параметр Значение Формат значения

links

Массив объектов NbiSorm2Link, содержащий параметры привязки СОРМ-2 съемников

NbiSorm2Link

total

Общее число записей, удовлетворяющих условиям выборки

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetSorm2LinkList>
 <nbi:domain>.root</nbi:domain>
 <nbi:params>
    <xsd:parameter>
       <xsd:name>limit</xsd:name>
       <xsd:value>10</xsd:value>
    </xsd:parameter>
    <xsd:parameter>
       <xsd:name>offset</xsd:name>
       <xsd:value>0</xsd:value>
    </xsd:parameter>
 </nbi:params>
</nbi:GetSorm2LinkList>
Ответ
<ns:GetSorm2LinkListResponse>
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
    <ax258:links>
       <ax258:domain>root</ax258:domain>
       <ax258:name>Vostok SORN</ax258:name>
    </ax258:links>
    <ax258:links>
       <ax258:domain>test.root</ax258:domain>
       <ax258:name>Vostok2 SORM</ax258:name>
    </ax258:links>
    <ax258:total>2</ax258:total>
 </ns:return>
</ns:GetSorm2LinkListResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSorm2Profile - Параметры СОРМ-2 съемника

Общая информация

  1. Команда актуальна, начиная с версии 1.13.

  2. Профиль съемника это набор параметров съемника, требующийся системе для отправки на него зеркалированного и обогащенного RADIUS трафика. Идентификатором съемника в системе NBI/ЛК является его имя (name). Оно используется в командах LinkSorm2Profile, DeleteSorm2Profile

Параметры объекта

Параметр Значение Формат значения

domain

Домен съемника

String

id

Object ID

String

name

Уникальное имя съемника, которое будет отображаться в чекбоксе по нему же будет осуществляться привязка

String

description

Описание (адрес установки, и прочая информация для администратора

String

ip

IP адрес съемника

String

port

Порт съемника

Integer

secret

RADIUS secret

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Информация актуальна с версии 1.13.

Параметры объекта

Параметр Значение Формат значения

domain

Домен профиля

String

name

Имя профиля

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Sorm3GetAndDeleteAbonentsCSVUpdate - Получить и удалить файл со списком редактирований абонентов, выполненных через NBI

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Возвращает и удаляет файл из директории /var/log/eltex-axis/sorm3/. Используется в eltex-radius-sorm3-federal для выгрузки в CSV информации по абонентам в файлы ABONENTS*.csv

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

filename

Имя CSV файла

String

Выходные параметры

Параметр Значение Формат значения

file

Содержимое файла

byte

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:Sorm3GetAndDeleteAbonentsCSVUpdate>
         <nbi:filename>ABONENTS_ENTERPRISE.csv</nbi:filename>
      </nbi:Sorm3GetAndDeleteAbonentsCSVUpdate>
Ответ
      <ns:Sorm3GetAndDeleteAbonentsCSVUpdateResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax232:file>MTY7OzE5NzAtMTItMzEgMjM6NTk6NTk7IDsyMDE4LTAzLTIxIDA5OjQzOjIzOzIwMTgtMTItMjQgMTI6MTY6MDY7NDI7MTs7OzvQodC+0YLRgNGD0LTQvdC40Log0LrQvtGA0L/QvtGA0LDRgtC40LLQvdC+0LPQviDQutC70LjQtdC90YLQsCBmZmZmZ2ZnZmcgZmZmZGZnZmc7MTk3MC0xMi0zMSAyMzo1OTo1OTswOzE7Ozs7Ozs7Ozs7OzA7Ozs3Ozs7CjE2OzsxOTcwLTEyLTMxIDIzOjU5OjU5OyA7MjAxOC0xMi0yNCAxMjoxNjowNjsyMDI0LTEyLTMxIDIzOjU5OjU5OzQyOzE7Ozs70KHQvtGC0YDRg9C00L3QuNC6INC60L7RgNC/0L7RgNCw0YLQuNCy0L3QvtCz0L4g0LrQu9C40LXQvdGC0LAgZmZmZmcgZmZmOzE5NzAtMTItMzEgMjM6NTk6NTk7MDsxOzs7O29wZmFtaWx5IG9wb3Q7Ozs7Ozs7MDs7Ozc7OzsK</ax232:file>
         </ns:return>
      </ns:Sorm3GetAndDeleteAbonentsCSVUpdateResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.12.

  2. Используется в eltex-radius-sorm3-federal для получения списка привязок и соответствущих им имен SSID (только SSID в состоянии up)

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

count

Количество возвращаемых записей

Integer

page

Номер страницы (пачки записей)

Integer

fieldFilters

NbiParameterArray Список фильтров

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

response

Массив параметров вида ключ-значение NbiParameterArray

NbiParameterArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
    <nbi:Sorm3RetrieveAllSsidLinkList>
        <nbi:count>1</nbi:count>
        <nbi:page>79</nbi:page>
    </nbi:Sorm3RetrieveAllSsidLinkList>
Ответ
      <ns:Sorm3RetrieveAllSsidLinkListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiParameterArray">
                <ax21:parameter xsi:type="ax21:NbiParameter">
                    <ax21:name>8619-054_ul_Sormovskaya_9_1.Sberbank.Krasnodar.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax21:name>
                    <ax21:value>SBRF_FREE_8619-054</ax21:value>
                </ax21:parameter>
                <ax21:parameter xsi:type="ax21:NbiParameter">
                    <ax21:name>8620-032_ul_Gagarina_148.Sberbank.YAblonovskiy.Adygeya_Resp.Krasnodarskiy_filial.Ug.Ap.root</ax21:name>
                    <ax21:value>SBRF_FREE_8620-032</ax21:value>
                </ax21:parameter>
            </ax21:response>
         </ns:return>
      </ns:Sorm3RetrieveAllSsidLinkListResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetUrlFilter - Получение списка URL

Общая информация

  1. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

name

Имя списка

Строка

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Объект NbiUrlFilter

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на домен списка

409

Списка с указанным именем не существует

451

Ошибка получения списка URL из БД
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetUrlFilter>
         <nbi:name>list</nbi:name>
      </nbi:GetUrlFilter>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetUrlFilterResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:profile>
               <ax233:domain>root</ax233:domain>
               <ax233:list>
                  <ax233:str>http://example1.com/</ax233:str>
                  <ax233:str>http://example2.com/</ax233:str>
               </ax233:list>
               <ax233:name>list</ax233:name>
               <ax233:type>BLACK</ax233:type>
            </ax233:profile>
         </ns:return>
      </ns:GetUrlFilterResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetUrlFilterList - Получение списков URL

Общая информация

  1. Команда на получение списка URL фильтров.
    При отсутствии домена - возвращает список всех фильтров соответствующие роли.
    Если указан домен - возвращает фильтры для указанного домена.
    Если домен начинается с точки - возвращает фильтры для указанного и дочерних доменов.

  2. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

domain

Домен списка.

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

count

Кол-во выводимых элементов.

Целое положительное число

page

Номер страницы, порции выдаваемых элементов.

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

name, domain или type (По умолчанию name)

orderType

Поле определяющее тип сортировки.

ASC или DESC (По умолчанию ASC)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Размер списка без учета фильтров или описание ошибки

Целое неотрицательное число или текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiUrlFilterSimple

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetUrlFilterList>
         <nbi:domain>root</nbi:domain>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>name</nbi:orderBy>
         <nbi:orderType>DESC</nbi:orderType>
      </nbi:GetUrlFilterList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetUrlFilterListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:profiles>
               <ax233:domain>my.root</ax233:domain>
               <ax233:listSize>1</ax233:listSize>
               <ax233:name>white</ax233:name>
               <ax233:type>WHITE</ax233:type>
            </ax233:profiles>
            <ax233:profiles>
               <ax233:domain>root</ax233:domain>
               <ax233:listSize>2</ax233:listSize>
               <ax233:name>black</ax233:name>
               <ax233:type>BLACK</ax233:type>
            </ax233:profiles>
         </ns:return>
      </ns:GetUrlFilterListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetUrlFilterListV2 - Получение списков URL

Общая информация

  1. Команда на получение списка URL фильтров.
    При отсутствии домена - возвращает список всех фильтров соответствующие роли.
    Если указан домен - возвращает фильтры для указанного домена.
    Если домен начинается с точки - возвращает фильтры для указанного и дочерних доменов.

  2. Команда актуальна, начиная с версии 1.9

Входные параметры

Параметр Значение Формат значения

name

Имя списка или часть имени

Текст, может отсутствовать

domain

Домен списка.

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

count

Кол-во выводимых элементов.

Целое положительное число

offset

Смещение относительно начала выборки

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

name, domain или type (По умолчанию name)

orderType

Поле определяющее тип сортировки.

ASC или DESC (По умолчанию ASC)

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Размер списка без учета фильтров или описание ошибки

Целое неотрицательное число или текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiUrlFilterSimple

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetUrlFilterList>
         <nbi:name>white</nbi:name>
         <nbi:domain>root</nbi:domain>
         <nbi:count>10</nbi:count>
         <nbi:offset>0</nbi:offset>
         <nbi:orderBy>name</nbi:orderBy>
         <nbi:orderType>DESC</nbi:orderType>
      </nbi:GetUrlFilterList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetUrlFilterListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:profiles>
               <ax233:domain>my.root</ax233:domain>
               <ax233:listSize>1</ax233:listSize>
               <ax233:name>list1_white</ax233:name>
               <ax233:type>WHITE</ax233:type>
            </ax233:profiles>
            <ax233:profiles>
               <ax233:domain>root</ax233:domain>
               <ax233:listSize>2</ax233:listSize>
               <ax233:name>notwhitelist</ax233:name>
               <ax233:type>BLACK</ax233:type>
            </ax233:profiles>
         </ns:return>
      </ns:GetUrlFilterListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetUrlFilter - Изменение списка URL

Общая информация

  1. Команда для создания и изменения списка URL

  2. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен SSID

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

type

Тип списка

'WHITE' или 'BLACK'

list

Список URL

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован

281

Не найден обязательный параметр запроса

417

Некорректный тип списка

418

Пустой список URL

420

Некорректный URL в списке

453

Ошибка записи списка URL в БД
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:SetUrlFilter>
         <nbi:name>list</nbi:name>
         <nbi:domain>root</nbi:domain>
         <nbi:type>BLACK</nbi:type>
         <nbi:list>
            <xsd:str>http://example.org</xsd:str>
            <xsd:str>http://example.com</xsd:str>
         </nbi:list>
      </nbi:SetUrlFilter>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:SetUrlFilterResponse>
         <ns:return xsi:type="ax22:NbiResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:SetUrlFilterResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteUrlFilter - Удаление списка URL

Общая информация

  1. Команда актуальна, начиная с версии 1.7

Входные параметры

Параметр Значение Формат значения

name

Имя списка

Строка

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на домен списка

409

Списка с указанным именем не существует
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DeleteUrlFilter>
         <nbi:name>black</nbi:name>
      </nbi:DeleteUrlFilter>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DeleteUrlFilterResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteUrlFilterResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetApps - Получить список приложений по имени

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения

name

имя списка

Строка

Выходные параметры

Параметр Значение Формат значения

apps

Данные списка

NbiAppsInfo

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetApps>
         <nbi:name>myapps</nbi:name>
      </nbi:GetApps>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAppsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:apps xsi:type="ax233:NbiAppsInfo">
               <ax233:domain>root</ax233:domain>
               <ax233:name>myapps</ax233:name>
               <ax233:size>3</ax233:size>
               <ax233:apps xsi:type="ax233:NbiApp">
                  <ax233:description>Domain Name System</ax233:description>
                  <ax233:name>dns</ax233:name>
               </ax233:apps>
               <ax233:apps xsi:type="ax233:NbiApp">
                  <ax233:description>Dropbox</ax233:description>
                  <ax233:name>dropbox</ax233:name>
               </ax233:apps>
               <ax233:apps xsi:type="ax233:NbiApp">
                  <ax233:description>Facebook</ax233:description>
                  <ax233:name>facebook</ax233:name>
                  <ax233:tags>social</ax233:tags>
               </ax233:apps>
            </ax233:apps>
         </ns:return>
      </ns:GetAppsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

448

Такого списка приложений не существует
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetApps>
         <nbi:name>mylist</nbi:name>
      </nbi:GetApps>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAppsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>448</ax21:code>
            <ax21:detail>No such Apps set'mylist'</ax21:detail>
            <ax258:apps xsi:nil="true"/>
         </ns:return>
      </ns:GetAppsResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAppsList - Получить список списков приложений

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения

name

Имя списка или часть имени

Текст, может отсутствовать

domain

Домен списка.

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

count

Кол-во выводимых элементов.

Целое положительное число

offset

Смещение относительно начала выборки

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

name, domain (По умолчанию name)

orderType

Поле определяющее тип сортировки.

ASC или DESC (По умолчанию ASC)

Выходные параметры

Параметр Значение Формат значения

appsListData

Список списков приложений

NbiAppsList

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAppsList>
         <nbi:domain>root</nbi:domain>
         <nbi:count>10</nbi:count>
         <nbi:offset>0</nbi:offset>
         <nbi:orderBy>name</nbi:orderBy>
         <nbi:orderType>ASC</nbi:orderType>
      </nbi:GetAppsList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAppsListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:appsListData xsi:type="ax233:NbiAppsList">
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps0</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps1</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps10</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps11</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps12</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps13</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps14</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps15</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps16</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:appsList xsi:type="ax233:NbiAppsInfoSimple">
                  <ax233:domain>root</ax233:domain>
                  <ax233:name>apps17</ax233:name>
                  <ax233:size>10</ax233:size>
               </ax233:appsList>
               <ax233:total>10</ax233:total>
            </ax233:appsListData>
         </ns:return>
      </ns:GetAppsListResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAvailableAppsList - Получить список всех доступных для фильтрации приложений

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Выходные параметры

Параметр Значение Формат значения

apps

Приложение (параметр может может повторяться несколько раз или не существовать вообще)

NbiApp

tags

Существующий тег (параметр может может повторяться несколько раз или не существовать вообще)

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAvailableAppsList/>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAvailableAppsListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax258:apps xsi:type="ax258:NbiApp">
               <ax258:description>Apple Filing Protocol</ax258:description>
               <ax258:name>afp</ax258:name>
               <ax258:tags>apple</ax258:tags>
            </ax258:apps>
            <ax258:apps xsi:type="ax258:NbiApp">
               <ax258:description>Amazon Data Services</ax258:description>
               <ax258:name>amazon</ax258:name>
            </ax258:apps>
            <ax258:apps xsi:type="ax258:NbiApp">
               <ax258:description>Advanced Message Queuing Protocol</ax258:description>
               <ax258:name>amqp</ax258:name>
            </ax258:apps>

              <!-- ... -->

              <ax251:tags>game</ax251:tags>
              <ax251:tags>messenger</ax251:tags>
              <ax251:tags>social</ax251:tags>
              <ax251:tags>apple</ax251:tags>
              <ax251:tags>microsoft</ax251:tags>
              <ax251:tags>google</ax251:tags>
              <ax251:tags>audio</ax251:tags>
              <ax251:tags>video</ax251:tags>
              <ax251:tags>p2p</ax251:tags>
         </ns:return>
      </ns:GetAvailableAppsListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetApps - Создать/заменить список приложений

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен списка.

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

appsList

Список имен приложений

NbiSetAppsList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:SetApps>
         <nbi:name>myapps</nbi:name>
         <nbi:domain>root</nbi:domain>
         <nbi:appsList>
            <xsd:apps>dns</xsd:apps>
            <xsd:apps>facebook</xsd:apps>
            <xsd:apps>dropbox</xsd:apps>
         </nbi:appsList>
      </nbi:SetApps>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:SetAppsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiResponse" xmlns:ax219="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax216="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax227="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax239="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax258="http://service.response.object.nbi.radius.eltex.org/xsd" xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax248="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax245="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax213="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax224="http://sorm3.response.object.nbi.radius.eltex.org/xsd" xmlns:ax221="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:ax211="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax23="http://object.nbi.radius.eltex.org/xsd" xmlns:ax233="http://locationHistory.response.object.nbi.radius.eltex.org/xsd" xmlns:ax255="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax230="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax252="http://sorm2.response.object.nbi.radius.eltex.org/xsd" xmlns:ax242="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://radiusUser.response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:SetAppsResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

62

Домен не зарегистрирован

447

Некорректное имя приложения
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org" xmlns:xsd="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:SetApps>
         <nbi:name>myapps</nbi:name>
         <nbi:domain>root</nbi:domain>
         <nbi:appsList>
            <xsd:apps>unknownApp1</xsd:apps>
            <xsd:apps>facebook</xsd:apps>
            <xsd:apps>unknownApp2</xsd:apps>
         </nbi:appsList>
      </nbi:SetApps>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:SetAppsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiResponse" xmlns:ax219="http://statistics.object.nbi.radius.eltex.org/xsd" xmlns:ax216="http://statistic.response.object.nbi.radius.eltex.org/xsd" xmlns:ax227="http://apList.response.object.nbi.radius.eltex.org/xsd" xmlns:ax239="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax236="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax258="http://service.response.object.nbi.radius.eltex.org/xsd" xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd" xmlns:ax248="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax245="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax213="http://authService.object.nbi.radius.eltex.org/xsd" xmlns:ax224="http://sorm3.response.object.nbi.radius.eltex.org/xsd" xmlns:ax221="http://ssidstats.response.object.nbi.radius.eltex.org/xsd" xmlns:ax211="http://tariff.object.nbi.radius.eltex.org/xsd" xmlns:ax23="http://object.nbi.radius.eltex.org/xsd" xmlns:ax233="http://locationHistory.response.object.nbi.radius.eltex.org/xsd" xmlns:ax255="http://apps.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax230="http://domains.response.object.nbi.radius.eltex.org/xsd" xmlns:ax252="http://sorm2.response.object.nbi.radius.eltex.org/xsd" xmlns:ax242="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd" xmlns:ax25="http://radiusUser.response.object.nbi.radius.eltex.org/xsd" xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd">
            <ax21:code>447</ax21:code>
            <ax21:detail>unknownApp1,unknownApp2</ax21:detail>
         </ns:return>
      </ns:SetAppsResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteApps - Удалить список приложений по имени

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Входные параметры

Параметр Значение Формат значения

name

Имя списка

Строка

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DeleteApps>
         <nbi:name>apps2</nbi:name>
      </nbi:DeleteApps>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:DeleteAppsResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteAppsResponse>
   </soapenv:Body>
</soapenv:Envelope>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateEntityProfile - Создать профиль юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет создать профиль юридического лица для дальнейшей привязки его к домену/роли.

  3. Имя профиля юридического лица уникально (регистр значения не имеет).

Входные параметры

Параметр Значение Формат значения Расшифровка формата

name

Имя профиля

^[a-zA-Z0-9]{1,64}$

Текст длиной до 64 символов

descr

Описание профиля

String

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

response

Идентификатор созданного профиля

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:CreateEntityProfile>
    <nbi:name>test entity</nbi:name>
    <nbi:descr>test description</nbi:descr>
</nbi:CreateEntityProfile>
Ответ
<ns:CreateEntityProfileResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>2</ax21:response>
    </ns:return>
</ns:CreateEntityProfileResponse>
Код Описание ошибки

2

Ошибка доступа к БД

33

Некорректное значение поля 'name'

281

Не указан один из обязательных параметров запроса

528

Профиль юр.лица 'name' уже существует с 'id'.

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateEntityProfileClass - Создать схему профиля юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет создать схему профиля юридического лица, описывающую параметры для привязки профиля к сущности (роли или домену).

  3. Имя схемы профиля уникально (регистр значения не имеет) в рамках одного профиля.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

profileId

Уникальный идентификатор профиля

int

Целое положительное число

name

Имя схемы профиля

^[a-zA-Z0-9]{1,64}$

Текст длиной до 64 символов

valueRegex

Способ валидации значений

String

Регулярное выражение длиной до 1024 символов

relationType

Отношение параметра к определенному виду сущностей (роли, домены)

^(domain|role)$

Домен или роль

descr

Описание параметра

.{0,255}$

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

response

Идентификатор созданной схемы профиля

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:CreateEntityProfileClass>
    <nbi:profileId>2</nbi:profileId>
    <nbi:name>test class</nbi:name>
    <nbi:valueRegex>*</nbi:valueRegex>
    <nbi:relationType>domain</nbi:relationType>
    <nbi:descr>test description</nbi:descr>
</nbi:CreateEntityProfileClass>
Ответ
<ns:CreateEntityProfileClassResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>2</ax21:response>
    </ns:return>
</ns:CreateEntityProfileClassResponse>
Код Описание ошибки

2

Ошибка доступа к БД

33

Некорректное значение поля 'name'

281

Не указан один из обязательных параметров запроса

522

Профиль юр.лица с указанным id не найден

523

Некорректное значение поля 'relationType'

529

Схема профиля юр.лица 'name' уже существует в 'profile_id' с 'id'

530

Регулярное выражение некорректно

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateEntityProfileValues - Создать параметры схем профилей юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет создать привязку сущности (конкретный домен или роль) к профилю.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profileValues

Параметры схем профилей юр.лица

classId, keyName и value

EntityProfileValue

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:CreateEntityProfileValues>
    <nbi:profileValues>
        <xsd:classId>1</xsd:classId>
        <xsd:keyName>root</xsd:keyName>
        <xsd:value>test value</xsd:value>
    </nbi:profileValues>
    <nbi:profileValues>
        <xsd:classId>2</xsd:classId>
        <xsd:keyName>root</xsd:keyName>
        <xsd:value>test value</xsd:value>
    </nbi:profileValues>
</nbi:CreateEntityProfileValues>
Ответ
<ns:CreateEntityProfileValuesResponse>
    <ns:return xsi:type="ax21:NbiResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
    </ns:return>
</ns:CreateEntityProfileValuesResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

524

Схема профиля юр.лица с указанным id не найдена

526

Значение поля 'value' не соответствует регулярному выражению, указанному в схеме профиля

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteEntityProfileById - Удалить профиль юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет удалить профиль по его уникальному идентификатору и все его зависимые сущности (схемы, параметры).

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

response

Количество удаленных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteEntityProfileById>
    <nbi:id>3</nbi:id>
</nbi:DeleteEntityProfileById>
Ответ
<ns:DeleteEntityProfileByIdResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>1</ax21:response>
    </ns:return>
</ns:DeleteEntityProfileByIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteEntityProfileClassById - Удалить схему профиля юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет удалить схему профиля и все параметры схемы профиля, привязанные к ней.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор схемы профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

response

Количество удаленных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteEntityProfileClassById>
    <nbi:id>3</nbi:id>
</nbi:DeleteEntityProfileClassById>
Ответ
<ns:DeleteEntityProfileClassByIdResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>1</ax21:response>
    </ns:return>
</ns:DeleteEntityProfileClassByIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteEntityProfileValues - Удалить параметры схем профилей юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет удалить параметры схемы профиля по их уникальным идентификаторам.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ids

Список уникальных идентификаторов параметров схем профилей

Integer

Выходные параметры

Параметр Значение Формат значения

response

Количество удаленных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:DeleteEntityProfileValues>
    <nbi:ids>6</nbi:ids>
    <nbi:ids>7</nbi:ids>
</nbi:DeleteEntityProfileValues>
Ответ
<ns:DeleteEntityProfileValuesResponse>
    <ns:return xsi:type="ax23:NbiCodeResponse">
        <ax23:code>0</ax23:code>
        <ax23:detail>Success</ax23:detail>
        <ax23:response>2</ax23:response>
    </ns:return>
</ns:DeleteEntityProfileValuesResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditEntityProfileById - Редактировать профиль юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет редактировать имя и описание профиля юридического лица.

  3. Имя профиля юридического лица уникально (регистр значения не имеет), потому при попытке использовать для переименования занятое имя, вернется ошибка.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор профиля

int

Целое положительное число

newName

Новое имя профиля

^[a-zA-Z0-9]{1,64}$

Текст длиной до 64 символов

newDescr

Новое описание профиля

String

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

response

Количество измененных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditEntityProfileById>
    <nbi:id>2</nbi:id>
    <nbi:newName>new test name</nbi:newName>
    <nbi:newDescr>new description</nbi:newDescr>
</nbi:EditEntityProfileById>
Ответ
<ns:EditEntityProfileByIdResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>1</ax21:response>
    </ns:return>
</ns:EditEntityProfileByIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

33

Некорректное значение поля 'newName'

281

Не указан один из обязательных параметров запроса

522

Профиль юр.лица с указанным id не найден

528

Профиль юр.лица 'name' уже существует с 'id'.

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditEntityProfileClass - Редактировать схему профиля с привязкой по ID

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет редактировать схему профиля по его уникальному идентификатору.

  3. Имя схемы профиля уникально (регистр значения не имеет) в рамках одного профиля.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор схемы профиля

int

Целое положительное число

name

Имя параметра

^[a-zA-Z0-9]{1,64}$

Текст длиной до 64 символов

valueRegex

Способ валидации значений

String

Регулярное выражение длиной до 1024 символов

relationType

Отношение параметра к определенному виду сущностей (роли, домены и т.д.)

^(domain|role)$

Домен или роль

descr

Описание параметра

String

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

response

Количество измененных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditEntityProfileClass>
    <nbi:id>2</nbi:id>
    <nbi:name>test class</nbi:name>
    <nbi:valueRegex>*</nbi:valueRegex>
    <nbi:relationType>domain</nbi:relationType>
    <nbi:descr>new description</nbi:descr>
</nbi:EditEntityProfileClass>
Ответ
<ns:EditEntityProfileClassResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>1</ax21:response>
    </ns:return>
</ns:EditEntityProfileClassResponse>
Код Описание ошибки

2

Ошибка доступа к БД

33

Некорректное значение поля 'name'

281

Не указан один из обязательных параметров запроса

523

Некорректное значение поля 'relationType'

524

Схема профиля юр.лица с указанным id не найдена

529

Схема профиля юр.лица 'name' уже существует в 'profile_id' с 'id'

530

Регулярное выражение некорректно

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditEntityProfileValues - Редактировать значения параметров схем профилей юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет редактировать несколько значений параметров схем профилей одновременно.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

profileValues

Параметры схем профилей юр.лица

id и value

EntityProfileValue

Выходные параметры

Параметр Значение Формат значения

response

Количество измененных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:EditEntityProfileValues>
    <nbi:profileValues>
        <xsd:id>2</xsd:id>
        <xsd:value>new value</xsd:value>
    </nbi:profileValues>
    <nbi:profileValues>
        <xsd:id>8</xsd:id>
        <xsd:value>other new value</xsd:value>
    </nbi:profileValues>
</nbi:EditEntityProfileValues>
Ответ
<ns:EditEntityProfileValuesResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>2</ax21:response>
    </ns:return>
</ns:EditEntityProfileValuesResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

525

Параметр схемы профиля юр.лица с указанным id не найден

526

Значение поля 'value' не соответствует регулярному выражению, указанному в схеме профиля

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SetEntityProfileValues - Обновить значения параметров схем профилей юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет обновить значения параметров для нескольких схем профилей одновременно.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

keyName

Ключ параметра схемы

String

Текст длиной до 255 символов.

profileValues

Значения параметров выбранного профиля в массиве ProfileValueArray.

Различные параметры профиля домена. Если указать значение параметра null или пустой строкой, то в процессе редактирования такой параметр будет удалён. Значения параметров валидируются через регулярные выражения, указанные в схеме. Если регулярное выражение не задано, валидации не будет.

Выходные параметры

Параметр Значение Формат значения

response

Индексы измененных записей

String

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:SetEntityProfileValues>
    <nbi:keyName>toor.pA</nbi:keyName>
    <nbi:profileValues>
        <xsd:items>
           <xsd:classId>1</xsd:classId>
           <xsd:value>79995554433</xsd:value>
        </xsd:items>
    </nbi:profileValues>
</nbi:SetEntityProfileValues>
Ответ
<ns:SetEntityProfileValuesResponse>
    <ns:return xsi:type="ax21:NbiCodeResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax21:response>[47, 52]</ax21:response>
    </ns:return>
</ns:SetEntityProfileValuesResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Отсутствуте один или несколько обязательных параметров

525

Параметр схемы профиля юр.лица с заданным идентификатором не найден

526

Значение поля 'value' не соответствует регулярному выражению, указанному в схеме профиля

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileById - Получить профиль юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить имя и описание профиля юридического лица по его уникальному идентификатору.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

profile

Профиль юр.лица

EntityProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileById>
    <nbi:id>2</nbi:id>
</nbi:GetEntityProfileById>
Ответ
<ns:GetEntityProfileByIdResponse>
    <ns:return xsi:type="ax2122:EntityProfileResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:profile xsi:type="ax2122:EntityProfile">
            <ax2122:description>test description</ax2122:description>
            <ax2122:id>2</ax2122:id>
            <ax2122:name>test entity</ax2122:name>
        </ax2122:profile>
    </ns:return>
</ns:GetEntityProfileByIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

522

Профиль юр.лица с указанным id не найден

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileClassById - Получить схему профиля юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить схему профиля по его идентификатору

Входные параметры

Параметр Значение Формат значения Расшифровка формата

id

Уникальный идентификатор схемы профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

profileClass

Схема профиля юр. лица

EntityProfileClass

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileClassById>
    <nbi:id>2</nbi:id>
</nbi:GetEntityProfileClassById>
Ответ
<ns:GetEntityProfileClassByIdResponse>
    <ns:return xsi:type="ax2122:EntityProfileClassResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:profileClass xsi:type="ax2122:EntityProfileClass">
            <ax2122:description>description</ax2122:description>
            <ax2122:id>2</ax2122:id>
            <ax2122:name>test class</ax2122:name>
            <ax2122:profileId>2</ax2122:profileId>
            <ax2122:relationType>domain</ax2122:relationType>
            <ax2122:valueRegex>*</ax2122:valueRegex>
        </ax2122:profileClass>
    </ns:return>
</ns:GetEntityProfileClassByIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

524

Схема профиля юр.лица с указанным id не найдена

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileClassesByProfileId - Получить список схем профиля юр.лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить все схемы профиля, относящиеся к одному профилю.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

profileId

Идентификатор профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

classes

Список схем профиля юр. лица

EntityProfileClass

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileClassesByProfileId>
    <nbi:profileId>2</nbi:profileId>
</nbi:GetEntityProfileClassesByProfileId>
Ответ
<ns:GetEntityProfileClassesByProfileIdResponse>
    <ns:return xsi:type="ax2122:EntityProfileClassListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:classes xsi:type="ax2122:EntityProfileClass">
            <ax2122:description/>
            <ax2122:id>1</ax2122:id>
            <ax2122:name>test</ax2122:name>
            <ax2122:profileId>2</ax2122:profileId>
            <ax2122:relationType>role</ax2122:relationType>
            <ax2122:valueRegex>*</ax2122:valueRegex>
        </ax2122:classes>
        <ax2122:classes xsi:type="ax2122:EntityProfileClass">
            <ax2122:description>test description</ax2122:description>
            <ax2122:id>2</ax2122:id>
            <ax2122:name>test class</ax2122:name>
            <ax2122:profileId>2</ax2122:profileId>
            <ax2122:relationType>domain</ax2122:relationType>
            <ax2122:valueRegex>*</ax2122:valueRegex>
        </ax2122:classes>
    </ns:return>
</ns:GetEntityProfileClassesByProfileIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

522

Профиль юр.лица с указанным id не найден

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileClassesByProfileIdAndRelationType - Получить список схем профиля юр.лица по типу отношения

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить все схемы профиля, относящиеся к одному профилю, с фильтрацией по типу отношения.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

profileId

Уникальный идентификатор профиля

int

Целое положительное число

relationType

Отношение параметра к определенному виду сущностей (роли, домены)

^(domain|role)$

Домен или роль

Выходные параметры

Параметр Значение Формат значения

classes

Список схем профиля юр. лица

EntityProfileClass

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileClassesByProfileIdAndRelationType>
    <nbi:profileId>2</nbi:profileId>
    <nbi:relationType>domain</nbi:relationType>
</nbi:GetEntityProfileClassesByProfileIdAndRelationType>
Ответ
<ns:GetEntityProfileClassesByProfileIdAndRelationTypeResponse>
    <ns:return xsi:type="ax2122:EntityProfileClassListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:classes xsi:type="ax2122:EntityProfileClass">
            <ax2122:description>test description</ax2122:description>
            <ax2122:id>2</ax2122:id>
            <ax2122:name>test class</ax2122:name>
            <ax2122:profileId>2</ax2122:profileId>
            <ax2122:relationType>domain</ax2122:relationType>
            <ax2122:valueRegex>*</ax2122:valueRegex>
        </ax2122:classes>
    </ns:return>
</ns:GetEntityProfileClassesByProfileIdAndRelationTypeResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

522

Профиль юр.лица с указанным id не найден

523

Некорректное значение поля 'relationType'

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileList - Получить список профилей юр.лиц

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить список всех профилей юридических лиц с пагинацией.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

offset

Сдвиг по записям

int

Целое неотрицательное число, по умолчанию - 0

count

Число записей

int

Целое неотрицательное число, по умолчанию - 100

Выходные параметры

Параметр Значение Формат значения

profiles

Список профилей юр. лиц

EntityProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileList>
    <nbi:offset>0</nbi:offset>
    <nbi:count>10</nbi:count>
</nbi:GetEntityProfileList>
Ответ
<ns:GetEntityProfileListResponse>
    <ns:return xsi:type="ax2122:EntityProfileListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:profiles xsi:type="ax2122:EntityProfile">
            <ax2122:description>description</ax2122:description>
            <ax2122:id>1</ax2122:id>
            <ax2122:name>test</ax2122:name>
        </ax2122:profiles>
        <ax2122:profiles xsi:type="ax2122:EntityProfile">
            <ax2122:description>test description</ax2122:description>
            <ax2122:id>2</ax2122:id>
            <ax2122:name>test name</ax2122:name>
        </ax2122:profiles>
    </ns:return>
</ns:GetEntityProfileListResponse>
Код Описание ошибки

2

Ошибка доступа к БД

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileValuesByClassId - Получить список параметров схемы профиля юр. лица

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить список всех параметров, относящихся к определенной схеме профиля.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

classId

Уникальный идентификатор схемы профиля

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

values

Список параметров схемы профиля юр. лица

EntityProfileValue

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileValuesByClassId>
    <nbi:classId>2</nbi:classId>
</nbi:GetEntityProfileValuesByClassId>
Ответ
<ns:GetEntityProfileValuesByClassIdResponse>
    <ns:return xsi:type="ax2122:EntityProfileValueListResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2122:values xsi:type="ax2122:EntityProfileValue">
            <ax2122:classId>2</ax2122:classId>
            <ax2122:id>1</ax2122:id>
            <ax2122:keyName>test</ax2122:keyName>
            <ax2122:value>test</ax2122:value>
        </ax2122:values>
        <ax2122:values xsi:type="ax2122:EntityProfileValue">
            <ax2122:classId>2</ax2122:classId>
            <ax2122:id>2</ax2122:id>
            <ax2122:keyName>test1</ax2122:keyName>
            <ax2122:value>value</ax2122:value>
        </ax2122:values>
    </ns:return>
</ns:GetEntityProfileValuesByClassIdResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

524

Схема профиля юр.лица с указанным id не найдена

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetEntityProfileValueByClassIdAndKey - Получить параметр схемы профиля юр. лица по ключу

Общая информация

  1. Команда актуальна, начиная с версии 1.19.

  2. Команда позволяет получить параметр схемы профиля по идентификатору схемы и ключу параметра.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

classId

Уникальный идентификатор схемы профиля

int

Целое положительное число

keyName

Ключ параметра схемы

String

Текст длиной до 255 символов

Выходные параметры

Параметр Значение Формат значения

value

Параметр схемы профиля юр. лица

EntityProfileValue

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:GetEntityProfileValueByClassIdAndKey>
    <nbi:classId>2</nbi:classId>
    <nbi:keyName>test.root</nbi:keyName>
</nbi:GetEntityProfileValueByClassIdAndKey>
Ответ
<ns:GetEntityProfileValueByClassIdAndKeyResponse>
    <ns:return xsi:type="ax2115:EntityProfileValueResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2115:value xsi:type="ax2115:EntityProfileValue">
            <ax2115:classId>2</ax2115:classId>
            <ax2115:id>2</ax2115:id>
            <ax2115:keyName>test.root</ax2115:keyName>
            <ax2115:value>test</ax2115:value>
        </ax2115:value>
    </ns:return>
</ns:GetEntityProfileValueByClassIdAndKeyResponse>
Код Описание ошибки

2

Ошибка доступа к БД

281

Не указан один из обязательных параметров запроса

524

Схема профиля юр.лица с указанным id не найдена

999

Системная ошибка

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttConfig - Получить список параметров OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда служит для получения конфигурации OTT на всей платформе. В нее входят параметры, которые являются постоянными, но для удобства вынесены в отдельный конфигурационный файл в NBI (например, данные о номинальной емкости ESR по числу привязок OTT). Эти параметры используются NBI при создании привязок и доступны всем через данную команду NBI.

Выходные параметры

Параметр Значение Формат значения

ottDocument

Объект конфигурации OTT

OttDocument

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttConfig/>
Ответ
      <ns:GetOttConfigResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax271:ottDocument xsi:type="ax271:OttDocument">
               <ax271:capacitys xsi:type="ax271:CapacityParam">
                  <ax271:max>10</ax271:max>
                  <ax271:subtype>100</ax271:subtype>
               </ax271:capacitys>
               <ax271:capacitys xsi:type="ax271:CapacityParam">
                  <ax271:max>20</ax271:max>
                  <ax271:subtype>200</ax271:subtype>
               </ax271:capacitys>
               <!-- more capacitys -->
               <ax271:params xsi:type="ax273:ProfileParam">
                  <ax273:defaultValue>md5</ax273:defaultValue>
                  <ax273:description>IKE authentication algorithm (md5, sha1), md5 by default</ax273:description>
                  <ax273:paramName>ipsec.auth-alg</ax273:paramName>
                  <ax273:valueRegex>^(md5|sha1)$</ax273:valueRegex>
               </ax271:params>
               <ax271:params xsi:type="ax273:ProfileParam">
                  <ax273:defaultValue>1</ax273:defaultValue>
                  <ax273:description>IKE DH Group (1, 2, 5), 1 by default</ax273:description>
                  <ax273:paramName>ipsec.dh-group</ax273:paramName>
                  <ax273:valueRegex>^(1|2|5)$</ax273:valueRegex>
               </ax271:params>
               <!-- more params -->
            </ax271:ottDocument>
         </ns:return>
      </ns:GetOttConfigResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда служит для привязки отдельных ТД (идентификатор - MAC) к OTT ESR (идентификатор - его адрес в management сети EMS).

  3. В ответ на команду приходит привязка ОТТ с автоматически созданным паролем. Логин равен MAC адресу (для удобства отладки на ESR).

Дополнительные параметры привязки передаются в виде списка пар ключ-значение:

  • ap_domain - домен узла, в который инициализирована точка. Значение сохраняется для поиска ESR, на которые уже привязаны другие ТД этой локации.

  • key - ключ, по которому была найдена привязка инициализации. Если ТД имела собственную привязку инициализации, то в key передается MAC-адрес. Если была использована привязка по умолчанию для ОТТ ТД, то - 'ott_default'. Значение сохраняется для поиска созданных ОТТ привязок при действиях с привязками инициализации.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC адрес ТД OTT

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

6 чисел в hex виде, разделенные двоеточием или тире

ip

ESR (Management IP), к которому осуществляется привязка ТД OTT

1.2.3.4

IP адрес в привычном виде

params

Дополнительные параметры привязки

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

ottLink

Привязка OTT OttLink

OttLink

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:CreateOttLink>
         <nbi:mac>aa:bb:11:22:33:44</nbi:mac>
         <nbi:ip>192.168.26.193</nbi:ip>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ap_domain</xsd:name>
               <xsd:value>root</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>key</xsd:name>
               <xsd:value>aa:bb:11:22:33:44</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:CreateOttLink>
Ответ
      <ns:CreateOttLinkResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax271:ottLink xsi:type="ax271:OttLink">
               <ax271:createDate>2018-03-13T15:53:33.572+07:00</ax271:createDate>
               <ax271:esrIp>192.168.26.193</ax271:esrIp>
               <ax271:login>aa:bb:11:22:33:44</ax271:login>
               <ax271:mac>aa:bb:11:22:33:44</ax271:mac>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>ap_domain</ax21:name>
                  <ax21:value>root</ax21:value>
               </ax271:parameter>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>key</ax21:name>
                  <ax21:value>aa:bb:11:22:33:44</ax21:value>
               </ax271:parameter>
               <ax271:password>9100HTdQic4SjwqEnor9jvBW</ax271:password>
            </ax271:ottLink>
         </ns:return>
      </ns:CreateOttLinkResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

456

OTT привязка для указанного MAC уже существует

458

Не найдены данные о емкости ESR

459

В дереве объектов не найден OTT ESR по Management IP

460

ESR полностью заполнен привязками (выберите другой ESR)

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда возвращает полную информацию о привязке ОТТ по указанному MAC или null, если нет соответствующей привязки.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC адрес ТД OTT

Выходные параметры

Параметр Значение Формат значения

ottLink

Привязка OTT

OttLink

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttLink>
         <nbi:mac>aa:bb:11:22:33:44</nbi:mac>
      </nbi:GetOttLink>
Ответ
      <ns:GetOttLinkResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax271:ottLink xsi:type="ax271:OttLink">
               <ax271:createDate>2018-03-13T15:53:33.572+07:00</ax271:createDate>
               <ax271:esrIp>192.168.26.193</ax271:esrIp>
               <ax271:login>aa:bb:11:22:33:44</ax271:login>
               <ax271:mac>aa:bb:11:22:33:44</ax271:mac>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>ap_domain</ax21:name>
                  <ax21:value>root</ax21:value>
               </ax271:parameter>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>key</ax21:name>
                  <ax21:value>aa:bb:11:22:33:44</ax21:value>
               </ax271:parameter>
               <ax271:password>9100HTdQic4SjwqEnor9jvBW</ax271:password>
            </ax271:ottLink>
         </ns:return>
      </ns:GetOttLinkResponse>
Код Описание ошибки

281

Несовместимый тип данных в параметре вызова

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

В дополнительных параметрах запроса могут быть переданы:

  • skip, limit - диапазон выборки;

  • ap_domain - фильтр по полю ap_domain (домен ТД, домен узла, в который была инициализирована точка доступа);

  • key - ключ, по которому была найдена привязка инициализации;

  • mac - MAC адрес точки доступа;

  • esr_ip - ESR (Management IP), к которому осуществляется привязка ТД OTT;

  • free_filter - фильтр по любому полю из mac, key, esr_ip, ap_domain.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрации

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

ottLink

Список привязок OTT OttLink

OttLink

total

Общее число привязок OTT удовлетворяющих фильтру

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttLinkList>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>skip</xsd:name>
               <xsd:value>0</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>limit</xsd:name>
               <xsd:value>2</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>ap_domain</xsd:name>
               <xsd:value>root</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttLinkList>
Ответ
      <ns:GetOttLinkListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax271:ottLink xsi:type="ax271:OttLink">
               <ax271:createDate>2018-03-13T15:53:33.572+07:00</ax271:createDate>
               <ax271:esrIp>192.168.26.193</ax271:esrIp>
               <ax271:login>aa:bb:11:22:33:44</ax271:login>
               <ax271:mac>aa:bb:11:22:33:44</ax271:mac>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>ap_domain</ax21:name>
                  <ax21:value>root</ax21:value>
               </ax271:parameter>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>key</ax21:name>
                  <ax21:value>aa:bb:11:22:33:44</ax21:value>
               </ax271:parameter>
               <ax271:password>9100HTdQic4SjwqEnor9jvBW</ax271:password>
            </ax271:ottLink>
            <ax271:ottLink xsi:type="ax271:OttLink">
               <ax271:createDate>2018-03-13T16:05:26.041+07:00</ax271:createDate>
               <ax271:esrIp>192.168.26.193</ax271:esrIp>
               <ax271:login>aa:bb:11:22:33:77</ax271:login>
               <ax271:mac>aa:bb:11:22:33:77</ax271:mac>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>ap_domain</ax21:name>
                  <ax21:value>root</ax21:value>
               </ax271:parameter>
               <ax271:parameter xsi:type="ax21:NbiParameter">
                  <ax21:name>key</ax21:name>
                  <ax21:value>aa:bb:11:22:33:44</ax21:value>
               </ax271:parameter>
               <ax271:password>EueGqFplb7UVmW06koPCFHYR</ax271:password>
            </ax271:ottLink>
            <ax271:total>2</ax271:total>
         </ns:return>
      </ns:GetOttLinkListResponse>
Код Описание ошибки

7

Не найден домен ('ap_domain')

8

Некорректный формат домена ('ap_domain')

10

Нет прав на указанный домен ('ap_domain')

62

Указанный домен ('ap_domain') не найден в дереве доменов

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет удалить произвольное количество привязок ОТТ.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

param

Имя параметра, по которому осуществляется удаление

Доступны: mac, key, ap_domain, esr_ip

value

Список значений параметра, по которому осуществляется удаление

NbiStringList

Варианты использования:

  • mac aa:bb:11:22:33:44 - удалить привязку ОТТ конкретного устройства (ТД или клиенского ESR);

  • key ott_default - удалить все привязки OTT, созданные по привязке инициализации OTT по умолчанию;

  • ap_domain ap.root - удалить все привязки ОТТ в домене ap.root (без удаления в дочерних доменах);

  • ap_domain .ap.root - удалить все привязки ОТТ в домене ap.root и всех дочерних;

  • esr_ip 1.2.3.4 - удалить все привязки OTT к конкретному старнционному ESR.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:DeleteOttLinks>
         <nbi:param>mac</nbi:param>
         <nbi:value>
            <xsd:str>aa:bb:11:22:33:44</xsd:str>
            <xsd:str>aa:bb:11:22:33:77</xsd:str>
         </nbi:value>
      </nbi:DeleteOttLinks>
Ответ
      <ns:DeleteOttLinksResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteOttLinksResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttLinkSummary - Получить данные о загруженности по всем OTT ESR, которые установлены в этом домене

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить информацию о загруженности OTT ESR привязками. В результат попадут только те ESR, которые установлены в указанном домене (домен узла в дереве EMS).

В дополнительных параметрах могут быть переданы:

  • ap_domain - домен ТД, чтобы посчитать, число существующих привязок этого ESR к точкам из указанного домена (значение localCount в ответе). Если ap_domain не передается, то значение localCount не высчитывается вовсе.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен узла, в котором стоят ESR OTT

params

Дополнительные параметры

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

esrOtt

Список ESR OTT

EsrOtt

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttLinkSummary>
         <nbi:domain>ott.root</nbi:domain>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ap_domain</xsd:name>
               <xsd:value>ott.root</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttLinkSummary>
Ответ
      <ns:GetOttLinkSummaryResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:esrOtt xsi:type="ax268:EsrOtt">
               <ax268:count>2</ax268:count>
               <ax268:id>10046</ax268:id>
               <ax268:ip>192.168.26.193</ax268:ip>
               <ax268:load>0.04</ax268:load>
               <ax268:localCount>2</ax268:localCount>
               <ax268:max>50</ax268:max>
               <ax268:subtype>1000</ax268:subtype>
            </ax268:esrOtt>
         </ns:return>
      </ns:GetOttLinkSummaryResponse>
Код Описание ошибки

7

Не найден домен

8

Некорректный формат домена

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

281

Несовместимый тип данных в параметре вызова

305

Не найден узел по указанному домену

458

Не найдены данные о емкости ESR

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttLinkSummaryLocal - Получить данные о загруженности OTT ESR, к которым есть привязки ТД, установленных в указанном домене

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить информацию о загруженности OTT ESR привязками. В результат попадут только те ESR, на которых есть привязки ОТТ к точкам из указанного домена (домен узла в дереве EMS).

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

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен узла ТД

params

Дополнительные параметры

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

esrOtt

Список ESR OTT

EsrOtt

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttLinkSummaryLocal>
         <nbi:domain>ott.root</nbi:domain>
         <nbi:params>
            <xsd:parameter>
               <xsd:name></xsd:name>
               <xsd:value></xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttLinkSummaryLocal>
Ответ
      <ns:GetOttLinkSummaryLocalResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:esrOtt xsi:type="ax268:EsrOtt">
               <ax268:count>2</ax268:count>
               <ax268:id>10046</ax268:id>
               <ax268:ip>192.168.26.193</ax268:ip>
               <ax268:load>0.04</ax268:load>
               <ax268:localCount>2</ax268:localCount>
               <ax268:max>50</ax268:max>
               <ax268:subtype>1000</ax268:subtype>
            </ax268:esrOtt>
         </ns:return>
      </ns:GetOttLinkSummaryLocalResponse>
Код Описание ошибки

7

Не найден домен

8

Некорректный формат домена

10

Нет прав на указанный домен

62

Указанный домен не найден в дереве доменов

458

Не найдены данные о емкости ESR

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateOttProfile - Создать профиль OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет пользователю создать профиль ОТТ. Профиль ОТТ - полный список параметров ОТТ, передаваемых сервис-активатором на ТД.

  3. Полный список доступных параметров профиля, ограничений на значения можно получить, выполнив команду GetOttConfig

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя профиля

params

Параметры профиля NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:CreateOttProfile>
         <nbi:name>baby</nbi:name>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ipsec.lifetime</xsd:name>
               <xsd:value>300</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>ipsec.nat-keepalive</xsd:name>
               <xsd:value>5</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:CreateOttProfile>
Ответ
      <ns:CreateOttProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:CreateOttProfileResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

313

Неизвестный параметр профиля OTT (проверить список параметров в ответе GetOttConfig, изменить запрос)

436

Не указан один из параметров вызова

461

Профиль с таким именем уже существует

Пример использования

См. также

  1. GetOttConfig - Получить список параметров OTT

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditOttProfile - Редактировать профиль OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет изменить параметры профиля ОТТ. При редактировании все старые параметры стираются и заменяются на новые, поэтому в команде нужно передавать полный список параметров, которые теперь нужно хранить в БД для данного профиля.

  3. Полный список доступных параметров профиля, ограничений на значения можно получить, выполнив команду GetOttConfig

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя профиля

params

Новые значения всех параметров профиля

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

profile

Профиль OTT NbiOttProfile

NbiOttProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:EditOttProfile>
         <nbi:name>rust</nbi:name>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ipsec.auth-alg</xsd:name>
               <xsd:value>md5</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>ipsec.gre-mode</xsd:name>
               <xsd:value>up</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:EditOttProfile>
Ответ
      <ns:EditOttProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:profile xsi:type="ax268:NbiOttProfile">
               <ax268:createDate>2018-03-05T14:12:10.422+07:00</ax268:createDate>
               <ax268:name>rust</ax268:name>
               <ax268:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mode</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
               </ax268:params>
            </ax268:profile>
         </ns:return>
      </ns:EditOttProfileResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

313

Неизвестный параметр профиля OTT (проверить список параметров в ответе GetOttConfig, изменить запрос)

436

Не указан один из параметров вызова

462

Не найден профиль OTT с указанным именем

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttProfile - Получить профиль OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить полный список параметров одного профиля ОТТ.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Имя профиля OTT

Выходные параметры

Параметр Значение Формат значения

profile

Профиль OTT NbiOttProfile

NbiOttProfile

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttProfile>
         <nbi:name>rust</nbi:name>
      </nbi:GetOttProfile>
Ответ
      <ns:GetOttProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax265:profile xsi:type="ax265:NbiOttProfile">
               <ax265:createDate>2018-03-05T14:12:10.422+07:00</ax265:createDate>
               <ax265:name>rust</ax265:name>
               <ax265:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mode</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.mode-cfg</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dh-group</ax21:name>
                     <ax21:value>1</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-lifetime</ax21:name>
                     <ax21:value>3600</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.status</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dpd-delay</ax21:name>
                     <ax21:value>60</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat-keepalive</ax21:name>
                     <ax21:value>30</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.use-xauth-passwd</ax21:name>
                     <ax21:value>off</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.pfs-group</ax21:name>
                     <ax21:value>0</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.force-establish</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.lifetime</ax21:name>
                     <ax21:value>86400</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mtu-offset</ax21:name>
                     <ax21:value>148</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-ping-counter</ax21:name>
                     <ax21:value>3</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.password</ax21:name>
                     <ax21:value>123456789</ax21:value>
                  </ax21:parameter>
               </ax265:params>
            </ax265:profile>
         </ns:return>
      </ns:GetOttProfileResponse>
Код Описание ошибки

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttProfileList - Получить список профилей OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить список профилей ОТТ. Уникальным признаком профиля ОТТ является его имя.

  3. В качестве дополнительных параметров можно передать ограничения выборки skip, limit.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрафии NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

profile

Список профилей OTT NbiOttProfile

NbiOttProfile

total

Общее число профилей OTT, удовлетворяющих фильтру

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttProfileList>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>skip</xsd:name>
               <xsd:value>1</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>limit</xsd:name>
               <xsd:value>1</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttProfileList>
Ответ
      <ns:GetOttProfileListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax265:profile xsi:type="ax265:NbiOttProfile">
               <ax265:createDate>2018-03-05T14:12:10.422+07:00</ax265:createDate>
               <ax265:name>rust</ax265:name>
               <ax265:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mode</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.mode-cfg</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dh-group</ax21:name>
                     <ax21:value>1</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-lifetime</ax21:name>
                     <ax21:value>3600</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.status</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dpd-delay</ax21:name>
                     <ax21:value>60</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat-keepalive</ax21:name>
                     <ax21:value>30</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.use-xauth-passwd</ax21:name>
                     <ax21:value>off</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.pfs-group</ax21:name>
                     <ax21:value>0</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.force-establish</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.lifetime</ax21:name>
                     <ax21:value>86400</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mtu-offset</ax21:name>
                     <ax21:value>148</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-ping-counter</ax21:name>
                     <ax21:value>3</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.password</ax21:name>
                     <ax21:value>123456789</ax21:value>
                  </ax21:parameter>
               </ax265:params>
            </ax265:profile>
            <ax265:total>3</ax265:total>
         </ns:return>
      </ns:GetOttProfileListResponse>
Код Описание ошибки

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttProfileNameList - Получить список имен профилей OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить список имен профилей ОТТ. Уникальным признаком профиля ОТТ является его имя.

  3. В качестве дополнительных параметров можно передать ограничения выборки skip, limit.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрафии

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

list

Список строк

NbiStringList

total

Общее число строк, удовлетворяющих заданному фильтру

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttProfileNameList>
         <!--Optional:-->
         <nbi:params>
            <xsd:parameter>
               <xsd:name>skip</xsd:name>
               <xsd:value>0</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>limit</xsd:name>
               <xsd:value>2</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttProfileNameList>
Ответ
      <ns:GetOttProfileNameListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax245:list xsi:type="ax245:NbiStringList">
               <ax245:str>trest</ax245:str>
               <ax245:str>rust</ax245:str>
            </ax245:list>
            <ax245:total>3</ax245:total>
         </ns:return>
      </ns:GetOttProfileNameListResponse>
Код Описание ошибки

281

Несовместимый тип данных в параметре вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteOttProfile - Удалить профили OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет удалить произвольное число профилей ОТТ.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

name

Список имен профилей OTT, которые будут удалены

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:DeleteOttProfile>
         <nbi:name>
            <xsd:str>baby</xsd:str>
            <xsd:str>profile</xsd:str>
         </nbi:name>
      </nbi:DeleteOttProfile>
Ответ
      <ns:DeleteOttProfileResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteOttProfileResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

466

Запрещено удалять профиль, который привязан к какой-либо станции OTT

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CreateOttStation - Создать станцию OTT (конфигурацию OTT ESR)

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет создать станцию ОТТ (ОТТ ESR). Станция ОТТ это уникальная для каждого ESR, предоставляющего услугу ОТТ, запись, связывающая адрес ESR в сети ЕМС, профиль ОТТ и дополнительные параметры, которые требуется переопределить относительно профиля.

  3. Среди дополнительных параметров обязательным является ipsec.remote-gateway, так как он должен быть уникальным на каждом ESR, так как к нему обращаются точки доступа через интернет.

  4. Полный список доступных параметров профиля, ограничений на значения можно получить, выполнив команду GetOttConfig

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP адрес станции OTT (ESR Management IP)

profile

Имя профиля OTT

params

Параметры профиля OTT, которые нужно переопределить для данного ESR

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:CreateOttStation>
         <nbi:ip>1.2.3.4</nbi:ip>
         <nbi:profile>rust</nbi:profile>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ipsec.remote-gateway</xsd:name>
               <xsd:value>10.11.12.13</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:CreateOttStation>
Ответ
      <ns:CreateOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:CreateOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

313

Неизвестный параметр профиля OTT (проверить список параметров в ответе GetOttConfig, изменить запрос)

436

Не указан один из параметров вызова

462

Не найден профиль OTT с указанным именем (в параметре 'profile')

463

Станция OTT с указанным адресом уже существует

532

IP-адрес удаленного шлюза (IPsec remote gateway) уже используется в настройках другого ESR

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EditOttStation - Полное редактирование станцию OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет изменить все параметры станции OTT. При редактировании все старые параметры стираются и заменяются на новые, поэтому в команде нужно передавать полный список параметров, которые теперь нужно хранить в БД для данной станции ОТТ.

  3. Для изменения только отдельных переданных в запросе параметров используйте UpdateOttStation

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP адрес станции OTT (ESR Management IP)

profile

Имя профиля OTT

params

Новые значения всех параметров станции OTT

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

station

Станция OTT NbiOttStation

NbiOttStation

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:EditOttStation>
         <nbi:ip>192.168.26.193</nbi:ip>
         <nbi:profile>trest</nbi:profile>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>ipsec.remote-gateway</xsd:name>
               <xsd:value>5.5.5.5</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:EditOttStation>
Ответ
      <ns:EditOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:station xsi:type="ax268:NbiOttStation">
               <ax268:createDate>2018-03-13T16:56:14.923+07:00</ax268:createDate>
               <ax268:ip>192.168.26.193</ax268:ip>
               <ax268:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.remote-gateway</ax21:name>
                     <ax21:value>5.5.5.5</ax21:value>
                  </ax21:parameter>
               </ax268:params>
               <ax268:profile>trest</ax268:profile>
            </ax268:station>
         </ns:return>
      </ns:EditOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

313

Неизвестный параметр профиля OTT (проверить список параметров в ответе GetOttConfig, изменить запрос)

436

Не указан один из параметров вызова

462

Не найден профиль OTT с указанным именем (в параметре 'profile')

464

Не найдена станция OTT по заданному IP

532

IP-адрес удаленного шлюза (IPsec remote gateway) уже используется в настройках другого ESR

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

UpdateOttStation - Редактировать отдельные параметры станций OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет изменить отдельные параметры станции OTT. Только переданные в запросе параметры будут изменены в базе данных. Для удаления параметра из БД нужно передавать значение "$unset" (без кавычек).

  3. Полный список доступных параметров профиля, ограничений на значения можно получить, выполнив команду GetOttConfig

  4. Команду можно выполнять сразу для нескольких станций (например, если все их нужно переключить на другой профиль). Однако, параметр remote-gateway является персональным параметром станции и потому при попытке выполнить его изменение более чем для одного устройства, система вернет ошибку.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

Список ESR Management IP, станции OTT которых нужно отредактировать

NbiStringList

params

Изменившиеся параметры станции OTT

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:UpdateOttStation>
         <nbi:ip>
            <xsd:str>192.168.26.193</xsd:str>
         </nbi:ip>
         <nbi:params>
            <xsd1:parameter>
               <xsd1:name>ipsec.remote-gateway</xsd1:name>
               <xsd1:value>5.4.3.2</xsd1:value>
            </xsd1:parameter>
         </nbi:params>
      </nbi:UpdateOttStation>
Ответ
      <ns:UpdateOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:UpdateOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

313

Неизвестный параметр профиля OTT (проверить список параметров в ответе GetOttConfig, изменить запрос)

436

Не указан один из параметров вызова

462

Не найден профиль OTT с указанным именем (в параметре 'profile')

463

Станция OTT с указанным адресом уже существует (возникает при попытке изменить 'esr_ip' на уже существующий в базе)

467

Разрешено менять 'esr_ip' только для одной станции OTT за один запрос

532

IP-адрес удаленного шлюза (IPsec remote gateway) уже используется в настройках другого ESR

533

IPsec remote gateway уникальный у каждой OTT станции, поэтому может изменяться командой только для одного ESR

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttStation - Получить параметры станции OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить индивидуальные параметры станции ОТТ.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP адрес станции OTT (ESR Management IP)

Выходные параметры

Параметр Значение Формат значения

station

Станция OTT

NbiOttStation

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttStation>
         <nbi:ip>192.168.26.193</nbi:ip>
      </nbi:GetOttStation>
Ответ
      <ns:GetOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:station xsi:type="ax268:NbiOttStation">
               <ax268:createDate>2018-03-13T16:56:14.923+07:00</ax268:createDate>
               <ax268:ip>192.168.26.193</ax268:ip>
               <ax268:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.remote-gateway</ax21:name>
                     <ax21:value>5.4.3.2</ax21:value>
                  </ax21:parameter>
               </ax268:params>
               <ax268:profile>trest</ax268:profile>
            </ax268:station>
         </ns:return>
      </ns:GetOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

MergeOttStation - Получить все параметры OTT по ESR IP (комбинация параметров профиля и станции)

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить все параметры Станции ОТТ и Профиля ОТТ, назначенного ей, в одном списке параметров для последующей передачи на ТД. Параметры станции переопределяют параметры профиля.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

IP адрес станции OTT (ESR Management IP)

Выходные параметры

Параметр Значение Формат значения

station

Станция OTT

NbiOttStation

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:MergeOttStation>
         <nbi:ip>192.168.26.193</nbi:ip>
      </nbi:MergeOttStation>
Ответ
      <ns:MergeOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:station xsi:type="ax268:NbiOttStation">
               <ax268:createDate>2018-03-13T16:56:14.923+07:00</ax268:createDate>
               <ax268:ip>192.168.26.193</ax268:ip>
               <ax268:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-ping-counter</ax21:name>
                     <ax21:value>3</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat-keepalive</ax21:name>
                     <ax21:value>30</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-encrypt-alg</ax21:name>
                     <ax21:value>aes</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.remote-gateway</ax21:name>
                     <ax21:value>5.4.3.2</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mtu-offset</ax21:name>
                     <ax21:value>148</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.lifetime</ax21:name>
                     <ax21:value>86400</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dpd-delay</ax21:name>
                     <ax21:value>60</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.gre-mode</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.password</ax21:name>
                     <ax21:value>123456789</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.force-establish</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.use-xauth-passwd</ax21:name>
                     <ax21:value>off</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.dh-group</ax21:name>
                     <ax21:value>1</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.pfs-group</ax21:name>
                     <ax21:value>0</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-auth-alg</ax21:name>
                     <ax21:value>md5</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.nat</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.sa-lifetime</ax21:name>
                     <ax21:value>3600</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.mode-cfg</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.status</ax21:name>
                     <ax21:value>up</ax21:value>
                  </ax21:parameter>
               </ax268:params>
               <ax268:profile>trest</ax268:profile>
            </ax268:station>
         </ns:return>
      </ns:MergeOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttStationList - Получить список станций OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить список станций ОТТ (ОТТ ESR). Станция ОТТ это уникальная для каждого ESR, предоставляющего услугу ОТТ, запись, связывающая адрес ESR в сети ЕМС, профиль ОТТ и дополнительные параметры, которые требуется переопределить относительно профиля.

  3. Среди дополнительных параметров обязательным является ipsec.remote-gateway, так как по этому адресу устройства связываются с ESR через интернет, он может быть назначен только на одно устройство и его нельзя получить из профиля.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрации

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

station

Список станций OTT

NbiOttStation

total

Общее число записей, удовлетворяющих фильтру

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttStationList>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>skip</xsd:name>
               <xsd:value>0</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>limit</xsd:name>
               <xsd:value>1</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttStationList>
Ответ
      <ns:GetOttStationListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax265:station xsi:type="ax265:NbiOttStation">
               <ax265:createDate>2018-03-13T16:56:14.923+07:00</ax265:createDate>
               <ax265:ip>192.168.26.193</ax265:ip>
               <ax265:params xsi:type="ax21:NbiParameterArray">
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.remote-gateway</ax21:name>
                     <ax21:value>4.4.4.4</ax21:value>
                  </ax21:parameter>
                  <ax21:parameter xsi:type="ax21:NbiParameter">
                     <ax21:name>ipsec.lifetime</ax21:name>
                     <ax21:value>33000</ax21:value>
                  </ax21:parameter>
               </ax265:params>
               <ax265:profile>trest</ax265:profile>
            </ax265:station>
            <ax265:total>1</ax265:total>
         </ns:return>
      </ns:GetOttStationListResponse>
Код Описание ошибки

281

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteOttStation - Удалить станцию OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет удалить произвольное число Станций ОТТ по их IP адресам (ESR IP в сети EMS).

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ip

Список IP адресов станций OTT (ESR Management IP)

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:DeleteOttStation>
         <nbi:ip>
            <xsd:str>1.2.3.4</xsd:str>
            <xsd:str>11.12.13.14</xsd:str>
         </nbi:ip>
      </nbi:DeleteOttStation>
Ответ
      <ns:DeleteOttStationResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteOttStationResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

465

Станция OTT имеет привязки к ТД и не может быть удалена

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AddOttBlack - Добавить записи в черный список OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. В правила блокировки можно добавить как целый MAC адрес, так и его часть (1-5 первых байт), в таком случае будет блокироваться весь диапазон адресов.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

macs

Список записей, которым нужно блокировать доступ к услуге OTT

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<nbi:AddOttBlack>
   <nbi:macs>
      <xsd:str>aa</xsd:str>
      <xsd:str>bb:01</xsd:str>
      <xsd:str>11:22:33:44:55:66</xsd:str>
   </nbi:macs>
</nbi:AddOttBlack>
Ответ
      <ns:AddOttBlackResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:AddOttBlackResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

468

Запись уже блокируется черным списком

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetOttBlackList - Получить список записей черного списка OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получать содержимое черного списка ОТТ. Черный список ОТТ один на всю систему. В случае попадания MAC или диапазона MAC в черный список доступ к услуге ОТТ для них закрывается.

В качестве дополнительных параметров можно передать:

  • skip, limit - диапазон выборки;

  • префикс mac, тогда будет фильтрация записей по полю mac по принципу 'start with'.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

params

Параметры фильтрации

NbiParameterArray

Выходные параметры

Параметр Значение Формат значения

macs

Список правил блокировки MAC

NbiBlackMac

total

Общее число записей, удовлетворяющих фильтрам выборки

long

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetOttBlackList>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>skip</xsd:name>
               <xsd:value>5</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>limit</xsd:name>
               <xsd:value>5</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetOttBlackList>
Ответ
      <ns:GetOttBlackListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax268:macs xsi:type="ax268:NbiBlackMac">
               <ax268:lockDate>2018-02-19T14:11:36.417+07:00</ax268:lockDate>
               <ax268:mac>ae:00:11:22:33:44</ax268:mac>
            </ax268:macs>
            <ax268:macs xsi:type="ax268:NbiBlackMac">
               <ax268:lockDate>2018-02-19T14:14:32.249+07:00</ax268:lockDate>
               <ax268:mac>aa:00:11:22:33:44:55</ax268:mac>
            </ax268:macs>
            <ax268:macs xsi:type="ax268:NbiBlackMac">
               <ax268:lockDate>2018-02-19T16:47:19.743+07:00</ax268:lockDate>
               <ax268:mac>ab:00</ax268:mac>
            </ax268:macs>
            <ax268:macs xsi:type="ax268:NbiBlackMac">
               <ax268:lockDate>2018-02-19T17:13:00.957+07:00</ax268:lockDate>
               <ax268:mac>ab:11</ax268:mac>
            </ax268:macs>
            <ax268:macs xsi:type="ax268:NbiBlackMac">
               <ax268:lockDate>2018-02-19T17:13:09.246+07:00</ax268:lockDate>
               <ax268:mac>ab:22:00</ax268:mac>
            </ax268:macs>
            <ax268:total>12</ax268:total>
         </ns:return>
      </ns:GetOttBlackListResponse>
Код Описание ошибки

281

Не указан один из параметров вызова

312

Некорректное значение фильтра по mac

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DeleteOttBlack - Удалить записи черного списка OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет удалить произвольное количество записей из черного списка ОТТ.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

param

Имя параметра, по которому делается удаление записей

Доступно только одно значение - mac

value

Список значений параметра, по которым делается удаление записей

NbiStringList

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:DeleteOttBlack>
         <nbi:param>mac</nbi:param>
         <nbi:value>
            <xsd:str>AA</xsd:str>
            <xsd:str>BB:11</xsd:str>
         </nbi:value>
      </nbi:DeleteOttBlack>
Ответ
      <ns:DeleteOttBlackResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
         </ns:return>
      </ns:DeleteOttBlackResponse>
Код Описание ошибки

312

Некорректный формат одного из значений параметра

436

Не указан один из параметров вызова

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

IsLockedOttBlack - Проверить блокировку ТД по черному списку OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет узнать, блокируется ли указанный MAC или диапазон MAC черным списком ОТТ.

  3. Может использоваться при работе сервис-активатора, чтобы блокировать доступ к услуге ОТТ, или в системе управления, чтобы узнать, имеет ли смысл добавлять запись в черный список, или же она уже заблокирована каким-либо правилом.

  4. Команда всегда возвращает код Успешно. В случае, если МАС адрес уже блокируется черным списком, в detail будет указана блокирующая запись.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

mac

MAC адрес ТД или его начальная часть

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:IsLockedOttBlack>
         <nbi:mac>bb:55:44:33:22:11</nbi:mac>
      </nbi:IsLockedOttBlack>
Ответ
      <ns:IsLockedOttBlackResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>bb</ax21:detail>
         </ns:return>
      </ns:IsLockedOttBlackResponse>
Код Описание ошибки

312

Неправильный формат параметра. Должен содержать 1-6 байт MAC адреса (HEX), разделенных символом ':'

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

OttDocument - Объект конфигурации OTT

Общая информация

  1. Актуально, начиная с версии 1.9.

  2. Данные загружаются из файла /usr/lib/eltex-radius-nbi/conf/ott/ott.xml. После изменения содержимого сервис NBI должен быть перезапущен, так как данные вычитываются только на старте.

Параметры объекта

Параметр Значение Формат значения

capacitys

Номинальная емкость по привязкам OTT для каждого типа ESR

CapacityParam

params

Параметры профиля, станции OTT

ProfileParam

Параметры профиля

Имя параметра Описание По умолчанию

ipsec.auth-alg

IKE authentication algorithm (md5, sha1), md5 by default

md5

ipsec.dh-group

IKE DH Group (1, 2, 5), 1 by default

1

ipsec.dpd-delay

IPsec DPD Delay (5..600), 60 by default

60

ipsec.encrypt-alg

IKE encryption algorithm (aes, des, 3des), aes by default

aes

ipsec.force-establish

Force establish tunnel (up, down), 'up' by default

up

ipsec.gre-mode

Use GRE mode (up, down), 'up' by default

up

ipsec.gre-mtu-offset

GRE MTU offset (0..220), 148 by default

148

ipsec.lifetime

IKE lifetime (180..86400), 86400 by default

86400

ipsec.mode-cfg

Use ISAKMP mode config (up, down), 'up' by default

up

ipsec.nat

Use NAT-T (up, down), 'up' by default

up

ipsec.nat-keepalive

IPsec NAT Keepalive (1..300), 30 by default

30

ipsec.password

IPsec password (8-48 chars)

eltex123

ipsec.pfs-group

IPsec DH Group (0, 1, 2, 5), 0 by default

0

ipsec.sa-auth-alg

IPsec authentication algorithm (md5, sha1), md5 by default

md5

ipsec.sa-encrypt-alg

IPsec encryption algorithm (null_enc, aes, des, 3des), aes by default

aes

ipsec.sa-lifetime

IPsec child SA lifetime (180..86400), 3600 by default

3600

ipsec.status

IPsec operational status (up, down), 'up' by default

up

ipsec.use-xauth-passwd

Use XAUTH password as IPsec password (on/off) default off

off

ipsec.xauth-password

XAUTH password (8-48 chars)

ipsec.xauth-user

XAUTH user (4-16 chars)

ipsec.remote-gateway

IPsec remote gateway (IP or URL)

ipsec.gre-ping-counter

GRE ping counter (3..60), 3 by default

3

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CapacityParam - Объект параметра емкости ESR по привязкам OTT

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Объект содержит данные о номинальной емкости ESR по привязкам OTT. Значения могут корректироваться на работающей системе с учетом наблюдений за работой оборудования, различных конфигураций, количества SSID (VLAN), используемых на ТД.

Параметры объекта

Параметр Значение Формат значения

subtype

Подтип ESR

Строка, строго соответствующая типизации устройства ESR в системе EMS.

max

Номинальная емкость

Integer

Значения по умолчанию

Тип ESR Номинальная емкость

ESR100

10

ESR200

20

ESR1000

100

ESR1200

100

ESR-1500

100

ESR-1700

1000

ESR-3100

100

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

mac

MAC адрес точки доступа

String

esrIp

Management IP OTT ESR’а для создания привязки

String

login

XAuth логин

String

password

XAuth пароль

String

parameter

Дополнительные параметры привязки OTT

NbiParameter

createDate

Дата создания привязки OTT

Calendar

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EsrOtt - Информация о OTT ESR

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Структура для отображения данных по загруженности ОТТ ESR привязками к ТД.

Параметры объекта

Параметр Значение Формат значения

id

ID объекта в дереве EMS

int

subtype

Подтип ESR

String

ip

ESR Management IP

String

count

Общее число привязанных ТД

int

max

Максимальная допустимая загрузка привязками для ESR данного типа

int

load

Загрузка ESR в сотых долях единицы

double

localCount

Число привязок из искомой локации (Домена узла с ТД)

int

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiOttProfile - Профиль OTT

Общая информация

  1. Актуальна, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

name

Имя

String

params

Параметры профиля в виде ключ-значение

NbiParameterArray

createDate

Дата создания профиля

Calendar

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiOttStation - Информация о Станции OTT

Общая информация

  1. Актуально, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

ip

Адрес станции - ESR management IP

String

profile

Профиль OTT

String

params

Массив параметров станции в виде ключ-значение

NbiParameterArray

createDate

Дата создания станции

Calendar

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiBlackMac - Правило блокировки ОТТ

Общая информация

  1. Актуально, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

mac

MAC адрес или его часть (правил блокировки диапазона MAC)

String

lockDate

Время внесения в черный список

Calendar

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SendEmailRequest - Отправить e-mail через службу Eltex NGW

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Может использоваться для отправки любых уведомлений. Например, можно сообщить пользователю его логин-пароль после создания учетной записи для Личного кабинета.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

email

Получатель

^(?!.\.\s$)\s*?(.)@(.?)\s*$

Адрес электронной почты

subject

Тема

String

0, Любые символы

message

Тело письма

String

0, Любые символы

Выходные параметры

Параметр Значение Формат значения

ngwCode

Код ответа NGW

int

ngwDetail

Пояснение к ответу NGW

String

code

Код ответа NBI

int

detail

Пояснение к ответу NBI

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:SendEmailRequest>
         <nbi:email>anna@ngs.ru</nbi:email>
         <nbi:subject>Предоставление доступа в ЛК Wi-Fi</nbi:subject>
         <nbi:message>Вам предоставлен доступ в ЛК Wi-Fi: логин anna, пароль password</nbi:message>
      </nbi:SendEmailRequest>
Ответ
      <ns:SendEmailRequestResponse>
         <ns:return xsi:type="ax298:NgwResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax298:ngwCode>0</ax298:ngwCode>
            <ax298:ngwDetail>Success</ax298:ngwDetail>
         </ns:return>
      </ns:SendEmailRequestResponse>
Код Описание ошибки

500

Неверно задан email

508

Ошибка NGW-NBI

Пример использования

См. также

  1. Создать пользователя в базе eltex_auth_service

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

SyncSSID - запустить асинхронный процесс исправления привязок в EMS.

Общая информация

  1. Команда актуальна, начиная с версии 1.19

  2. Команда предназначена для запуска асинхронных задач по исправлению привязок, на указанном SSID. При указании SSID, домена запускается синхронизация всех привязок этого SSID. Для того чтобы запустить исправление только одной привязки, необходимо указать NAS Key (ключ привязки SSID).

  3. Чтобы проверить статус процесса синхронизации в EMS, используйте команду GetAsyncProcessStatus

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID

^[ a-zA-Z0-9_\-\.!]{1,32}$

Строка соответствующая регулярному выражению из колонки формат значения

ssidDomain

Домен SSID

FQDN

Домен в формате FQDN

nasKey

Опциональный параметр, ключ привязки

Текст

Выходные параметры

Параметр Значение Формат значения

taskId

Идентификатор созданной асинхронной задачи

Положительное целое число или несколько чисел

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание

0

Успешно

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен SSID

62

Домен не зарегистрирован

227

Имя SSID не задано или не удовлетворяет требованиям

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

3

Ошибка от сервиса NBI EMS

16

SSID не существует

Пример использования

Запрос

Запуск синхронизации всех привязок SSID SSID_TEST_LINKS@root.

   <soapenv:Body>
      <soapenv:Body>
      <nbi:SyncSSID>
         <nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
         <nbi:ssidDomain>root</nbi:ssidDomain>
      </nbi:SyncSSID>
   </soapenv:Body>
   </soapenv:Body>
Ответ
    <soapenv:Body>
      <ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>4</ax21:taskId>
            <ax21:taskId>5</ax21:taskId>
         </ns:return>
      </ns:SyncSSIDResponse>
   </soapenv:Body>
Запрос

Запуск синхронизации привязки SSID SSID_TEST_LINKS@root в домене ap.root.

   <soapenv:Body>
      <soapenv:Body>
      <nbi:SyncSSID>
         <nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
         <nbi:ssidDomain>root</nbi:ssidDomain>
         <nbi:nasKey>ap.root</nbi:nasKey>
      </nbi:SyncSSID>
   </soapenv:Body>
   </soapenv:Body>
Ответ
   <soapenv:Body>
      <ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>9</ax21:taskId>
         </ns:return>
      </ns:SyncSSIDResponse>
   </soapenv:Body>

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DesyncSSID - запустить асинхронный процесс удаления SSID с ТД в заданной привязке

Общая информация

  1. Команда актуальна, начиная с версии 1.19

  2. Команда предназначена для запуска асинхронных задач по удаления SSID с точек по привязке. Необходимо указать название SSID, домен SSID и ключ привязки SSID.

  3. Чтобы проверить статус процесса синхронизации в EMS, используйте команду GetAsyncProcessStatus

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

ssidName

Имя SSID

^[ a-zA-Z0-9_\-\.!]{1,32}$

Строка соответствующая регулярному выражению из колонки формат значения

ssidDomain

Домен SSID

FQDN

Домен в формате FQDN

nasKey

Ключ привязки - домен, MAC-адрес или IP-адрес.

Текст

Выходные параметры

Параметр Значение Формат значения

taskId

Идентификатор созданной асинхронной задачи

Положительное целое число или несколько чисел

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

Примеры команд и кодов

Код Описание

0

Успешно

8

Нет домена или домен не соответствует правилам

10

Домен роли не имеет прав на домен SSID

62

Домен не зарегистрирован

227

Имя SSID не задано или не удовлетворяет требованиям

18

В конфигурации неверно настроен адрес EMS NBI или он недоступен

3

Ошибка от сервиса NBI EMS

16

SSID не существует

521

Ключ привязки задан некорректно
Запрос
      <nbi:DesyncSSID>
         <nbi:ssidName>RT_DEV</nbi:ssidName>
         <nbi:ssidDomain>ap.root</nbi:ssidDomain>
         <nbi:nasKey>new.root</nbi:nasKey>
      </nbi:DesyncSSID>
Ответ
      <ns:DesyncSSIDResponse">
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>8</ax21:taskId>
         </ns:return>
      </ns:DesyncSSIDResponse>
Запрос
      <nbi:DesyncSSID>
         <nbi:ssidName>RT_DEV</nbi:ssidName>
         <nbi:ssidDomain>ap.root</nbi:ssidDomain>
         <nbi:nasKey>region.ap.root</nbi:nasKey>
      </nbi:DesyncSSID>
Ответ
      <ns:DesyncSSIDResponse>
         <ns:return xsi:type="ax21:NbiTaskIdListResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:taskId>12</ax21:taskId>
            <ax21:taskId>13</ax21:taskId>
         </ns:return>
      </ns:DesyncSSIDResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAsyncProcessStatus - получить статус асинхронного процесса в EMS.

Общая информация

  1. Команда актуальна, начиная с версии 1.21

  2. Команда предназначена для получения статуса асинхронного процесса . Для того чтобы получить статус асинхронного процесса необходимо указать processId (Идентификатор асинхронного процесса).

Входные параметры

Параметр Значение Формат значения Расшифровка формата

processId

Идентификатор асинхронного процесса

int

Целое положительное число

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

message

Ответ от EMS

Текст английскими буквами с пробелами и спецсимволами.

processId

Идентификатор асинхронного процесса

Целое положительное число

status

Статус асинхронного процесса

Текст

Возможные статусы

Финальный статус означает, что процесс в этом статусе завершен.

Статус Описание Финальный

NOT_START

Не запущен

WORKED

В работе

FINISHED

Завершен успешно

Да

LOCALE_ERROR

Завершен с проблемами

Да

FATAL_ERROR

Не планово завершен

Да

CANCELED

Прерван оператором

Да

UNKNOW

Неизвестный

WARN

Внимание (В работе)

RESPONSE

Ответ (В работе)

CANCELED_WITH_ERROR

Прерван, были ошибки

Да

TO_CONTINUE

Ожидание

ID_NOT_SPECIFIED

Не найден ID процесса

Да

NOT_FOUND

Не найден процесс с данным ID

Да

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос

Получение статуса асинхронного процесса.

   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAsyncProcessStatus>
         <nbi:process_Id>1</nbi:process_Id>
      </nbi:GetAsyncProcessStatus>
   </soapenv:Body>
Ответ
   <soapenv:Body>
      <ns:GetAsyncProcessStatusResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:AsyncProcessResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:message>OK</ax21:message>
            <ax21:processId>1</ax21:processId>
            <ax21:status>FINISHED</ax21:status>
         </ns:return>
      </ns:GetAsyncProcessStatusResponse>
   </soapenv:Body>
Код Описание ошибки

281

Неверное задание идентификатора процесса

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetVersion - Получение версии сервиса NBI SOAP/XML

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Также используется для проверки работоспособности сервиса, наличия соединения с сервером.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

response

Объект NbiMessage

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:GetVersion/>
Ответ
      <ns:GetVersionResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiMessage">
               <ax21:message>1.9-717 (19-03-2018 16:13:09)</ax21:message>
            </ax21:response>
         </ns:return>
      </ns:GetVersionResponse>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetClientInfo - получение информации о клиенте SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

response

Объект NbiClientInfo

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetClientInfo/>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetClientInfoResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeClientInfo"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiClientInfo">
                    <ax21:clientLogin>soapuser</ax21:clientLogin>
                    <ax21:domain>enterprise.root</ax21:domain>
                    <ax21:domain>test.root</ax21:domain>
                    <ax21:domain>hotspot.root</ax21:domain>
                    <ax21:roleName>Enterprise</ax21:roleName>
                    <ax21:superuser>false</ax21:superuser>
                </ax21:response>
            </ns:return>
        </ns:GetClientInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetClientStatistics - получение статистики по клиенту SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

response

Объект NbiClientStatistics

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:GetClientStatistics/>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:GetClientStatisticsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeClientStatistics"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiClientStatistics">
                    <ax21:availableTariffs>6</ax21:availableTariffs>
                    <ax21:availableUsers>40081</ax21:availableUsers>
                </ax21:response>
            </ns:return>
        </ns:GetClientStatisticsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGlobalConfig - Получение глобальных настроек системы SoftWLC

Общая информация

  1. Команда актуальна, начиная с версии 1.8

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

response

Массив объектов NbiParameter

name - ключ, value - значение параметра

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
<soap:Envelope>
   <soap:Header/>
   <soap:Body>
      <nbi:GetGlobalConfig/>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope>
    <soapenv:Body>
       <ns:GetGlobalConfigResponse xmlns:ns="http://nbi.radius.eltex.org">
          <ns:return xsi:type="ax22:NbiCodeParameterListResponse">
             <ax22:code>0</ax22:code>
             <ax22:detail/>
             <ax22:response xsi:type="ax22:NbiParameterArray">
                <ax22:parameter xsi:type="ax22:NbiParameter">
                   <ax22:name>sorm3.enabled</ax22:name>
                   <ax22:value>true</ax22:value>
                </ax22:parameter>
                <ax22:parameter xsi:type="ax22:NbiParameter">
                   <ax22:name>pcrf.url</ax22:name>
                   <ax22:value>http://localhost:7070</ax22:value>
                </ax22:parameter>
                <ax22:parameter xsi:type="ax22:NbiParameter">
                   <ax22:name>sorm2.enabled</ax22:name>
                   <ax22:value>false</ax22:value>
                </ax22:parameter>
             </ax22:response>
          </ns:return>
       </ns:GetGlobalConfigResponse>
    </soapenv:Body>
 </soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetHostName - Получить hostname сервера

Общая информация

  1. Команда выполняет на сервере команду Linux hostname.

  2. Команда актуальна, начиная с версии 1.19.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

В случае ошибки - пояснение к ответу, а в случае успеха - результат работы команды (hostname сервера)

Текст английскими буквами с пробелами и спецсимволами

Примеры команд и кодов

Код Описание

0

Успешно

515

Ошибка в процессе выполнения команды hostname

516

Команда hostname вернула ошибочный код завершения (отличный от 0)
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetHostName/>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetHostNameResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>ubuntu</ax21:detail>
         </ns:return>
      </ns:GetHostNameResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetServerInfo - Получить информацию о сервере

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

Выходные параметры

Параметр Значение Формат значения

response

Объект NbiServerInfo

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nbi="http://nbi.radius.eltex.org">
   <soap:Header/>
   <soap:Body>
      <nbi:GetServerInfo/>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetServerInfoResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiCodeServerInfoResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:response xsi:type="ax21:NbiServerInfo">
               <ax21:serverTime>2017-06-27T13:29:23.059+07:00</ax21:serverTime>
               <ax21:timeZoneID>Asia/Krasnoyarsk</ax21:timeZoneID>
               <ax21:version>1.8-6666 (27-06-2017 13:27:36)</ax21:version>
            </ax21:response>
         </ns:return>
      </ns:GetServerInfoResponse>
   </soapenv:Body>
</soapenv:Envelope>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DisconnectSession - Разорвать сессию

Общая информация

  1. Команда для принудительного разрыва пользовательской сессии.

  2. Команда актуальна, начиная с версии 1.8.

Входные параметры

Параметр Значение Формат значения

userName

Имя пользователя

Строка

domain

Домен SSID

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

macAddress

Мак-адрес пользователя

Мак-адрес в формате 'XX:XX:XX:XX:XX:XX' или 'XX-XX-XX-XX-XX-XX'

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

allSessionsCount

Количество найденных сессий

Целое неотрицательное число

disconnectedSessionsCount

Количество разорванных сессий

Целое неотрицательное число

removedMacsCount

Количество удаленных MAC-адресов

Целое неотрицательное число

pcrfKey

Ключ ответа PCRF

Строка, текст

pcrfCode

Код ответа PCRF

Целое неотрицательное число

pcrfMessage

Детальное пояснение к ответу PCRF

Строка, текст

Примеры кодов

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

281

Не найден обязательный параметр запроса

295

Ошибка обработки команды в PCRF-API
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DisconnectSession>
         <nbi:userName>user</nbi:userName>
         <nbi:domain>root</nbi:domain>
      </nbi:DisconnectSession>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DisconnectSessionResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiDisconnectSessionResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:allSessionsCount>1</ax21:allSessionsCount>
            <ax21:disconnectedSessionsCount>1</ax21:disconnectedSessionsCount>
            <ax21:pcrfCode>0</ax21:pcrfCode>
            <ax21:pcrfKey>PcrfErrorCode.success</ax21:pcrfKey>
            <ax21:pcrfMessage>Success</ax21:pcrfMessage>
            <ax21:removedMacsCount>1</ax21:removedMacsCount>
         </ns:return>
      </ns:DisconnectSessionResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DisconnectSsid - Разорвать сессии по SSID и его домену

Общая информация

  1. Команда для принудительного разрыва пользовательских сессий по SSID и его домену.

  2. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Тип значения Формат значения

ssid

SSID, в котором нужно разорвать все сессии

String

Текст длиной от 1 до 32 символов, состоящий из латинских букв, цифр и спецсимволов "_", "-", ".", "!"

domain

Домен SSID

String

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Выходные параметры

NbiResponse

Параметр Значение Тип значения Формат значения

code

Код ответа

int

Целое неотрицательное число

detail

Пояснение к ответу

String

Текст

NbiDisconnectSessionResponse

Параметр Значение Тип значения Формат значения

code

Код ответа

int

Целое неотрицательное число

detail

Пояснение к ответу

String

Текст

allSessionsCount

Количество найденных сессий

Integer

Целое неотрицательное число

disconnectedSessionsCount

Количество разорванных сессий

Integer

Целое неотрицательное число

removedMacsCount

Количество удаленных MAC-адресов

Integer

Целое неотрицательное число

pcrfKey

Ключ ответа PCRF

String

Текст (например, "PcrfErrorCode.ssidDisconnected")

pcrfCode

Код ответа PCRF

Integer

Целое неотрицательное число

pcrfMessage

Детальное пояснение к ответу PCRF

String

Текст (например, "2 out of 2 session(s) were disconnected")
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DisconnectSsid>
         <nbi:ssid>SSID1</nbi:ssid>
         <nbi:domain>root</nbi:domain>
      </nbi:DisconnectSsid>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DisconnectSsidResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiDisconnectSessionResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:allSessionsCount>2</ax21:allSessionsCount>
            <ax21:disconnectedSessionsCount>2</ax21:disconnectedSessionsCount>
            <ax21:pcrfCode>1029</ax21:pcrfCode>
            <ax21:pcrfKey>PcrfErrorCode.ssidDisconnected</ax21:pcrfKey>
            <ax21:pcrfMessage>2 out of 2 session(s) were disconnected and 2 mac(s) were removed by SSID 'SSID1' and domain 'root'</ax21:pcrfMessage>
            <ax21:removedMacsCount>2</ax21:removedMacsCount>
         </ns:return>
      </ns:DisconnectSsidResponse>
   </soapenv:Body>
</soapenv:Envelope>

Примеры кодов

Код Описание ошибки

0

Успешно

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

Нет прав на указанный домен

227

Некорректное название SSID

295

Ошибка обработки команды в PCRF-API

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

DisconnectDomain - Разорвать пользовательские сессии по домену

Общая информация

  1. Команда для принудительного разрыва пользовательских сессий по домену.

  2. Команда актуальна, начиная с версии 1.18.

Входные параметры

Параметр Значение Тип значения Формат значения

domain

Домен, в котором нужно разорвать все сессии

String

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Выходные параметры

NbiResponse

Параметр Значение Тип значения Формат значения

code

Код ответа

int

Целое неотрицательное число

detail

Пояснение к ответу

String

Текст

NbiDisconnectSessionResponse

Параметр Значение Тип значения Формат значения

code

Код ответа

int

Целое неотрицательное число

detail

Пояснение к ответу

String

Текст

allSessionsCount

Количество найденных сессий

Integer

Целое неотрицательное число

disconnectedSessionsCount

Количество разорванных сессий

Integer

Целое неотрицательное число

removedMacsCount

Количество удаленных MAC-адресов

Integer

Целое неотрицательное число

pcrfKey

Ключ ответа PCRF

String

Текст (например, "PcrfErrorCode.domainDisconnected")

pcrfCode

Код ответа PCRF

Integer

Целое неотрицательное число

pcrfMessage

Детальное пояснение к ответу PCRF

String

Текст (например, "2 out of 2 session(s) were disconnected")
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:DisconnectDomain>
         <nbi:domain>root</nbi:domain>
      </nbi:DisconnectDomain>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:DisconnectDomainResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:NbiDisconnectSessionResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax21:allSessionsCount>2</ax21:allSessionsCount>
            <ax21:disconnectedSessionsCount>2</ax21:disconnectedSessionsCount>
            <ax21:pcrfCode>1028</ax21:pcrfCode>
            <ax21:pcrfKey>PcrfErrorCode.domainDisconnected</ax21:pcrfKey>
            <ax21:pcrfMessage>2 out of 2 session(s) were disconnected and 2 macs were removed by domain 'root'</ax21:pcrfMessage>
            <ax21:removedMacsCount>2</ax21:removedMacsCount>
         </ns:return>
      </ns:DisconnectDomainResponse>
   </soapenv:Body>
</soapenv:Envelope>

Примеры кодов

Код Описание ошибки

0

Успешно

7

Некорректный домен

8

Домен не удовлетворяет правилам FQDN

10

Нет прав на указанный домен

62

Несуществующий домен

295

Ошибка обработки команды в PCRF-API

999

Системная ошибка: нет параметров в запросе

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetErrorCodes - Получить список кодов ошибок

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

  2. Команда позволяет получить полный список кодов ошибок с описанием.
    Этот список вынесен в документацию на странице Коды ошибок, однако разработчики не всегда своевременно добавляют описание в документацию и потому, в случае отсутствия кода в документации, можно найти его, выполнив команду GetErrorCodes.

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

language

Код локали

en, ru

Двухбуквенный код языка. Поддерживаются английский - en, русский - ru.

Выходные параметры

Параметр Значение Формат значения

response

Массив параметров вида ключ-значение

NbiParameterArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
      <nbi:GetErrorCodes>
         <nbi:language>ru</nbi:language>
      </nbi:GetErrorCodes>
Ответ
      <ns:GetErrorCodesResponse>
         <ns:return>
            <ax22:code>0</ax22:code>
            <ax22:detail/>
            <ax22:response xsi:type="ax22:NbiParameterArray">
               <ax22:parameter xsi:type="ax22:NbiParameter">
                  <ax22:name>0</ax22:name>
                  <ax22:value>Успешно</ax22:value>
               </ax22:parameter>
               <ax22:parameter xsi:type="ax22:NbiParameter">
                  <ax22:name>1</ax22:name>
                  <ax22:value>Неизвестная ошибка</ax22:value>
               </ax22:parameter>
               <!-- more error codes -->
            </ax22:response>
         </ns:return>
      </ns:GetErrorCodesResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

InvalidatePortalDatabaseCache - Сброс кэша базы данных ELTEX_PORTAL

Общая информация

  1. Команда для сброса кэша базы данных ELTEX_PORTAL

  2. Команда актуальна, начиная с версии 1.10

Входные параметры

Нет

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

Примеры команд и кодов

Код Описание ошибки

0

Успешно

1

Сброс не выполнен из-за внутренней ошибки
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:InvalidatePortalDatabaseCache>
      </nbi:InvalidatePortalDatabaseCache>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:NbiResponse>
         <ns:return xsi:type="ax22:NbiResponse">
            <ax22:code>0</ax22:code>
            <ax22:detail/>
         </ns:return>
      </ns:NbiResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetAddressesListByKladr - Получение списка адресов по КЛАДР по городу, улице и номеру дома.

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

  2. Команда позволяет получить список адресов по КЛАДР, который отображается в виде структуры дерева: область, регион, город, улица, номер дома, каждый элемент которого содержит атрибуты id, name, okato, type, typeShort, zip. Параметры город, улица и номер дома являются обязательными.

  3. Параметр match определяет точное совпадение искомого адреса в найденном списке адресов по КЛАДР и равен true, если такое совпадение уникально. Если адреса не найдены или найдено несколько адресов, то match равен false.

Входные параметры

Параметр Значение Формат значения Расшифровка формата

parameters

Почтовый адрес в формате КЛАДР

Массив объектов NbiParameter

Параметры адреса в формате КЛАДР и их допустимые значения

Выходные параметры

Параметр Значение Формат значения

match

boolean

response

AddressResponse

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
   <soap:Body>
      <nbi:GetAddressesListByKladr>
         <nbi:parameters>
            <xsd:parameter>
               <xsd:name>City</xsd:name>
               <xsd:value>Новосибирск</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>Street</xsd:name>
               <xsd:value>Окружная</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
               <xsd:name>HouseNumber</xsd:name>
               <xsd:value>29В</xsd:value>
            </xsd:parameter>
         </nbi:parameters>
      </nbi:GetAddressesListByKladr>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:GetAddressesListByKladrResponse xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax298:GetAddressesListResponse">
                <ax21:code>0</ax21:code>
                <ax21:detail></ax21:detail>
                <ax298:match>true</ax298:match>
                <ax298:response xsi:type="ax298:AddressResponse">
                    <ax298:addresses xsi:type="ax298:CommonKladrAddress">
                        <ax298:region xsi:type="ax298:Region">
                            <ax298:id>5400000000000</ax298:id>
                            <ax298:name>Новосибирская</ax298:name>
                            <ax298:okato>50000000000</ax298:okato>
                            <ax298:type>Область</ax298:type>
                            <ax298:typeShort>обл</ax298:typeShort>
                            <ax298:zip>630545</ax298:zip>
                            <ax298:district xsi:type="ax298:District">
                                <ax298:id xsi:nil="true" />
                                <ax298:name xsi:nil="true" />
                                <ax298:okato xsi:nil="true" />
                                <ax298:type xsi:nil="true" />
                                <ax298:typeShort xsi:nil="true" />
                                <ax298:zip xsi:nil="true" />
                                <ax298:city xsi:type="ax298:City">
                                    <ax298:id>5400000100000</ax298:id>
                                    <ax298:name>Новосибирск</ax298:name>
                                    <ax298:okato>50401000000</ax298:okato>
                                    <ax298:type>Город</ax298:type>
                                    <ax298:typeShort>г</ax298:typeShort>
                                    <ax298:zip>630132</ax298:zip>
                                    <ax298:street xsi:type="ax298:Street">
                                        <ax298:id>54000001000091600</ax298:id>
                                        <ax298:name>Окружная</ax298:name>
                                        <ax298:okato>50401373000</ax298:okato>
                                        <ax298:type>Улица</ax298:type>
                                        <ax298:typeShort>ул</ax298:typeShort>
                                        <ax298:zip>630020</ax298:zip>
                                        <ax298:house xsi:type="ax298:House">
                                            <ax298:id>5400000100009160001</ax298:id>
                                            <ax298:name>29В</ax298:name>
                                            <ax298:okato>50401373000</ax298:okato>
                                            <ax298:type>дом</ax298:type>
                                            <ax298:typeShort>д</ax298:typeShort>
                                            <ax298:zip>630020</ax298:zip>
                                        </ax298:house>
                                    </ax298:street>
                                </ax298:city>
                            </ax298:district>
                        </ax298:region>
                    </ax298:addresses>
                </ax298:response>
            </ns:return>
        </ns:GetAddressesListByKladrResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

281

Параметр запроса не указан или пуст

312

Некорректное значение для параметра

313

Неизвестный параметр

436

Не указан обязательный параметр

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAccountStatistics. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

username

Логин аккаунта Wi-Fi пользователя

Текст до 64-х символов.

domain

Домен аккаунта Wi-Fi пользователя

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

inputOctets

Суммарное кол-во исходящих данных для аккаунта Wi-Fi пользователя, в байтах

Целое неотрицательное число.

outputOctets

Суммарное кол-во входящих данных для аккаунта Wi-Fi пользователя, в байтах

Целое неотрицательное число.

sessionTime

Суммарное кол-во времени длительности сессии для аккаунта Wi-Fi пользователя, в секундах

Целое неотрицательное число.

inputPacketsDrop

Суммарное количество отброшенных входящих пакетов для аккаунта Wi-Fi пользователя

Целое неотрицательное число.

outputPacketsDrop

Суммарное количество отброшенных исходящих пакетов для аккаунта Wi-Fi пользователя

Целое неотрицательное число.

inputBytesDrop

Суммарное количество отброшенных входящих байт для аккаунта Wi-Fi пользователя

Целое неотрицательное число.

outputBytesDrop

Суммарное количество отброшенных исходящих байт для аккаунта Wi-Fi пользователя

Целое неотрицательное число.

outputPacketLost

Суммарное количество потерянных исходящих пакетов для аккаунта Wi-Fi пользователя

Целое неотрицательное число.

sessionsCount

Количество подключений для аккаунта Wi-Fi пользователя.

Целое неотрицательное число.

mac

Массив строковых элементов, каждый из которых содержит MAC-адрес.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAcct. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

username

Логин

Текст до 64-х символов.

domain

Домен пользователя

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

authentic

Тип аутентификации

Текст

connectionInfoStart

Информация о соединении при старте

Текст

connectionInfoStop

Информация о соединении при завершении

Текст

framedAddress

Адрес, выданный клиенту

4 целых числа в диапазоне [0…​255] разделенных точкой.

framedProtocol

Атрибут использования пакетного доступа

Текст

groupname

Имя группы, в которой состоит пользователь

Текст

inputOctets

Кол-во исходящих данных для пользователя, в байтах

Целое неотрицательное число.

outputOctets

Кол-во входящих данных для пользователя, в байтах

Целое неотрицательное число.

nasIp

IP-адрес точки доступа, к которой подключен пользователь

4 целых числа в диапазоне [0…​255] разделенных точкой.

nasMac

MAC адрес точки доступа, к которой подключен пользователь, а также имя SSID, к которой подключен пользователь. MAC и SSID разделяются «:»

6 двузначных шестнадцатеричных числа, разделенных дефисом, двоеточием, текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

nasPortId

Идентификатор порта точки доступа

Целое неотрицательное число.

nasPortType

Тип порта точки доступа

Текст

nasSecret

Ключ для работы с RADIUS сервером

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

nasDomain

Домен точки доступа.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

realm

Realm

Текст

serviceType

Тип услуги

Текст

sessionId

Идентификатор сессии

Текст

sessionTime

Время длительности сессии в секундах

Целое неотрицательное число.

startDelay

Задержка при старте

Целое неотрицательное число.

stopDelay

Задержка при завершении

Целое неотрицательное число.

startTime

Время начала сессии

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

stopTime

Время завершения сессии

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

terminateCause

Причина завершения сессии

Текст

userMAC

MAC адрес пользователя

Шесть двузначных шестнадцатеричных чисел, разделенных дефисом

uniqueId

Уникальный идентификатор записи

Текст

xascendSessionSvrKey

Идентификатор сессии, в которой клиент послал запрос отключения

Текст

inputPacketsDrop

Количество отброшенных входящих пакетов

Целое неотрицательное число.

outputPacketsDrop

Количество отброшенных исходящих пакетов

Целое неотрицательное число.

inputBytesDrop

Количество отброшенных входящих байт

Целое неотрицательное число.

outputBytesDrop

Количество отброшенных исходящих байт

Целое неотрицательное число.

outputPacketLost

Количество потерянных исходящих пакетов

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApDomainStatistics. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

domain

Домен группы ТД

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

apCount

Количество ТД с данным доменом

Целое неотрицательное число

connections

Количество подключений пользователей к точкам доступа с данным доменом

Целое неотрицательное число

inputOctets

Суммарное кол-во исходящих данных для всех пользователей точек данного домена, в байтах

Целое неотрицательное число

lostPackets

Суммарное количество потерянных исходящих пакетов

Целое неотрицательное число

outputOctets

Суммарное кол-во входящих данных для всех пользователей точек данного домена, в байтах

Целое неотрицательное число

peakConnections

Не используется

peakTime

Не используется

uniqueAccount

Количество уникальных аккаунтов для точек доступа данного домена

Целое неотрицательное число

uniqueMAC

Количество уникальных устройств для точек доступа данного домена

Целое неотрицательное число

leafs

Поддомены, массив объектов NbiApDomainStatistics

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAttr. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя атрибута

Текст, любые символы.

oper

Оператор. Не более 2-х символов

Текст, любые символы.

value

Значение атрибута

Текст, любые символы.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthAttr. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя атрибута

Текст, любые символы.

description

Описание атрибута

Описание, любые символы.

editable

Редактируемость

Цифра 0 или 1.

type

Тип значения аттрибута

"integer","string","boolAllow","bool" либо "tab".

regex

Регулярное выражение для проверки значений

Регулярное выражение, любые символы.

valueHelp

ToolTip свойства

Помощь, любые символы.

exist

Существование аттрибута

"both" либо "user" либо "role".

operator

Массив объектов RadiusOperators.

label

Значение, видимое в GUI

Метка, любые символы.

strict

Запрещать изменять значение при редактировании роли

Цифра 0 или 1.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthAttrArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

attr

Массив объектов NbiAuthAttr Описание атрибута.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthRoleArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

attr

Массив объектов NbiAuthRole. Список атрибутов для данной роли.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthRole. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

check

Массив объектов NbiAttr. Список атрибутов проверки для данной роли.

common

Массив объектов NbiAttr. Список операторских атрибутов для данной роли.

reply

Массив объектов NbiAttr. Список атрибутов ответа для данной роли.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthUserArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

attr

Массив объектов NbiAuthUser. Список атрибутов для данного пользователя.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAuthUser. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

check

Массив объектов NbiAttr. Список атрибутов проверки для данной роли.

common

Массив объектов NbiAttr. Список операторских атрибутов для данной роли.

reply

Массив объектов NbiAttr. Список атрибутов ответа для данной роли.

rolePrioArray

Массив ролей с приоритетами

NbiAuthRolePrioArray

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты системного пользователя и роли

Общая информация

  1. В данной таблице указан список параметров системных ролей и пользователей.

  2. Разработчики не всегда своевременно добавляют описание в документацию и потому в системе предусмотрена команду GetAuthAttrListV2.

Уровень доступа к вкладкам:

  • 0 - нет доступа;

  • 1 - только чтение;

  • 2 - чтение и запись.

Список атрибутов

Имя Описание Редактируемый Значения Принадлежность Операторы

Группа portal-constructor

Eltex-PC-Gallery

Изменить доступ к галерее и ресурсам

да

Access level: 0,1,2

role

=

Eltex-PC-Portal-Advertising

Изменить доступ к настройкам рекламы

да

Access level: 0,1,2

role

=

Eltex-PC-Portal-Scheduler

Изменить настройки работы расписаний

да

Access level: 0,1,2

role

=

Eltex-PC-System-Settings

Системные настройки виртуальных порталов

да

Access level: 0,1,2

role

=

Eltex-Portal-Constructor-Read-Only

Разрешить просмотр виртуальных порталов

да

0-false, 1-true

role

=

Eltex-PC-Portal-Payments

Изменить доступ к настройкам оплаты

да

Access level: 0,1,2

role

=

Eltex-Portal-Constructor-Read-Write

Разрешить изменение виртуальных порталов

да

0-false, 1-true

role

=

Eltex-PC-Portal-Appearance

Изменить доступ к разделу 'Внешний вид порталов'

да

1-read, 2-read/write

role

=

Eltex-Portal-Constructor-Superuser

Администратор системы 'Конструктор порталов'

да

0-false, 1-true

role

=

Eltex-PC-Portal-Antispam

Изменить доступ к настройкам антиспама

да

Access level: 0,1,2

role

=

Eltex-PC-Portal-Settings

Общие настройки виртуальных порталов

да

Access level: 0,1,2

role

=

Eltex-PC-Portal-Lang

Языковые настройки виртуальных порталов

да

Access level: 0,1,2

role

=

Eltex-PC-Portal-Tariffs

Изменить доступ к настройкам тарифов

да

Access level: 0,1,2

role

=

Eltex-PC-Management

Разрешить управление порталами

да

0-false, 1-true

role

=

Eltex-PC-Portal-Polls

Изменить доступ к настройкам опросов

да

Access level: 0,1,2

role

=

Группа auth-user

Eltex-Domain

Домен пользователя

да

max 253 characters

user

+=, =

Operator-Name

Имя и отчество через пробел

да

1..253 characters

user

:=

Operator-Email

Поле ввода Email-адреса

да

e-mail address format

user

:=

Eltex-Service-User

Is user a SoftWLC service user

нет

0-false, 1-true

user

=

Cleartext-Password

Пароль пользователя в открытом виде (для MD5, PEAP), до 253 символов.

да

1-253 ASCII printable characters [0x20-0x7E]

user

:=

Operator-Family

Фамилия

да

1..253 characters

user

:=

Operator-Phone

Поле ввода мобильного телефона

да

phone format: 11 numbers, must start with 79

user

:=

Eltex-User-Timezone

Идентификатор таймзоны

да

max 253 characters, for example 'Europe/Moscow', default TimeZone - 'Europe/Moscow'

user

=

Eltex-User-Expires

Ограничение на действие пароля

да

date-time format: yyyy-MM-dd hh:mm:ss

user

<

Eltex-Built-In

Атрибут для обозначения дефолтной роли/пользователя

нет

'1' for default roles

role

=

Eltex-SoftWLC-Administrator

Администратор платформы SoftWLC

да

0-false, 1-true

role

=

Eltex-User-Create-Date

Дата создания пользователя/роли

нет

date-time format: yyyy-MM-dd hh:mm:ss

both

=

Operator-Description

Текстовое поле. Дополнительная информация о пользователе

да

max 253 characters

user

:=

Группа wifi-personal-office

Eltex-Tab-StatisticURL-Jobs

StatisticURL: Jobs

да

Access level: 0,1,2

role

=

Eltex-Tab-Pcrf-L2-Subnets

Настройки PCRF: Вкладка Подсети по location (L2)

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Stat-Hotspot-Users

B2B statistic: Hotspot users

да

Access level: 0,1

role

=

Eltex-Tab-Technical-Support

Страница для обращений в техподержку провайдера

да

Access level: 0,1

role

=

Eltex-Tab-SMS-Statistic-Group

Sent SMS grouped statistic

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Stat-Hotspot-Return

B2B statistic: Hotspot return

да

Access level: 0,1

role

=

Eltex-Tab-Help-About

Справка: О программе

да

Access level: 0,1

role

=

Eltex-Tab-SMS-Outgoing

Sent SMS list

да

Access level: 0,1

role

=

Eltex-Tab-B2B-RadiusUsers

Radius users pages for B2B

да

Access level: 0,1,2

role

=

Eltex-Tab-Client-Startpage

Start page for B2B clients

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Statistic-Hotspot

Statistic pages for B2B Hotspot clients

да

Access level: 0,1

role

=

Eltex-Tab-Feedback

Страница для обратной связи/претензий

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-AuthType

Interval statistic of account confirmation methods

да

Access level: 0,1

role

=

Eltex-Tab-WiFi-Voucher

Пользователи Wi-Fi: Ваучеры

да

Access level: 0,1,2

role

=

Eltex-Tab-Pcrf-Macs

Tab PCRF macs

да

Access level: 0,1,2

role

=

Eltex-Tab-Eventlog

Журнал событий

да

Access level: 0,1

role

=

Eltex-Tab-Wireless-Mac-Lists

For editing Macs

да

Access level: 0,1,2

role

=

Eltex-Tab-StatisticURL-Common

StatisticURL: Common infomation

да

Access level: 0,1

role

=

Eltex-Tab-Sheduler

Sheduler for auto changing password on SSID

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi-Enterprise

Пользователи Wi-Fi: Enterprise

да

Access level: 0,1,2

role

=

Eltex-Tab-Help

Справка

да

Access level: 0,1

role

=

Eltex-Tab-Settings-Tariff

Settings: tariff

да

Access level: 0,1,2

role

=

Eltex-Tab-View-Map

Tab mapping AP

да

Access level: 0,1

role

=

Eltex-Tab-Statistic

Статистика

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Stat-Hotspot-Service

B2B statistic: Hotspot service

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-SSIDGroup

Статистика: Группы SSID

да

Access level: 0,1

role

=

Eltex-Tab-Pcrf-Info

PCRF settings: PCRF Info tab

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-RadiusUsers-Hotspot

B2B Hotspot Users

да

Access level: 0,1,2

role

=

Eltex-Tab-Settings-Hotspot-Def-Access-Lists

Hotspot def access lists(white or black)

да

Access level: 0,1,2

role

=

Eltex-User-Wi-Fi-Password-Digit-Only

Требовать числовой формат пароля УЗ пользователей Wi-Fi

да

0-false, 1-true

role

=

Eltex-Tab-Pcrf-CoA-Logs

PCRF settings: CoA Logs tab

да

Access level: 0,1,2

role

=

Eltex-Tab-Sorm2

Edit SORM2 profiles, links

да

Access level: 0,1,2

role

=

Eltex-Tab-Eventlog-UserAccount

Журнал событий: Журнал модификаций учетных записей

да

Access level: 0,1

role

=

Eltex-Tab-B2B-RadiusUsers-TopActive-Hotspot

B2B Top active Hotspot users

да

Access level: 0,1,2

role

=

Eltex-HotWiFi-Link

Access to link to HotWiFi platform

да

Access level: 0,1

role

=

Eltex-Tab-Pcrf-Settings

Вкладка Настройки PCRF

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-RadiusUsers-TopActive-Enterprise

B2B Top active Enterprise users

да

Access level: 0,1,2

role

=

Eltex-Tab-Pcrf-Settings-AppsList

Application filter

да

Access level: 0,1,2

role

=

Eltex-Tab-Statistic-SSIDSMS

Статистика: SSIDSMS

да

Access level: 0,1

role

=

Eltex-Tab-Eventlog-Default

Журнал событий: Журнал событий

да

Access level: 0,1

role

=

Eltex-Tab-Settings-DomainTree

Настройки: Дерево доменов

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Office-Integral-Status

B2B Office Integral Status

да

Access level: 0,1

role

=

Eltex-Tab-Settings-RadiusNas

Settings: Server addresses

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi-BrasTariff

Wi-Fi users: BRAS tariff

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Stat-Enterprise-Traffic

B2B statistic: Enterprise traffic

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-Start

Статистика: Стартовая

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Stat-Hotspot-Traffic

B2B statistic: Hotspot traffic

да

Access level: 0,1

role

=

Eltex-Tab-B2B-AccessPoints-Regular

B2B Access Regular Points

да

Access level: 0,1

role

=

Eltex-Tab-Reports

Tab to display reports

да

Access level: 0,1,2

role

=

Eltex-Tab-SMS-Statistic

Radius users pages for B2B

да

Access level: 0,1

role

=

Eltex-Tab-B2B-RadiusUsers-Enterprise

B2B Enterprise Users

да

Access level: 0,1,2

role

=

Eltex-Wi-Fi-Office-Read-Write-System-Settings

Категория пользователя

да

0 - custom, 1 - super-admin, 2 - provider staff, 3 - client staff

role

=

Eltex-Tab-Pcrf-L3-Subnets

Настройки PCRF: Вкладка Подсети по диапазонам IP (DHCP, L3)

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi-BrasAttribute

Пользователи Wi-Fi: BRAS пользователи

да

Access level: 0,1,2

role

=

Eltex-Tab-Settings

Настройки

да

Access level: 0,1,2

role

=

Eltex-Support-Link

Menu Tab for support link

да

Access level: 0,1

role

=

Eltex-Dpi-Link

Menu Tab for DPI link

да

Access level: 0,1

role

=

Eltex-Tab-WiFi-Hotspot

Пользователи Wi-Fi: Hotspot

да

Access level: 0,1,2

role

=

Eltex-Tab-Settings-AdminRole

Настройки: Системные роли

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi-PCRF-Scenarios

Tab PCRF scenarios

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi-BrasService

Пользователи Wi-Fi: BRAS сервисы

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-RadiusUsers-Vouchers

B2B Vouchers

да

Access level: 0,1,2

role

=

Eltex-Tab-Statistic-SSID

Статистика: SSID

да

Access level: 0,1

role

=

Eltex-Tab-Map

Tab mapping AP

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Stat-Enterprise-UsersSessions

Statistic of moving user between access points

да

Access level: 0,1

role

=

Eltex-Tab-Settings-AdminClient

Настройки: Системные пользователи

да

Access level: 0,1,2

role

=

Eltex-Tab-StatisticURL

StatisticURL

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Statistic-Enterprise

Statistic pages for B2B Enterprise clients

да

Access level: 0,1

role

=

Eltex-User-Wi-Fi-Password-Length

Длина пароля должна лежать в диапазоне от 1 до 253

да

1..253

role

=

Eltex-User-Wi-Fi-Password-Show

Разрешить просмотр паролей УЗ пользователей Wi-Fi

да

0-false, 1-true

role

=

Eltex-Tab-SMS-Statistic-Time

Sent SMS interval statistic

да

Access level: 0,1

role

=

Eltex-Tab-Help-License

Справка: Лицензии

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-Graph

Статистика: График

да

Access level: 0,1

role

=

Eltex-Tab-Settings-AccessList

Настройки: Списки доступа

да

Access level: 0,1,2

role

=

Eltex-Tab-Settings-Hotspot-Access-Lists

Настройки: Списки пользователей

да

Access level: 0,1,2

role

=

Eltex-Tab-Statistic-Common

Статистика: Сводные данные

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-NasDomain

Статистика: Группы ТД

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-Session

Статистика: Статистика сессий УЗ

да

Access level: 0,1

role

=

Eltex-Tab-Portal

Переход в конструктор порталов

да

Access level: 0,1

role

=

Eltex-Tab-WiFi-Bras

Пользователи Wi-Fi: BRAS

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-AccessPoints-Problem

B2B Access Problem Points

да

Access level: 0,1

role

=

Eltex-Tab-Settings-AuthNas

Настройки: Серверные адреса

да

Access level: 0,1,2

role

=

Eltex-User-Wi-Fi-Show-Ap-Ip

Отображать IP адреса точек доступа. Не используется с версии 1.20. Оставили для обратной совместимости.

да

0-false, 1-true

role

=

Eltex-Tab-Statistic-Acct

Статистика: Журнал сессий

да

Access level: 0,1

role

=

Eltex-Tab-Statistic-ApInfo

Статистика: Точки доступа

да

Access level: 0,1

role

=

Eltex-Tab-Users

Users

да

Access level: 0,1,2

role

=

Eltex-Tab-Help-Help

Справка: Помощь

да

Access level: 0,1

role

=

Eltex-Tab-Settings-System

Настройки: Система

да

Access level: 0,1,2

role

=

Eltex-User-Wi-Fi-Show-Tariff

Отображать тарифный план УЗ пользователей Wi-Fi

да

0-false, 1-true

role

=

Eltex-Tab-Wireless-Networks

For editing SSIDs

да

Access level: 0,1,2

role

=

Eltex-Tab-WiFi

Пользователи Wi-Fi

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-AccessPoints

B2B Access Points

да

Access level: 0,1

role

=

Eltex-Tab-Pcrf-Vrf

PCRF settings: Editing BRAS VRF

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Users-Sessions

Сессии пользователей Wi-Fi

да

Access level: 0,1

role

=

Eltex-Tab-WiFi-Equipment

Пользователи Wi-Fi: Equipment

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-RadiusUsers-Equipment

B2B Equipment Devices

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-Statistic-Domain

Статистика по домену

да

Access level: 0,1

role

=

Eltex-Tab-B2B-Stat-Domain-Ssid-Type

Статистика по типу SSID

да

Access level: 0,1

role

=

Eltex-Tab-Ordered-Reports

Вкладка для отображения заказанных отчетов

да

Access level: 0,1,2

role

=

Eltex-Tab-Reports-Scheduler

Планировщик отчетов

да

Access level: 0,1,2

role

=

Eltex-Tab-Eventlog-PortalConstructor

Журнал событий: события конструктора порталов

да

Access level: 0,1

role

=

Eltex-User-Wi-Fi-PassGen-List-Characters

Список используемых символов

да

max 253 characters

role

+=

Eltex-Tab-B2B-Stat-Equipment-Traffic

B2B statistic: Equipment traffic

да

Access level: 0,1

role

=

Eltex-Tab-WiFi-Hotels

Пользователи Wi-Fi: Hotels

да

Access level: 0,1,2

role

=

Eltex-Tab-B2B-RadiusUsers-Hotels

B2B Hotels

да

Access level: 0,1,2

role

=

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiClientInfo. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

clientLogin

Имя пользователя клиента SowtWLC

Текст, любые символы.

domain

0 или более элементов. Домены роли.

Текст в формате FQDN.

roleName

Имя роли пользователя SoftWLC

Текст, любые символы.

superuser

Флаг, если "true", то пользователь является суперпользователем. Иначе "false"

'true' или 'false'

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiClientStatistics. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

availableTariffs

Количество доступных тарифных планов для клиента SowtWLC

Целое неотрицательное число.

availableUsers

Количество доступных пользовательских аккаунтов для клиента SowtWLC

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomain. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

domain

Домен

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

descr

Описание домена

Текст длиной до 255 символов.

attr

Один или более объект NbiParameter

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomain2. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.6

Параметры объекта

Параметр Значение Формат значения

domain

Домен

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

descr

Описание домена

Текст длиной до 255 символов.

type

Тип домена

both - может использоваться для объектов любого типа,

ap - может использоваться только как географический домен (домен ТД),

service - может использоваться только как сервисный домен (домен пользователей wi-fi, сервисов, тарифов)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainShaperProfile. Описание объекта

Общая информация

  1. Объект содержит информацию об ограничениях трафика на ТД внутри конкретного домена и связанных (если это задано здесь же) SSID.

  2. Поле 'ssid' содержит массив элементов типа NbiSsidShaperProfile для указания ограничений для SSID.

  3. Команда актуальна, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

domain

Домен группы ТД

Домен группы ТД (узла в дереве).

averageUp

Среднее значение ограничения на исходящий трафик

Целое число.

peakUp

Пиковое значение ограничения на исходящий трафик

Целое число.

averageDown

Среднее значение ограничения на входящий трафик

Целое число.

peakDown

Пиковое значение ограничения на входящий трафик

Целое число

ssid

Список SSID NbiSsidShaperProfile

См. также

  1. GetDomainShaper

  2. SetDomainShaper

  3. NbiSsidShaperProfile

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainShaperProfileMerged. Описание объекта

Общая информация

  1. Объект содержит суммарную информацию об ограничениях трафика на ТД внутри домена и связанных (если это задано здесь же) SSID.

  2. Поле 'ssid' содержит массив элементов типа NbiSsidShaperProfileMerged для указания ограничений для SSID.

  3. Команда актуальна, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

domain

Домен группы ТД

Домен группы ТД (узла в дереве).

averageUp

Среднее значение ограничения на исходящий трафик

Целое число.

peakUp

Пиковое значение ограничения на исходящий трафик

Целое число.

averageDown

Среднее значение ограничения на входящий трафик

Целое число.

peakDown

Пиковое значение ограничения на входящий трафик

Целое число

ssid

Список SSID NbiSsidShaperProfileMerged

См. также

  1. GetDomainShaper

  2. NbiSsidShaperProfileMerged

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiEntryDescr. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

descr

Описание сущности

Текст, любые символы

entry

Сущность

Текст, любые символы

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiKeyArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

key

Массив (несколько элементов key) строковых параметров (ключей устройства)

Текст, любые символы.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiMacExpiresInfo. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.6

Параметры объекта

Параметр Значение Формат значения

mac

MAC адрес

6 двузначных шестнадцатеричных чисел, разделенных ':'.

expiresTime

Дата, после которой MAC-адрес считается недействительным

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

lastActivityTime

Время последней активности

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiMessage. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

message

Строка с сообщением от сервиса

Любой текст

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNameArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Строка с именем. Может быть любое количество элементов name

Любой текст

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNameDomainArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiNameDomain.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNameDomain. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя

Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями

domain

Домен

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNasArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

nas

Массив объектов NbiNas.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNas. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

descr

Описание NAS

Текст, любые символы.

domain

Домен NAS

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

ip

IP-адрес NAS

4 целых числа в диапазоне [0…​255], разделенных точкой.

mac

MAC адрес точки доступа

6 двузначных шестнадцатеричных чисел, разделенных ':'.

name

Имя NAS

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

secret

Ключ для работы с сервером RADIUS

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 60-ти символов. Допускаются цифры.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNasStatistics. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

connections

Количество подключений пользователей к точке доступа

Целое неотрицательное число.

domain

Домен ТД

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

inputOctets

Суммарное кол-во исходящих данных для всех пользователей точки доступа, в байтах

Целое неотрицательное число.

lostPackets

Суммарное количество потерянных исходящих пакетов

Целое неотрицательное число.

nas

IP-адрес ТД

4 целых числа в диапазоне [0…​255], разделенных точкой.

outputOctets

Суммарное кол-во входящих данных для всех пользователей точки доступа, в байтах

Целое неотрицательное число.

peakConnections

Не используется

peakTime

Не используется

uniqueAccount

Количество уникальных аккаунтов для точки доступа.

Целое неотрицательное число.

uniqueMAC

Количество уникальных устройств для точки доступа.

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiParameterArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

param

Массив объектов NbiParameter.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiParameter. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя параметра

Текст, любые символы.

value

Значение параметра

Текст, любые символы.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiProfile. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя правила

Текст, любые символы

domain

Домен правила.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

deviceType

Тип устройств, для которых создано правило

Текст, любые символы

descr

Описание правила

Текст, любые символы

params

Массив объектов NbiParameter

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

id

Идентификатор связки

Целое неотрицательное число

deviceKey

Ключ устройства

Текст, любые символы

ruleName

Имя правила инициализации

Текст, любые символы

ruleDomain

Домен правила инициализации

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

nodeDomain

Домен узла дерева EMS

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusSSIDIntervalStatisticsItem. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

intervalStart

Время начала интервала статистики

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

bytesIn

Кол-во исходящих данных для пользователя, в байтах

Целое неотрицательное число.

bytesOut

Кол-во входящих данных для пользователя, в байтах

Целое неотрицательное число.

connectionsCount

Количество подключений к SSID

Целое неотрицательное число.

pcktsLost

Количество потерянных пакетов

Целое неотрицательное число.

uniqMacCount

Количество уникальных клиентских MAC-адресов

Целое неотрицательное число.

uniqUsersCount

Количество уникальных клиентов

Целое неотрицательное число.

summary

Является ли данная запись обобщающей, т.е. - для строчки "Итого"

Текст true/false

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusSSIDStatisticsItem. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

ssidName

Имя SSID

Имя SSID

ssidDomain

Домен SSID

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

bytesIn

Кол-во исходящих данных для пользователя, в байтах

Целое неотрицательное число.

bytesOut

Кол-во входящих данных для пользователя, в байтах

Целое неотрицательное число.

connectionsCount

Количество подключений к SSID

Целое неотрицательное число.

pcktsLost

Количество потерянных пакетов

Целое неотрицательное число.

uniqMacCount

Количество уникальных клиентских MAC-адресов

Целое неотрицательное число.

uniqUsersCount

Количество уникальных клиентов

Целое неотрицательное число.

activeAPs

Количество точек доступа, к которым происходили подключения

Целое неотрицательное число.

summary

Является ли данная запись обобщающей, т.е. - для строчки "Итого"

Текст true/false

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUserGItem. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Логин пользователя

Текст.

password

Пароль пользователя.

Текст.

domain

Домен пользователя.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

clientCrtLink

Ссылка на клиентский сертификат

HTTP-ссылка для скачивания сертификата с севера.

country

Код страны

Две заглавные буквы латиницей.

state

Регион

Текст, латиница.

location

Населенный пункт

Текст, латиница.

organization

Название организации

Текст, латиница.

organizationUnit

Название отдела в организации

Текст, латиница.

email

Почтовый адрес организации

Текст, латиница. Должен соответствовать стандарту интернет адресов RFC 5322.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUserItem. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя пользователя

Текст.

domain

Домен пользователя.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

password

Пароль пользователя

Текст.

tariffCode

Код тарифного плана, к которому привязан пользователь.

Текст.

clientCrtLink

Ссылка для скачивания клиентского сертификата, если он сгенерирован для пользователя.

HTTP-ссылка для скачивания сертификата с севера.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUserItemSingle. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

clientCrtLink

Ссылка для скачивания клиентского сертификата, если он сгенерирован для пользователя.

HTTP-ссылка для скачивания сертификата с севера.

domain

Домен пользователя.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

name

Имя пользователя

Текст.

password

Пароль пользователя

Текст.

tariffCode

Код тарифного плана, к которому привязан пользователь.

Текст.

check

Массив объектов NbiAttr. Список атрибутов проверки для данного пользователя.

common

Массив объектов NbiAttr. Список операторских атрибутов для данного пользователя.

reply

Массив объектов NbiAttr. Список атрибутов ответа для данного пользователя.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUserWithMac. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.6

Параметры объекта

Параметр Значение Формат значения

clientCrtLink

Ссылка для скачивания клиентского сертификата, если он сгенерирован для пользователя.

HTTP-ссылка для скачивания сертификата с севера.

domain

Домен пользователя.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

name

Имя пользователя

Текст.

password

Пароль пользователя

Текст.

tariffCode

Код тарифного плана, к которому привязан пользователь.

Текст.

check

Массив объектов NbiAttr. Список атрибутов проверки для данного пользователя.

common

Массив объектов NbiAttr. Список операторских атрибутов для данного пользователя.

reply

Массив объектов NbiAttr. Список атрибутов ответа для данного пользователя.

mac

Один или более объектов NbiMacExpiresInfo. Мак адрес, привязанный к данной УЗ.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiServerInfo. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.8

Параметры объекта

Параметр Значение Формат значения

serverTime

Текущее время сервера

Текст

timeZoneID

Идентификатор таймзоны

Текст

version

Версия

Текст

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariff - Данные об отдельном тарифе

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

createDate

Дата создания тарифного плана.

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00".

deactivated

Флаг, если установлен в 'true', значит все пользователи данного тарифного плана деактивированы.

'true' или 'false'

tariffCode

Код тарифного плана.

Текст, любые символы.

tariffDescr

Описание тарифного плана.

Текст, любые символы.

tariffDomain

Домен тарифного плана.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

tariffName

Название тарифного плана.

Текст, любые символы.

users

Кол-во пользователей, привязанных к данному тарифному плану.

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSingleTariff - Данные об отдельном тарифе с атрибутами

Общая информация

  1. Объект актуален, начиная с версии 1.5.

Параметры объекта

Параметр Значение Формат значения

reply

пользовательские REPLY-атрибуты

NbiAttrArray

check

пользовательские CHECK-атрибуты

NbiAttrArray

groupcheck

групповые CHECK-атрибуты

NbiAttrArray

groupreply

групповые REPLY-атрибуты

NbiAttrArray

portal

портальные атрибуты

NbiAttrArray

tariffName

RU имя тарифа

String

tariffCode

EN код тарифа

String

tariffDomain

Домен тарифного плана

String

tariffDescr

Подробное описание тарифа

String

createDate

Дата создания тарифа

Calendar

deactivated

Флаг деактивации тарифного плана (и соответственно всех клиентов)

boolean

users

Кол-во пользователей

int

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSingleTariffExtended - Данные об отдельном тарифе с атрибутами и списком порталов

Общая информация

  1. Объект актуален, начиная с версии 1.10

Параметры объекта

Параметр Значение Формат значения

portals

Массив объектов NbiNameArray. Список имен порталов.

NbiNameArray

bras

Список атрибутов BRAS.

NbiAttrArray

reply

NbiAttrArray пользовательские REPLY-атрибуты

NbiAttrArray

check

NbiAttrArray польовательские CHECK-атрибуты

NbiAttrArray

groupcheck

NbiAttrArray групповые CHECK-атрибуты

NbiAttrArray

groupreply

NbiAttrArray групповые REPLY-атрибуты

NbiAttrArray

portal

NbiAttrArray портальные атрибуты

NbiAttrArray

tariffName

RU имя тарифа

String

tariffCode

EN код тарифа

String

tariffDomain

Домен тарифного плана

String

tariffDescr

Подробное описание тарифа

String

createDate

Дата создания тарифа

Calendar

deactivated

Флаг деактивации тарифного плана (и соответственно всех клиентов)

boolean

users

Кол-во пользователей

int

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSingleTariffWithBrasAttrs - Данные об отдельном тарифе, включая BRAS-атрибуты

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

createDate

Дата и время создания тарифного плана.

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00".

deactivated

Флаг деактивации всех пользователей тарифного плана.

"true" или "false".

tariffCode

Уникальный код тарифного плана.

Текст до 64-х латинских символов и цифр.

tariffDescr

Описание тарифного плана

Текст.

tariffDomain

Домен тарифного плана. Уникальная связка с именем тарифного плана.

Текст в формате FQDN.

tariffName

Имя тарифного плана. Уникальная связка с доменом тарифного плана.

Текст.

user

Количество пользователей, принадлежащих данному тарифному плану

Число.

check

Массив объектов NbiAttr. Список индивидуальных атрибутов проверки. Полный список.

groupcheck

Массив объектов NbiAttr. Список групповых атрибутов проверки. Полный список.

groupreply

Массив объектов NbiAttr. Список групповых атрибутов ответа. Полный список.

portal

Массив объектов NbiAttr. Список атрибутов для Captive Portal. Полный список.

reply

Массив объектов NbiAttr. Список индивидуальных атрибутов ответа. Полный список.

bras

Массив объектов NbiAttr. Список атрибутов bras. Полный список.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSingleTariffWithPortals - Данные об отдельном тарифе, включая список порталов

Общая информация

  1. Объект актуален, начиная с версии 1.8

  2. Начиная с версии 1.19 не происходит подсчёт пользователей, принадлежащих тарифному плану. Параметр users всегда имеет значение 0

Параметры объекта

Параметр Значение Формат значения

createDate

Дата и время создания тарифного плана.

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00".

deactivated

Флаг деактивации всех пользователей тарифного плана.

"true" или "false".

tariffCode

Уникальный код тарифного плана.

Текст до 64-х латинских символов и цифр.

tariffDescr

Описание тарифного плана

Текст.

tariffDomain

Домен тарифного плана. Уникальная связка с именем тарифного плана.

Текст в формате FQDN.

tariffName

Имя тарифного плана. Уникальная связка с доменом тарифного плана.

Текст.

users

Deprecated. Количество пользователей, принадлежащих данному тарифному плану

Число.

check

Массив объектов NbiAttr. Список индивидуальных атрибутов проверки. Полный список.

groupcheck

Массив объектов NbiAttr. Список групповых атрибутов проверки. Полный список.

groupreply

Массив объектов NbiAttr. Список групповых атрибутов ответа. Полный список.

portal

Массив объектов NbiAttr. Список атрибутов для Captive Portal. Полный список.

reply

Массив объектов NbiAttr. Список индивидуальных атрибутов ответа. Полный список.

portals

Массив объектов NbiNameArray. Список имен порталов.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffArray - Список тарифов с атрибутами

Общая информация

  1. Объект актуален, начиная с версии 1.7.

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов с описанием свойств тарифов

NbiSingleTariff

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffArrayExtended - Список тарифов с атрибутами и списком порталов

Общая информация

  1. Объект актуален, начиная с версии 1.10

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiSingleTariffExtended с описанием свойств тарифов

NbiSingleTariffExtended

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffArrayWithPortals - Список тарифов с атрибутами и списком порталов

Общая информация

  1. Объект актуален, начиная с версии 1.8.

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiSingleTariffWithPortals с описанием свойств тарифов

NbiSingleTariffWithPortals

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffIncludeBrasArray - Список тарифов с атрибутами, включая BRAS-атрибуты

Общая информация

  1. Объект актуален, начиная с версии 1.6.

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiSingleTariffWithBrasAttrs с описанием свойств тарифов

NbiSingleTariffWithBrasAttrs

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты тарифного плана

Общая информация

  1. Список актуален, начиная с версии 1.5

Список атрибутов

Атрибут Описание и значения Операторы Имя атрибута в GUI EMS

Eltex-Tariff-Portal-Only

Портальный атрибут. Флаг, если 'true', значит тарифный план предназначен для портальной авторизации

=

Портальная аутентификация

Eltex-Tariff-Bras

Установить 'true' если тарифный план для работы через BRAS

=

Eltex-Tariff-Price

Портальный атрибут. Только для портальной авторизации, цена тарифного плана, в рублях.
Можно указать дробное значение 'xx.xx'

=

Цена, руб.

Eltex-User-Deactivated

Групповой атрибут проверки. Деактивация всех пользователей тарифного плана при значении 'true'.

==

Деактивация пользователей

Called-Station-Id

Групповой атрибут проверки. Разрешенные/запрещенные SSID в виде регулярного выражения. Нужно учитывать, что данный атрибут для точки доступа имеет вид «<MAC>:<SSID>», и если задавать ограничение только по SSID, выражение должно начинаться с «^.+[:]».

=~
!~

SSID

Simultaneous-Use

Групповой атрибут проверки. Максимальное число одновременных подключений для пользователей тарифного плана (от 1).

:=

Ограничение доступа

WISPr-Bandwidth-Max-Down

Групповой атрибут ответа. Только для непортальной авторизации. Максимальная скорость полосы пропускания входящего трафика в битах в секунду. Принимает значения от 1024 до 1363148800.

=

Макс. скорость входящего трафика, kbps

WISPr-Bandwidth-Max-Up

Групповой атрибут ответа. Только для непортальной авторизации. Максимальная скорость полосы пропускания исходящего трафика в битах в секунду. Принимает значения от 1024 до 1363148800.

=

Макс. скорость исходящего трафика, kbps

LVL7-Wireless-Client-Policy-Down

Групповой атрибут ответа. Только для непортальной авторизации. Policy профиль для приема данных для абонентов тарифного плана, не более 253 символов.

=

Policy для входящего трафика

LVL7-Wireless-Client-Policy-Up

Групповой атрибут ответа. Только для непортальной авторизации. Policy профиль для исходящих данных для абонентов тарифного плана, не более 253 символов.

=

Policy для исходящего трафика

Session-Timeout

Групповой атрибут ответа. Только для непортальной авторизации. Максимальная продолжительность сессии, в секундах. Минимальное значение - 60. Максимальное значение - 7776000

=

Продолжительность, мин

Eltex-Traffic-Limit

Атрибут ответа. Только для непортальной авторизации. Общее ограничение по количеству входящих данных для каждого пользователя, в байтах. Минимальное значение 1048576.

=

Квота по трафику, Мбайт

Eltex-Work-Time-Limit

Атрибут ответа. Только для непортальной авторизации. Общее ограничение времени для всех сессий пользователя тарифного плана, в секундах. Минимальное значение 60.

=

Квота по времени, мин

Eltex-Validity-Period

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

=

Срок действия, мин

Tunnel-Type

Групповой атрибут ответа. Только для непортальной авторизации. Указать протокол туннелирования для пользователей тарифного плана. Для корректной настройки VLAN всегда выставлять «13».

=

Протокол туннелирования

Tunnel-Medium-Type

Групповой атрибут ответа. Только для непортальной авторизации. Указать, какой транспорт использовать при создании туннеля для тех протоколов, которые могут работать на нескольких транспортах. Для корректной настройки VLAN всегда выставлять «6».

=

Транспорт

Tunnel-Private-Group-Id

Групповой атрибут ответа. Только для непортальной авторизации. Установить идентификатор VLAN. Разрешается только один идентификатор. Для установки VLAN также используется атрибут Eltex-Additional-Vlans.

=

CVLAN

Eltex-Additional-Vlans

Групповой атрибут ответа. Только для непортальной авторизации. Установить несколько идентификаторов VLAN для абонентов тарифного плана. Идентификаторы указываются через запятую (,). Разрешено до 9-ти идентификаторов для пользователя.

=

Дополнительные VLAN

Reply-Message

Групповой атрибут ответа. Только для непортальной авторизации. Ответное сообщение пользователю, не более 253 символов.

=

Ответное сообщение

Eltex-State-On-N

Портальный атрибут. Только для портальной авторизации. 'true', если настроен сценарий N тарифного плана

=

Настроить сценарий {N}

Eltex-State-Away-Time-N

Портальный атрибут. Только для портальной авторизации. Время хранения авторизационных данных клиента на ТД при его отключении для сценария N тарифного плана, в секундах. Минимальное значение 60.

=

Время ожидания пользователя, мин

Eltex-State-External-Url-N

Портальный атрибут. Только для портальной авторизации. Адрес для перенаправления всех запросов пользователя, кроме тех, на которые разрешен доступ в этом сценарии.

=

Внешний URL-адрес

Eltex-State-Session-Timeout-N

Портальный атрибут. Только для портальной авторизации. Общее время сценария, в секундах. Минимальное значение 60.

=

Продолжительность, мин

Eltex-State-Start-Session-Before-Redirect-N

Портальный атрибут. Только для портальной авторизации. Флаг (true или false), посылать ли пакеты аккаунтинга в случае, если настроен URL-адрес для перенаправления, единственный обязательный атрибут для сценария.

=

Начинать сессию перед перенаправлением

Eltex-State-Traffic-Limit-N

Портальный атрибут. Только для портальной авторизации. Ограничение по трафику для текущего сценария, в байтах. Минимальное значение 1048576.

=

Остаток трафика в состоянии, Мб

Eltex-State-Work-Time-Limit-N

Портальный атрибут. Только для портальной авторизации. Ограничение по рабочему времени для текущего сценария, в секундах. Минимальное значение 60.

=

Квота по времени в состоянии, мин

Eltex-State-Bandwidth-Max-Down-N

Портальный атрибут. Только для портальной авторизации. Ограничение скорости входящего трафика для сценария N тарифного плана, в битах в секунду. Принимает значения от 1024 до 1363148800.

=

Лимит скорости входящего трафика, kbps

Eltex-State-Bandwidth-Max-Up-N

Портальный атрибут. Только для портальной авторизации. Ограничение скорости исходящего трафика для сценария N тарифного плана, в битах в секунду. Принимает значения от 1024 до 1363148800.

=

Лимит скорости исходящего трафика, kbps

Eltex-State-LVL7-Wireless-Client-Policy-Down-N

Портальный атрибут. Только для портальной авторизации. Название policy профиля для входящего трафика для сценария N тарифного плана.

=

Policy для входящего трафика

Eltex-State-LVL7-Wireless-Client-Policy-Up-N

Портальный атрибут. Только для портальной авторизации. Название policy профиля для исходящего трафика для сценария N тарифного плана.

=

Policy для исходящего трафика

Eltex-State-Permitted-Ip_M_-N

Портальный атрибут. Только для портальной авторизации. Адрес хоста, до которого клиенту разрешен доступ при настроенном URL-адресе для перенаправления. Тут M - порядковый номер адреса для сценария N тарифного плана.

=

Список разрешенных хостов

Eltex-State-Reset-Period-N

Портальный атрибут. Только для портальной авторизации. Cron-выражение, при выполнении которого будет осуществлен переход на следующий шаг сценария.

Подробнее о формате

=
Атрибуты для PCRF/BRAS Тарифа

Атрибут

Описание и значения

Операторы

Acct-Interim-Interval

Интервал отправки аккаунтинга, с

=

Session-Timeout

Время жизни сессии, с Минимальное значение - 60 Максимальное значение - 7776000

=

Idle-Timeout

Время жизни сессии при бездействии пользователя, с Максимальное значение - 86400

=

Simultaneous-Use

Количество одновременных сессий с одним логином и паролем

:=

Cisco-Account-Info

Атрибут, указывающий список сервисов и сценариев вида:
A<имя сервиса/сценария> для разрешенных;
Одна запись может содержать произвольное количество таких атрибутов.

+=

Eltex-Tariff-Portal-Only

false

=

Eltex-Tariff-Bras

true

=

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffAttrArray - Массив атрибутов тарифного плана.

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

param

Массив объектов NbiTariffAttr.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTariffAttr - Атрибут тарифного плана.

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Наименование атрибута

Текст, любые символы. Например: Eltex-Work-Time-Limit.

type

Тип атрибута тарифного плана

portal|groupcheck|groupreply|…​

ops

Операторы атрибута тарифного плана

Список операторов, разделенных |. Возможные операторы: =|:=|==|+=|!=|>|>=|<|⇐|=|!|=|!

valueRegexp

Регулярное выражение для проверки значения атрибута

Текст, любые символы.

canWrite

Имеет ли пользователь право записывать данный атрибут

true|false

scenario

Флаг сценарного атрибута

true|false

group

Группа атрибута

<пусто>|hotspot|enterprise

label

Имя для отображения в гуи-формах

Текст, любые символы.

descr

Описание для отображения в гуи-формах

Текст, любые символы.

objType

Физический тип атрибута

string|bool|separator|int

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSsid. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.18

Параметры объекта

Параметр Значение Формат значения

name

Имя SSID

Имя SSID

domain

Домен SSID

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

descr

Описание SSID

Текст длиной до 255 символов.

createDate

Время создания SSID

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00".

updateDate

Время последнего изменения SSID

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00".

attr

Один или более объект NbiParameter

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSsidArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5.1

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiSsid Список SSID.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSsidShaperProfile. Описание объекта

  1. Объект содержит информацию об ограничениях трафика на SSID внутри конкретного домена.

  2. Имеет смысл только в составе NbiDomainShaperProfile.

  3. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

name

Имя SSID

Имя SSID, созданного в БД.

domain

Домен SSID

Домен SSID, созданного в БД.

averageUp

Среднее значение ограничения на исходящий трафик

Целое число.

peakUp

Пиковое значение ограничения на исходящий трафик

Целое число.

averageDown

Среднее значение ограничения на входящий трафик

Целое число.

peakDown

Пиковое значение ограничения на входящий трафик

Целое число

См. также

  1. GetDomainShaper

  2. SetDomainShaper

  3. NbiDomainShaperProfile

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiLocationAp. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.8

Параметры объекта

Параметр Значение Формат значения

name

Имя ТД

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

type

Тип ТД

Строка.

ip

IP адрес ТД

4 целых числа в диапазоне [0…​255], разделенных точкой.

domain

Домен SSID

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

mac

MAC адрес точки доступа

6 двузначных шестнадцатеричных чисел, разделенных ':'

city

Город

Строка.

street

Улица

Строка.

house

Дом

Строка.

building

Корпус

Строка.

floor

Этаж

Строка.

office

Офис

Строка.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiLocationAcct. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.8

Параметры объекта

Параметр Значение Формат значения

clientDomain

Домен пользователя

Текст длиной до 255 символов, удовлетворяющий правилам FQDN

nasIP

IP-адрес точки доступа, к которой подключен пользователь

4 целых числа в диапазоне [0…​255] разделенных точкой.

nasMAC

MAC адрес точки доступа, к которой подключен пользователь, а также имя SSID, к которой подключен пользователь. MAC и SSID разделяются «:»

6 двузначных шестнадцатеричных числа, разделенных дефисом, двоеточием, текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

nasDomain

Домен точки доступа.

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

summarySessionTime

Суммарное время длительности сессий на ТД

Длительность по стандарту "ISO 8601" в формате "P[n]Y[n]M[n]DT[n]H[n]M[n]S", например "P1Y2M10DT2H30M"

startTime

Время начала первой сессии

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

stopTime

Время завершения последней сессии на ТД

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

clientMAC

MAC адрес пользователя

Шесть двузначных шестнадцатеричных чисел, разделенных дефисом

SSID

Имя SSID

Текст английскими буквами разного регистра с символами пробела внутри текста, тире, точки и нижними подчеркиваниями длиной до 32-х символов.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiLocationAp. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.8

Параметры объекта

Параметр Значение Формат значения

acct

Объект NbiLocationAcct

ap

Объект NbiLocationAp

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

RolePrio. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

priority

Приоритет роли

Натуральное число

role

Название роли

Строка с именем роли

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

TlsCrtData. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

period

Период действия сертификата

Целое число, дней.

country

Код страны

Две заглавные буквы латиницей.

state

Регион

Текст, любые символы.

location

Населенный пункт

Текст, любые символы.

organization

Название организации

Текст, любые символы.

organizationUnit

Название отдела в организации

Текст, любые символы.

emailDomain

Домен почтового адреса организации

Значение, удовлетворяющее правилам FQDN.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

CertificateSubjectInfo. Описание объекта

Общая информация

Объект для описания параметров клиентского сертификата.

  1. Объект актуален, начиная с версии 1.18

Параметры объекта

Параметр Значение Формат значения

period

Период действия сертификата

Целое число, дней.

country

Код страны

Две заглавные буквы латиницей.

state

Регион

Текст, латиница.

location

Населенный пункт

Текст, латиница.

organization

Название организации

Текст, латиница.

organizationUnit

Название отдела в организации

Текст, латиница.

email

Почтовый адрес организации

Текст, латиница. Должен соответствовать стандарту интернет адресов RFC 5322.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTreeObj - Параметры объекта в дереве EMS

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

Параметры объекта

Параметр Значение Формат значения

type

Тип

String

subtype

Подтип

String

mac

MAC-адрес

6 двузначных шестнадцатеричных чисел, разделенных ':'

ip

IP адрес

4 числа в диапазоне от 0 до 255, разделенные точкой

domain

Домен

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

id

Идентификатор

Целое неотрицательное число

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты объекта дерева

Общая информация

  1. Список актуален, начиная с версии 1.22

Список атрибутов

Параметр Значение Формат значения Расшифровка формата

ActNumber

Номер заявки

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст без спецсимволов длиной до 64-ти символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - и пробел

AuthName

Read community / User v3 (для версий snmp v1 и v2c указывается ReadCommunity, для snmp v3 указывается Login)

String

Текст

AuthPassword

Write community / Password v3 (для версий snmp v1 и v2c указывается WriteCommunity, для snmp v3 указывается Password)

String

Текст

AuthProtocol

Протокол аутентификации

SHA|MD5

SHA или MD5

BlockTraps

Регистрация трапов

Block|Accept

Block или Accept

BrasService

BRAS service provider

true|false

true или false

Building

Корпус

^[ .\-/a-zA-Zа-яА-ЯёЁ0-9]{0,32}$

Текст без спецсимволов длиной до 32-х символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - / . и пробел

Cell

Ключ поиска точки доступа, имеет уникальное значение в рамках домена. Высчитывается как хеш от суммы данных l2-interface и DHCP Opt82

String

Текст

City

Город

^[ .\-a-zA-Zа-яА-ЯёЁ0-9]{1,128}$

Текст без спецсимволов длиной до 128-ми символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - . и пробел

ClusterMode

Режим кластера

on|off|softwlc

on - Full, off - Off или softwlc - SoftWLC

Country

Страна

^[ \-a-zA-Zа-яА-ЯёЁ]{1,32}$

Текст без спецсимволов длиной до 32-x символов, допустимы английские и русские буквы разного регистра, символ - и пробел

CustomCfg

Индивидуальная конфигурация OTT устройства

^[ \-a-zA-Zа-яА-ЯёЁ]{1,255}$

Текст без спецсимволов длиной до 255-ти символов, допустимы английские и русские буквы разного регистра, допустим символ - и пробел

Description

Произвольное описание или дополнительная информация по устройству

^.{0,255}$

Текст длиной до 255-ти символов, допустимы любые символы

District

Район

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,255}$

Текст без спецсимволов длиной до 255-ти символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - и пробел

Domain

Домен

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

DpiStepLogic

DPI (Step Logic)

true|false

true или false

EsrDomain

Домен узла для поиска Station ESR

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

EsrMode

Режим ESR

Station|Client|StationCE|StationL2| StationLocalSoftGRE

Station, Client, StationCE, StationL2 или StationLocalSoftGRE

ESRname

Имя ESR до которого поднят туннель

String

Текст

failoverPeerName

Название failover peer (для мониторинга DHCP failover)

String

Текст

FileTransport

Файловый протокол

TFTP|HTTP|FTP

TFTP, HTTP или FTP

Floor

Этаж

^(-?[0-9]{0,3})$

Допустимы положительные или отрицательные целые числа, максимум трехзначное число

FullName

ФИО

^.{0,255}$

Текст длиной до 255-ти символов, допустимы любые символы

Hex

Представление последовательности байт Opt82

([0-9a-fA-F]+)-([0-9a-fA-F]+)

Последовательность байт в шестнадцатеричной системе счисления, разделенная знаком -

HouseNumber

Номер дома

^[ _.\-/a-zA-Zа-яА-ЯёЁ0-9]{1,32}$

Текст без спецсимволов длиной до 32-х символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - _ / . и пробел

initTime

Дата инициализации устройства

dd.MM.yyyy HH:mm:ss

Время в формате "dd.MM.yyyy HH:mm:ss"

INN

Идентификационный номер налогоплательщика

String

Представляет собой число из 10 или 12 символов

IpAddress

IP адрес

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой

Latitude

Широта

^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$

Указывается вещественное число в диапазоне от -90 до 90

login

Имя пользователя для автоматического подключения по Telnet/SSH

String

Текст

Longitude

Долгота

^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$

Указывается вещественное число в диапазоне от -180 до 180

MacAddress

MAC-адрес устройства

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

NasIpAddress

NAS Ip-адрес устройства (адрес устройства, с которым будет происходить обмен по протоколу RADIUS)

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой

NasMac

MAC станционного ESR, к которому подключена точка

^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$

NetconfLogin

Netconf Login

String

Текст

NetconfPassword

Netconf Password

String

Текст

NetconfPort

Netconf порт

^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$

Число в диапазоне [1..65535]

Office

Офис

^[ №.\-/a-zA-Zа-яА-ЯёЁ0-9]{0,128}$

Текст без спецсимволов длиной до 128 символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы № - / . и пробел

omapiKey

Ключ для подключения с помощью OMAPI

String

Текст

omapiKeyName

Имя ключа для подключения с помощью OMAPI

String

Текст

OttMode

Подключение через сети сторонних операторов (Over-the-top)

None|Connected|ServiceProvider

None - для обычных ТД
Connected - для ТД/ESR-10, подключенных по модели OTT
ServiceProvider - для станционных ESR, которые предоставляют услугу по модели OTT (сейчас привязки инициализации для них не используются)

OutOfService

Флаг 'Выведено из обслуживания'

true|false

true или false

OutOfServiceDate

Дата 'Выведено из обслуживания'

dd.MM.yyyy HH:mm:ss

Время в формате "dd.MM.yyyy HH:mm:ss"

password

Пароль для автоматического подключения по Telnet/SSH

String

Текст

Port

SNMP порт

^(161|102[5-9]|10[3-9][0-9]|[1-9][1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$

Число в диапазоне [1..65535]

PrivacyPassword

Ключ шифрования

String

Текст

PrivacyProtocol

Протокол шифрования

AES|DES

AES или DES

RealUsed_WIPS_WIDS

Реальное применение WIPS/WIDS. Флаг - применяется сервис WIPS/WIDS или нет. Используется, когда этот сервис каким-то образом включен у большего числа устройств, чем допускается лицензией.

true|false

true или false

Region

Область

^[ \-/a-zA-Zа-яА-ЯёЁ0-9]{0,255}$

Текст без спецсимволов длиной до 255-x символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символ - / и пробел

RegionId

Номер регион

^(0[1-9]|[1-9][0-9])$

Двухзначное число

SecurityLevel

Тип аутентификации

NONE|NO_AUTH_NO_PRIV| AUTH_NO_PRIV|AUTH_PRIV

NONE, NO_AUTH_NO_PRIV, AUTH_NO_PRIV или AUTH_PRIV

SnmpTransport

Транспортный протокол для SNMP

TCP|UDP

TCP или UDP

sshPort

Порт для автоматического подключения по SSH

^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$

Число в диапазоне [1..65535]

Status

Статус устройства

ERROR, WRONG, AVAILABLE или UNKNOWN

ERROR - недоступно, WRONG - доступно, но есть какие-то проблемы, AVAILABLE - доступно, UNKNOWN - неизвестное

StatusDate

Время смены статуса устройства на текущее

dd.MM.yyyy HH:mm:ss

Время в формате "dd.MM.yyyy HH:mm:ss"

Street

Улица

^[ .\-/a-zA-Zа-яА-ЯёЁ0-9]{1,128}$

Текст без спецсимволов длиной до 128-и символов, допустимы английские и русские буквы разного регистра, цифры 0-9, символы - / . и пробел

Timeout

Таймаут обмена с устройством, в миллисекундах

^([1-9][0-9]{3,4}|1[01][0-9]{4}|120000)$

Может принимать значения [1000..120000], не рекомендуется делать менее 5000 мс

TunnelIpAddr

Tunnel IP (для поднятия data-tunnel на ESR)

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

4 целых числа в диапазоне [0…​255], разделенных точкой

UseExternalAcs

Использовать внешний ACS

true|false

true или false

Version

Версия SNMP

v2c|v3

v2c или v3

VideoRxPowerReq

Запрашивать уровень сигнала КТВ ONT при синхронизации

true|false

true или false

VrrpStatus

Получение статуса VRRP

true|false

true или false

WebLogin

Имя пользователя для автоматического подключения по Web

String

Текст

WebPassword

Пароль для автоматического подключения по Web

String

Текст

WIPS_WIDS_Service

Включить WIPS/WIDS service

true|false

true или false

Zip

Почтовый индекс

^([0-9]{6})$

Представляет собой число из 6 цифр

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiNodeObject - Параметры узла дерева EMS

Общая информация

  1. Объект актуален, начиная с версии 1.19.

  2. Объект, описывающий узел дерева EMS

Параметры объекта

Параметр Значение Формат значения

id

ID узла

int

type

Тип

String

domain

Домен

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Параметры правила инициализации точек доступа

Общая информация

  1. Информация актуальна, начиная с версии 1.5.1

Список атрибутов

Параметр Описание Совместимые устройства

FirmwareUpdateEnabled

Обновить на актуальный файл ПО
Установить в 'true', чтобы при инициализации точка доступа обновилась на актуальный файл ПО. В противном случае выставить 'false'. По умолчанию принимает значение 'false'

WEP, WOP

FirmwareUpdateOttEnabled

Обновить на актуальный файл ПО OTT
Аналогично предыдущему пункту, но распространяется на точки доступа подключенные по схеме OTT. По умолчанию - 'false'.

WEP, WOP

FirmwareUpdateProtocol

Протокол загрузки ПО
Протокол, по которому точка доступа скачивает файл ПО. Принимает значения 'HTTP', 'TFTP', 'FTP' (для ESR). По умолчанию принимает значение 'HTTP'

WEP, WOP, ESR

NEED_RESET

Восстановить конфигурацию по умолчанию
Установить в 'true', чтобы восстановить конфигурацию по умолчанию перед инициализацией. В противном случае выставить 'false'. По умолчанию принимает значение 'false'

WEP, WOP

NEED_LOAD_TEMPLATE_INDIVIDUAL

Использовать индивидуальный шаблон
Установить в 'true', чтобы поиск шаблона конфигурации осуществлялся по MAC адресу. По умолчанию принимает значение 'false'. Индивидуальные шаблоны создаются через интерфейс EMS.

WEP, WOP

ConfigurationTemplate

Шаблон конфигурации
Имя шаблона конфигурации при инициализации ТД

WEP, WOP

SnmpTransportType

SNMP транспорт
Принимает значения 'TCP' или 'UDP'. По умолчанию принимает значение 'UDP'

WEP, WOP, WB, ESR

SnmpReadonlyCommunity

SNMP community (пароль) для запросов на чтение
По умолчанию принимает значение 'public'

WEP, WOP, WB, ESR

SnmpReadWriteCommunity

SNMP community (пароль) для запросов на чтение/запись
По умолчанию принимает значение 'private'

WEP, WOP, WB, ESR

EsrMode

Режим ESR
Назначение ESR, схема установки:
Station (provider edge),
Client (на стороне клиента. например, ESR без функции BRAS, только для подключения сторонних ТД),
StationCE (customer edge. например, ESR с функцией BRAS)

ESR

BrasService

Сервис BRAS
Установить в 'true', если на ESR используется услуга BRAS. По умолчанию принимает значение 'false'.

ESR

RadiusApSecret

Ключ RADIUS
Секретный ключ точки доступа для radius-сервера. Если не установить, то точка доступа не будет добавлена в radius-сервер

WEP, WOP, WB, ESR

См. также

  1. CreateInitRule для создания правил инициализации

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Параметры виртуального портала

Общая информация

  1. Список добавлен в версии 1.5

  2. Начиная с версии 1.18 не поддерживается, вместо него нужно использовать PortalEditProperties

Список атрибутов

Параметр Описание и значения

site.new.name

Только для команды EditPortalParams. Новое имя виртуального портала.

phone.invalid.message

Не используется с версии 1.7

phone.invalid.message.ru

Не используется с версии 1.7

phone.invalid.message.en

Не используется с версии 1.7

phone.invalid.message.kk

Не используется с версии 1.7

site.success.message

Равен параметру 'site.success.message.ru'.

site.success.message.ru

Не используется с версии 1.7

site.success.message.en

Не используется с версии 1.7

site.success.message.kk

Не используется с версии 1.7

site.redirect

Равен параметру 'site.redirect.ru'.

site.redirect.ru

URL-адрес для перенаправления пользователя после успешной авторизации. Для языка 'ru'.

site.redirect.en

URL-адрес для перенаправления пользователя после успешной авторизации. Для языка 'en'.

site.redirect.kk

URL-адрес для перенаправления пользователя после успешной авторизации. Для языка 'kk'.

site.redirect.zh

URL-адрес для перенаправления пользователя после успешной авторизации. Для языка 'zh'.

payments.ipList

Не используется с версии 1.5

use.ap.redirect

Не используется с версии 1.5

site.templates

Не используется с версии 1.5

deny.self.registration

Запретить саморегистрацию для портальных пользователей. Значения "true" или "false".

phone.placeholder

Не используется с версии 1.7

phone.prefix

Не используется с версии 1.7

phone.regexp

Не используется с версии 1.7

site.title

Равен параметру 'site.title.ru'.

site.title.ru

Заголовок виртуального портала, обязательный параметр. Для языка 'ru'.

site.title.en

Заголовок виртуального портала, обязательный параметр. Для языка 'en'.

site.title.kk

Заголовок виртуального портала, обязательный параметр. Для языка 'kk'.

site.title.zh

Заголовок виртуального портала, обязательный параметр. Для языка 'zh'.

site.captcha

Использовать капчу. Значения "true" или "false".

captcha.length

Количество символов в капче.

default.locale

Язык отображения виртуального портала по умолчанию.

advertising.host

Не используется с версии 1.7.

advertising.host.ru

Не используется с версии 1.7.

advertising.host.en

Не используется с версии 1.7.

advertising.host.kk

Не используется с версии 1.7.

redirect.page5

Включить возможность настройки рекламной страницы на портале. В качестве значения указывается имя несуществующей локальной акции на портале (Например для значения "page5" страница будет доступна по ссылке "http://host:port/eltex_portal/page5").

redirect.page4

Включить возможность настройки рекламной страницы на портале. В качестве значения указывается имя несуществующей локальной акции на портале (Например для значения "page4" страница будет доступна по ссылке "http://host:port/eltex_portal/page4").

redirect.page3

Включить возможность настройки рекламной страницы на портале. В качестве значения указывается имя несуществующей локальной акции на портале (Например для значения "page3" страница будет доступна по ссылке "http://host:port/eltex_portal/page3").

redirect.page2

Включить возможность настройки рекламной страницы на портале. В качестве значения указывается имя несуществующей локальной акции на портале (Например для значения "page2" страница будет доступна по ссылке "http://host:port/eltex_portal/page2").

redirect.page1

Включить возможность настройки рекламной страницы на портале. В качестве значения указывается имя несуществующей локальной акции на портале (Например для значения "page1" страница будет доступна по ссылке "http://host:port/eltex_portal/page1").

site.domain

Домен области видимости виртуального портала.

sms.cut.ssid

Обрезать имя SSID в смс сообщении, если длина смс слишком большая. Значения "true" или "false".

site.descr

Равен параметру 'site.descr.ru'.

site.descr.ru

Описание виртуального портала. Отображается в подвале сайта. Для языка 'ru'.

site.descr.en

Описание виртуального портала. Отображается в подвале сайта. Для языка 'en'.

site.descr.kk

Описание виртуального портала. Отображается в подвале сайта. Для языка 'kk'.

site.descr.zh

Описание виртуального портала. Отображается в подвале сайта. Для языка 'zh'.

sms.msg.template

Равен параметру 'sms.msg.template.ru'.

sms.msg.template.ru

Шаблон смс сообщения, отправляемого клиенту. Используйте специальные слова: %password% (обязательный параметр, пароль сгенерированного аккаунта пользователя), %phone% (номер телефона пользователя), %ssid% (имя сети SSID), %lastdate% (дата, до которой валиден аккаунт пользователя, значение берется из тарифного плана), %limitminutes% (общее ограничение по рабочему времени, значение берется из тарифного плана), %limittraffic% (общее ограничение по трафику, значение берется из тарифного плана). Для языка 'ru'.

sms.msg.template.en

Шаблон смс сообщения, отправляемого клиенту. Используйте специальные слова: %password% (обязательный параметр, пароль сгенерированного аккаунта пользователя), %phone% (номер телефона пользователя), %ssid% (имя сети SSID), %lastdate% (дата, до которой валиден аккаунт пользователя, значение берется из тарифного плана), %limitminutes% (общее ограничение по рабочему времени, значение берется из тарифного плана), %limittraffic% (общее ограничение по трафику, значение берется из тарифного плана). Для языка 'en'.

sms.msg.template.kk

Шаблон смс сообщения, отправляемого клиенту. Используйте специальные слова: %password% (обязательный параметр, пароль сгенерированного аккаунта пользователя), %phone% (номер телефона пользователя), %ssid% (имя сети SSID), %lastdate% (дата, до которой валиден аккаунт пользователя, значение берется из тарифного плана), %limitminutes% (общее ограничение по рабочему времени, значение берется из тарифного плана), %limittraffic% (общее ограничение по трафику, значение берется из тарифного плана). Для языка 'kk'.

sms.msg.template.zh

Шаблон смс сообщения, отправляемого клиенту. Используйте специальные слова: %password% (обязательный параметр, пароль сгенерированного аккаунта пользователя), %phone% (номер телефона пользователя), %ssid% (имя сети SSID), %lastdate% (дата, до которой валиден аккаунт пользователя, значение берется из тарифного плана), %limitminutes% (общее ограничение по рабочему времени, значение берется из тарифного плана), %limittraffic% (общее ограничение по трафику, значение берется из тарифного плана). Для языка 'zh'.

site.additional.auth.params

Включить запрос у пользователя дополнительных параметров при авторизации. Значения "true" или "false".

site.auth.param.email

Добавить поле ввода email клиента при авторизации. Значения "true" или "false".

site.auth.param.email.required

Сделать поле ввода email обязательным для заполнения. Значения "true" или "false".

site.auth.param.family

Добавить поле ввода фамилии клиента при авторизации. Значения "true" или "false".

site.auth.param.family.required

Сделать поле ввода фамилии клиента обязательным. Значения "true" или "false".

site.auth.param.name

Добавить поле ввода имени клиента при авторизации. Значения "true" или "false".

site.auth.param.name.required

Сделать поле ввода имени клиента обязательным. Значения "true" или "false".

sms.gate

Не используется с версии 1.7.

wifi.password.length

Длина генерируемого для пользователя пароля при авторизации.

site.restrict.sms

Включить ограничение на отправку смс. Значения "true" или "false".

site.restrict.sms.seconds.between.attempts

Количество секунд ограничения между неудачными попытками для одного пользователя.

site.restrict.sms.attempts

Количество разрешенных попыток отправки смс на номер для одного пользователя

site.restrict.sms.seconds.for.ban

Количество секунд бана при превышении попыток отправки смс.

tune.payment.service

Активировать сервис оплаты Яндекс.Касса. Значения "true" или "false".

payment.qiwi

Включить возможность работы с QIWI Wallet. Значения "true" или "false".

payment.mobile

Включить возможность оплаты через счет мобильного номера. Значения "true" или "false".

payments.shopId

Идентификатор магазина.

payments.phonePaymentsSupport

Номера телефонов технической поддержки, введеные через запятую.

payments.scid

Номер витрины (SCID).

payments.secret

Пароль магазина.

payment.masterpass

Включить возможность оплаты через MasterPass. Значения "true" или "false".

payment.yapurse

Включить возможность оплаты через Яндекс.Кошелек. Значения "true" или "false".

demo.payment

Включить демо режим оплаты.

payment.terminal

Включить возможность оплаты через терминал. Значения "true" или "false".

payment.webmoney

Включить возможность оплаты через WebMoney. Значения "true" или "false".

payment.cards

Включить возможность оплаты через банковские карты. Значения "true" или "false".

payment.promsvyazbank

Включить возможность оплаты через сервисы Промсвязьбанка. Значения "true" или "false".

payment.sber

Включить возможность оплаты через сервисы "Сбербанк Онлайн" и "Сбербанк СМС". Значения "true" или "false".

payment.aclick

Включить возможность оплаты через сервис "Альфа Клик". Значения "true" или "false".

defaultCountryCode

Код страны для номера телефона по умолчанию. Например Russia/7

allowCountrySelection

Включить возможность выбора клиентом кода страны для номера телефона.

preferredCountryCodes

Варианты кодов для номера телефона, которые доступны на данном портале. Например: ["Abkhazia/7940","Australia/61"]

authMethod.demo

Включить демонстрационный режим для регистрации по номеру телефона.

authMethod.esia

Включить возможность авторизации через Госуслуги.

login.disable

Запретить авторизацию по логину/паролю.

helpEnabled

Включить возможность настройки и отображение страницы помощи.

successEnabled

Включить возможность настройки и отображение страницы успешного прохождения регистрации на портале.

notification.inbound.call

Влючить возможность подтверждения личности клиента с помощью входящего звонка.

notification.inbound.sms

Включить возможность подтверждения личности клиента с помощью входящего СМС-сообщения.

notification.outbound.sms

Включить возможность подтверждения личности клиента с помощью исходящего СМС-сообщения.

mac.store.period

Период хранения MAC-адреса пользователя в системе, в минутах.

accessList/accessList.mac

Параметры списка доступа по MAC.

accessList/accessList.def

Параметры списка доступа по DEF (номер телефона).

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

PortalEditProperties - Редактируемые параметры виртуального портала. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.18.

Параметры объекта

Параметр Значение Формат значения Описание Ограничения

notificationCallInbound

boolean

Звонок от пользователя

Должен быть настроен NGW

notificationSmsInbound

boolean

SMS от пользователя

Должен быть настроен NGW

notificationCallOutbound

boolean

Звонок пользователю

Должен быть настроен NGW. Должен быть указан outboundCallTimeout

notificationSmsOutbound

boolean

SMS пользователю

Должен быть настроен NGW

authMethodEsia

boolean

Авторизация ЕСИА

Должна быть настроена интеграция с ЕСИА.

authMethodDemo

boolean

Демо режим

authMethodFanId

boolean

Авторизация Fan ID

Не может использоваться при включенном welcomeEnabled

loginEnabled

boolean

Авторизация включена

registrationEnabled

boolean

Регистрация включена

Должен быть указан хотя бы один метод подтверждения личности

authParamsName

boolean

Имя пользователя будет запрошено при регистрации

authParamsNameRequired

boolean

Имя является обязательным параметром регистрации

authParamsFamily

boolean

Фамилия будет запрошена при регистрации

authParamsFamilyRequired

boolean

Фамилия является обязательным параметром регистрации

authParamsEmail

boolean

Email будет запрошен при регистрации

authParamsEmailRequired

boolean

Email является обязательным параметром регистрации

advertisingAllowed

boolean

Спрашивать согласие пользователей на рекламную рассылку

advertisingRequired

boolean

Согласие на рекламную рассылку является обязательным для регистрации

countryCodeDefault

String

Код страны по умолчанию

Один из допустимых кодов. AvailablePortalCountryCodes

countryCodeSelectionAllowed

boolean

Выбор кода страны разрешен

smsCutSsid

boolean

Урезать SSID в SMS

smsSecondsBetweenAttempts

int

Количество секунд между попытками отправки SMS

Не может быть меньше 5.

countryCodePreferred

Одно или несколько значений кодов стран.(См. пример запроса)

String

Выбор стран, расположенных в начале списка

Должен быть разрешен выбор кода страны. Один из допустимых кодов. AvailablePortalCountryCodes

outboundCallTimeout

int

Таймаут исходящего звонка(сек.)

Целое число от 10 до 300

wifiPasswordLength

int

Длина генерируемого пароля для регистрации пользователя

Целое число от 4 до 30

openTimeout

int

Время повторного свободного входа (без повторной авторизации/регистрации) (сек.)

Не меньше 60

macStorePeriod

int

Период хранения MAC (сек.)

Не меньше 60

redirectParamSessionId

boolean

Добавлять идентификатор сессии в URL перенаправления

authMethodSats

boolean

Авторизация с АТС Смольного

Должна быть настроена интеграция с АТС Смольного

captchaEnabled

boolean

Captcha включена

При отправке в запросе значения true, необходимо указать значение параметра captchaLength

captchaLength

int

Длина Captcha

Целое число от 1 до 8

smsRestrict

boolean

Включить систему антиспам

При установке в true должны быть указаны smsSecondsBetweenAttempts и smsBanSeconds

smsAttemptsMax

int

Максимальное количество попыток отправки SMS до бана

Не может быть меньше 2. Обязательный параметр если включен антиспам

smsBanSeconds

int

Время ограничения SMS(сек.)

Не может быть меньше 30. Обязательный параметр если включен антиспам

welcomeEnabled

boolean

Страница Welcome включена

Не может быть включена при включенной авторизации Fan ID

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты аккаунта Wi-Fi пользователя

Общая информация

  1. Список актуален, начиная с версии 1.17.

Список атрибутов

Атрибут Описание и значения Операторы Редактируется

Атрибуты проверки

Simultaneous-Use

Максимальное число одновременных подключений с этой учетной записи (от 1).

:=

да

Eltex-User-Deactivated

Деактивация пользователя RADIUS, допустимые значения 'true' или 'false'.

==

да

Eltex-User-Expires

Срок действия учетной записи пользователя RADIUS

<

нет

Cleartext-Password

Пароль пользователя в открытом виде (для MD5, PEAP), не более 253 символов.

:=

да

Calling-Station-Id

MAC-адрес устройства пользователя, 6 двузначных hex-чисел, разделенных дефисами (-) или двоеточиями (:).

==
=~
!~
+=
-=

да

Called-Station-Id

Разрешенные/запрещенные SSID в виде регулярного выражения. Нужно учитывать, что данный атрибут для точки доступа имеет вид «<MAC>:<SSID>», и если задавать ограничение только по SSID, выражение должно начинаться с «^.+[:]».

=~
!~

да

Eltex-User-Deactivation-Expires

Срок деактивации учетной записи пользователя RADIUS. Не требует наличия Eltex-User-Deactivated

>

да

TLS-Client-Cert-Serial

Серийный номер TLS сертификата клиента.

:=

нет

Атрибуты ответа

Eltex-User-Create-Date

Дата создания пользователя RADIUS

=

нет

WISPr-Bandwidth-Max-Down

Максимальная скорость полосы пропускания входящего трафика в битах в секунду.

=

да

WISPr-Bandwidth-Max-Up

Максимальная скорость полосы пропускания исходящего трафика в битах в секунду.

=

да

LVL7-Wireless-Client-Policy-Down

Policy профиль для приема данных для абонента, не более 253 символов.

=

да

LVL7-Wireless-Client-Policy-Up

Policy профиль для исходящих данных для абонента, не более 253 символов.

=

да

Session-Timeout

Максимальная продолжительность сессии, в секундах.

=

да

Tunnel-Type

Указать протокол туннелирования для пользователя. Для корректной настройки VLAN для пользователя, всегда выставлять «13».

=

да

Tunnel-Medium-Type

Указать, какой транспорт использовать при создании туннеля для тех протоколов, которые могут работать на нескольких транспортах. Для корректной настройки VLAN для пользователя, всегда выставлять «6».

=

да

Tunnel-Private-Group-Id

Установить идентификатор VLAN. Разрешается только один идентификатор. Для установки VLAN также используется атрибут Eltex-Additional-Vlans.

=

да

Eltex-Additional-Vlans

Установить несколько идентификаторов VLAN для абонента. Идентификаторы указываются через запятую (,). Разрешено до 9-ти идентификаторов для пользователя.

=

да

Reply-Message

Ответное сообщение пользователю, не более 253 символов.

=

да

Eltex-Traffic-Limit

Общее ограничение по количеству входящих данных для пользователя, в байтах

=

да

Eltex-Work-Time-Limit

Общее ограничение времени для всех сессий пользователя, в секундах

=

да

Eltex-Validity-Period

Срок действия учетной записи пользователя с момента создания, в минутах

=

да

Eltex-User-State

Текущее состояние пользователя при портальной аутентификации

=

нет

Eltex-State-Begin-Date

Время установки текущего состояния пользователя при портальной аутентификации

=

нет

Атрибуты ответа, используемые только на BRAS

Cisco-AVPair

Произвольный атрибут вида ключ-значение.
Одна запись может содержать произвольное количество таких атрибутов.

+=

да

Cisco-Account-Info

Атрибут, указывающий список сервисов вида:
A<имя сервиса> для разрешенных сервисов;
N<имя сервиса> для запрещенных.
Одна запись может содержать произвольное количество таких атриубутов.

+=

да

Idle-Timeout

Период бездействия, с

=

да

Acct-Interim-Interval

Интервал отправки аккаунтинга, с

=

да

Атрибуты, не участвующие в RADIUS обмене

Eltex-User-Category

Категория записи:
enterprise - пользователь для WPA Enterprise,
hotspot - пользователь, создаваемый на портале авторизации,
voucher - ваучер,
voucher_bras - ваучер при использовании BRAS,
bras - пользователь, создаваемый на портале авторизации при использовании BRAS,
service - сервис, используемый в BRAS тарифах,
equipment - устройство технической сети,
pms - пользователь, создаваемый через сервис eltex-ted.

=

да

Operator-SSID

Имя SSID для подключения (не более 253 символов).

=

да

Operator-Family

Фамилия пользователя Wi-Fi (не более 253 символов).

=

да

Operator-Name

Имя и отчество пользователя Wi-Fi (не более 253 символов).

=

да

Operator-Division

Отдел (не более 253 символов).

=

да

Operator-Position

Должность (не более 253 символов).

=

да

Operator-Email

Email (не более 253 символов).

=

да

Operator-Email-Notify

Флаг, который указывает на необходимость отправки уведомлений по Email для данного пользователя (0 - не отправлять, 1 - отправлять)

=

да

Operator-Creator-Email-Notify

Флаг, который указывает на необходимость отправки уведомлений по Email для оператора данного пользователя (0 - не отправлять, 1 - отправлять)

=

да

Operator-Phone

Мобильный телефон (не более 253 символов).

=

да

Operator-Phone-Notify

Флаг, который указывает на необходимость отправки уведомлений по СМС для данного пользователя (0 - не отправлять, 1 - отправлять)

=

да

Operator-Creator-Phone-Notify

Флаг, который указывает на необходимость отправки уведомлений по СМС для оператора данного пользователя (0 - не отправлять, 1 - отправлять)

=

да

Operator-Description

Произвольный комментарий не более 253 символов.

=

да

Operator-Legal-Id

Паспортные данные (не более 253 символов).

=

да

Operator-Creator-Name

Имя системного пользователя ЛК-NBI

=

да

Operator-Creator-Family

Фамилия системного пользователя ЛК-NBI

=

да

Operator-Creator-Phone

Номер телефона системного пользователя ЛК-NBI

=

да

Advertising-Permitted

Согласие пользователя на рассылку рекламы(true или false)

=

да

Eltex-Hotspot-Inactive

Подтвержденный пользователь (false) или не подтвержденный(true)

=

нет

Eltex-User-Dev-Type

Тип устройства пользователя(mobile/tablet/pc)

:=

да

Eltex-User-Dev-Os

ОС устройства пользователя

:=

да

Eltex-User-Dev-Browser

Браузер пользователя

:=

да

Eltex-User-Dev-Vendor

Производитель устройства пользователя

:=

да

Eltex-User-Portal-Lang

Выбранный пользователем язык (тот, который они выбрали на портале)

:=

да

Eltex-User-Auth-Type

Способ подтверждения пользователя

:=

да

Eltex-Ssid-Security

Тип шифрования сети: PLAIN_TEXT, WPA_PERSONAL, WPA_ENTERPRISE

:=

да

Eltex-Ssid-Type

Тип SSID: hotspot, enterprise

:=

да

Eltex-AP-Domain

Домен точки (или пользователя)

:=

да

NAS-IP-Address

IP-адрес точки доступа

:=

да

Eltex-Registration-Number

Номер брони (для интеграции с гостиничными системами)

=

да

Eltex-Room-Number

Номер комнаты (для интеграции с гостиничными системами)

=

да

Eltex-Hotel-Id

Идентификатор отеля (для интеграции с гостиничными системами)

=

да

Описание значений для атрибута Cisco-AVPair

Значение атрибута Описание значения

subscriber:traffic-class={Класс трафика}

Класс трафика

subscriber:filter-id={Имя фильтра};subscriber:filter-action={permit|deny|redirect|redirect-without-parameters}

Выбранные фильтры: Имя фильтра, Действие

subscriber:filter-id={Имя фильтра};subscriber:filter-redirect-url={URL}

Выбранные фильтры: Имя фильтра, URL

subscriber:filter-default-action={permit|deny|redirect}

Действие по умолчанию

subscriber:filter-default-redirect-url={Фильтр:URL}

URL по умолчанию (для redirect)

subscriber:quota-volume={Квота по трафику в байтах}

Квота по трафику в байтах

subscriber:quota-time={Квота по времени в секундах}

Квота по времени в секундах

subscriber:flow-status={enabled-uplink|enabled-downlink|enabled|disabled}

Возможность прохождения IP потоков

subscriber:precedence={Приоритет}

Приоритет

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты SSID

Общая информация

  1. Список актуален, начиная с версии 1.5

  2. Имя SSID - текст английскими буквами разного регистра с символами пробела внутри текста, тире, точки, восклицательного знака и нижними подчеркиваниями длиной до 32-х символов. Символы пробела в начале и в конце текста запрещены. Выражение для проверки: ^[ a-zA-Z0-9_\\-\\.!]{1,32}$

Список атрибутов

Атрибут Описание и значения

Radio

Радио интерфейс для VAP: ALL — 'включить на всех радио интерфейсах', ALL24 — 'включить на всех, где 2,4 ГГц, ALL5 — 'включить на всех, где 5 ГГц'.

Ssid_Status

Статус SSID. Для блокировки установить «locked», для работы - «operational». По умолчанию «operational».

VAP_Status

Статус сети на ТД. Чтобы при установке сети на ТД сеть была включена, нужно установить в «up». В противном случае в «down».

PMKSA_Caching

Включить (true) или отключить (false) PMKSA-кэширование.

Support_80211k

Включить (true) или отключить (false) поддержку 802.11k.

Wireless_Multicast_Forwarding

Включить (true) или отключить (false) поддержку Wireless Multicast Forwarding.

Vlan_ID

Установить идентификатор VLAN. Диапазон 1 - 4094. Если вы используете аутентификацию на основе RADIUS, назначенный VLAN ID для RADIUS-клиента отменяет VLAN ID, настроенный для SSID.

Vlan_Priority

Приоритет для VLAN. Доступные значения: 0-7. Данный параметр можно задать, только если значение Priority равно 1 (802.11p).

Bridge_Location

Bridge, location name at ESR. Максимум 200 символов, формат домена.

VRF

Virtual Routing and Forwarding instance. Максимум 31 символ. Значение по умолчанию 1.

Switch_Community

Switch Community at ESR. true, false.

Opt82_Require

Option 82 required. true, false (by default false).

Traffic_Mode

Traffic mode (1 tunnel, 0 local)

Security_Type

Режим безопасности для SSID: NONE - 0, WPA Personal - 1, WPA Enterprise — 2.

Ssid_Type

Тип сети в SSID: Hotspot - 0, Enterprise - 1, Equipment - 2.

Validate_SSID_Radius_Accounting

Запретить назначать WPA2 Personal на VAP, если не заполнены параметры для RADIUS accounting. Допустимые значения 'true' или 'false'.

WPA_Support

Включить поддержку WPA-TKIP. Только для режимов WPA Personal и WPA Enterprise. Допустимые значения 'true' или 'false'.

WPA2_Support

Включить поддержку WPA2-AES. Только для режимов «WPA Personal» и «WPA Enterprise». Допустимые значения 'true' или 'false'. На точках доступа WPA2-AES является обязательным параметром, пока не будет поддержан WPA3. Потому пытаться отключать его не имеет смысла.

Broadcast_SSID

Установить в 'false', чтобы сделать сеть скрытой. Иначе в 'true'.

WPA_Key

Секретный ключ для WPA Personal. Строка от 8 до 63, можно использовать ASCII печатные символы с кодами в диапазоне [0x20-0x7E].
Об использовании символов, требующих экранирования, можно прочитать здесь.

MAC_Auth_Type

Можно настроить глобальный список MAC адресов, которым разрешено или запрещено иметь доступ в сеть: disable - 0, local - 1, radius — 2.

Policy_Type

Политика доступа по MAC спискам (списки берутся с Radius-сервера, либо прописаны локально на ТД). Допустимые значения: 1-Global, 2-Allow, 3-Block. Global - политика доступа определяется значением параметра Global Policy, который настраивается на вкладке Client QoS. Global. Block - все MAC адреса, которые имеются в списках, будут блокироваться(черный список), Allow - пропускаться(белый список).

Broadcast_Key_Refresh_Rate

Интервал изменения ключа вещания в секундах (по умолчанию 300). Допустимый диапазон 0 - 86400 секунд. Значение 0 указывает, что ключ вещания не обновляется. Ключ трансляция не обновляется, если Fast_Transition_Mode установлен в true. Только для режимов «WAP Personal» и «WAP Enterprise».

Vlan_Trunk

Режим магистрали VLAN. В магистральном режиме весь исходящий трафик не маркируется. Допустимые значения 'true' - включить режим, 'false' - выключить.

General_Mode

При включенном параметре General Mode происходит передача нетегированного и тегированного трафика через настраиваемый VAP. При отключении параметра передается только тегированный трафик. Допустимые значения 'true' или 'false'.

General_Vlan_Id

Если General VLAN-ID не указан, то через настраиваемый VAP передается нетегированный трафик сквозным образом. Если General VLAN-ID указан, то через настраиваемый VAP передается нетегированный трафик со снятием/навешиванием указанного VLAN-ID. Допустимые значения: 1 - 4094, по умолчанию General VLAN-ID равен 1.

Band_Steer

Вы можете включить или отключить режим band steer (true|false).

Session_Key_Refresh_Rate

Интервал изменения ключа сессии для каждого клиента. Допустимый диапазон 0 - 86400 секунд. Значение 0 указывает, что ключ не обновляется. Только для режима безопасности «WPA Enterprise».

Active_Server

Для SSID можно настроить до 4-х RADIUS серверов. Указывается, какой из четырех серверов выбрать для аутентификации беспроводных клиентов. Только для режима безопасности «WAP Enterprise». Допустимые значения: 0 — первичный сервер, 1 — сервер-1, 2 — сервер-2, 3 — сервер-3.

Use_Global_Radius

Использовать ли глобальный RADIUS-сервер, или использовать настроенные для данного SSID RADIUS-серверы. 'true' — если использовать глобальный, 'false' — иначе. Только для режима безопасности «WPA Enterprise».

Radius_IP_Address

Адрес основного RADIUS сервера для этой SSID. Только для режима безопасности «WPA Enterprise».

Radius_IP_Address_1

Адрес резервного RADIUS сервера. При неудачной аутентификации на основном сервере происходят попытки на резервных серверах по порядку. Только для режима безопасности «WPA Enterprise».

Radius_IP_Address_2

Адрес резервного RADIUS-сервера. При неудачной аутентификации на основном сервере происходят попытки на резервных серверах по порядку. Только для режима безопасности «WPA Enterprise».

Radius_IP_Address_3

Адрес резервного RADIUS-сервера. При неудачной аутентификации на основном сервере происходят попытки на резервных серверах по порядку. Только для режима безопасности «WPA Enterprise».

Radius_Key

Секретный ключ для основного сервера RADIUS. До 63 алфавитно-цифровых и специальных символов. Ключ чувствителен к регистру. Ключ должен совпадать с ключом на NAS (точках доступа). Только для режима безопасности «WPA Enterprise».

Radius_Key_1

Ключ для первого резервного сервера. Только для режима безопасности «WPA Enterprise».

Radius_Key_2

Ключ для второго резервного сервера. Только для режима безопасности «WPA Enterprise».

Radius_Key_3

Ключ для третьего резервного сервера. Только для режима безопасности «WPA Enterprise».

Radius_Accounting

Отслеживать и измерять потребление ресурсов конкретного пользователя, таких как время сессии, количество переданных и полученных данных, и т. д.. Только для режима безопасности «WPA Enterprise». Допустимые значения 'true' или 'false'.

Radius_Accounting_Period

Период отправки пакетов аккаунтинга RADIUS. Допустимые значения от 30 до 86400.

Radius_Port

Порт RADIUS-сервера. Допустимые значения от 1 до 65534. Значение по умолчанию - 1812.

Station_Isolation

Если выключена (false), WI-FI клиенты могут общаться друг с другом посылая трафик через NAS (AP). Если включена (true), NAS блокирует связь между wi-fi клиентами одного SSID. При этом NAS позволяет обмен трафиком между его wi-fi клиентами и проводными устройствами в сети, через WDS, а также с wi-fi клиентами, относящимися к разным SSID.

Priority

Включить DSCP (0) или использовать 802.11p (1). Только в последнем случае при создании/редактировании SSID можно задать параметр Vlan_Priority.

Client_Qos_Mode

Включить (true) или отключить (false) QoS на SSID.

DiffServ_Policy_Up

Имя Policy Map, применяемой к передаче трафика к точке доступа NAS. Используйте 'RetrievePolicyMapList', чтобы получить список имен Policy Map.

DiffServ_Policy_Down

Имя Policy Map, применяемой к трафику от точки доступа NAS. Используйте 'RetrievePolicyMapList', чтобы получить список имен Policy Map.

Bandwidth_Limit_Down

Максимально допустимая скорость передачи от точки доступа (NAS) к беспроводному клиенту в битах в секунду. Допустимый диапазон 0 - 1363148800 bps. Ненулевой заданное значение округляется до ближайшего значения 64 Kbps для использования в AP (NAS), но не менее 64 Kbps. Значение 0 означает, что максимальная пропускная способность не ограничена.

Bandwidth_Limit_Up

Максимально допустимая скорость передачи клиента к точке доступа (NAS) в битах в секунду. Допустимый диапазон 0 - 1363148800 bps. Ненулевой заданное значение округляется до ближайшего значения 64 Kbps для использования в AP (NAS), но не менее 64 Kbps. Значение 0 означает, что максимальная пропускная способность не ограничена.

VAP_Limit_Down

Ограничение ширины полосы трафика от точки доступа к клиентам (в сумме), подключенным к данному VAP, бит/с. Диапазон возможных значений: 0 – 4294967295 бит/с. Если назначен 0, то ограничение не применяется. Любое ненулевое значение округляется до величины, кратной 64 кбит/с;

VAP_Limit_Up

Ограничение ширины полосы трафика от клиентов (в сумме), подключенных к данному VAP, до точки доступа, бит/с. Диапазон возможных значений: 0 – 4294967295 бит/с. Если назначен 0, то ограничение не применяется. Любое ненулевое значение округляется до величины, кратной 64 кбит/с.

Fast_Transition_Mode

Флаг для указания, разрешена ли FT аутентификация. FT аутентификация действительна для «WPA2 Personal» или «WPA2 Enterprise» режима безопасности. По умолчанию режим FT отключен (false). Установите true, чтобы включить.

FT_over_DS

Для включения FT используя Over-The-DS механизм, нужно установить true. По умолчанию установлена в ‘false’. Только для режимов «WPA Personal» и «WPA Enterprise».

R0_key_Holder

Идентификатор точки доступа (NAS) для передачи в радиус Access Request Message. Идентификатор используется в качестве R0KH ID. Только для режимов «WPA Personal» и «WPA Enterprise».

R1_key_Holder

Идентификатор R1KH. Только для режимов «WPA Personal» и «WPA Enterprise».

MDID

Используется для идентификации группы точек доступа в пределах ESS, между которыми STA может использовать Fast_Transition_Mode. Только для режимов «WPA Personal» и «WPA Enterprise». Значение по умолчанию - 0.

Reassociation_Deadline

Время, в течение которого AP сохраняет PTKSA и любые ресурсы для STA запроса Re-association от STA. Значение по умолчанию составляет 1000 единиц времени. Только для режимов «WPA Personal» и «WPA Enterprise».

CP_Admin_Mode

Включить (true) или отключить (false) Captive Portal

CP_Web_Portal

Имя Web-портала, который будет использоваться для данного CP.

CP_Protocol

Используемый протокол (HTTP, HTTPS или Auto).

CP_Verification

Тип проверки: поддерживается только 'CaptivePortal'.

CP_External

Включить (true) или отключить (false) использование внешнего портала.

CP_External_URL

URL-адрес для пренаправления.

CP_Away_Time

Время, в минутах, в течение которого при отключении клиента информация о его авторизации запоминается на ТД.

CP_Session_Timeout

Длительность сессии клиента Wi-Fi, в минутах.

CP_Permitted_IP

Разрешенный IP-адрес после авторизации.

Pre_Authentication

Только для «WPA Personal» и «WPA Enterprise». Включить («true») или отключить («false») предварительную аутентификацию для WPA2 клиентов.

MFP

Безопасность для незащищенных и незашифрованных 802.11 пакетов управления. Только для «WPA Personal» и «WPA Enterprise». «Not Required»- 0, «Capable»- 1, «Required» - 2. По умолчанию «Capable» (1).

Check_Minimal_Signal

Включить («true») или отключить («false») проверку минимального сигнала.

Minimal_Signal_Level

Уровень минимального сигнала. Диапазон от -100 до -1 dBm.

Minimal_Signal_Timeout

Таймаут проверки минимального сигнала. Диапазон от 1 до 300 секунд.

Roaming_Signal_Level

Уровень минимального сигнала для роуминга. Диапазон от -100 до -1 dBm. По умолчанию -100.

User_Mobility_Domain

Название группы, в рамках которой может быть совершен роуминг;

TLS_Enable

Включить («true») или отключить («false») поддержку аутентификации по клиентскому сертификату TLS.

Schedule_Work_Time

Включить («true») или отключить («false») работу данной SSID по расписанию.

Schedule_For_Monday

Расписание работы для понедельника в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Tuesday

Расписание работы для вторника в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Wednesday

Расписание работы для среды в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Thursday

Расписание работы для четверга в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Friday

Расписание работы для пятницы в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Saturday

Расписание работы для субботы в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Schedule_For_Sunday

Расписание работы для воскресения в формате '[1|0] HH:mm-HH:mm', где 1 значит включать SSID в указанный интервал времени, а 0 значит не включать SSID в этот день. Например '1 08:00-22:30' или '0 00:00-00:00'

Accounting_Wait_Ip

Включить («true») или отключить («false») Accounting wait IP

CP_Radius_Retry_Count

Количество попыток отправки сообщений. Допустимые значения от 0 до 86400.

CP_Radius_Retry_Timeout

Таймаут между попытками отправки сообщений. Допустимые значения от 1 до 86400.

Ap_Bss_Radius_Acct_Retry_Count

Количество попыток отправки пакетов аккаунтинга RADIUS. Допустимые значения от 0 до 9.

Ap_Bss_Radius_Acct_Retry_Timeout

Таймаут между попытками отправки пакетов аккаунтинга RADIUS. Допустимые значения от 1 до 86400.

Ap_Bss_Radius_Auth_Retry_Count

Количество попыток отправки пакетов авторизации RADIUS. Допустимые значения от 0 до 9.

Ap_Bss_Radius_Auth_Retry_Timeout

Таймаут между попытками отправки пакетов авторизации RADIUS. Допустимые значения от 1 до 86400.

Ap_Bss_Supp_Timeout

Определяет время ожидания ответа на EAP запрос. Допустимые значения от 1 до 60.

Ap_Bss_Max_R_Eeq

Определяет количество попыток отправки. Допустимые значения от 1 до 10.

Radius_Domain

Домен, используемый при авторизации пользователей. Допустимые значения от 1 до 63.

ApFbtRrbKey

RRB key. Допустимое количество символов - 16.

hotspot20

Имя шаблона Hotspot 2.0. Допустимое количество символов от 1 до 40.

MacList

Имя списка. Допустимое количество символов от 1 до 64.

DPI_Step_Logic

Включить («true») или отключить («false») DPI Step Logic.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Список операторов для атрибутов пользователя Wi-Fi.

Общая информация

  1. Список актуален, начиная с версии 1.5

Список операторов

Оператор Описание

:=

Значение добавляется в список параметров конфигурации или в ответ, и заменяется, если такой атрибут уже содержится.

==

Верное, если запрос содержит атрибут и его значение равно указанному.

!=

Верно, если запрос содержит атрибут и его значение не равно указанному.

>

Верно, если запрос содержит атрибут и его значение больше указанного.

>=

Верно, если запрос содержит атрибут и его значение больше либо равно указанному.

<

Верно, если запрос содержит атрибут и его значение меньше указанного.

< =

Верно, если запрос содержит атрибут и его значение меньше либо равно указанному.

=*

Верно, если запрос содержит указанный атрибут, вне зависимости от его значения.

!*

Верно, если запрос не содержит указанный атрибут.

+=

Значение добавляется в список параметров конфигурации или в ответ.

=

Значение добавляется в ответ, если он еще не содержит такого атрибута.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Атрибуты домена

Общая информация

  1. Список актуален, начиная с версии 1.17

  2. Версия 1.19.2: добавлена поддержка profile_id

  3. Версия 1.21: добавлена поддержка hotel_id

Список атрибутов

Параметр Значение Формат значения

domain_type

Тип домена

ap, service, both

users_limit

Квота на пользователей. Максимальное количество Wi-Fi пользователей в домене(или поддоменах). Атрибут может отсутствовать, тогда квота не устанавливается.

Целое неотрицательное число (от 0 до 2147483647)

time_zone

Таймзона

Идентификатор таймзоны. Формат Asia/Krasnoyarsk

region_id

Идентификатор оператора связи или филиала

Допустимые значения от 1 до 99 или пустое

company

Название компании

Строка длиной не более 255 символов, может быть пустой

foreign_key

Внешний идентификатор

Строка длиной не более 255 символов, может быть пустой

personal_account

Номер лицевого счёта

Строка длиной 12 цифр или пустая строка

profile_id

Идентификатор профиля

Список целых значений, может быть пустым. Значения отделяются друг от друга через запятую

hotel_id

Идентификатор отеля

Целое положительное число (от 1 до 2147483647)

Расшифровка значений типа домена 'domain_type':

  • ap - Создание пользователей с этим доменом не разрешено. К домену привязываются ТД

  • service - В этом домене можно создавать Wi-Fi пользователей

  • both - Комбинация ap и service, значение по умолчанию

  • отсутствие атрибута - Использовать тип родительского домена. Если все родительские домены пустые, то использовать тип both

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApInfo. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

name

Имя ТД

Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 32-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.

type

Тип ТД

Строка.

ip

IP адрес ТД

4 целых числа в диапазоне [0…​255], разделенных точкой.

domain

Домен SSID

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

mac

MAC адрес точки доступа

6 двузначных шестнадцатеричных чисел, разделенных ':'

state

Состояние ТД

Строка

workTime

Время в работе в секундах

Целое положительное число от 0 до 263-1.

actNumber

Номер заявки

Строка.

fwVersion

Версия ПО

Строка.

city

Город

Строка.

street

Улица

Строка.

house

Дом

Строка.

building

Корпус

Строка.

floor

Этаж

Строка.

office

Офис

Строка.

fullName

ФИО

Строка.

ssids

Список SSID. Массив объектов NbiApSSIDInfo

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApSSIDInfo. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

name

Имя SSID

Текст английскими буквами разного регистра с символами пробела, тире, точки и нижними подчеркиваниями длиной до 32-х символов.

domain

Домен SSID

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

isVAPUp

Состояние VAP

Текст "true/false".

security

Режим безопасности

Строка.

portalName

Имя портала для ssid

Строка.

portalTariffs

Список тарифов портала с доменами

Строка в формате tariff@domain, tariff@domain.

radioFreq

Частота радиомодуля

Текст "5/2,4".

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiStringList. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

str

Массив строковых параметров

Текст, любые символы.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiUrlFilterSimple. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен SSID

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

type

Тип списка

'WHITE' или 'BLACK'

listSize

Размер списка URL

Число

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiUrlFilter. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен SSID

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

type

Тип списка

'WHITE' или 'BLACK'

list

Список URL

NbiStringList

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiInitializationAp. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

ip

IP-адрес точки доступа

4 целых числа в диапазоне [0…​255], разделенных точкой.

mac

MAC-адрес точки доступа

6 двузначных шестнадцатеричных чисел, разделенных ':'.

type

Тип устройства

Текст длиной до 255 символов

status

Статус инициализации

Возможные значение: NEVER, IN_PROGRESS, SUCCESSFUL, FAILED, INTERRUPTED, MAC_ALREADY_EXIST, UPDATE_IN_PROGRESS, UPDATE_FAILED, WRONG_MAC, DELETE_FAILED, DELETED_SUCCESS.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ip |IP-адрес точки доступа |^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$ |4 целых числа в диапазоне [0…​255], разделенных точкой. |AP

NbiRadiusUsersFlatArray - Список пользователей wi-fi по таблице radstat.

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Параметры объекта

Параметр Значение Формат значения

items

Массив объектов с информацией о пользователях

NbiRadiusUserFlat

totalCount

Общее число записей с учетом фильтрации

long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUserFlat - Пользователь wi-fi по таблице radstat.

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

userName

Имя пользователя

String

userDomain

Домен пользователя

String

createDate

Дата создания

String

userUpdateDate

Дата последней активности на портале

String

mac

MAC адрес устройства, с которого было подключение при регистрации данного пользователя

String

ssid

SSID, к которому подключался пользователь при регистрации

String

family

Фамилия

String

name

Имя

String

devision

Подразделение

String

position

Должность

String

email

E-mail

String

organization

Организация

String

country

Код страны

String

state

Субъект

String

location

Населенный пункт

String

phone

Телефон

String

category

Категория пользователя в системе SoftWLC

String

deactivated

Признак деактивации пользователя

Boolean

tariff_name

Имя активного тарифа

String

validity_period

Период валидности пользователя

Integer

validUntil

Дата окончания периода валидности пользователя

String

clientFamily

Фамилия оператора, создавшего УЗ

String

clientName

Имя оператора, создавшего УЗ

String

clientPhone

Телефон оператора, создавшего УЗ

String

advertisingPermitted

Согласие на рассылку рекламы

Boolean

hotspotInactive

Признак не активности hotspot пользователя

Boolean

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusUsersStatCounters - Показатели статистики по пользователям.

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Параметры объекта

Параметр Значение Формат значения

totalCount

Всего пользователей

long

addedTodayCount

Пользователей добавлено сегодня

long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAttrArray - Массив атрибутов.

Общая информация

  1. Команда актуальна, начиная с версии 1.5.

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов с описанием атрибутов

NbiAttr

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusItemGraphArray - Массив объектов данных по графику, списку

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiRadiusItemGraphSingle с данными о запрошенных величинах

NbiRadiusItemGraphSingle

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusItemGraphSingle - Объект данных по графику, списку величин

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

Параметры объекта

Параметр Значение Формат значения

name

Имя параметра, показателя, счетчика

String

value

Значение параметра, показателя, счетчика

double

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AcctStats - Статистика подключений пользователей.

Общая информация

  1. Объект актуален, начиная с версии 1.6

Параметры объекта

Параметр Значение Формат значения

inputOctets

Сумма входящих байт.

BigInteger

outputOctets

Сумма исходящих байт.

BigInteger

lostPackets

Сумма потерянных пакетов.

Целое неотрицательное число.

connections

Количество сессий.

Целое неотрицательное число.

uniqueMac

Количество уникальных пользовательских устройств.

Целое неотрицательное число.

uniqueAccounts

Кол-во уникальных УЗ.

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAcctArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

param

Массив объектов NbiAcct.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApStatsEntry - Статистика по точке доступа.

Общая информация

  1. Объект актуален, начиная с версии 1.6

Параметры объекта

Параметр Значение Формат значения

ap

Объект NbiNameDomain. Имя и домен точки доступа

stats

Объект AcctStats

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusStatisticArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.3

Параметры объекта

Параметр Значение Формат значения

item

Массив объектов NbiRadiusStatisticItemArray

NbiRadiusStatisticItemArray

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiRadiusStatisticItemArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.3

Параметры объекта

Параметр Значение Формат значения

time

Время сбора статистики

Целое положительное число.

item

Объект NbiRadiusItemGraphArray

NbiRadiusItemGraphArray

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiLocationSubnetProfile - Объект, описывающий профиль PCRF-подсети

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

subnetName

Имя подсети

Текст, любые символы.

vrf

VRF

Текст, любые символы.

location

Местоположение

Текст, любые символы.

nasIp

IP-адрес NAS

4 целых числа в диапазоне [0…​255], разделенных точкой.

mac

MAC-адрес NAS

MAC адрес маленькими буквами с разделителями двоеточиями. Может быть пустым.

userDomain

Домен пользователя

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

portalId

Идентификатор портала

Текст, любые символы.

apDomain

Домен точки доступа

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

apId

Идентификатор точки доступа

Текст, любые символы.

ssid

Имя ssid

Текст длиной до 255 символов.

subnetType

Тип подсети

Целочисленное значение из списка: (SERVICE(0), AP_DYNAMIC(1), AP_STATIC(2)).

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiPCRFScriptArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

param

Массив объектов NbiPCRFScript.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiPCRFScript - PCRF сценарий

Общая информация

  1. Объект актуален, начиная с версии 1.5

Параметры объекта

Параметр Значение Формат значения

title

Название скрипта

Текст, любые символы.

domain

Название домена

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

steps

Массив объектов NbiParameter

Список пар "сервис - порядок выполнения".

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiServiceProfile - Профиль сервиса для конкретного пользователя.

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

username

Имя пользователя

Текст, любые символы.

userdomain

Домен пользователя

Текст, любые символы.

quota

Массив объектов NbiServiceQuota

NbiServiceQuota.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiServiceQuota - Квота, установленная для сервиса.

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

servicename

Имя сервиса

Текст, любые символы.

servicedomain

Домен сервиса

Текст, любые символы.

quotatime

Квота по времени

Целое неотрицательное число.

quotavolume

Квота по трафику

Целое неотрицательное число.

NbiLightRadiusUserArray - Массив пользователей Wi-Fi.

Общая информация

  1. Объект актуален, начиная с версии 1.3

  2. Объект содержит массив основных данных Wi-Fi пользователей.

Параметры объекта

Параметр Значение Формат значения

param

Массив объектов NbiLightUser.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiLightUser - Содержит основные данные о Wi-Fi пользователе.

Общая информация

  1. Объект актуален, начиная с версии 1.3

  2. Объект содержит основные данные о Wi-Fi пользователе.

Параметры объекта

Параметр Значение Формат значения

username

Имя пользователя

Текст, любые символы.

domain

Домен пользователя

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

creation_date

Дата создания

Дата в формате «yyyy-MM-dd HH:mm:ss».

phone

Телефон пользователя

Текст, любые символы.

email

Email пользователя

Текст, любые символы.

mac

МАС-адрес пользователя

6 двузначных шестнадцатеричных чисел, разделенных ':'.

family

Фамилия пользователя

Текст, любые символы.

opName

Имя и отчетство пользователя

Текст, любые символы.

id

Идентификатор пользователя

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainFlat. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

id

Идентификатор домена

Целое неотрицательное число.

name

Наименование домена

Текст длиной до 63 символов.

type

Тип домена

"both" или "ap" или "service".

children

Домен имеет дочерние домены

"true" или "false".

Расшифровка значений типа домена 'type':

  • ap - Создание пользователей с этим доменом не разрешено. К домену привязываются ТД

  • service - В этом домене можно создавать Wi-Fi пользователей

  • both - Комбинация ap и service, значение по умолчанию

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainFlatArray. Описание объекта

Общая информация

  1. Объект актуален, начиная с версии 1.7

Параметры объекта

Параметр Значение Формат значения

array

Один или более объект NbiDomainFlat

position

Позиция последнего добавленного элемента в массиве array

Целое неотрицательное число.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApp. Описание объекта

Общая информация

Данные одного приложения списка приложений

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

name

Уникальное имя приложения

Строка

description

Краткое описание приедложения

Строка

tags

Имя тега

Строка (параметр может может повторяться несколько раз или не существовать вообще)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAppsInfoSimple. Описание объекта

Общая информация

Краткая информация о списке приложений

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

size

Размер списка

Integer

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAppsInfo. Описание объекта

Общая информация

Информация о списке приложений

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

name

Имя списка

Строка

domain

Домен

Текст длиной до 255 символов, удовлетворяющий правилам FQDN.

size

Размер списка

Integer

apps

Информация о приложений

NbiApp (параметр может может повторяться несколько раз или не существовать вообще)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiAppList. Описание объекта

Общая информация

Список списков приложений

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

total

Общее число списков

Integer

appsList

Краткая информация об списке приложений

NbiAppsInfoSimple (параметр может может повторяться несколько раз или не существовать вообще)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSetAppsList. Описание объекта

Общая информация

Список имен приложений

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

apps

Имя приложения

Строка (параметр может может повторяться несколько раз или не существовать вообще)

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiTopActiveUsersArray - Список пользователей c информацией по трафику

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

users

Объекты списка пользователей NbiActiveUser

NbiActiveUser

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiActiveUser - Данные пользователя и статистика по его трафику

Общая информация

  1. Команда актуальна, начиная с версии 1.9.

Параметры объекта

Параметр Значение Формат значения

username

Логин пользователя

String

deactivated

Флаг деактивации пользователя

Boolean

deactivationUntil

Время выключения деактивации

String

name

Имя пользователя

String

family

Фамилия пользователя

String

tariffName

Имя последнего тарифного плана, на котором находился пользователь

String

lastVisit

Время последней авторизации пользователя

Instant

domain

Домен пользователя

String

octetsTotal

Суммарное число входящего и исходящего трафика в байтах

BigInteger

octetsIn

Входящий трафик в байтах

BigInteger

octetsOut

Исходящий трафик в байтах

BigInteger

octetsTotalAvg

Среднее число суммарного входящего и исходящего трафика (байт/сек)

BigDecimal

octetsInAvg

Среднее число входящего трафика (байт/сек)

BigDecimal

octetsOutAvg

Среднее число исходящего трафика (байт/сек)

BigDecimal

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainTimezone - Домен и его таймзона.

Общая информация

  1. Объект актуален, начиная с версии 1.9

Параметры объекта

Параметр Значение Формат значения

domain

Домен, для которого нужно получить таймзону

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

timezone

Идентификатор таймзоны, например 'Asia/Novosibirsk'

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiGeoAp - Данные объекта на карте

Общая информация

  1. Актуально, начиная с версии 1.10.

  2. Объект содержит информацию о точках доступа на карте. Объект может содержать информацию об одной точке или нескольких точках в регионе.

Параметры объекта

Параметр Значение Формат значения

apInfo

Информация о ТД, если в данной области она одна

NbiApInfo

latitude

Координаты, широта

Double

longitude

Долгота

Double

geoHash

GeoHash (сейчас не используется)

String

apOnline

Число точек доступа онлайн

Long

apOffline

Число точек доступа оффлайн

Long

userOnline24

Число пользователей онлайн в 2.4 ГГц

Long

userOnline50

Число пользователей онлайн в 5 ГГц

Long

vapOn24

Число ТД с VAP в 2.4 ГГц

Long

vapOn50

Число ТД с VAP в 5 ГГц

Long

maxUsers

Максимальное число пользователей онлайн на ТД

Long

maxTraffic

Максимальный трафик через точку, b/s

Double

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiGeoApListItem - Объект Точки доступа (eltex_ems.ELTEX_OBJ_GEO)

Общая информация

  1. Актуально, начиная с версии 1.10.

Параметры объекта

Параметр Значение Формат значения

emsId

ID объекта в дереве EMS

Integer

name

Имя объекта в дереве EMS

String

type

Полный тип объекта

String

subtype

Подтип объекта

String

serialNumber

Серийный номер объекта

String

domain

Домен объекта

String

available

Доступность объекта

Integer

status

Расширенный статус объекта

Integer

statusCause

Причина установки статуса

String

startTime

Время обновления статуса на устройстве

Timestamp

uptime

Время в работе, с

BigInteger

ip

IP адрес

String

mac

MAC адрес

String

maxTraffic

Максимальный трафик через точку, bps

Double

maxUsers

Максимальное число одновременных подключений к точке

Integer

user24

Текущее число подключенных клиентов в диапазоне 2.4 ГГц

Integer

user50

Текущее число подключенных клиентов в диапазоне 5 ГГц

Integer

zip

Почтовый индекс

String

regionId

Номер региона

String

actNumber

Номер заявки

String

fullName

ФИО

String

country

Страна

String

region

Область

String

city

Город

String

district

Район

String

street

Улица

String

building

Корпус

String

house

Номер дома

String

floor

Этаж

String

office

Офис

String

lat

Широта (0.0 по умолчанию)

Float

lon

Долгота (0.0 по умолчанию)

Float

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiGeoApList - Список Точек доступа (eltex_ems.ELTEX_OBJ_GEO)

Общая информация

  1. Актуально, начиная с версии 1.10.

Параметры объекта

Параметр Значение Формат значения

items

Список ТД

Массив NbiGeoApListItem

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiFreeSearchFilter - Объект поиска по тексту

Общая информация

  1. Актуально, начиная с версии 1.10.

Параметры объекта

Параметр Значение Формат значения

searchString

Строка поиска

String

fields

Имена полей доступные для поиска

Массив String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainFilter - Объект фильтра по домену

Общая информация

  1. Актуально, начиная с версии 1.10.

Параметры объекта

Параметр Значение Формат значения

name

Полный домен

String

nested

Включая вложенные домены

Boolean

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoObjectListRequest - Условия выборки Точек доступа (eltex_ems.ELTEX_OBJ_GEO)

Общая информация

  1. Актуально, начиная с версии 1.13.

Параметры объекта

Параметр Значение Формат значения

domains

Список доменов. Если пустой, то будут учтены все домены, доступные роли

Массив NbiDomainFilter

freeSearch

Поиск по текстовому полю

NbiFreeSearchFilter

params

Дополнительные параметры выборки

NbiParameterArray

В качестве дополнительных параметров можно указывать:

  • available - статус доступности -1 (все), 0 или 1 (доступно);
    по умолчанию -1;

  • status - список расширенных статусов (цифр через запятую), в которых могут находиться возвращаемые объекты;
    по умолчанию пустая строка;

  • types - типы устройств (в системе EMS, разделенные запятой);
    по умолчанию все типы;

  • offset - сдвиг от начала списка;
    по умолчанию 0;

  • limit - количество выводимых элементов;
    по умолчанию 100;

  • orderFields - поле, определяющее, по какому элементу сортировать выдаваемые данные;
    по умолчанию пустая строка;

  • orderType - поле определяющее тип сортировки;
    по умолчанию ASC;

  • esrmode - режим, в котором находится ESR (используется только для ESR устройств);
    по умолчанию -1;

  • ott - режим OTT, в котором могут находиться возвращаемые объекты;
    по умолчанию -1;
    разрешены значения: -1 - All, 0 - Not OTT, 1 - OTT Connected (Client), 2 - OTT ServiceProvider.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiGeoApListItemWithOutOfService - Объект Точки доступа (eltex_ems.ELTEX_OBJ_GEO и eltex_ems.ELTEX_OBJ_PROP)

Общая информация

  1. Актуально, начиная с версии 1.17.

Параметры объекта

Параметр Значение Формат значения

emsId

ID объекта в дереве EMS

Integer

name

Имя объекта в дереве EMS

String

type

Полный тип объекта

String

subtype

Подтип объекта

String

serialNumber

Серийный номер объекта

String

domain

Домен объекта

String

available

Доступность объекта

Integer

status

Расширенный статус объекта

Integer

statusCause

Причина установки статуса

String

startTime

Время обновления статуса на устройстве

String

uptime

Время в работе, с

BigInteger

ip

IP адрес

String

mac

MAC адрес

String

maxTraffic

Максимальный трафик через точку, bps

Double

maxUsers

Максимальное число одновременных подключений к точке

Integer

user24

Текущее число подключенных клиентов в диапазоне 2.4 ГГц

Integer

user50

Текущее число подключенных клиентов в диапазоне 5 ГГц

Integer

zip

Почтовый индекс

String

region

Номер региона

String

actNumber

Номер заявки

String

fullName

ФИО

String

country

Страна

String

city

Город

String

district

Район

String

street

Улица

String

building

Корпус

String

house

Номер дома

String

floor

Этаж

String

office

Офис

String

lat

Широта (0.0 по умолчанию)

Float

lon

Долгота (0.0 по умолчанию)

Float

initTime

Время иниациализации

String

outOfServiceDate

Время выведения устройства из обслуживания

String

outOfService

Показатель выведения устройства из обслуживания

boolean

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiGeoApListWithOutOfService - Список Точек доступа (eltex_ems.ELTEX_OBJ_GEO и eltex_ems.ELTEX_OBJ_PROP)

Общая информация

  1. Актуально, начиная с версии 1.17.

Параметры объекта

Параметр Значение Формат значения

items

Список ТД

Массив NbiGeoApListItemWithOutOfService

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GetGeoApListWithOutOfServiceRequest - Условия выборки Точек доступа (eltex_ems.ELTEX_OBJ_GEO и eltex_ems.ELTEX_OBJ_PROP)

Общая информация

  1. Актуально, начиная с версии 1.17.

Параметры объекта

Параметр Значение Формат значения

domains

Список доменов. Если пустой, то будут учтены все домены, доступные роли

Массив NbiDomainFilter

freeSearch

Поиск по текстовому полю

NbiFreeSearchFilter

params

Дополнительные параметры выборки

NbiParameterArray

В качестве дополнительных параметров можно указывать:

  • available - статус доступности -1 (все), 0 или 1 (доступно);
    по умолчанию -1;

  • status - список расширенных статусов (цифр через запятую), в которых могут находиться возвращаемые объекты;
    по умолчанию пустая строка;

  • types - типы устройств (в системе EMS, разделенные запятой);
    по умолчанию все типы;

  • orderFields - поле, определяющее, по какому элементу сортировать выдаваемые данные;
    по умолчанию пустая строка;

  • orderType - поле определяющее тип сортировки;
    по умолчанию ASC;

  • esrmode - режим, в котором находится ESR (используется только для ESR устройств);
    по умолчанию -1;

  • ott - режим OTT, в котором могут находиться возвращаемые объекты;
    по умолчанию -1;
    разрешены значения: -1 - All, 0 - Not OTT, 1 - OTT Connected (Client), 2 - OTT ServiceProvider;

  • outOfService - признак выведения устройств из обслуживания false (устройство не выведенно), true (выведенно).

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Объект информации по точке. Актуально начиная с версии 1.17.

Параметры объекта

Параметр Значение Формат значения

ip

IP-адрес в формате
^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

String

name

Название точки в системе

String

type

Тип точки

String

domain

Домен точки

String

mac

MAC-адрес точки

String

building

Номер здания

String

city

Город

String

floor

Этаж

String

office

Кабинет

String

street

Улица

String

house

Номер дома

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

GeoCoordinateItem - Геокоординаты почтового адреса

Общая информация

  1. Объект актуален, начиная с версии 1.18

Параметры объекта

Параметр Значение Формат значения

address

Почтовый адрес

String

latitude

Широта

Double

longitude

Долгота

Double

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Параметры адреса в формате КЛАДР и их допустимые значения.

Общая информация

  1. Объект актуален, начиная с версии 1.18

Параметры адреса

Параметр Значение Формат значения Расшифровка формата Обязательный параметр

Country

Страна

^[ \-a-zA-Zа-яА-ЯёЁ]{1,64}$

Текст до 64-х символов

Нет

Region

Область

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

District

Район

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

City

Город

^[ .\-a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

Street

Улица

^[ .\-/a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

HouseNumber

Номер дома

^[ _.\-/a-zA-Zа-яА-ЯёЁ0-9]{1,35}$

Текст до 35-и символов

Да

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Контейнер со структурой ответа от КЛАДР

Параметры объекта

Параметр Значение Формат значения

commonKladrAddress

CommonKladrAddress

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Контейнер с общей структурой ответа от КЛАДР

Параметры объекта

Параметр Значение Формат значения

region

Region

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Представление параметров региона из КЛАДР

Параметры объекта

Параметр Значение Формат значения

district

District

id

Long

name

String

zip

Integer

type

String

typeShort

String

okato

Long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Представление параметров района из КЛАДР

Параметры объекта

Параметр Значение Формат значения

city

City

id

Long

name

String

zip

Integer

type

String

typeShort

String

okato

Long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Представление параметров города из КЛАДР

Параметры объекта

Параметр Значение Формат значения

street

Street

id

Long

name

String

zip

Integer

type

String

typeShort

String

okato

Long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Представление параметров улицы из КЛАДР

Параметры объекта

Параметр Значение Формат значения

house

House

id

Long

name

String

zip

Integer

type

String

typeShort

String

okato

Long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

Представление параметров дома из КЛАДР

Параметры объекта

Параметр Значение Формат значения

id

Long

name

String

zip

Integer

type

String

typeShort

String

okato

Long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiUserSessionItem - Сессия пользователя Wi-Fi.

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Параметры объекта

Параметр Значение Формат значения

username

Логин пользователя

String

userMac

MAC-адрес пользователя

String

userIp

IP-адрес пользователя

String

apDomain

Домен ТД, к которой подключен пользователь

String

ssid

Сеть, к которой подключен пользователь

String

nasMac

MAC-адрес ТД

String

nasIp

IP-адрес ТД

String

startTime

Время начала сессии

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

endTime

Время окончания сессии

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

sessionTime

Длительность сессии, в секундах

int

inputOctets

Входящий трафик пользователя, в байтах

BigInteger

outputOctets

Исходящий трафик пользователя, в байтах

BigInteger

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

AvailablePortalCountryCodes - Допустимые коды стран для редактирования параметров портала

Общая информация

  1. Список допустимых кодов стран

Параметры объекта

Код страны

Abkhazia/7840

Abkhazia/7940

Abkhazia/99544

Afghanistan/93

Aland-Islands/35818

Albania/355

Algeria/213

American-Samoa/1684

American-Samoa/684

Andorra/376

Angola/244

Anguilla/1264

Antigua-and-Barbuda/1268

Argentina/54

Armenia/374

Aruba/297

Aruba/5998

Ascension-Island/247

Australia-Australian-Antarctic-Territory/6721

Australia/61

Australian-External-Territories/672

Austria/43

Azerbaijan/994

Bahamas/1242

Bahrain/973

Bangladesh/880

Barbados/1246

Belarus/375

Belgium/32

Belize/501

Benin/229

Bermuda/1441

Bhutan/975

Bolivia/591

Bonaire/5997

Bosnia-and-Herzegovina/387

Botswana/267

Brazil/55

British-Indian-Ocean-Territory/246

British-Virgin-Islands/1284

Brunei/673

Bulgaria/359

Burkina-Faso/226

Burundi/257

Cambodia/855

Cameroon/237

Canada/1

Cape-Verde/238

Cayman-Islands/1345

Central-African-Republic/236

Chad/235

Chile/56

China/86

Christmas-Island/6189164

Cocos-Islands/6189162

Colombia/57

Comoros/269

Cook-Islands/682

Costa-Rica/506

Croatia/385

Cuba/53

Curacao/5999

Cyprus/357

Czech-Republic/420

Democratic-Republic-of-the-Congo/243

Denmark/45

Djibouti/253

Dominica/1767

Dominican-Republic/1809

Dominican-Republic/1829

Dominican-Republic/1849

East-Timor/670

Ecuador/593

Egypt/20

El-Salvador/503

Equatorial-Guinea/240

Eritrea/291

Estonia/372

Ethiopia/251

Falkland-Islands/500

Faroe-Islands/298

Federated-States-of-Micronesia/691

Fiji/679

Finland/358

Former-Netherlands-Antilles/599

France/33

French-Guiana/594

French-Polynesia/689

Gabon/241

Gambia/220

Georgia/995

Germany/49

Ghana/233

Gibraltar/350

Greece/30

Greenland/299

Grenada/1473

Guadeloupe/590

Guam/1671

Guam/671

Guatemala/502

Guernsey/441481

Guinea-Bissau/245

Guinea/224

Guyana/592

Haiti/509

Honduras/504

Hong-Kong/852

Hungary/36

Iceland/354

India/91

Indonesia/62

Iran/98

Iraq/964

Ireland/353

Isle-of-Man/441624

Israel/972

Italy/39

Ivory-Coast/225

Jamaica/1876

Jan-Mayen/4779

Japan/81

Jersey/441534

Jordan/962

Kazakhstan/7

Kenya/254

Kiribati/686

Kosovo/383

Kuwait/965

Kyrgyzstan/996

Laos/856

Latvia/371

Lebanon/961

Lesotho/266

Liberia/231

Libya/218

Liechtenstein/423

Lithuania/370

Luxembourg/352

Macau/853

Macedonia/389

Madagascar/261

Malawi/265

Malaysia/60

Maldives/960

Mali/223

Malta/356

Marshall-Islands/692

Martinique/596

Mauritania/222

Mauritius/230

Mayotte/262269

Mayotte/262639

Mexico/52

Moldova/373

Monaco/377

Mongolia/976

Montenegro/382

Montserrat/1664

Morocco/212

Morocco/2125288

Morocco/2125289

Mozambique/258

Myanmar/95

Nagorno-Karabakh/37447

Nagorno-Karabakh/37497

Namibia/264

Nauru/674

Nepal/977

Netherlands/31

New-Caledonia/687

New-Zealand/64

Nicaragua/505

Niger/227

Nigeria/234

Niue/683

Norfolk-Island/6723

North-Korea/850

Northern-Cyprus/90392

Northern-Ireland/4428

Northern-Mariana-Islands/1670

Norway/47

Oman/968

Pakistan/92

Palau/680

Palestine/970

Panama/507

Papua-New-Guinea/675

Paraguay/595

Peru/51

Philippines/63

Pitcairn-Islands/64

Poland/48

Portugal/351

Puerto-Rico/1787

Puerto-Rico/1939

Qatar/974

Republic-of-the-Congo/242

Reunion/262

Romania/40

Russia/7

Rwanda/250

Saba/5994

Saint-Helena/290

Saint-Kitts-and-Nevis/1869

Saint-Lucia/1758

Saint-Pierre-and-Miquelon/508

Saint-Vincent-and-the-Grenadines/1784

Samoa/685

San-Marino/378

Sao-Tome-and-Principe/239

Saudi-Arabia/966

Senegal/221

Serbia/381

Seychelles/248

Sierra-Leone/232

Singapore/65

Sint-Eustatius/5993

Sint-Maarten/1721

Sint-Maarten/5995

Slovakia/421

Slovenia/386

Solomon-Islands/677

Somalia/252

South-Africa/27

South-Georgia-and-the-South-Sandwich-Islands/500

South-Korea/82

South-Ossetia/99534

South-Sudan/211

Spain/34

Sri-Lanka/94

Sudan/249

Suriname/597

Svalbard/4779

Swaziland/268

Sweden/46

Switzerland/41

Syria/963

Taiwan/886

Tajikistan/992

Tanzania/255

Thailand/66

Togo/228

Tokelau/690

Tonga/676

Transnistria/3732

Transnistria/3735

Trinidad-and-Tobago/1868

Tristan-da-Cunha/2908

Tunisia/216

Turkey/90

Turkmenistan/993

Turks-and-Caicos-Islands/1649

Tuvalu/688

Uganda/256

Ukraine/380

United-Arab-Emirates/971

United-Kingdom/44

United-States-Virgin-Islands/1340

United-States/1

Uruguay/598

Uzbekistan/998

Vanuatu/678

Vatican-City/3906698

Venezuela/58

Vietnam/84

Wallis-and-Futuna/681

Yemen/967

Zambia/260

Zanzibar/25524

Zimbabwe/263

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Объект актуален, начиная с версии 1.18.

Параметры объекта

Параметр Значение Формат значения

pid

Идентификатор устройства в дереве устройств

int

domain

Домен устройства

String

nasMac

MAC-адрес ESR’а, к которому подключена сторонняя ТД

String

cell

Идентификатор сети

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainSsidTypeStatisticItem - Описание объекта статистики по домену

Общая информация

  1. Команда актуальна, начиная с версии 1.18.

Параметры объекта

Параметр Значение Формат значения

ssidType

Тип SSID

int

countUnicLogin

Количество уникальных логинов

long

countUnicMac

Количество уникальных MAC-адресов

long

inputOctets

Входящий трафик, байт

String

outputOctets

Исходящий трафик, байт

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiDomainIntegralStatus - Интегральный статус узла дерева объектов

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

Параметры объекта

Параметр Значение Формат значения

domainName

Домен узла

String

greenStatusCount

Число доступных устройств

long

yellowStatusCount

Число устройств с активными авариями

long

redStatusCount

Число недоступных устройств

long

grayStatusCount

Число устройств выведенных из обслуживания

long

pinkStatusCount

Число устройств без IP

long

orangeStatusCount

Число устройств в состоянии Нет синхронизации

long

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiApDeviceItem - Информация о точке доступа (eltex_ems.ELTEX_OBJ_GEO)

Общая информация

  1. Актуально, начиная с версии 1.17.

Параметры объекта

Параметр Значение Формат значения

name

Имя объекта в дереве EMS

String

domain

Домен объекта

String

ip

IP адрес

String

type

Полный тип объекта

String

subtype

Подтип объекта

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Общая информация

  1. Объект актуален, начиная с версии 1.19.

Параметры объекта

Параметр Значение Формат значения

id

Уникальный идентификатор привязки

int

ssidName

Имя SSID’а

String

ssidDomain

Домен SSID’а

String

nasKey

Ключ привязки SSID

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

NbiSsidLinkExtended - Объект привязки SSID’а с расширенными параметрами

Общая информация

  1. Объект актуален, начиная с версии 1.19.

Параметры объекта

Параметр Значение Формат значения

extendedParams

Параметры SSID’а, расширенные для данной привязки

NbiParameter

id

Уникальный идентификатор привязки

int

ssidName

Имя SSID’а

String

ssidDomain

Домен SSID’а

String

nasKey

Ключ привязки SSID

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EntityProfile - Профиль юридического лица

Общая информация

  1. Объект актуален, начиная с версии 1.19.

  2. Объект, позволяющий показать отношение сущности (роли или домена) к определённому юридическому лицу

Параметры объекта

Параметр Значение Формат значения

id

ID профиля

int

name

Имя профиля

String

description

Описание профиля

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EntityProfileClass - Схема профиля юридического лица

Общая информация

  1. Объект актуален, начиная с версии 1.19.

  2. Объект определяет параметры для привязки профиля к сущности (роли или домену)

Параметры объекта

Параметр Значение Формат значения

id

Идентификатор схемы профиля

int

name

Имя схемы

String

profileId

Идентификатор профиля, к которому привязана схема

int

valueRegex

Способ валидации значений

String

relationType

Отношение параметра к определенному виду сущностей (роли, домены и т.д.)

String

description

Описание параметра

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

EntityProfileValue - Параметр схемы профиля юр. лица

Общая информация

  1. Объект актуален, начиная с версии 1.19.

  2. Объект определяет привязку профиля к сущности (роли или домену)

Параметры объекта

Параметр Значение Формат значения

id

Идентификатор параметра

int

classId

Идентификатор схемы профиля

int

keyName

Сущность, к которой относится этот параметр

String

value

Значение параметра

String

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ProfileValueItem - значение класса профиля и идентификатор класса профиля

Общая информация

  1. Содержит в себе значение класса профиля и идентификатор класса профиля.

Параметры объекта

Параметр Значение Формат значения

classId

Идентификатор класса профиля.

Можно найти в схеме профиля, например с помощью команды GetEntityProfileClassesByProfileId или GetEntityProfileClassesByProfileIdAndRelationType

Целое неотрицательное число

value

Значение класса профиля

Строковое значение. Должно соответствовать регулярному выражению, если оно есть в схеме профиля.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

ProfileValueArray - массив элементов ProfileValueItem ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Общая информация

  1. Массив элементов ProfileValueItem

Параметры объекта

Параметр Значение Формат значения

items

Массив значений параметров профилей ProfileValueItem

ProfileValueItem

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Коды ошибок – ErrorCodes

Разработчики не всегда своевременно добавляют описание в документацию и потому, в случае отсутствия кода в документации, можно найти его, выполнив команду GetErrorCodes.

Коды ошибок для версии 1.0

Код Описание ошибки

0

Успешно

1

Неизвестная ошибка

2

Ошибка взаимодействия с базой данных

999

Системная ошибка. Какая-то неучтенная ошибка, в коде системы. Требует вмешательства разработчиков

3

Ошибка EMS-NBI: код ''{0}'' сообщение ''{1}''

4

Ошибки инициализации сервиса

5

NAS уже существует

6

Такого NAS ''{0}'' не существует

7

Не найден обязательный параметр запроса 'domain'

8

Домен не соответствует правилам

9

Некорректный домен роли (отсутствует)

10

У роли нет прав на домен ''{0}''

11

Такого пользователя RADIUS ''{0}[{1}]" не существует

12

Некорректный логин клиента (отсутствует или пустой)

13

Клиент ''{0}'' заблокирован

14

Истек срок для клиента ''{0}''

15

Нет такого клиета ''{0}''

16

Нет такого SSID

17

Нельзя удалить SSID ''{0}[{1}]" , т.к он связан с NAS

18

Ошибка обращения в EMS NBI: код ''{0}'', статус ''{1}''

19

Пользователь ''{0}@{1}'' уже существует

20

Некорректное поле username (отсутствует)

21

Нет ожидаемых атрибутов пользователя

22

Отсутствует имя атрибута ''{0}'' пользователя RADIUS

23

Такого атрибута пользователя не существует

24

Некорректный оператор ''{0}'' атрибута пользователя

25

Такого оператора ''{0}'' атрибута пользователя не существует

26

Атрибут пользователя ''{0}'' не содержит оператора ''{1}''

27

Некорректное значение для атрибута ''{0}'', допустимо: {1}

28

Отсутствует обязательный атрибут пользователя ''{0}''

29

Поле search пусто

30

Некорректное поле ip/nasIp

31

Некорректное поле "secret"

32

Некорректное поле "descr"

33

Некорректное поле "name"

34

Данный SSID ''{0}.{1}'' уже существует

35

Нет атрибутов SSID

36

Имя атрибута SSID ''{0}'' некорректно или отсутствует

37

Некорректное значение ''{0}'' для атрибута ''{1}''

38

Отсутсвует обязательный атрибут SSID: ''{0}''

39

Такого атрибута ''{0}'' SSID не существует

40

Такого CPInstance не существует

41

PolicyMap ''{0}'' не существует

42

SSID {0}[{1}] не содержит NAS с данным ключом ''{2}''

43

SSID уже связана с данным NAS

44

Нет доступных NAS для SSID

45

Неизвестный ответ от EMS сервера

46

Нет атрибута Security_Type для SSID {0}[{1}]

47

Выставлен атрибут использовать глобальный радиус сервер для SSID {0}[{1}]

48

Нет поля Radius domain в настройках

49

Security type не Wpa Enterprise для SSID ''{0}[{1}]

50

Нет атрибута "Use_Global_Radius" для SSID ''{0}[{1}]

51

Такая связка уже существует

52

Некорректное имя правила инициализации (технического профиля)

53

Ключи отсутствуют или содержат некорректное значение

54

Нет прав с данным именем ''{0}[{1}]

55

Нет такого web портала ''{0}'' среди CPI

56

Некорректное поле username_count

57

Некорректное поле username length

58

Некорректное поле password length

59

Группа RADIUS уже существует

60

Такой группы ''{0}[{1}]" RADIUS не существует

61

Некорректная группа

62

Несуществующий домен ''{0}''

63

Некорректное поле mac/nasMac

64

И mac и ip отсутствуют

65

Нет устройства с MAC-адресом ''{0}''

66

Устройств с mac ''{0}'' больше, чем один

67

Домен ''{0}'' уже существует

68

Некорректное поле groupname (отсутствует)

69

Некорректное поле user

70

Некорректное значение приоритета

71

Пользователь уже состоит в этой группе

72

Этот приоритет уже дан другой группе

73

Нет такого пользователя в группе

74

Некорректное значение атрибута ''{0}''

75

Некорректное дата создания TLS сертификата ''{0}''

76

Ошибка создания TLS сертификата

77

Нет устройства с ip адресом ''{0}''

78

Устройств с ip ''{0}'' больше, чем один

79

Не удалось удалить сертификаты

80

Ошибка обновления сертификата

81

Некорректное поле password isDigit

Коды ошибок для версии 1.2

Код Описание ошибки

100

Не существует тарифа с таким кодом ''{0}''

101

Недопустимый поле тарифа со значением ''{0}''

102

Не существует Web портала с именем ''{0}''

103

Некорректное поле "webPortal"

104

Некорректное значение ''{0}'' для поля "userIp"

105

Некорректное поле "timeStart"

106

Некорректное поле "timeEnd"

107

Время старта должно быть раньше времени окончания

108

Заголовок тарифа ''{0}'' дублирует в нескольких тарифах

109

Портал ''{0}'' уже содержит тариф ''{1}''

110

Некорректные тарифы

111

Нет тарифа с кодом ''{0}'' на портале ''{1}''

112

Значение "Count" должно быть целым и положительным

113

Значение "Page" должно быть целым и положительным

114

Некорректное значение поля "orderBy"

115

Некорректное поле "index"

116

Некорректное поле "resourceId"

117

Некорректное поле "resource data"

118

Текущий пользователь не обладает правами на портале ''{0}''

119

Некорректный тип контента ''{0}'' для ресурса

120

Пользователь не имеет тариф

121

У тарифа с кодом ''{0}'' нет сценария с индексом {1}

122

Невозможно удалить обязательный атрибут ''{0}''

123

Нет таких атрибутов ''{0}'' в аккаунте пользователя

124

Нет параметров в update-запросе

125

Некорректный параметр ''{0}''

126

Некорректное значение для параметра ''{0}''

127

Нет обязательного параметра ''{0}''

128

Web портал ''{0}'' уже существует

129

Невозможно создать директорию на портале

130

Невозможно удалить директорию на портале

131

Значение "startIndex" должно быть целым положительным, либо 0

132

Некорректное cron-выражение для атрибута ''{0}''

Коды ошибок для версии 1.3

Код Описание ошибки

200

Эта функция не реализована

201

Auth-service атрибуты пользователя не были загружены

202

Неизвестная роль auth-атрибутов

203

Пользователь ''{0}'' уже существует

204

Некорректный auth-пользователь ''{0}''

205

Некорректная auth-роль ''{0}''

206

Auth-пользователь ''{0}'' не существует

207

Неизвестный атрибут auth-пользователя ''{0}''

208

Роль ''{0}'' уже существует

209

Auth-роль ''{0}'' не существует

210

Домен auth-пользователя ''{0}'' не определен

211

Auth-NAS ''{0}'' уже существует

212

Auth-NAS ''{0}'' не существует

213

(127.0.0.1) не разрешен(?)

214

Директория ''{0}'' не существует

215

Директория пуста

216

Домен ''{0}'' используется в ''{1}'', поэтому не может быть удален

217

Домен ''{0}.{1}'' не существует

218

Некорректное значение ''{0}'' для локали

219

Невозможно удалить пользователя ''{0}'', от имени которого делается запрос

220

Невозможно удалить роль, потому что она привязана к пользователю

221

Невозможно добавить роль с дублирующим приоритетом

222

Невозможно создать пользователя без домена

223

Временной интервал не указан либо имеет недопустимое значение

225

SSID не указан либо пуст

226

Тарифный план не является портальным

227

Некорректное название SSID

228

Некорректное поле "nasIp"

229

Некорректное поле"nasMac"

230

Некорректное поле "parentDomain"

231

Некорректное поле "newname"

232

Значение параметра ''{0}'' эквивалентно значению параметра ''{1}''

233

Не указано время начала

234

Пользователь не имеет прав на редактирование портала ''{0}''

235

Некорректный параметр портала в запросе

236

Некорретное поле "profile"

237

Недопустимые тарифы для портала

238

Недопустимый код тарифа для удаления

239

Некорректное поле "webPortal"

240

Некорректное значение ''{0}'' для обязательного атрибута ''{1}''

241

Нет nasMac-а и nasIp

242

SSID ''{0}'' уже содержит NAS домен ''{1}''

243

SSID ''{0}'' уже содержит NAS ip ''{1}''

244

SSID ''{0}'' уже содержит NAS mac ''{1}''

245

Код ''{0}'' тарифного плана уже существует

246

Тариф с именем ''{0}'' и доменом ''{1}'' уже существует

247

Ошибка при добавлении тарифного плана

248

Нельзя удалить тарифный план с кодом ''{0}'', к нему привязаны {1} пользователей

249

Множественное совпадение для атрибута с именем ''{0}''

250

Нельзя редактировать атрибут тарифного плана ''{0}''

251

Нет такого оператора ''{0}'' для тарифного атрибута ''{1}''

252

Некорректное значение для атрибута ''{0}'', допустимо: {1}

253

Нет атрибута, ограничивающего сценарий {0}

254

Нельзя начинать сессию перед редиректом, если нет URL-адреса для редиректа в сценарии {0}

255

Некорректное имя тарифа: ''{0}''

256

Некоррекстное описание тарифного плана

257

Нет обязательного атрибута ''{0}''

258

Некорректное имя атрибута ''{0}''

259

Некорректное имя устройства ''{0}''

260

Некорректное имя параметра привязки инициализации ''{0}''

261

Некорректное значение параметра привязки инициализации ''{0}''

262

Превышено ограничение количества пользователей для домена ''{1}'' ({0})

263

Ограничение количества пользователей больше, чем у родительского домена ({0})

264

Ограничение количества пользователей меньше, чем у дочернего домена ''{0}'' ({1})

265

Ограничение количества пользователей меньше, чем текущее количество ({0})

266

Некорректная длина полного домена

267

Не найдены параметры NAS

268

Пустой список сервисов

269

Неверный список сервисов. Маркер 'again' не может быть на первом месте

270

Не удается найти сервис с именем ''{0}''

271

Пустое имя скрипта

272

Скрипт с именем ''{0}'' уже существует

273

Ошибка чтения скрипта с именем ''{0}''

274

Не удается найти скрипт с именем ''{0}''

275

Нельзя изменить тип тарифного плана с кодом ''{0}'' (атрибут "Eltex-Tariff-Portal-Only"), т.к. к тарифу привязан(ы) {1} пользователь(и)

276

Нельзя удалить скрипт, так как он используется в PCRF тарифе

277

Нельзя удалить сервис, так как он используется в PCRF тарифе/скрипте

278

Редактирование собственного домена ({0}) запрещено

279

Устройство не найдено по IP-адресу

280

Работа с MongoDB отключена в конфигурации. Пожалуйста, проверьте ''{0}''

281

Параметр запроса ''{0}'' не указан или пуст

282

Shaper профиль не существует для ''{0}''

283

Некорректное поле тип домена

284

Подсеть ''{0}@{1}'' для {2} уже существует

285

Подсеть ''{0}@{1}'' для {2} не найдена

286

Значение параметра ''{0}'' не входит в диапазон разрешенных [{1}..{2}]

287

Не найден параметр ''{0}'' SSID ''{1}@{2}''

289

Некорректное значение параметра ''{0}'' SSID ''{1}@{2}'': ''{3}''

290

Параметр ''{0}'' не назначен или имеет пустое значение

291

Некорректное значение параметра SSID ''{0}''

292

SSID shaper ''{0}@{1}'' не найден для ''{2}''

293

SSID shaper ''{0}@{1}'' уже существует для ''{2}''

294

Не указаны для выполнения запроса

295

Ошибка выполнения команды PCRF-API ''{0}'': {1}

296

Shaper для домена ''{0}'' уже существует

297

У пользователя нет прав на редактирование параметра ''{0}''

298

Нельзя удалять шаблонный портал

299

Виртуальный портал привязан к SSID: {0}

300

Нет прав для выполнения данной операции

301

Неподдерживаемое поле: {0}

302

Значение ''{0}'' не может быть меньше чем ''{1}''

303

Значение ''{0}'' не может быть назначено, если ''{1}'' не назначено

304

Несовместимый домен

305

Узел по домену ''{0}'' не найден

306

Дерево объектов EMS уже содержит узел с доменом ''{0}''

307

Нельзя отвязать все тарифные планы с виртуального портала

308

Некорректное поле "newName"

309

Правило инициализации {0}[{1}] уже существует для типа устройств {2}

310

Правило инициализации {0}[{1}] не существует для типа устройств {2}

311

Некорректный тип устройств {0}

312

Некорректное значение ''{0}'' для параметра ''{1}''

313

Неизвестный параметр ''{0}''

314

Не найден шаблон конфигурации ''{0}''

Коды ошибок для версии 1.6

Код Описание ошибки

400

Mac-адрес ''{0}'' уже привязан к УЗ ''{1}''

401

Mac-адрес ''{0}'' не зарегистрирован в домене ''{1}''

402

Некорректное поле ''{0}''

403

Пара новое значение SSID (''{0}'') и домен (''{1}'') уже существует

404

PCRF сценарий ''{0}'' не может иметь имя существующего PCRF сервиса

405

PCRF сервис ''{0}'' не может иметь имя существующего PCRF сценария

406

PCRF сервис ''{0}'' уже существует в домене ''{1}''

407

Все домены из списка должны быть вложенные

408

Все домены из списка должны быть невложенные

409

Не найден список URL ''{0}''

412

Сортировка по ''{0}'' не поддерживается

413

Неизвестный ключ поиска объекта (не MAC, IP, или домен): ''{0}''

414

Родительский узел для узла ''{0}'' не найден

415

Не найден домен узла ''{0}''

416

Не найден объект в дереве ''{0}'', ''{1}''

Коды ошибок для версии 1.7

Код Описание ошибки

417

Некорректный тип списка. Разрешены: ''WHITE'', ''BLACK''

418

Список URL не может быть пустым

419

Неизвестная акция ''{0}''

420

Некорректный формат URL ''{0}''

421

Объект по имени ''{0}'' уже существует

422

Символы: % \ '' " ` запрещено использовать в имени узла

423

Домену ''{2}'' нельзя указать тип ''{3}'', т.к. его родительский домен ''{0}'' имеет тип ''{1}''

424

Корень должен иметь тип домена 'both'

425

Домену ''{0}'' нельзя указать тип ''{1}'', т.к. его дочерний домен ''{2}'' имеет тип ''{3}''

Коды ошибок для версии 1.8

Код Описание ошибки

426

По ключу(ам) ''{0}'' привязок не существует

427

Список пользователей ''{0}''[''{1}''] не найден

428

Некорректный тип списка пользователей. Допустимые значения: ''WHITE'', ''BLACK''

429

Некорректный тип списка пользователей по способу блокировки. Допустимые значения: ''mac'', ''login''

430

Список пользователей не может быть пустым

431

Список пользователей ''{0}''[''{1}''] уже существует

432

Некорректное значение выражения ''{0}'

433

Некорректное значение IP, маски подсети ''{0}''

434

Пароль не указан, либо указано пустое значение

435

Нельзя удалить тарифный план с кодом ''{0}'', так как он привязан к порталам: {1}

436

Не указан обязательный параметр ''{0}''

437

Некорректный тип сортировки ''{0}''

438

Некорректный тип объекта для показа истории перемещения ''{0}''

439

Некорректный формат длительности промежутков между сессиями ''{0}''

440

Ошибка выполнения SORM2-API команды ''{0}'': {1}

441

''{0}'' не сконфигурирован. Проверьте ''{1}'' в {2}.

442

Таймзона с ID ''{0}'' не существует

443

Невозможно удалить дефолтную роль

444

У системного пользователя ''{0}'' отсутствует обязательный атрибут ''{1}''

445

Атрибут ''{0}'' не является редактируемым

446

Список MAC адресов ''{0}''[''{1}''] привязан к порталу

449

Функционал устарел и больше не поддерживается

450

Профиль СОРМ-2 клиента не найден для домена ''{0}''.

451

Ошибка получения списка URL ''{0}'': {1}.

452

URL фильтр ''{0}'' слишком велик, чтобы редактироваться через NBI.

453

Ошибка записи списка URL ''{0}'': {1}.

Коды ошибок для версии 1.9

Код Описание ошибки

447

Некорректное имя приложения ''{0}''

448

Несуществующий список приложений ''{0}''

454

Недопустимое значение флага деактивации ''{0}''

455

Некорректный список категорий пользователя ''{0}''

456

OTT привязка для MAC ''{0}'' уже существует

457

Не найден OTT ESR в домене ''{0}''

458

Не найдена OTT емкость для ''{0}''

459

Не найден OTT ESR по указанному management IP ''{0}''

460

ESR IP ''{0}'' перегружен OTT привязками (максимум {1} для ESR{2})

461

OTT профиль ''{0}'' уже существует

462

Не найден OTT profile ''{0}''

463

Станция OTT ''{0}'' уже существует

464

Не найдена Станция OTT ''{0}''

465

Станция OTT ''{0}'' уже имеет привязки к устройствам

466

Профиль OTT ''{0}'' уже привязан к Станциям ОТТ

467

Редактировать IP адрес разрешается только для одной Станции OTT

468

MAC ''{0}'' уже добавлен в черный список

Коды ошибок для версии 1.10

Код Описание ошибки

469

Список URL используется в сервисах ''{0}''

470

Список приложений используется в сервисах ''{0}''

471

Некорректное значение limit ''{0}''

472

Некорректное значение offset ''{0}''

473

Некорректное значение availability ''{0}''

474

Некорректное значение status ''{0}''

Коды ошибок для версии 1.11

Код Описание ошибки

475

Список номеров ''{0}''[''{1}''] привязан к порталу

476

Только служебный пользователь может добавлять realUserName в заголовок запроса

477

Выполнение запроса заняло слишком много времени. Требуется выбрать домен нижнего уровня, с меньшим количеством точек доступа

478

В списке параметров инициализации отсутствует обязательный атрибут ''{0}''

Коды ошибок для версии 1.12

Код Описание ошибки

Коды ошибок для версии 1.13

Код Описание ошибки

479

Пользователь ''{0}@{1}'' является PCRF-сервисом, и не поддерживается функциями работы с радиус пользователями более, т.к. сервисы были перемещены в отдельную таблицу MySql radius.service

480

Запрещено привязывать вложенный домен

481

Запрещено создавать привязку без имени профиля

482

Невозможно удалить связку без указания профиля и домена

483

Запись ''{0}'' уже существует

484

Запись ''{0}'' не существует

485

Запись ''{0}'' используется

Коды ошибок для версии 1.14

Код Описание ошибки

Коды ошибок для версии 1.15

Код Описание ошибки

486

Не удается сгенерировать список символов по переданному в поле userNameType регулярному выражению

487

Не удается сгенерировать список символов по переданному в поле passwordType регулярному выражению

Коды ошибок для версии 1.16

Код Описание ошибки

Коды ошибок для версии 1.17

Код Описание ошибки

488

У роли нет прав на метод ''{0}''

Коды ошибок для версии 1.18

Код Описание ошибки

489

Некорректное поле 'vrf'

490

VRF ''{0}'' уже существует

491

VRF ''{0}'' не найден

492

Недостаточно параметров для создания нового VRF. Требуется: {0}

493

Удаление VRF ''{0}'' не разрешено. VRF используется в {1} SSID’ах

494

Ошибка авторизации

495

Недостаточно привилегий для выполнения операции

496

Ошибка при создании пользователя

497

Ошибка при работе сервера

498

Данные не найдены

499

Не указан email или телефон

500

Неверно задан email ''{0}''

501

Неверно задан номер телефона ''{0}''

502

Пустое имя параметра

503

Пустое значение параметра

504

SSO пользователь с ''{0}'' (''{1}'') уже существует

505

Отсутствует обязательный объект параметров портала

506

Ошибка DOORS-NBI: ''{0}''

507

Ошибка ELVIS-NBI: ''{0}''

508

Ошибка NGW-NBI

509

Некорректное значение срока действия сертификата

510

Отсутствует обязательный параметр для сертификата ({0})

511

Профиль пользователя SSO содержит множественную привязку. Список привязок: ''{0}''

512

Пользователь имеет привязку к другому локальному кабинету. Привязка: ''{0}''

513

Невозможно найти контейнер привязок в профиле пользователя SSO: ''{0}''

514

Пользователь с именем ''{0}'' и e-mail ''{1}'' уже создан и имеет привязку к локальному кабинету ''{0}''

531

Суммарная длина логина и домена не должна превышать 63 символа для создания TLS сертификата

Коды ошибок для версии 1.19

Код Описание ошибки

515

Ошибка при выполнении команды Linux ''{0}''

516

Команда Linux ''{0}'' некорректно завершила работу, вернув код {1} и сообщение: {2}

517

Сумма значений {0} ({1} kbps) для SSID больше значения {0} домена ({2} kbps). Значение {0} домена должно быть больше или равно суммы {0} значений SSID ({3}+{4}*64kbps).

518

У SSID {0} задано значение {1}, превышающее значение домена.

519

Привязка SSID не найдена по linkId={0}

520

SSID не найден по linkId={0}

521

Некорректное значение поля 'nasKey'

522

Профиль юр.лица с id={0} не найден

523

Некорректное значение поля 'relationType'

524

Схема профиля юр.лица с id={0} не найдена

525

Параметр схемы профиля юр.лица с id={0} не найден

526

Значение поля 'value' не соответствует регулярному выражению, указанному в схеме профиля

527

Выбранный 'profile_id' уже установлен на родительском домене

528

Профиль юр.лица 'name' уже существует с 'id'

529

Схема профиля юр.лица 'name' уже существует в 'profile_id' с 'id'

530

Регулярное выражение некорректно

Коды ошибок для версии 1.21

Код Описание ошибки

535

Домен с параметром hotel_id=''{0}'' уже существует

536

Атрибут holel_id должен быть целым положительным числом

537

База данных ''{0}'' отключена в конфигурации. Пожалуйста, проверьте ''{1}''

Коды ошибок для версии 1.22

Код Описание ошибки

538

Запрещенный параметр ''{0}''

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Метрики NBI

  1. Метрики NBI

  2. Описание метрики типа Timer

  3. Описание метрики типа Meter

  4. Начало работы с метриками в NBI

Метрики NBI

Метрики актуальны, начиная с версии 1.10.

В этой версии метрики доступны:

  • по каждому методу wsdl: иcпользуется тип timer;

  • по клиентам, обращающимся в NBI (host): используется тип meter;

  • по кодам возвращаемых ошибок: используется тип meter;

  • по клиентам и вызываемым ими методам: используется тип meter;

Описание метрики типа Timer

Метрика Описание метрики

count

количество событий

max

максимальная длительность вызова, наблюдаемая с момента запуска показателей

mean

средняя длительность вызова, наблюдаемая с момента запуска показателей

min

минимальная длительность вызова, наблюдаемая с момента запуска показателей

stddev

стандартное отклонение

p50

значение 50-го процентиля

p75

значение 75-го процентиля

p95

значение 95-го процентиля

p98

значение 98-го процентиля

p99

значение 99-го процентиля

p999

значение 999-го процентиля

mean_rate

средняя скорость запросов

m1_rate

скорость запросов за одну минуту

m5_rate

скорость запросов за пять минут

m15_rate

скорость запросов за пятнадцать минут

rate_unit

запросы в секунду

duration_unit

миллисекунды

Описание метрики типа Meter

Метрика Описание метрики

count

количество событий

mean_rate

средняя скорость запросов

m1_rate

скорость запросов за одну минуту

m5_rate

скорость запросов за пять минут

m15_rate

скорость запросов за пятнадцать минут

rate_unit

запросы в секунду

duration_unit

миллисекунды

Meter измеряет скорость событий в единицу времени и предоставляет экспоненциально-взвешенное скользящее среднее значение RPS (Requests per second) для минутного, пятиминутного и пятнадцатиминутного окна. Это означает, что в результатах одного измерения (например, пятиминутного окна) мы видим данные за последние 5 минут с уклоном в сторону более новых данных.

Начало работы с метриками в NBI

Для сохранения результатов измерений в NBI для всех типов метрик используется один общий репортер. Для каждой цели регистрации метрик создается .csv файл и каждые 15 минут ее состояние записывается в качестве новой строки или нескольких строк, в зависимости от цели регистрации метрик. После старта приложения и запроса главной страницы, репортер начинает выводить метрики в .csv файлы. Результаты сохраняются в .csv файлах в директорию /var/log/eltex-axis/radius-nbi/metricsNBI. Период сохранения метрик в файлы может быть изменен в главном конфигурационном файле.

/etc/eltex-radius-nbi/radius_nbi_config.txt

# metrics
metric.interval.s=30
Общая нагрузка на NBI (total.csv).

Используя этот лог, можно

  • построить кривую изменения нагрузки по времени;

  • узнать пиковую нагрузку;

  • найти наименее загруженный период перед планированием работ на ядре.

t;count;mean_rate;m1_rate;m5_rate;m15_rate;rate_unit
2018-11-02 14:31:50;3;0.089;0.396;0.552;0.584;second
2018-11-02 14:32:20;22;0.345;0.538;0.562;0.585;second
Нагрузка на NBI по клиентам (clients.csv).

Используя этот лог, можно

  • узнать, какой из клиентов NBI (серверов в сети ядра) создает наибольшую нагрузку на NBI;

  • обнаружить случаи несанкционированного доступа в NBI с других машин (например, случайно с тестовых серверов).

t;client_ip;count;mean_rate;m1_rate;m5_rate;m15_rate;rate_unit
2018-11-02 14:42:20;127.0.0.1;3;0.005;0.000;0.068;0.290;second
2018-11-02 14:42:20;192.168.26.211;19;0.030;0.000;0.033;0.111;second
2018-11-02 14:42:50;127.0.0.1;3;0.004;0.000;0.061;0.280;second
2018-11-02 14:42:50;192.168.26.211;19;0.029;0.000;0.030;0.107;second
Время выполнения для каждого метода wsdl (executeTimer.csv).

Используя этот лог, можно

  • найти самые медленные методы для их последующей оптимизации в ПО;

  • найти методы, которые вызываются чаще всего;

  • проверить был ли хоть один вызов метода за все время работы.

t;wsdl_action;count;max;mean;min;stddev;p50;p75;p95;p98;p99;p999;mean_rate;m1_rate;m5_rate;m15_rate;rate_unit;duration_unit
2018-11-02 14:47:20;GetClientInfo;1;3.992;3.992;3.992;0.000;3.992;3.992;3.992;3.992;3.992;3.992;0.001;0.000;0.008;0.069;second;milliseconds
2018-11-02 14:47:20;GetFullDomainsChanged;1;81.012;81.012;81.012;0.000;81.012;81.012;81.012;81.012;81.012;81.012;0.001;0.000;0.008;0.069;second;milliseconds
2018-11-02 14:47:20;GetVersion;19;0.180;0.041;0.018;0.034;0.031;0.039;0.180;0.180;0.180;0.180;0.020;0.000;0.012;0.079;second;milliseconds
2018-11-02 14:47:20;RetrieveDomainsTimezone;1;0.175;0.175;0.175;0.000;0.175;0.175;0.175;0.175;0.175;0.175;0.001;0.000;0.008;0.069;second;milliseconds

Имя вызванного метода указано в столбце wsdl_action, количество вызовов в столбце count, значения остальных столбцов можно посмотреть в таблице timer. В лог добавляются только те методы, которые реально вызывались. Если команда не используется ни одним из компонентов ядра, то данных (даже нулевых) в этом логе не будет.

Коды возврата для каждого метода wsdl (executeCode.csv).

Используя этот лог, можно

  • узнать какие методы в принципе возвращают ошибки;

  • отношение числа ошибок к числу успешных выполнений.

t;wsdl_action;code;count;mean_rate;m1_rate;m5_rate;m15_rate;rate_unit
2018-11-02 14:54:20;GetClientInfo;SUCCESS;1;0.001;0.000;0.002;0.043;second
2018-11-02 14:54:20;GetFullDomainsChanged;SUCCESS;1;0.001;0.000;0.002;0.043;second
2018-11-02 14:54:20;GetVersion;SUCCESS;19;0.014;0.000;0.003;0.050;second
2018-11-02 14:54:20;RetrieveDomainsTimezone;SUCCESS;1;0.001;0.000;0.002;0.043;second

Имя вызванного метода указано в столбце wsdl_action, результаты вызова в столбце code, количество вызовов с одинаковым результатом в столбце count, значения остальных столбцов можно посмотреть в таблице meter.

Статистика по клиентам и вызываемым ими методам (clientsActions.csv).

Используя этот лог, можно

  • узнать, какой из клиентов NBI (серверов в сети ядра) какие методы вызывает;

  • узнать по каждому методу возвращаемые ошибки;

  • отношение числа ошибок к числу успешных выполнений.

t;client_ip;wsdl_action;code;count;mean_rate;m1_rate;m5_rate;m15_rate;rate_unit
2020-06-22 14:17:22;127.0.0.1;CreateDomainCommander;ILLEGAL_DOMAIN;1;0.001;0.000;0.011;0.076;second
2020-06-22 14:17:22;127.0.0.1;GetAdminAuthUserEmails;SUCCESS;1;0.001;0.000;0.011;0.076;second
2020-06-22 14:17:22;127.0.0.1;GetClientInfoCommander;SUCCESS;6;0.007;0.000;0.012;0.078;second
2020-06-22 14:17:22;127.0.0.1;GetFullDomainsChangedCmd;SUCCESS;1;0.001;0.000;0.011;0.076;second
2020-06-22 14:17:22;127.0.0.1;RetrieveDomainsTimezoneCommander;SUCCESS;1;0.001;0.000;0.011;0.076;second

IP клиента указано в столбце client_ip, имя вызванного метода в столбце wsdl_action, результаты вызова в столбце code, количество вызовов с одинаковым результатом в столбце count, значения остальных столбцов можно посмотреть в таблице meter.

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12

Типы и подтипы объектов (устройств и узлов дерева) в SoftWLC

Общая информация

  1. Тип обычно обозначает семейство устройств (например, WEP, ESR, UEP), а подтип — конкретную модель.

  2. В данном виде типы и подтипы устройств хранятся в таблице eltex_ems.ELTEX_MAIN_TREE.

  3. У устройств Eltex подтип соответствует маркировке модели. Например, у WEP-3ax типом является WEP, а подтипом -3ax (с дефисом в начале), а у ESR200 ESR - тип, 200 - подтип. У некоторых объектов подтип может отсутствовать (например, у MA4000).

  4. Узлы дерева (тип NODE) не имеют подтипа.

Таблица типов и подтипов

Тип Подтип

NODE

MA4000

MES

access

MES

agregation

MES5448

MES3000L

ESR

-10

ESR

-20

ESR

-12V

ESR

100

ESR

200

ESR

1000

ESR

1200

ESR

-1500

ESR

-1511

ESR

-1700

WB

-15-W

WEP

-12ac

WEP

-12ac-RevB

WEP

-12ac-RevC

WEP

-2ac

WEP

-2ac-Smart

WEP

-2ac-Z

WEP

-3ax

WEP

-1L

WEP

-2L

WEP

-20L

WEP

-20L-Z

WOP

-12ac

WOP

-12ac-LR

WOP

-12ac-LR-RevB

WOP

-12ac-LR-RevD

WOP

-12ac-LR-RevD-SFP

WOP

-12ac-LR-RevD-GPON

WOP

-12ac-ER

WOP

-12ac-ER-SFP

WOP

-12ac-ER-GPON

WOP

-12ac-RevB

WOP

-12ac-RevC

WOP

-2ac

WOP

-2ac-RevB

WOP

-2ac-RevB-SFP

WOP

-2ac-RevB-GPON

WOP

-2ac-RevC

WOP

-2ac-SFP

WOP

-2ac-GPON

WOP

-2ac-LR2

WOP

-2ac-LR5

WOP

-2ac-LR5-RevB

WOP

-2L

WOP

-3ax

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12