Команды для инициации подключения и отключения

При появлении задачи синхронизации, если на данный момент соединение не установлено, обработчик подключается к устройству, используя параметры подключения, затем выполняет команды, прописанные в параметре sa.terminal.connect. Далее выполняются команды синхронизации, возможно последовательно для нескольких договоров. Когда задания выполнены и новых нет в течении sa.batch.waitNext.millis, то происходит отключение от устройства, но перед этим выполняются команды, указанные в sa.terminal.disconnect. Перед самим отключением выполняется команда sa.terminal.exit (в отличие от sa.terminal.disconnect после этой команды нет ожидания ответа от устройства ).

Возможные наборы команд для событий

Для каждого события есть три набора команд: "перед вызовом обычного набора", "обычный набор", "после вызова обычного набора". Например, sa.terminal.serv.modify, sa.terminal.serv.modify.before, sa.terminal.serv.modify.after. Наборы команд .before и .after в основном предназначены для вызова других наборов команд и изменения логики работы, в зависимости от ситуации.

Также можно использовать отдельные наборы команд для разных типов сервисов. Для этого нужно использовать префикс sa.terminal.set.имя_набора_команд. и указать его типы сервисов в параметре sa.terminal.set.имя_набора_команд.servTypeIds:

Команды опций .serv.inetOption.x. и .connection.inetOption.x. автоматически наследуются для дочерних опций к опции с ID равным x.

Макросы

Макросы вызываются с помощью последовательности ${имямакроса()}. Внутри фигурных скобок может быть логическое выражение, однако в этом случае, оно должно быть оформлено как правильный java-код, например: ${(newState()==1)?'вкл':'выкл'}, ${(newState()==1&&oldState()!=1)?(connectionEnable()+optionsEnable()):''}.

Доступны следующие макросы:

• ip() - IP-адрес сессии или IP-адрес сервиса или начало диапазона IP-адресов сервиса;

• ipList() - список IP-адресов диапазона сервиса, через запятую с пробелом, например: 192.168.1.1, 192.168.1.2, 192.168.1.3, 192.168.1.4, 192.168.1.5, ... ;

• ipList(',') - список IP-адресов диапазона сервиса, через запятую, например: 192.168.1.1,192.168.1.2,192.168.1.3,192.168.1.4,192.168.1.5,... ;

• net() - подсеть сервиса в виде строки, например, 192.168.1.1/24;

• mask() - маска подсети сервиса, например, 24;

• netmask() - маска подсети сервиса, например, 255.255.255.0;

• netmaskWildcard() - wildcard подсети, например, 0.0.0.255;

• ipNetHostMin() - первый адрес подсети, например, 192.168.1.1;

• ipNetHostMax() - последний адрес подсети, например, 192.168.1.254;

• ipNetBroadcast() - 192.168.1.255;

• ipFrom() - первый адрес диапазона сервиса;

• ipTo() - последний адрес диапазона сервиса;

• contractId() - ID договора

• contractTitle() - название договора

• servId() - ID сервиса договора

• servTitle() - название сервиса договора

• servDeviceId() - ID устройства, к которому привязан сервис договора

• vlan() - VLAN сервиса

• svlan() - SVLAN устройства данного обработчика;

• svlan(id_устройства) - SVLAN устройства с указанным ID;

• svlan(servDeviceId()) - SVLAN устройства сервиса;

• iface() - интерфейс сервиса

• ifaceTitle() - название интерфейса сервиса

• ifaceTitleBeforeColon() - название интерфейса до символа ':'

• ifaceTitleAfterColon() - название интерфейса после символа ':'

• mac() - MAC-адрес, в виде 0a:1b:2c:3d:4e:5f

• macBytes() - MAC-адрес, в виде 0a1b2c3d4e5f

• macDoted() - MAC-адрес, в виде 0a1b.2c3d.4e5f

• identifier() - идентификатор сервиса

• servParam(имя_параметра) - параметр сервиса

• servParam(имя_параметра, значение_по_умолчанию) - параметр сервиса

• option() - возвращает активную опцию (используя фильтр sa.inetOption.root, если он установлен);

• option(id_опции) - возвращает активную опцию, которая будет потомком к указанной id_опции (т.е. таким образом можно отфильтровать до опции из определенной подгруппы);

• param(опция, имя_параметра, значение_по_умолчанию) - параметр конфигурации опции (или одного из предка опции, т.к. параметры наследуются) или значение_по_умолчанию, если опция==null или параметр в опции не указан;

• param(имя_параметра, значение_по_умолчанию) - параметр конфигурации устройства (или одного из предка устройства, т.к. параметры наследуются) или значение_по_умолчанию, если параметр в устройстве не указан;

