Описание команд NBI XML/SOAP
система SoftWLC

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

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

Команды и примеры

GetVersion - получение версии сервиса NBI SOAP/XML

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами
response Объект NbiMessage

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

Код Описание
0 Успех
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv= "http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body/>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv= "http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:GetVersionResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
<ns:response>
<ns:message>1.1-57 / September 9 2015</ns:message>
</ns:response>
</ns:return>
</ns:GetVersionResponse>
</soapenv:Body>
</soapenv:Envelope>

CreateDomain – Создание домена в системе SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
parentDomain Родительский домен (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
name Имя нового узла домена. ^(?!-|_|.*(__|--).*)[a-zA-Z0-9_\\-]{1,63})$ Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 63-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.
decsr Описание нового узла домена. .{0,255}$ До 255-ти любых символов.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
7 Нет родительского домена
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain></xsd:parentDomain>
<xsd:name></xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>7</ns:code>
<ns:detail>Incorrect field 'parentDomain'</ns:detail>
</ns:return>
</ns:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
8 Родителький домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>-123</xsd:parentDomain>
<xsd:name></xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>8</ns:code>
<ns:detail>Domain '-123' does not conform to the rules FQDN</ns:detail>
</ns:return>
</ns:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Родительский домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>rot</xsd:parentDomain>
<xsd:name></xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>62</ns:code>
<ns:detail>Such 'rot' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
</ns:return>
</ns:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Нет обязательного поля name или оно некорректно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>enterprise.root</xsd:parentDomain>
<xsd:name></xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse 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:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
67 Создаваемый домен уже существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>enterprise.root</xsd:parentDomain>
<xsd:name>test</xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>67</ns:code>
<ns:detail>Domain 'test.enterprise.root' already exists!</ns:detail>
</ns:return>
</ns:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервера EMS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>enterprise.root</xsd:parentDomain>
<xsd:name>sber</xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse 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:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на родительский домен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>root</xsd:parentDomain>
<xsd:name></xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse 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:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>enterprise.root</xsd:parentDomain>
<xsd:name>sber</xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse 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:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateDomain>
<xsd:parentDomain>enterprise.root</xsd:parentDomain>
<xsd:name>alpha</xsd:name>
<xsd:descr></xsd:descr>
</xsd:CreateDomain>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateDomainResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
</ns:return>
</ns:CreateDomainResponse>
</soapenv:Body>
</soapenv:Envelope>

