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

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

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

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

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

ssidName

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

Имя SSID

ssidDomain

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

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

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

Domain

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

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

code

Код ответа

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

detail

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

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

response

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

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

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

33

Имя SSID не задано или не удовлетворяет требованиям.
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName></xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>33</ns:code>
                <ns:detail>Incorrect field 'ssidName'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

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

8

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

62

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

16

SSID не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test5</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>16</ns:code>
                <ns:detail>No SSID with name 'test5[wifi.root]'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

49

На SSID настроена авторизация не через radius-сервер
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveUserListBySSID>
            <nbi:ssidName>eltex_local</nbi:ssidName>
            <nbi:ssidDomain>enterprise.root</nbi:ssidDomain>
        </nbi:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNameDomainResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>49</ax21:code>
                <ax21:detail>Attribute 'Security_Type' is no 'WPA Enterprise' (2) for SSID 'eltex_local[enterprise.root]'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

47

SSID использует глобальный radius-сервер (невозможно гарантировать совпадение доменов SSID и глобальный radius-сервера)
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveUserListBySSID>
            <nbi:ssidName>eltex_local</nbi:ssidName>
            <nbi:ssidDomain>enterprise.root</nbi:ssidDomain>
        </nbi:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeNameDomainResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>47</ax21:code>
                <ax21:detail>Attribute 'Use_Global_Radius' set to 'true' for SSID 'eltex_local[enterprise.root]'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiNameDomainArray"/>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveUserListBySSID>
            <xsd:ssidName>test54</xsd:ssidName>
            <xsd:ssidDomain>wifi.root</xsd:ssidDomain>
        </xsd:RetrieveUserListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveUserListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>andrey</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>andrey2</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>roman</ns:name>
                    </ns:item>
                    <ns:item>
                        <ns:domain>wifi.root</ns:domain>
                        <ns:name>test</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveUserListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>

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