Синтаксис команды:

Aladdin.JAS.Agent.Terminal <команда> [[<параметр>] [<ключ>] [<аргумент>]] ... [[<параметр>] [<ключ>] [<аргумент>]]

Для получения справки из консоли следует ввести следующую команду:

Aladdin.JAS.Agent.Terminal --help

Ключ --help работает на всех уровнях вложенности команд консольного агента (т.е. его можно использовать также после команды или параметра), например:

Aladdin.JAS.Agent.Terminal server initialize --help

Полный перечень команд, параметров и ключей консольного агента приведен ниже.

Команда

licenses (просмотр лицензий JAS/JMS)

Параметр

Описание

list

Выводит информацию о текущих зарегистрированных лицензиях.

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

Aladdin.JAS.Agent.Terminal licenses list

Пример вывода:

 

Примечание. Полное управление лицензиями JMS/JAS доступно в аналогичной команде консольного агента Aladdin.JAS.Agent.Terminal, см. Часть 1 Руководства администратора [2], раздел «Приложение 2. Справочник команд консольного агента Aladdin.EAP.Agent.Terminal»

Команда

server (управление сервером JAS)

Параметр

Описание

status

Вывод текущего статуса сервера. (Не требует ключей.)

Пример вывода:

·   start

·   stop

·   pause

·   continue

Управление статусом сервера. (Не требует ключей.)

·   start – запуск сервера

·   stop – остановка сервера

·   pause – приостановление работы сервера

·   continue – восстановить работу сервера после установки на паузу

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

Aladdin.JAS.Agent.Terminal server stop

Пример вывода:

 

initialize

Инициализирует сервер JMS: выполняет последовательную настройку всех параметров конфигурации сервера JMS, определенную в ini-файле конфигурации (передается в параметре ключа -p). Пример ini-файла см. в разделе «Подготовительные действия», с. 19.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   -p (обязательный) – файл (.ini) конфигурации сервера JAS вместе с путём в файловой системе.

·   -t (опциональный) -- значение таймаута для операций запуска/остановки сервера в миллисекундах.

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

sudo Aladdin.JAS.Agent.Terminal server initialize -p /mnt/hgfs/SmolenskShared/jas_conf.ini -t 120000

password

Выполняет установку мастер-пароля БД JAS.

Инициализирует сервер JMS: выполняет последовательную настройку всех параметров конфигурации сервера JMS, определенную в ini-файле конфигурации (передается в параметре ключа -p). Пример ini-файла см. в разделе «Подготовительные действия», с. 19.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --value – значение пароля.

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

sudo Aladdin.JAS.Agent.Terminal server password --value ‘ZXasqw12!@ZXasqw12!@’

autostart

Используется для управления автостартом сервиса сервера JAS:

Aladdin.JAS.Agent.Terminal server autostart enable - включает автостарт

Aladdin.JAS.Agent.Terminal server autostart disable - отключает автостарт

config show

Выгружает текущие настройки сервера JAS по каждому из компонентов. На входе передается имя каталога, в который будет выгружена конфигурация. Если каталог не существует – он будет создан, если какой-то из файлов конфигурации уже существует на диске – он будет обновлен. Конфигурация выгружается в формате JSON

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

Aladdin.JAS.Agent.Terminal server config show --path /tmp/jas_config

Пример выдачи:

 

Настройки выгружаются в файлы:

·   BusinessLogic.json

·   CertificateValidator.json

·   JournalingManager.json

·   NotificationManager.json

·   SyslogManager.json

config upload

Активация расширенных настроек JAS из файла. За одно выполнение команды можно задать настройки одного или нескольких компонентов.

Ключи:

·   -b         — путь к загружаемому файлу настроек аутентификации, U2F, TFL;

·   -c          — путь к загружаемому файлу настройки сертификатов для U2F;

·   -j          — путь к загружаемому файлу настройки журналирования аутентификации;

·   -n         — путь к загружаемому файлу настройки профилей Messaging-транспорта;

Примечание. Ключ -n не рекомендуется использовать для настройки профилей Messaging-транспорта. Для конфигурирования Messaging-транспорта используйте команду sms, подробнее см. «Порядок настройки транспорта для работы с Messaging-токенами», с. 24);

·   -s          — путь к загружаемому файлу настройки Syslog.

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