• ipGate() - шлюз из IP-ресурса

• ipDns() - DNS из IP-ресурса

• ipSubnetMask() - маска подсети из IP-ресурса

• ipParam(имя_параметра) - параметр из конфигурации IP-ресурса

• deviceId() - ID устройства данного обработчика;

• deviceIP() - IP-адрес устройства (из поля Хост/порт) данного обработчика;

• deviceIP(id_устройства) - IP-адрес устройства (из поля Хост/порт) с указанным ID;

• deviceIdentifier() - идентификатор устройства данного обработчика;

• deviceIdentifier(id_устройства) - идентификатор устройства с указанным ID;

• deviceIdentifier(servDeviceId()) - идентификатор устройства сервиса;

• deviceAttr(id_атрибута) - значение атрибута устройства данного обработчика;

• deviceAttr(id_устройства, id_атрибута) - значение атрибута устройства с указанным ID;

• deviceAttr(id_устройства, id_атрибута, значение_по_умолчанию) - значение атрибута устройства с указанным ID, если значения нет - возвращается значение по умолчанию;

• connectionAgentDeviceId() - ID агентского устройства, к которому привязано соединение;

• connectionDeviceId() - ID устройства, к которому привязано соединение;

• translit(строка) - транслитерированное значение агрумента;

• format(шаблон, арг1, ...) - форматирование, используя java.text.MessageFormat.format(String, Object...);

• now() - текущее время, например, ${format('{0,date,yyyy}', now())} ;

• nowString() - текущее время, в формате dd.MM.yyyy HH:mm:ss ;

• setEndSequence(строка) - установка последовательности для ожидания приглашения ввода новой команды;

• newState() - новое (требуемое) состояние сервиса/сессии;

• oldState() - старое (текущее) состояние сервиса/сессии;

• skipIfEmpty(val) - пропускает выполнение команды, если val - null или пустая строка;

• skipIf(val) - пропускает выполнение команды, если val - true;

• mikrotikLastIds() - результаты вызова предыдущей команды (для Mikrotik, все параметры id, через запятую)

• loopServ(имя_параметра_шаблона_команды, использовать_в_цикле_родительский_сервис, выполять_как_отдельную_команду_или_построить_строку) - способ выполнения команд с использованием дочерних сервисов; выполняется цикл для всех дочерних сервисов, а также для родительского, если второй агрумент равен true; шаблоном команды является значение параметра, имя которого прописано в первом агрументе; выполняются как отдельные команды (true) или возвращается конкатенированная строка с указанным разделителем

  m_ipLoop=${net()}

  sa.commandSet.staticIP.serv.create.1=/queue/simple/remove\n=numbers=${contractId()}:${servId()}

  sa.commandSet.staticIP.serv.create.2=/queue/simple/add\n=name=${contractId()}:${servId()}\n=target=127.0.0.1/32,${loopServ('m_ipLoop', false, ',')}

Вызовы других наборов команд через макросы

Для каждого события есть три набора команд: "перед вызовом обычного набора", "обычный набор", "после вызова обычного набора". Например, sa.terminal.serv.modify, sa.terminal.serv.modify.before, sa.terminal.serv.modify.after. Наборы команд .before и .after предназначены в основном для вызова других наборов команд и изменения логики работы, в зависимости от ситуации. Например, стандартная предопределенная конфигурация выглядит так:

Макросы serviceEnable(), serviceDisable(), connectionEnable(), connectionDisable(), connectionClose(), optionsEnable(), optionsDisable() вызывают соответствующие наборы команд. optionsSwitch() - вызывает наборы команд на отключение для старых опций и включение для новых. newState() и oldState() возвращают текущее и новое состояние сервиса или соединения, значения -1 - удален (для сервиса), 0 - отключен, 1 - включен.

Новый режим

Для управления с помощью Mikrotik API нужно указать:

Для управления с помощью Mikrotik API-SSL нужно указать:

В обоих случаях используется библиотека mikrotik-java. Она поддерживает как api так и api-ssl. Синтаксис несколько отличается от того, который описан в протоколе Mikrotik, примеры можно посмотреть здесь: https://github.com/GideonLeGrange/mikrotik-java.

Пример конфигурации:

Еще пример:

Старый режим

Так же есть вот такой режим работы:

sa.terminal.protocol=mikortik

Это тоже протокол Mikrotik API, но другой синтакс команд в конфигурации. В данный момент он объявлен устаревшим и возможно будет удален в следующих версиях. Не рекомендуем его использовать.

Здесь команды задаются немного другим образом: