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

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

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

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

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

usernаme

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

^.{1,64}$

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

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

domain

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

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

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

Domain

deactivate

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

.*

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

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

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

code

Код ответа

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

detail

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

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

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

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

11

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

20

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

8

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

10

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

62

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

18

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

3

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

0

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

Вернуться к списку команд
Версия 1.23-2695
Дата публикации 02-09-2022 11:42:18