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

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

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

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

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

ssidDomain

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

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

Текст длиной до 235 символов, удовлетворяющий правилам 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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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://nbi.radius.eltex.org">
    <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>

Вернуться к списку команд
Версия 1.29-3249
Дата публикации 21-12-2023 02:50:11