RetrieveRuleList – Запрос списка правил инициализации из SoftWLC

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

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

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

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

name

Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

.*

Любые символы

domain

Поле для поиска по домену правил. Может быть пустым.

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

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

deviceType

Поле для поиска по по типу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

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

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

code

Код ответа

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

detail

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

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

response

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

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

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

8

Домен не соответствует правилам

Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>3 2</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '3 2' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>

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

10

Домен роли не имеет прав на данный домен

Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>wifi</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            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:RetrieveRuleListResponse>
    </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:RetrieveRuleList>
            <xsd:name></xsd:name>
            <xsd:domain>test1.root</xsd:domain>
            <xsd:deviceType></xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            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:RetrieveRuleListResponse>
    </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:RetrieveRuleList>
            <xsd:name>%</xsd:name>
            <xsd:domain></xsd:domain>
            <xsd:deviceType>W?P%</xsd:deviceType>
        </xsd:RetrieveRuleList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:rule>
                        <ns:descr>testq awerqe</ns:descr>
                        <ns:deviceType>WOP-12ac-LR</ns:deviceType>
                        <ns:domain>root</ns:domain>
                        <ns:name>test1</ns:name>
                        <ns:params>
                            <ns:name>RadiusApSecret</ns:name>
                            <ns:value>eltex</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareName</ns:name>
                            <ns:value>version-6.6.6.tgz</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareUpdateProtocol</ns:name>
                            <ns:value>HTTP</ns:value>
                        </ns:params>
                        <ns:params>
                            <ns:name>ConfigurationTemplate</ns:name>
                            <ns:value>profile__40.23.cluster__eltex.org.xml</ns:value>
                        </ns:params>
                    </ns:rule>
                    <ns:rule>
                        <ns:descr>test1 asdf</ns:descr>
                        <ns:deviceType>WEP-12ac</ns:deviceType>
                        <ns:domain>enterprise.root</ns:domain>
                        <ns:name>test2</ns:name>
                        <ns:params>
                            <ns:name>RadiusApSecret</ns:name>
                            <ns:value/>
                        </ns:params>
                        <ns:params>
                            <ns:name>FirmwareUpdateProtocol</ns:name>
                            <ns:value>TFTP</ns:value>
                        </ns:params>
                    </ns:rule>
                </ns:response>
            </ns:return>
        </ns:RetrieveRuleListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.22-2494
Дата публикации 05-04-2022 04:47:30