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

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

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

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
mac	MAC-адрес устройства пользователя услуги Wi-Fi	^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$	6 двузначных шестнадцатеричных чисел, разделенных ':'.
usernаme	Логин клиента. Уникальность аккаунта определяется по логину и домену.	^.{1,64}$	Текст до 64-х символов.	Wi-Fi пользователь
domain	Домен клиента. Уникальность определяется по логину и домену.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN	Domain
expiresTime	Дата, при достижении которой MAC-адрес устройства отвязывается от учетной записи Wi-Fi клиента.		Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"
sessionTimeout	Время открытой сессии в секундах.		Целое положительное число

Параметр

Значение

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

Расшифровка формата

Ссылка

mac

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

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

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

usernаme

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

^.{1,64}$

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

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

domain

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

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

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

Domain

expiresTime

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

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

sessionTimeout

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

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

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

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

Параметр

Значение

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

code

Код ответа

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

detail

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

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

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

Код	Описание
0	Успешно

Код

Описание

Успешно

Запрос

      <nbi:AddRadiusUserMac>
         <nbi:mac>aa:bb:cc:dd:ee:04</nbi:mac>
         <nbi:username>test</nbi:username>
         <nbi:domain>nsk.root</nbi:domain>
         <nbi:expiresTime>2018-01-01T00:00:00+07:00</nbi:expiresTime>
         <nbi:openTimeout>3600</nbi:openTimeout>
      </nbi:AddRadiusUserMac>

Ответ

      <ns:AddRadiusUserMacResponse">
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail />
         </ns:return>
      </ns:AddRadiusUserMacResponse>

Код	Описание ошибки
7	Не указан домен учетной записи пользователя.
8	Домен не удовлетворяет правилам FQDN.
10	Пользователь, выполняющий операцию, не имеет прав на указанный домен.
11	Такой учетной записи не существует.
20	Имя пользователя некорректно.
62	Указанный домен не зарегистрирован.
63	MAC-адрес не передан или не валиден

Вернуться к списку команд
Версия 1.26-3099
Дата публикации 18-05-2023 06:44:06