DeleteDomain – Удаление домена из системы SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Удаляемый домен (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
7 Отсутствует домен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain></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>7</ns:code>
<ns:detail>Incorrect field 'domain'</ns:detail>
</ns:return>
</ns:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
8 Домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain>re etc</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>8</ns:code>
<ns:detail>Domain 're etc' does not conform to the rules FQDN</ns:detail>
</ns:return>
</ns:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain>retc</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>62</ns:code>
<ns:detail>Such 'retc' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
</ns:return>
</ns:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервера EMS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain>alpha.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>3</ns:code>
<ns:detail>Error from EMS server: code 103, message 'null'</ns:detail>
</ns:return>
</ns:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain>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>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:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteDomain>
<xsd:domain>alpha.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>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:DeleteDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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>

RetrieveDomainTree – Получить список доменов, зарегистрированных в системе SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Фильтр по домену. Если установлен, то вывод только списка поддоменов для данного. Может быть пустым. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Объект NbiNameArray

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

Код Описание ошибки
8 Домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

CreateNas – Создание новой точки доступа

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.
domain Домен области видимости точки (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

EditNas – Редактирование параметров точки доступа в базе RADIUS

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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-х символов. Допускаются цифры, знаки тире и нижнее подчеркивание.
domain Новый домен области видимости точки (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RemoveNas – Удаление точки доступа из базы RADIUS

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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 Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
30 Нет IP-адреса или он не верен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveNasList – Запрос списка точек доступа из базы RADIUS

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

Параметр Значение Формат значения Расшифровка формата Ссылка
search Доп. поле, если установлено, то выдается список NAS, один из параметров которых содержит значение данного поля. В противном случае выводится список всех доступных NAS. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). .* Любые символы

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNas

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

Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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>

RetrieveProfileList – Запрос списка шаблонов конфигурации из SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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://org.eltex.radius.nbi/xsd">
<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>

SetProfileByIp – Загрузка шаблона конфигурации на точку доступа по IP адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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
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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetProfileByMac – Загрузка шаблона конфигурации на точку доступа по MAC адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
mac MAC-адрес точки доступа ^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ 6 двухзначных шестнадцатеричных чисел, разделенных ':'. AP
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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetProfileByDomain – Загрузка шаблона конфигурации на группу точек доступа

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен NAS, определяющий группу точек (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
profile Имя шаблона конфигурации (?!^.*(__).*$)(^[A-Za-z0-9-_\.]{1,40}$) Текст английскими буквами разного регистра без пробелов и спецсимволов длиной до 40-ка символов. Допускаются цифры, знаки тире и нижнее подчеркивание (подряд только одно). Шаблон

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveRuleList – Запрос списка правил инициализации из SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
name Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). .* Любые символы
domain Поле для поиска по домену правил. Может быть пустым. (?=^.{0,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
deviceType Поле для поиска по по типу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiProfile

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

Код Описание ошибки
8 Домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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:RetrieveRuleListResponsexmlns: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>

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

Параметр Значение Формат значения Расшифровка формата Ссылка
keys Объект NbiKeyArray AP
ruleName Имя правила инициализации. .* Любые символы
ruleDomain Домен правила. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
nodeDomain Домен узла, в который добавляется устройство. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiProfileLink

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

Код Описание ошибки
8 Домен правила или домен узла не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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://org.eltex.radius.nbi/xsd" 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: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>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" 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:01</xsd1:key>
</xsd:keys>
<xsd:ruleName>myrules</xsd:ruleName>
<xsd:ruleDomain>root</xsd:ruleDomain>
<xsd:nodeDomain>101.root</xsd:nodeDomain>
</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>0</ns:code>
<ns:detail/>
<ns:response>
<ns:link>
<ns:deviceKey>a8:f9:b4:00:00:01</ns:deviceKey>
<ns:id>38</ns:id>
<ns:nodeDomain>101.root</ns:nodeDomain>
<ns:ruleDomain>root</ns:ruleDomain>
<ns:ruleName>myrules</ns:ruleName>
</ns:link>
</ns:response>
</ns:return>
</ns:CreateRuleLinkResponse>
</soapenv:Body>
</soapenv:Envelope>

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

Параметр Значение Формат значения Расшифровка формата Ссылка
keys Объект NbiKeyArray AP

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
10 Удаляемое устройство привязано к правилу, на которое не распространяется область видимости домена пользователя
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRuleLink>
<xsd:keys>
<xsd1:key>a8:f9:b4:00:a0:a1</xsd1:key>
</xsd:keys>
</xsd:RemoveRuleLink>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRuleLinkResponse 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 domain of Rule ('test1[root]'), which linked with key 'a8:f9:b4:00:a0:a1'. Role`s domains: 'enterprise.root test.root hotspot.root'.</ns:detail>
</ns:return>
</ns:RemoveRuleLinkResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
53 Один из ключей устройства пустой
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRuleLink>
<xsd:keys>
<xsd1:key></xsd1:key>
</xsd:keys>
</xsd:RemoveRuleLink>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRuleLinkResponse 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:return>
</ns:RemoveRuleLinkResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно. Если для некоторых ключей не было связок, информация об этом в detail.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://request.object.nbi.radius.eltex.org/xsd">
<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 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRuleLinkResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail>for key 'a8:f9:b4:00:0a:a1' no links found; for key 'a8:f9:b4:00:0a:a2' no links found</ns:detail>
</ns:return>
</ns:RemoveRuleLinkResponse>
</soapenv:Body>
</soapenv:Envelope>

RemoveRuleLinkByNodeDomain – Удалить привязки устройств и правила инициализации по домену ТД

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен точек доступа (узла дерева EMS) (?=^.{0,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
10 Роль пользователя не имеет прав на домен ТД
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен правила инициализации (?=^.{0,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
10 Роль пользователя не имеет прав на домен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

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

Параметр Значение Формат значения Расшифровка формата Ссылка
deviceKey Поле для поиска по ключу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). .* Любые символы AP
ruleName Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). .* Любые символы
ruleDomain Поле для поиска по домену правил. Может быть пустым. (?=^.{0,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
nodeDomain Поле для поиска по домену узла. Может быть пустым. (?=^.{0,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiProfileLink

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

Код Описание ошибки
10 Роль пользователя не имеет прав на домен правила или домен узла
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRuleLinkList>
<xsd:deviceKey>%??</xsd:deviceKey>
<xsd:ruleName>test?</xsd:ruleName>
<xsd:ruleDomain>enterprise.root</xsd:ruleDomain>
<xsd:nodeDomain>test.root</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>0</ns:code>
<ns:detail/>
<ns:response>
<ns:link>
<ns:deviceKey>a8:f9:b4:00:00:09</ns:deviceKey>
<ns:id>1</ns:id>
<ns:nodeDomain>test.root</ns:nodeDomain>
<ns:ruleDomain>enterprise.root</ns:ruleDomain>
<ns:ruleName>test2</ns:ruleName>
</ns:link>
<ns:link>
<ns:deviceKey>a8:f9:b4:00:00:0a</ns:deviceKey>
<ns:id>2</ns:id>
<ns:nodeDomain>test.root</ns:nodeDomain>
<ns:ruleDomain>enterprise.root</ns:ruleDomain>
<ns:ruleName>test2</ns:ruleName>
</ns:link>
</ns:response>
</ns:return>
</ns:RetrieveRuleLinkListResponse>
</soapenv:Body>
</soapenv:Envelope>

GetInitStatus – Получить статус инициализации устройства по MAC-адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
mac MAC-адрес точки доступа. ^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ 6 двухзначных шестнадцатеричных чисел, разделенных ':'. AP

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

Параметр Значение Формат значения
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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetRuleByIp – Единократное назначение правила инициализации на уже инициализированное устройство по IP-адресу с целью переконфигурации

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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
ruleName Имя правила инициализации. .* Любые символы
ruleDomain Домен правила. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Домен правила или домен узла не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetRuleByMac – Единократное назначение правила инициализации на уже инициализированное устройство по MAC-адресу с целью переконфигурации

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

Параметр Значение Формат значения Расшифровка формата Ссылка
mac MAC-адрес точки доступа. ^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ 6 двухзначных шестнадцатеричных чисел, разделенных ':'. AP
ruleName Имя правила инициализации. .* Любые символы
ruleDomain Домен правила. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Домен правила или домен узла не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetRuleByDomain – Единократное назначение правила инициализации на уже проинициализированную группу устройств с целью переконфигурации

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasDomain Домен точек доступа, по которому определяем группу устройств. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. AP
ruleName Имя правила инициализации. .* Любые символы
ruleDomain Домен правила. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Домен правила или домен ТД не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrievePolicyMapList – Запрос списка имен Client QoS.PolicyMap по домену из SoftWLC

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен, может быть пустым. Если установлен, то ограничивает список PolicyMap. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Объект NbiNameArray

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

Код Описание ошибки
10 Домен роли не имеет прав на домен NAS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveSSIDAttrListResponse - Запрос списка атрибутов SSID

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiEntryDescr.

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

Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDAttrListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
<ns:response>
<ns:entry>
<ns: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).</ns:descr>
<ns:entry>Vlan_ID</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Set 'locked' if you want deactivate SSID. Otherwise set 'operational'. By default is 'operational'.</ns:descr>
<ns:entry>Ssid_Status</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Select one of the following Radio interface for VAP: 'Radio 1' - 0, 'Radio 2' - 1, 'Radio 3' - 2, 'All' - 3.</ns:descr>
<ns:entry>Radio</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Select one of the following Security modes for this VAP: None - 0, WPA Personal - 1, WPA Enterprise - 2.</ns:descr>
<ns:entry>Security_Type</ns:entry>
</ns:entry>
<ns:entry>
<ns: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'</ns:descr>
<ns:entry>WPA_Support</ns:entry>
</ns:entry>
<ns:entry>
<ns: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'</ns:descr>
<ns:entry>WPA2_Support</ns:entry>
</ns:entry>
<ns:entry>
<ns: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'</ns:descr>
<ns:entry>TKIP_Support</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>You can enable or disable a band steer mode (true|false).</ns:descr>
<ns:entry>Band_Steer</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable or disable PMKSA caching (true|false). By default enable.</ns:descr>
<ns:entry>PMKSA_Caching</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Broadcast SSID, set 'true' to enable and 'false' to disable</ns:descr>
<ns:entry>Broadcast_SSID</ns:entry>
</ns:entry>
<ns:entry>
<ns: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 characters include upper and lower case alphabetic letters, the numeric digits, and special symbols such as @ and #.</ns:descr>
<ns:entry>WPA_Key</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>MAC_Auth_Type</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>MFP</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Broadcast_Key_Refresh_Rate</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Vlan_Trunk</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Session_Key_Refresh_Rate</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Pre_Authentication</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Active_Server</ns:entry>
</ns:entry>
<ns:entry>
<ns: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'.</ns:descr>
<ns:entry>Use_Global_Radius</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enter the IPv4 address for the primary RADIUS server for this VAP (SSID).</ns:descr>
<ns:entry>Radius_IP_Address</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Radius_IP_Address_1</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Radius_IP_Address_2</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Radius_IP_Address_3</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Radius_Key</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-1 uses RADIUS Key-1.</ns:descr>
<ns:entry>Radius_Key_1</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-2 uses RADIUS Key-2.</ns:descr>
<ns:entry>Radius_Key_2</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enter the RADIUS key associated with the configured backup RADIUS servers. The server at RADIUS IP Address-3 uses RADIUS Key-3.</ns:descr>
<ns:entry>Radius_Key_3</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Radius_Accounting</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Station_Isolation</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>DSCP - 0 or 802.11p - 1</ns:descr>
<ns:entry>Priority</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Client_Qos_Mode</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>DiffServ_Policy_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>DiffServ_Policy_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Bandwidth_Limit_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Bandwidth_Limit_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable (true) or disable (false) minimum signal checking.</ns:descr>
<ns:entry>Check_Minimal_Signal</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Minimum signal level, dBm. Range: [-100...-1], default: -100</ns:descr>
<ns:entry>Minimal_Signal_Level</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Minimum signal timeout, sec. Range: [1...300]</ns:descr>
<ns:entry>Minimal_Signal_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Fast_Transition_Mode</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>FT_over_DS</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>R0_key_Holder</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>R1_key_Holder</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>MDID</ns:entry>
</ns:entry>
<ns:entry>
<ns: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.</ns:descr>
<ns:entry>Reassociation_Deadline</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The flag to use Captive Portal. If this flag is true than attributes apCaptivePortalVirtualPortalName, apCaptivePortalProtocolMode, apCaptivePortalVerifyMode, apCaptivePortalURLRedirectMode, apCaptivePortalRedirectURL will be available</ns:descr>
<ns:entry>CP_Admin_Mode</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Web portal name</ns:descr>
<ns:entry>CP_Web_Portal</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The protocol used. For example HTTP or HTTPS in any register</ns:descr>
<ns:entry>CP_Protocol</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Type of inspection. For example radius or guest in any register</ns:descr>
<ns:entry>CP_Verification</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable redirection. If this flag is true than attribute apCaptivePortalRedirectURL will be available</ns:descr>
<ns:entry>CP_Redirect</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The address to which to redirect</ns:descr>
<ns:entry>CP_Redirect_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable the use of an external portal. If this flag is true than attributes apCaptivePortalExternalUrl, apCaptivePortalAwayTime, apCaptivePortalSessionTimeout will be available</ns:descr>
<ns:entry>CP_External</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>URL of external portal address.</ns:descr>
<ns:entry>CP_External_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Time, in minutes, during which the information is stored on the client's TD, if the client disconnected</ns:descr>
<ns:entry>CP_Away_Time</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the client's session, in minutes</ns:descr>
<ns:entry>CP_Session_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') after authorization state for Captive Portal</ns:descr>
<ns:entry>CP_After_Authorization_State_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Permitted IP for after authorization state</ns:descr>
<ns:entry>CP_Permitted_IP</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') state 1 for Captive Portal</ns:descr>
<ns:entry>CP_State1_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>URL address for redirect when an state 1 occurs</ns:descr>
<ns:entry>CP_State1_External_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the client's session before state 1, in minutes</ns:descr>
<ns:entry>CP_State1_Session_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the state 1, in minutes</ns:descr>
<ns:entry>CP_State1_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed transmission rate from the AP (NAS) to the wireless client on state 1 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State1_Bandwidth_Limit_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed client transmission rate to the AP (NAS) on state 1 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State1_Bandwidth_Limit_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') state 2 for Captive Portal</ns:descr>
<ns:entry>CP_State2_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>URL address for redirect when an state 2 occurs</ns:descr>
<ns:entry>CP_State2_External_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the client's session before state 2, in minutes</ns:descr>
<ns:entry>CP_State2_Session_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the state 2, in minutes</ns:descr>
<ns:entry>CP_State2_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed transmission rate from the AP (NAS) to the wireless client on state 2 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State2_Bandwidth_Limit_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed client transmission rate to the AP (NAS) on state 2 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State2_Bandwidth_Limit_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') state 3 for Captive Portal</ns:descr>
<ns:entry>CP_State3_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>URL address for redirect when an state 3 occurs</ns:descr>
<ns:entry>CP_State3_External_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the client's session before state 3, in minutes</ns:descr>
<ns:entry>CP_State3_Session_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the state 3, in minutes</ns:descr>
<ns:entry>CP_State3_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed transmission rate from the AP (NAS) to the wireless client on state 3 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State3_Bandwidth_Limit_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed client transmission rate to the AP (NAS) on state 3 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State3_Bandwidth_Limit_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') state 4 for Captive Portal</ns:descr>
<ns:entry>CP_State4_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>URL address for redirect when an state 4 occurs</ns:descr>
<ns:entry>CP_State4_External_URL</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the client's session before state 4, in minutes</ns:descr>
<ns:entry>CP_State4_Session_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>The duration of the state 4, in minutes</ns:descr>
<ns:entry>CP_State4_Timeout</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed transmission rate from the AP (NAS) to the wireless client on state 4 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State4_Bandwidth_Limit_Down</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Maximum allowed client transmission rate to the AP (NAS) on state 4 in kilobits per second. The valid range is 0-1331200 Kbps.</ns:descr>
<ns:entry>CP_State4_Bandwidth_Limit_Up</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Enable ('true') or disable ('false') TLS support</ns:descr>
<ns:entry>TLS_Enable</ns:entry>
</ns:entry>
<ns:entry>
<ns:descr>Roaming disconnect signal level, dBm. Range: [-100...-1], default: -100</ns:descr>
<ns:entry>Roaming_Signal_Level</ns:entry>
</ns:entry>
</ns:response>
</ns:return>
</ns:RetrieveSSIDAttrListResponse>
</soapenv:Body>
</soapenv:Envelope>

CreateSSID – Создание нового SSID в базе wireless

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

Параметр Значение Формат значения Расшифровка формата Ссылка
name Имя SSID. Уникальность SSID определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
domain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
descr Описание SSID .{0,255}$ Любые символы в количестве до 255-ти.
params Атрибуты SSID, могут отсутствовать. В противном случае ожидается один или больше объект NbiParameter. Список возможных атрибутов и их значений

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test8</xsd:name>
<xsd:domain></xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse 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:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test9</xsd:name>
<xsd:domain>wifi</xsd:domain>
<xsd:descr>TDwifi</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse 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:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test8</xsd:name>
<xsd:domain>test1.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse 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:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
38 Нет обязательного атрибута.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test8</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>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>38</ns:code>
<ns:detail>No mandatory attribute 'Security_Type'</ns:detail>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Нет обязательного поля name или оно не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name></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>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse 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:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
32 Поле descr содержит больше 200 символов
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test9</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TDwifidddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse 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:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
39 Не задан атрибут
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateSSID>
<xsd:name>test8</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>?</xsd1:name>
<xsd1:value>?</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>39</ns:code>
<ns:detail>No attribute with name '?'</ns:detail>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
37 Некорректное значение для атрибута.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<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>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value></xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>37</ns:code>
<ns:detail>Incorrect value '' for attribute 'Security_Type'</ns:detail>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
36 Некорректное имя или отсутствие атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<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>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name></xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>36</ns:code>
<ns:detail>Incorrect attribute name!</ns:detail>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
34 SSID уже существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<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>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>34</ns:code>
<ns:detail>SSID 'test7[wifi.root]' already exists.</ns:detail>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<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>0</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Security_Type</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:CreateSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
</ns:return>
</ns:CreateSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>

EditSSID – Редактирование параметров и атрибутов SSID в базе wireless

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

Параметр Значение Формат значения Расшифровка формата Ссылка
name Имя SSID. Уникальность SSID определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
domain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
descr Новое описание SSID .{0,255}$ Любые символы в количестве до 255-ти.
params Атрибуты SSID, могут отсутствовать. В противном случае ожидается один или больше объект NbiParameter.Список возможных атрибутов и их значений.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain></xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Up</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Priority</xsd1:name>
<xsd1:value>1</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>test1.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Up</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Нет обязательного поля name или оно не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name></xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Up</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Bandwidth_Limit_Down</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
<xsd:params>
<xsd1:name>Priority</xsd1:name>
<xsd1:value>1</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
32 Поле descr содержит больше 200 символов
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TDTDwifidddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Down</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
39 Не корректное имя или отсутствие атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>?</xsd1:name>
<xsd1:value>?</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>39</ns:code>
<ns:detail>No attribute with name '?'</ns:detail>
</ns:return>
</ns:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
37 Некорректное значение для атрибута.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Priority</xsd1:name>
<xsd1:value></xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>37</ns:code>
<ns:detail>Incorrect value '' for attribute 'Priority'</ns:detail>
</ns:return>
</ns:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
36 Не корректное имя или отсутствие атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<xsd:params>
<xsd1:name></xsd1:name>
<xsd1:value></xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>36</ns:code>
<ns:detail>Incorrect attribute name!</ns:detail>
</ns:return>
</ns:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>tes</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Down</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse 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:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
<xsd:descr>TD</xsd:descr>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Bandwidth_Limit_Up</xsd1:name>
<xsd1:value>5000000</xsd1:value>
</xsd:params>
</xsd:EditSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
</ns:return>
</ns:EditSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>

RemoveSSID – Удаление SSID из базы wireless

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

Параметр Значение Формат значения Расшифровка формата Ссылка
name Имя SSID. Уникальность SSID определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
domain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveSSID>
<xsd:name>1</xsd:name>
<xsd:domain>1.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>62</ns:code>
<ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
</ns:return>
</ns:RemoveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Нет обязательного поля name или оно не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveSSID>
<xsd:name></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>33</ns:code>
<ns:detail>Incorrect field 'name'</ns:detail>
</ns:return>
</ns:RemoveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
17 SSID привязан к ТД
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveSSID – Запрос списка атрибутов SSID

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

Параметр Значение Формат значения Расшифровка формата Ссылка
name Имя SSID. Уникальность SSID определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
domain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Объект NbiSsid

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

Код Описание ошибки
10 Домен роли не имеет прав на домен NAS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse 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:attrList>
<ns:empty>true</ns:empty>
</ns:attrList>
<ns:createDate/>
<ns:descr/>
<ns:domain/>
<ns:name/>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wi</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>8</ns:code>
<ns:detail>Domain 'wi' does not conform to the rules FQDN</ns:detail>
<ns:response>
<ns:attrList>
<ns:empty>true</ns:empty>
</ns:attrList>
<ns:createDate/>
<ns:descr/>
<ns:domain/>
<ns:name/>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>test1.root</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse 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:attrList>
<ns:empty>true</ns:empty>
</ns:attrList>
<ns:createDate/>
<ns:descr/>
<ns:domain/>
<ns:name/>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name></xsd:name>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>33</ns:code>
<ns:detail>Incorrect field 'name'</ns:detail>
<ns:response>
<ns:attrList>
<ns:empty>true</ns:empty>
</ns:attrList>
<ns:createDate/>
<ns:descr/>
<ns:domain/>
<ns:name/>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name>tes</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse 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:attrList>
<ns:empty>true</ns:empty>
</ns:attrList>
<ns:createDate/>
<ns:descr/>
<ns:domain/>
<ns:name/>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSID>
<xsd:name>test7</xsd:name>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RetrieveSSID>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
<ns:response>
<ns:attrList>
<ns:name>Radio</ns:name>
<ns:value>0</ns:value>
</ns:attrList>
<ns:attrList>
<ns:name>Bandwidth_Limit_Down</ns:name>
<ns:value>5000000</ns:value>
</ns:attrList>
<ns:attrList>
<ns:name>Priority</ns:name>
<ns:value>1</ns:value>
</ns:attrList>
<ns:attrList>
<ns:name>Bandwidth_Limit_Up</ns:name>
<ns:value>5000000</ns:value>
</ns:attrList>
<ns:attrList>
<ns:name>Security_Type</ns:name>
<ns:value>0</ns:value>
</ns:attrList>
<ns:createDate>2015-05-21 15:31:46</ns:createDate>
<ns:descr>TD</ns:descr>
<ns:domain>wifi.root</ns:domain>
<ns:name>test7</ns:name>
</ns:response>
</ns:return>
</ns:RetrieveSSIDResponse>
</soapenv:Body>
</soapenv:Envelope>

RetrieveSSIDList – Запрос списка SSID на основе содержащихся в них атрибутов

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

Параметр Значение Формат значения Расшифровка формата Ссылка
params 0 и более объектов NbiParameter. Если установлены, то выводятся SSID, которые имеют данные атрибуты, иначе – все доступные.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNameDomain

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

Код Описание ошибки
36 Не корректное имя или отсутствие атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDList>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name></xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:RetrieveSSIDList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>36</ns:code>
<ns:detail>Incorrect attribute name!</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveSSIDListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
37 Некорректное значение для атрибута.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDList>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value></xsd1:value>
</xsd:params>
</xsd:RetrieveSSIDList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>37</ns:code>
<ns:detail>Incorrect value '' for attribute 'Radio'</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveSSIDListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
39 Не корректное имя или отсутствие атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDList>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Rad</xsd1:name>
<xsd1:value></xsd1:value>
</xsd:params>
</xsd:RetrieveSSIDList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>39</ns:code>
<ns:detail>No attribute with name 'Rad'</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveSSIDListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDList>
<!--1 or more repetitions:-->
<xsd:params>
<xsd1:name>Radio</xsd1:name>
<xsd1:value>0</xsd1:value>
</xsd:params>
</xsd:RetrieveSSIDList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<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>

RetrieveSSIDListByDomain – Запрос списка SSID, принадлежащих домену

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен SSID. Может быть пустым, тогда в ответе будет весь список SSID, доступный данной роли. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNameDomain

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

Код Описание ошибки
8 Домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

SetSSIDByDomain –Установить SSID на домен ТД

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasDomain Домен Nas, определяющий группу точек доступа. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Идентификатор связки Целое неотрицательное число.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен SSID или домен ТД
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен SSID или домен ТД не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Нет обязательного поля name или оно не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByDomain>
<xsd:nasDomain>wifi.root</xsd:nasDomain>
<xsd:ssidName></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>33</ns:code>
<ns:detail>Incorrect field 'ssidName'</ns:detail>
<ns:response/>
</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: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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
43 SSID уже содержит связку с данным доменом
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>

SetSSIDByIp – Установить SSID на точку доступа по IP-адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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 определяется по имени и домену. ^[\w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Идентификатор связки Целое неотрицательное число.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName>test7</xsd:ssidName>
<xsd:ssidDomain></xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName>test7</xsd:ssidName>
<xsd:ssidDomain>wifi</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName>test7</xsd:ssidName>
<xsd:ssidDomain>test1.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName></xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервиса NBI EMS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
30 Нет NasIp или он не верен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp></xsd:nasIp>
<xsd:ssidName>tes</xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
43 NAS уже содержит SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName>test7</xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>43</ns:code>
<ns:detail>SSID 'test7[wifi.root]' already contains NAS with ip 192.168.201.162</ns:detail>
<ns:response/>
</ns:return>
</ns:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.162</xsd:nasIp>
<xsd:ssidName>tes</xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse 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:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByIp>
<xsd:nasIp>192.168.201.23</xsd:nasIp>
<xsd:ssidName>test7</xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:SetSSIDByIp>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:SetSSIDByIpResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
<ns:response>82</ns:response>
</ns:return>
</ns:SetSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>

SetSSIDByMac – Установить SSID на точку доступа по MAC-адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasMac MAC-адрес точки доступа ^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ 6 двухзначных шестнадцатеричных чисел, разделенных ':'. AP
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Идентификатор связки Целое неотрицательное число.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:SetSSIDByMac>
<xsd:nasMac>a8:f9:4b:1f:f3:e0</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>33</ns:code>
<ns:detail>Incorrect field 'ssidName'</ns:detail>
<ns:response/>
</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: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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
63 Нет NasMac или он не верен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
43 NAS уже содержит SSID
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:return>
</ns:SetSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>

RemoveSSIDByDomain – Удаление SSID с домена ТД

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasDomain Домен Nas, определяющий группу точек доступа. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Домен ТД или домен SSID отсутствует или не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveSSIDByDomain>
<xsd:nasDomain>wifi.root</xsd:nasDomain>
<xsd:ssidName></xsd:ssidName>
<xsd:ssidDomain>wifi.root</xsd:ssidDomain>
</xsd:RemoveSSIDByDomain>
</soapenv:Body>
</soapenv:Envelope></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>33</ns:code>
<ns:detail>Incorrect field 'ssidName'</ns:detail>
</ns:return>
</ns:RemoveSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<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>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:RemoveSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервиса NBI EMS
Пример
Запрос Ответ
<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>3</ns:code>
<ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
</ns:return>
</ns:RemoveSSIDByDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
16 SSID не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RemoveSSIDByIp – Удаление SSID с точки доступа по IP-адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
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 определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveSSIDByIp>
<xsd:nasIp>192.168.201.23</xsd:nasIp>
<xsd:ssidName></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>33</ns:code>
<ns:detail>Incorrect field 'ssidName'</ns:detail>
</ns:return>
</ns:RemoveSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<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>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:RemoveSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервиса NBI EMS
Пример
Запрос Ответ
<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>3</ns:code>
<ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
</ns:return>
</ns:RemoveSSIDByIpResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
30 Нет NasIp или он не верен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RemoveSSIDByMac – Удаление SSID с точки доступа по MAC-адресу

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasMac MAC-адрес точки доступа. ^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ 6 двухзначных шестнадцатеричных чисел, разделенных ':'. AP
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>
Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveSSIDByMac>
<xsd:nasMac>a8:f9:4b:1f:f3:e0</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>33</ns:code>
<ns:detail>Incorrect field 'ssidName'</ns:detail>
</ns:return>
</ns:RemoveSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
18 В конфигурации неверно настроен адрес EMS NBI или он недоступен
Пример
Запрос Ответ
<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>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:RemoveSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
3 Ошибка от сервиса NBI EMS
Пример
Запрос Ответ
<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>3</ns:code>
<ns:detail>Error from EMS server: code 103, message 'No handler for action'</ns:detail>
</ns:return>
</ns:RemoveSSIDByMacResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
63 Нет NasMac или он не верен
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveNasListBySSID – Запрос списка точек доступа, на которых установлен SSID

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

Параметр Значение Формат значения Расшифровка формата Ссылка
nasDomain Домен Nas, если мы хотим получить не весь список, а только для данного домена. Может быть пустым. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNas

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

Код Описание ошибки
10 Домен роли не имеет прав на домен NAS
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveSSIDListByNas – Запрос списка SSID, установленных на точку доступа

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

Параметр Значение Формат значения Расшифровка формата Ссылка
ssidDomain Домен SSID, если мы хотим получить не весь список, а только для данного домена. Может быть пустым. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам 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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

RetrieveSSIDListByWebPortal – Запрос списка SSID, на которые установлен Web-портал

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

Параметр Значение Формат значения Расшифровка формата Ссылка
webPortal Имя Web портала ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNameDomain

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

Код Описание ошибки
33 Имя Web-портала отсутствует или не удовлетворяет формату
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDListByWebPortal>
<xsd:webPortal></xsd:webPortal>
</xsd:RetrieveSSIDListByWebPortal>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListByWebPortalResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>33</ns:code>
<ns:detail>Incorrect field 'webPortal'</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveSSIDListByWebPortalResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
55 Web-портал не найден в настройках SSID`ов
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDListByWebPortal>
<xsd:webPortal>default2</xsd:webPortal>
</xsd:RetrieveSSIDListByWebPortal>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListByWebPortalResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>55</ns:code>
<ns:detail>No Web-Portal with name 'default2' in Captive Portals settings</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveSSIDListByWebPortalResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveSSIDListByWebPortal>
<xsd:webPortal>default</xsd:webPortal>
</xsd:RetrieveSSIDListByWebPortal>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveSSIDListByWebPortalResponse 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>local2</ns:name>
</ns:item>
</ns:response>
</ns:return>
</ns:RetrieveSSIDListByWebPortalResponse>
</soapenv:Body>
</soapenv:Envelope>

RetrieveRadiusOperList – Получить список операторов для атрибутов Wi-Fi пользователей

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

Параметр Значение Формат значения Расшифровка формата Ссылка
attr Фильтр по имени атрибута Wi-Fi пользователей. Может отсутсвовать. .* Текст.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiEntryDescr

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

Код Описание ошибки
23 Некорректное имя атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusOperList>
<xsd:attr>gero et</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>No radius user attribute with name 'gero et'</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://org.eltex.radius.nbi/xsd">
<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>

RetrieveRadiusUserAttrList - Запрос списка атрибутов Wi-Fi пользователей

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

Параметр Значение Формат значения
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>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента. Уникальность аккаунта определяется по логину и домену. ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента. Уникальность определяется по логину и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
tlsCrtData Исходные данные для генерации клиентского сертификата. Объект TlsCrtData. Если тег пустой или period меньше 0, генерация сертификата не происходит. Для генерации обязательным является только тег period, остальные могут быть заменены значениями по умолчанию.
params Атрибуты пользователя, ожидается один или больше объект NbiAttr.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Объект NbiRadiusUserGItem

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain></xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse 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:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен клиента
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse 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:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>test1.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse 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:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
21 Отсутствуют атрибуты
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>21</ns:code>
<ns:detail>No attributes in modify request!</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
22 Некорректный или отсутствует атрибут
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>22</ns:code>
<ns:detail>Incorrect attribute name!</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
23 Некорректное имя атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>?</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>23</ns:code>
<ns:detail>No attribute with name '?'</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
24 Некорректный оператор для атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>24</ns:code>
<ns:detail>Incorrect operator ''</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
28 Отсутствует обязательный атрибут пользователя
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Session-Timeout</xsd1:name>
<xsd1:oper>=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>28</ns:code>
<ns:detail>Missing mandatory attribute 'Cleartext-Password'</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
26 Некорректный оператор для атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>26</ns:code>
<ns:detail>Attribute 'Cleartext-Password' no contains operator '='</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
19 Данный аккаунт уже существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>19</ns:code>
<ns:detail>User 'test[wifi.root]' already exist</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
20 Имя пользователя некорректно.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username></xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData/>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>20</ns:code>
<ns:detail>Incorrect field 'username'</ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
75 Некорректное значение для объекта TlsCrtData
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://object.nbi.radius.eltex.org/xsd" xmlns:xsd2="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData>
<xsd1:country></xsd1:country>
<xsd1:emailDomain></xsd1:emailDomain>
<xsd1:location></xsd1:location>
<xsd1:organization></xsd1:organization>
<xsd1:organizationUnit></xsd1:organizationUnit>
<xsd1:period>3</xsd1:period>
<xsd1:state></xsd1:state>
</xsd:tlsCrtData>
<xsd:attributes>
<xsd2:name>Cleartext-Password</xsd2:name>
<xsd2:oper>:=</xsd2:oper>
<xsd2:value>123</xsd2:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>75</ns:code>
<ns:detail></ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
76 Ошибка создания клиентского сертификата
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://object.nbi.radius.eltex.org/xsd" xmlns:xsd2="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData>
<xsd1:country>RU</xsd1:country>
<xsd1:emailDomain>qwerty@qwe.ru</xsd1:emailDomain>
<xsd1:location>Novosibirsk</xsd1:location>
<xsd1:organization>Eltex</xsd1:organization>
<xsd1:organizationUnit>In-soft</xsd1:organizationUnit>
<xsd1:period>3</xsd1:period>
<xsd1:state>Novosibirsk</xsd1:state>
</xsd:tlsCrtData>
<xsd:attributes>
<xsd2:name>Cleartext-Password</xsd2:name>
<xsd2:oper>:=</xsd2:oper>
<xsd2:value>123</xsd2:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>76</ns:code>
<ns:detail></ns:detail>
<ns:response>
<ns:clientCrtLink/>
<ns:domain/>
<ns:name/>
<ns:password/>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://object.nbi.radius.eltex.org/xsd" xmlns:xsd2="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CreateRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<xsd:tlsCrtData>
<xsd1:country>RU</xsd1:country>
<xsd1:emailDomain>qwerty@qwe.ru</xsd1:emailDomain>
<xsd1:location>Novosibirsk</xsd1:location>
<xsd1:organization>Eltex</xsd1:organization>
<xsd1:organizationUnit>In-soft</xsd1:organizationUnit>
<xsd1:period>3</xsd1:period>
<xsd1:state>Novosibirsk</xsd1:state>
</xsd:tlsCrtData>
<xsd:attributes>
<xsd2:name>Cleartext-Password</xsd2:name>
<xsd2:oper>:=</xsd2:oper>
<xsd2:value>123</xsd2:value>
</xsd:attributes>
</xsd:CreateRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:CreateRadiusUserResponse 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>wifi.root</ns:domain>
<ns:name>test</ns:name>
<ns:password>123</ns:password>
</ns:response>
</ns:return>
</ns:CreateRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента. Уникальность аккаунта определяется по логину и домену. ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента. Уникальность определяется по логину и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
params Атрибуты пользователя, ожидается один или больше объект NbiAttr.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain></xsd:domain>
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse 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:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен клиента
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>root</xsd:domain>
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse 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:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>1.root</xsd:domain>
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse 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:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
21 Отсутствуют атрибуты
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>21</ns:code>
<ns:detail>No attributes in modify request!</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
22 Некорректный или отсутствует атрибут
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>22</ns:code>
<ns:detail>Incorrect attribute name!</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
23 Некорректное имя атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:attributes>
<xsd1:name>?</xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>23</ns:code>
<ns:detail>No attribute with name '?'</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
24 Некорректный оператор для атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>24</ns:code>
<ns:detail>Incorrect operator ''</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
26 Некорректный оператор для атрибута
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>=</xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>26</ns:code>
<ns:detail>Attribute 'Cleartext-Password' no contains operator '='</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
11 Данного аккаунта не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>11</ns:code>
<ns:detail>No user 'client1[enterprise.root]' in RADIUS server</ns:detail>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
20 Имя пользователя некорректно.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username></xsd:username>
<xsd:domain></xsd:domain>
<xsd:attributes>
<xsd1:name></xsd1:name>
<xsd1:oper></xsd1:oper>
<xsd1:value></xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse 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:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
<!--1 or more repetitions:-->
<xsd:attributes>
<xsd1:name>Cleartext-Password</xsd1:name>
<xsd1:oper>:=</xsd1:oper>
<xsd1:value>123</xsd1:value>
</xsd:attributes>
</xsd:EditRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:EditRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
</ns:return>
</ns:EditRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента. Уникальность аккаунта определяется по логину и домену. ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента. Уникальность определяется по логину и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain
newDomain Новый домен клиента. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
8 Нет домена или домен не соответствует правилам. Также относится и к новому домену.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUserDomain>
<xsd:username>client1</xsd:username>
<xsd:domain></xsd:domain>
<xsd:newDomain></xsd:newDomain>
</xsd:EditRadiusUserDomain>
</soapenv:Body>
</soapenv:Envelope>
<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>8</ns:code>
<ns:detail>Domain '' does not conform to the rules FQDN</ns:detail>
</ns:return>
</ns:EditRadiusUserDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен клиента. Также относится и к новому домену.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUserDomain>
<xsd:username>client1</xsd:username>
<xsd:domain>root</xsd:domain>
<xsd:newDomain>root</xsd:newDomain>
</xsd:EditRadiusUserDomain>
</soapenv:Body>
</soapenv:Envelope>
<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>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:EditRadiusUserDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован. Также относится и к новому домену.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUserDomain>
<xsd:username>client1</xsd:username>
<xsd:domain>1.root</xsd:domain>
<xsd:newDomain>1.root</xsd:newDomain>
</xsd:EditRadiusUserDomain>
</soapenv:Body>
</soapenv:Envelope>
<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>62</ns:code>
<ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
</ns:return>
</ns:EditRadiusUserDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
11 Данного аккаунта не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUserDomain>
<xsd:username>client1</xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:newDomain>hotspot.root</xsd:newDomain>
</xsd:EditRadiusUserDomain>
</soapenv:Body>
</soapenv:Envelope>
<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>11</ns:code>
<ns:detail>No user 'client1[enterprise.root]' in RADIUS server</ns:detail>
</ns:return>
</ns:EditRadiusUserDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
20 Имя пользователя некорректно.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EditRadiusUserDomain>
<xsd:username></xsd:username>
<xsd:domain></xsd:domain>
<xsd:newDomain></xsd:newDomain>
</xsd:EditRadiusUserDomain>
</soapenv:Body>
</soapenv:Envelope>
<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>20</ns:code>
<ns:detail>Incorrect field 'username'</ns:detail>
</ns:return>
</ns:EditRadiusUserDomainResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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>
<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>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента. Уникальность аккаунта определяется по логину и домену. ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента. Уникальность определяется по логину и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
11 Данного аккаунта не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>11</ns:code>
<ns:detail>No user 'test[wifi.root]' in RADIUS server</ns:detail>
</ns:return>
</ns:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен пользователя
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse 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:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain></xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse 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:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>test1.root</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse 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:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
20 Имя пользователя некорректно.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username></xsd:username>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse 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:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
79 Ошибка при удалении сертификата.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username></xsd:username>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>79</ns:code>
<ns:detail>Failed to delete certificate for user</ns:detail>
</ns:return>
</ns:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RemoveRadiusUser>
<xsd:username>test</xsd:username>
<xsd:domain>wifi.root</xsd:domain>
</xsd:RemoveRadiusUser>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RemoveRadiusUserResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
</ns:return>
</ns:RemoveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
domain Домен клиента. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
10 Домен роли не имеет прав на домен пользователя
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка
tariffCode Код тарифного плана ^.{1,64}$ Текст до 64-х символов.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.

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

Код Описание ошибки
100 Тарифного плана с таким кодом не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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://org.eltex.radius.nbi/xsd">
<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>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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>

RetrieveRadiusUser – Получить все атрибуты аккаунта Wi-Fi клиента из базы RADIUS

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента. Уникальность аккаунта определяется по логину и домену. ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента. Уникальность определяется по логину и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiAttr

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

Код Описание ошибки
11 Данного аккаунта не существует
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username>client1</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>11</ns:code>
<ns:detail>No user 'client1[enterprise.root]' in RADIUS server</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен пользователя
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>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>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:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
8 Нет домена или домен не соответствует правилам
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>?</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>8</ns:code>
<ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username>client1</xsd:username>
<xsd:domain>1.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>62</ns:code>
<ns:detail>Such '1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
20 Имя пользователя некорректно.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username></xsd:username>
<xsd:domain>1.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>20</ns:code>
<ns:detail>Incorrect field 'username'</ns:detail>
<ns:response/>
</ns:return>
</ns:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUser>
<xsd:username>client</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:attr>
<ns:name>Tunnel-Private-Group-Id</ns:name>
<ns:oper>=</ns:oper>
<ns:value>148</ns:value>
</ns:attr>
<ns:attr>
<ns:name>Eltex-User-Create-Date</ns:name>
<ns:oper>:=</ns:oper>
<ns:value>2015-07-30 13:08:14</ns:value>
</ns:attr>
<ns:attr>
<ns:name>Cleartext-Password</ns:name>
<ns:oper>:=</ns:oper>
<ns:value>1</ns:value>
</ns:attr>
<ns:attr>
<ns:name>Simultaneous-Use</ns:name>
<ns:oper>:=</ns:oper>
<ns:value>1</ns:value>
</ns:attr>
</ns:response>
</ns:return>
</ns:RetrieveRadiusUserResponse>
</soapenv:Body>
</soapenv:Envelope>

RetrieveRadiusUserList – Запрос списка аккаунтов WiFi клиентов из базы RADIUS

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

Параметр Значение Формат значения Расшифровка формата Ссылка
usernаme Логин клиента, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов). ^.{1,64}$ Текст до 64-х символов. Wi-Fi пользователь
domain Домен клиента, может быть пустым. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain
tariffCode Фильтр по коду тарифного плана. Может отсутствовать. ^.{1,64}$ Текст до 64-х символов.

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiRadiusUserItem.

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

Код Описание ошибки
8 Домен не соответствует правилам.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUserList>
<xsd:username></xsd:username>
<xsd:domain>?</xsd:domain>
<xsd:tariffCode>blue3</xsd:tariffCode>
</xsd:RetrieveRadiusUserList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveRadiusUserListResponse 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:RetrieveRadiusUserListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
10 Домен роли не имеет прав на домен пользователя.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUserList>
<xsd:username></xsd:username>
<xsd:domain>root</xsd:domain>
<xsd:tariffCode>blue3</xsd:tariffCode>
</xsd:RetrieveRadiusUserList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveRadiusUserListResponse 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:RetrieveRadiusUserListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
62 Домен клиента не зарегистрирован
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd" xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUserList>
<xsd:username></xsd:username>
<xsd:domain>1.root</xsd:domain>
<xsd:tariffCode>blue3</xsd:tariffCode>
</xsd:RetrieveRadiusUserList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveRadiusUserListResponse 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:RetrieveRadiusUserListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
100 Тарифного плана с таким кодом не существует.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUserList>
<xsd:username></xsd:username>
<xsd:domain></xsd:domain>
<xsd:tariffCode>code</xsd:tariffCode>
</xsd:RetrieveRadiusUserList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveRadiusUserListResponse 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:response/>
</ns:return>
</ns:RetrieveRadiusUserListResponse>
</soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки
0 Успешно
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveRadiusUserList>
<xsd:username></xsd:username>
<xsd:domain>enterprise.root</xsd:domain>
<xsd:tariffCode>white</xsd:tariffCode>
</xsd:RetrieveRadiusUserList>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveRadiusUserListResponse xmlns:ns="http://org.eltex.radius.nbi/xsd">
<ns:return>
<ns:code>0</ns:code>
<ns:detail/>
<ns:response>
<ns:item>
<ns:clientCrtLink/>
<ns:domain>enterprise.root</ns:domain>
<ns:name>79134641359</ns:name>
<ns:password>133219</ns:password>
<ns:tariffCode>white</ns:tariffCode>
</ns:item>
</ns:response>
</ns:return>
</ns:RetrieveRadiusUserListResponse>
</soapenv:Body>
</soapenv:Envelope>

RetrieveUserListBySSID – Запрос списка пользователей, которые могут подключаться к данному SSID

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

Параметр Значение Формат значения Расшифровка формата Ссылка
ssidName Имя SSID. Уникальность SSID определяется по имени и домену. ^[ \w-]{1,32}$ Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов. SSID
ssidDomain Домен SSID. Уникальность SSID определяется по имени и домену. (?=^.{1,255}$)(^(?:(?!\d+\.|-)[a-zA-Z0-9_\-]{1,63}(?<!-)\.?)+(?:[a-zA-Z]{2,})$) Текст длиной до 255 символов, удовлетворяющий правилам FQDN. Domain

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

Параметр Значение Формат значения
code Код ответа Целое неотрицательное число.
detail Пояснение к ответу Текст английскими буквами с пробелами и спецсимволами.
response Массив объектов NbiNameDomain

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

Код Описание ошибки
33 Имя SSID не задано или не удовлетворяет требованиям.
Пример
Запрос Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://org.eltex.radius.nbi/xsd">
<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:RetrieveUserListBySSIDRes