SyncSSID - запустить асинхронный процесс исправления привязок в EMS.
Общая информация
-
Команда актуальна, начиная с версии 1.19
-
Команда предназначена для запуска асинхронных задач по исправлению привязок для указанного SSID. При указании SSID, домена запускается синхронизация всех привязок этого SSID. Для того чтобы запустить исправление только одной привязки, необходимо указать NAS Key (ключ привязки SSID).
-
Чтобы проверить статус процесса синхронизации в EMS, используйте команду GetAsyncProcessStatus
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата |
|---|---|---|---|
ssidName |
Имя SSID |
^[ a-zA-Z0-9_\-\.!]{1,32}$ |
Строка соответствующая регулярному выражению из колонки формат значения |
ssidDomain |
Домен SSID |
FQDN |
Домен в формате FQDN |
nasKey |
Опциональный параметр, ключ привязки SSID |
^([0-9a-fA-F]{2}[:-]){0,5}([0-9a-fA-F]{2})$ или (?=^.{1,235}$)(^((?!-||.(__|--).)[a-zA-Z0-9-]{1,63}.)((?!-|_|.(_|--).*)[a-zA-Z0-9-]{1,63})$) |
MAC-адрес или префикс MAC-адреса, домен или вложенный домен (например, '.test.root') |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
taskId |
Идентификатор созданной асинхронной задачи |
Положительное целое число или несколько чисел |
code |
Код ответа |
Целое неотрицательное число. |
detail |
Пояснение к ответу |
Текст английскими буквами с пробелами и спецсимволами. |
Примеры команд и кодов
| Код | Описание |
|---|---|
0 |
Успешно |
3 |
Ошибка от сервиса NBI EMS |
7 |
Не найден обязательный параметр запроса 'ssidDomain' |
8 |
Нет домена или домен не соответствует правилам |
10 |
Домен роли не имеет прав на домен SSID |
16 |
SSID не существует |
18 |
В конфигурации неверно настроен адрес EMS NBI или он недоступен |
62 |
Домен не зарегистрирован |
227 |
Имя SSID не задано или не удовлетворяет требованиям |
Пример использования
Запрос
Запуск синхронизации всех привязок SSID SSID_TEST_LINKS@root.
<soapenv:Body>
<soapenv:Body>
<nbi:SyncSSID>
<nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
<nbi:ssidDomain>root</nbi:ssidDomain>
</nbi:SyncSSID>
</soapenv:Body>
</soapenv:Body>
Ответ
<soapenv:Body>
<ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
<ns:return xsi:type="ax21:NbiTaskIdListResponse">
<ax21:code>0</ax21:code>
<ax21:detail>Success</ax21:detail>
<ax21:taskId>4</ax21:taskId>
<ax21:taskId>5</ax21:taskId>
</ns:return>
</ns:SyncSSIDResponse>
</soapenv:Body>
Запрос
Запуск синхронизации привязки SSID SSID_TEST_LINKS@root в домене ap.root.
<soapenv:Body>
<soapenv:Body>
<nbi:SyncSSID>
<nbi:ssidName>SSID_TEST_LINKS</nbi:ssidName>
<nbi:ssidDomain>root</nbi:ssidDomain>
<nbi:nasKey>ap.root</nbi:nasKey>
</nbi:SyncSSID>
</soapenv:Body>
</soapenv:Body>
Ответ
<soapenv:Body>
<ns:SyncSSIDResponse xmlns:ns="http://nbi.radius.eltex.org">
<ns:return xsi:type="ax21:NbiTaskIdListResponse">
<ax21:code>0</ax21:code>
<ax21:detail>Success</ax21:detail>
<ax21:taskId>9</ax21:taskId>
</ns:return>
</ns:SyncSSIDResponse>
</soapenv:Body>
См. также
Вернуться к списку команд
Версия 1.26-3099
Дата публикации 18-05-2023 06:44:06