Команда show

Команда show выводит информацию об учетной записи, аналогичную таблице учетных записей

upmgr show [-i CLIENT_ID [-s SECTION_NAME]]

CLIENT_ID

уникальный идентификатор Клиента управления, может состоять из любых символов, за исключением следующих: \?/:”>*<|, не должен начинаться или заканчиваться символами пробел, табуляция или точка, и не должен быть равен “NUL” или “CON” или “PRN” или “AUX” или “COMx” или “LPTx”, где x [1..9];

Если не указывать ключ -i  выводится краткая информация обо всех профилях

При указании ключа -i  выводится расширенная информация для указанного управляемого VPN устройства.

SECTION_NAME

имя секции данных. Например, ”---VPN PRODUCT---”, ”---LSP---”, ”---LICENSE---” и т.п. 

Пример

upmgr show 

client01 active 0 3 enabled unknown 14/05/2012 00:21:38 40.0.0.101 none 

Команда create

Команда create позволяет создать новую учетную запись в консоли С-Терра КП

upmgr create -i CLIENT_ID -p PRODUCT_PKG [-g CLIENT_GROUP] [-s UPAGENT_SETTINGS] [-dev_pwd DEVICE_PWD]

PRODUCT_PKG

путь до профиля управляемого VPN устройства (.vpd файла), либо путь до инсталляционных файлов/инициализационных скриптов VPN продукта

CLIENT_GROUP

имя группы, к которой принадлежит учетная запись (формат SUB1/SUB2/NAME); 

UPAGENT_SETTINGS

имя файла, содержащего настройки Клиента управления

DEVICE_PWD

в данной версии не используется

Пример создания новой учетной записи с идентификатором “client02”, с именем инсталляционного файла продукта CSP VPN Server  “e:\share\test_pkg.exe”

upmgr create -i client02 -p e:\share\test_pkg.exe

Команда remove

Команда remove позволяет удалить учетную запись управляемого VPN устройства

upmgr remove -i CLIENT_ID

Пример удаления учетной записи с идентификатором “ client02”:

upmgr remove -i client02

Команда get

Команда get позволяет получить инсталляционные файлы/инициализационные скрипты для управляемого VPN устройства в указанную директорию

upmgr get -i CLIENT_ID -d PRODUCT_DIR [-s UPAGENT_SETTINGS] [-ask_user_mode ASK_USER_MODE] [-check_mode CHECK_MODE] [-notify_client_port NOTIFY_CLIENT_PORT][-cont_list CONTLIST_FILE][-vpndata ( current|last_noapplied )] [-token_type ( rutoken|etoken ) -token_lib_path TOKEN_LIB_PATH][-external_init_rng]

PRODUCT_DIR

директория, в которую будут сохранены инсталляционные файлы/ инициализационные скрипты для Клиента управления

UPAGENT_SETTINGS

файл с настройками Клиента управления.

Если он не указан будет использоваться конфигурационный файл по умолчанию (C:\Documents and Settings\All Users\Application Data\UPServer\csettings.txt)

ASK_USER_MODE

режим запроса подтверждения о применении обновления, устанавливаемый в пакете Клиента управления, может принимать значения:

auto - подтверждение запрашивается, если установлен S-Terra Client/CSP VPN Client (значение по умолчанию)

never  - подтверждение никогда не запрашивается

always - подтверждение запрашивается всегда.

Если значение другое, то оно трактуется как auto.

CHECK_MODE

режим проверки исполняемых модулей, подписанных ЭЦП, при получении обновления, может принимать значения:

<пустая строка> - исполняемые модули не проверяются

none  - исполняемые модули не проверяются

full - проверяются присланные в обновлении расширенные обновления и бинарные коды нового Клиента управления

Если значение отсутствует, то оно приравнивается к значению none

NOTIFY_CLIENT_PORT

сетевой порт, который Клиент управления будет использовать для обмена сообщениями с Сервером управления. Если он не указан, то будет использоваться порт, указанный в конфигурационном файле Клиента управления (по умолчанию порт 43011);

CONTLIST_FILE

файл, содержащий данные (имя и пароль) контейнера на Сервере управления, а также имя и пароль контейнера на управляемом VPN устройстве, куда будет скопирован переносимый контейнер. Файл имеет формат, например, cont.ini и содержит следующие поля:

[CONTAINER_<ID>]

SourceName=file_p15://XXXXXXXX

SourcePassword=1

DestinationName=file_p15://XXXXXXXXXXX

DestinationPassword=2 

-vpndata

опция выбора данных профиля управляемого VPN устройства:

current - профиль, соответствующий последнему примененному обновлению или, если таковых еще не было, заданному при создании учётной записи управляемого VPN устройства;

last_noapplied - последняя редакция профиля, даже если она еще не была выслана в обновлении.

-token_type

выбор типа токена доступные варианты: rutoken, etoken

TOKEN_LIB_PATH

путь до совместимой с токеном библиотеки, указывается, если выбран один из типов токенов

-external_init_rng

контейнер, содержащий файл с внешней гаммой для управляемого VPN устройства. Внешняя гамма представляет собой заранее сформированную последовательность случайных чисел и применяется для облегчения разворачивания и дальнейшего обслуживания СКЗИ, не имеющих аппаратных датчиков случайных чисел

Пример получения инсталляционных файлов/инициализационных скриптов для управляемого VPN устройства “client02”, c записью их в каталог “e:\share\#init\client02”, Клиенту управления никогда не запрашивать подтверждение о применении обновления и всегда проверять на ЭЦП присланные обновления:

upmgr.exe get -i client02 -d e:\share\#init\client02 -ask_user_mode never -check_mode full

Команда update

Команда update позволяет создать обновление на Сервере управления для управляемого VPN устройства

upmgr update -i CLIENT_ID [-p[d] PRODUCT_PKG] [-a UPAGENT_PKG] [-s UPAGENT_SETTINGS] [-sca (UPCACERTS_FILE|*)] [-e EXTENDED_DATA] [-date CREATION_DATE] [-time CREATION_TIME] [-use_vpnsync]

PRODUCT_PKG

путь до профиля управляемого VPN устройства (.vpd файла), либо путь до инсталляционных файлов/инициализационных скриптов VPN продукта

Если вместо ключа -p указать ключ -pd, то Клиенту управления будут пересылаться только данные, без бинарных кодов VPN продукта.

UPAGENT_PKG

директория, в которой размещен установочный файл Клиента управления (указывается, если получена новая версия Клиента управления от разработчика, текущая версия размещена в каталоге upagent)

UPAGENT_SETTINGS

имя файла, содержащего настройки Клиента управления

UPCACERTS_FILE|*

имя файла в формате PKCS#7 (.p7b) со списком СА сертификатов Сервера управления, которые передаются управляемому VPN устройству в составе обновления. Если передается один СА сертификат, то файл может быть с расширением .cer. Если нужно передать весь актуальный список СА сертификатов Сервера управления, то следует указать «*»

EXTENDED_DATA

каталог, в котором расположены расширенные данные и скрипты обновления

CREATION_DATE

CREATION_TIME

формат: dd/mm/yy, hh:mm 

дата и время, когда Сервер управления сформирует пакет обновления и сделает его доступным для скачивания Клиентом управления. Если указанное время уже прошло, то пакет обновления будет сформирован и открыт для скачивания сразу после создания обновления (если параметры не указаны, то используются текущая дата и время).

-use_vpnsync

опция используется при задании шаблона профиля для применения обновления к данным, полученным напрямую с управляемого VPN устройства 

Пример создания обновления для управляемого VPN устройства “client02” на основе профиля “e:\share\test_pkg.exe”:

upmgr update -i client02 -p e:\share\test_pkg.exe

Команда retry

Команда retry повторяет попытку применения неудачного обновления

upmgr retry -i CLIENT_ID

Пример повторения попытки применения неудачного обновления для управляемого VPN устройства “client02”:

upmgr retry -i client02

Команда clear

Команда clear позволяет отменить все непримененные и незавершенные обновления

upmgr clear -i CLIENT_ID [-force]

force 

флаг для команды clear, позволяющий произвести отчистку всех непримененных и незавершенных обновлений, не взирая на их статус. 

Пример удаления всех непримененных обновлений для управляемого VPN устройства “client02”:

upmgr clear -i client02 -force 

Команда disable

Команда disable блокирует все сетевые обмены Сервера управления с Клиентом управления

upmgr disable -i CLIENT_ID

Пример запрета всех сетевых обменов с Клиентом управления “client02”:

upmgr disable -i client02

Команда enable

Команда enable разрешает Серверу управления сетевые обмены с Клиентом управления

upmgr enable -i CLIENT_ID

Пример разрешения сетевых обменов Серверу управления с Клиентом управления “client02”:

upmgr enable -i client02

Команда set_group