Aladdin.JAS.Agent.Terminal server config upload -b /tmp/jas_config/BusinessLogic.json -c /tmp/jas_config/CertificateValidator.json -j /tmp/jas_config/JournalingManager.json -n /tmp/jas_config/NotificationManager.json -s /tmp/jas_config/SyslogManager.json

Формат и назначение конфигурационных файлов приведены в разделе «Приложение 3. Справочник конфигурационных файлов JAS», с. 137.

Команда

sms

Параметр

Описание

savedefault

Команда по получению (выгрузке в виде файла) конфигураций по умолчанию для трёх типов messaging-транспорта (транспорта для отправки SMS-сообщений пользователям):

·   Offline -- сохранение сообщений в локальную папку для отладки сервиса;

·   HTTP – HTTP-транспорт для взаимодействия с SMS-шлюзом.

Ключи:

·   -t          — один из типов транспорта (Offline и HTTP, значения могут быть указаны без учёта регистра);

·   -p         — путь сохранения конфигурационного файла.

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

Aladdin.JAS.Agent.Terminal sms savedefault -t offline -p /mnt/ hgfs/ShareVM/offline_default.json

Формат файла конфигураций см. в разделе «Приложение 3. Справочник конфигурационных файлов JAS», с. 137

register

Регистрирует указанный профиль для SMS-транспорта

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   -p или --path (обязательный) – указывается файл конфигурации профиля транспорта.

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

sudo Aladdin.JAS.Agent.Terminal sms register -p /mnt/hgfs/ShareVM/jas_http_config_1.json

Пример выдачи:

 

list

Отображает зарегистрированные профили SMS-транспорта. Каждый профиль отображается с присвоенным ему индексом (номером).

Активный профиль выделяется знаком [*].

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

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

sudo Aladdin.JAS.Agent.Terminal sms list

Пример выдачи:

 

setactive

Устанавливает активный профиль SMS-транспорта по указанному индексу (номеру).

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --index (обязательный) – укажите индекс (номер) профиля, выбрав один из индексов, полученный с помощью команды sms list (см. выше).

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

sudo Aladdin.JAS.Agent.Terminal sms setactive --index 2

Пример выдачи:

 

remove

Удаляет профиль SMS-транспорта по указанному имени профиля.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --name (обязательный) – укажите имя профиля, как оно указано в выдаче команды sms list (см. выше).

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

sudo Aladdin.JAS.Agent.Terminal sms remove "Профиль Http-транспорта"

Пример выдачи:

 

test

Отправляет тестовое SMS-сообщение на указанный телефон по указанному имени профиля.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --phone (обязательный) – укажите номер телефона, по которому следует отправить тестовое сообщение.

·   --name (обязательный) – укажите имя профиля, как оно указано в выдаче команды sms list (см. выше).

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

sudo Aladdin.JAS.Agent.Terminal sms test --phone 89101111111 --name "Профиль Http-транспорта"

Пример выдачи:

 

Команда

ssl (настройка SSL для API-интерфейсов AdministrationService и AuthenticationService)

Параметр

Описание

show

Отображает текущую конфигурацию SSL для интерфейсов AdministrationService и AuthenticationService.

Например:

sudo Aladdin.JAS.Agent.Terminal ssl show

Пример выдачи:

 

enable

Позволяет активировать SSL для интерфейсов AdministrationService и AuthenticationService.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --path – путь к файлу сертификата для SSL;

·   --password – пароль от указанного сертификата;

·   --thumbprint – отпечаток сертификата;

·   --api – тип API: административный – admin, аутентификация – auth, оба – all (по умолчанию)

Для активации SSL требуется указать либо путь к файлу сертификата и пароль от контейнера сертификата, либо указать отпечаток уже зарегистрированного в хранилище сертификата.

Например:

sudo Aladdin.JAS.Agent.Terminal ssl enable --path /home/user/Desktop/jas1.jms4.local.pfx --password P@ssw0rd! --api admin

Пример выдачи:

 

disable

Позволяет отключить SSL для интерфейсов AdministrationService и AuthenticationService.

  Важно! Для своего выполнения команда требует повышения привилегий пользователя с помощью sudo.

Ключи:

·   --api – тип API: административный – admin, аутентификация – auth, оба – all (по умолчанию)