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

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

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

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

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

nasDomain

Домен Nas, если мы хотим получить не весь список, а только для данного домена. Может быть пустым.

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

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

ssidName

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

Имя SSID

ssidDomain

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

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

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

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

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

code

Код ответа

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

detail

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

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

response

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

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

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

10

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

8

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

62

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

33

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

16

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

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveNasListBySSID>
            <xsd:nasDomain></xsd:nasDomain>
            <xsd:ssidName>local</xsd:ssidName>
            <xsd:ssidDomain>enterprise.root</xsd:ssidDomain>
        </xsd:RetrieveNasListBySSID>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveNasListBySSIDResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:nas>
                        <ns:descr/>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:ip>192.168.40.23</ns:ip>
                        <ns:mac>a8:f9:4b:1f:fc:80</ns:mac>
                        <ns:name>817</ns:name>
                        <ns:secret>eltex</ns:secret>
                    </ns:nas>
                </ns:response>
            </ns:return>
        </ns:RetrieveNasListBySSIDResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.24-2769
Дата публикации 18-10-2022 03:26:05