Команда set_group позволяет изменить принадлежность учетной записи к группе

upmgr set_group -g CLIENT_GROUP {-i CLIENT_ID|-go OLD_CLIENT_GROUP}

CLIENT_GROUP 

имя группы, к которой будет принадлежать учетная запись (формат SUB1/SUB2/NAME)

OLD_CLIENT_GROUP

имя группы, к которой принадлежала учетная запись ранее(формат PARENT0/PARENT1[/NAME][*]);

Пример включения учетной записи “client02” в группу ’’Moscow/Office01’’:

upmgr.exe set_group -g Moscow/Office01 -i client02 

Команда set_prop

Команда set_prop добавляет описание учетной записи

upmgr set_prop  -i CLIENT_ID [-dev_pwd DEVICE_PWD] [-client_desc_f CLIENT_DESC_FILE] [-client_desc CLIENT_DESC] [-ex_var_file FILE]

DEVICE_PWD 

зарезервировано для будущих версий

CLIENT_DESC

произвольная строка для описания профиля, вносимая в поле Description

CLIENT_DESC_FILE

Если произвольная строка для описания профиля, вносимая в поле Description, сохранена в виде файла, то указывается путь до него

FILE

имя файла, в котором указаны строки с переменными и их значениями, которые передаются скрипту cook.bat при его запуске в процессе подготовки расширенного обновления. Формат строки: EX_имя_переменной=значение_переменной

Пример добавления в описание “client01” свойства «work_with_token» (может работать с токеном) со значением «eToken NG-FLASH».

upmgr.exe set_prop -i client02 -client_desc “в одной сети с client01” -ex_var_file “C:\Program Files\S-Terra\S-Terra KP\prop_client02.txt”

Команда show_cert

Команда show_cert запускает стандартную GUI программу операционной системы для отображения рабочего сертификата Сервера управления

upmgr show_cert

Пример показа рабочего сертификата Сервера управления:

upmgr show_cert

Команда renew_cert

Команда renew_cert запускает перевыпуск рабочего сертификата Сервера управления (начало срока действия сертификата - за день до текущей даты, время жизни сертификата - 1 месяц)

upmgr renew_cert [-expired_only]

-expired_only 

рабочий сертификат Сервера управления пересоздается, если у него истек срок действия

Пример пересоздания рабочего сертификата Сервера управления только в том случае, если у него истек срок действия. Ограничение для версий, младше 4.2: команда работает только для RSA-сертификатов, так как перевыпуск ГОСТ-сертификатов требует интерактивного участия администратора:

upmgr renew_cert -expired_only

Команда check_files

Команда check_files запускает проверку целостности файлов Сервера управления

upmgr check_files

check_files 

проверка целостности файлов Сервера управления 

Команда backup

Команда backup запускает процесс сохранения данных о Клиентах управления и настройках Сервера управления в файл. В процессе сохранения архивируются данные Сервера управления, кроме контейнеров с секретными ключами сертификатов Сервера управления и статистической информации о Клиентах управления, хранимой в базе данных статистики.

upmgr backup -f BACKUP_FILE_NAME [-i INC_BACKUP_FILE_NAME]

BACKUP_FILE_NAME 

имя основного файла для сохранения данных о Клиентах управления и настройках Сервера управления.

INC_BACKUP_FILE_NAME

имя инкрементального файла для сохранения данных о Клиентах управления и настройках Сервера управления.

Пример сохранения данных о клиентах управления и настройках Сервера управления:

upmgr.exe backup -f c:\backup01.bin 

Команда restore

Команда restore запускает процесс восстановления данных о Клиентах управления и настройках Сервера управления из файла. В процессе будут восстановлены данные Сервера управления, кроме контейнеров с секретными ключами сертификатов Сервера управления и статистической информации о Клиентах управления, хранимой в базе данных статистики

upmgr restore -f BACKUP_FILE_NAME [-i INC_BACKUP_FILE_NAME] [-d REMOVE_DIRECTORY]

BACKUP_FILE_NAME 

имя основного файла с данными о Клиентах управления и настройках Сервера управления.

INC_BACKUP_FILE_NAME

имя инкрементального файла для сохранения данных о Клиентах управления и настройках Сервера управления.

REMOVE_DIRECTORY

имя подлежащей удалению временной директории, в которую были сохранены файлы для восстановления

Пример восстановления данных Сервера управления из файла C:\backup01.bin:

upmgr.exe restore -f c:\backup01.bin