You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Вход админа в систему

По умолчанию пароль администратора : "admin".
После выполнения команды браузер автоматически сохраняет cookie с именем "gcccookie", в котором хранится токен авторизации.
Далее cookie автоматически отправляется браузером для всех последующих команд.

Авторизация не требуется. Входные параметры RAW JSON:

POST /v1.0/lm/login


{
   "loginPass" : "admin",
   "loginRememberMe" : tru
}

Смена пароля админа 


Авторизация требуется. Входные параметры RAW JSON:

POST /v1.0/lm/newpassword


{
   "newPassword" : "admin",
   "loginRememberMe" : true
}


Обновление токена авторизации

Авторизация требуется. Входных параметров нет

POST /v1.0/lm/refreshauthtoken


Выход  админа из системы

Авторизация требуется. Входных параметров нет

POST /v1.0/lm/logout

Обновление настроек

По умолчанию адрес сервиса активации для Guardant Station Cloud  https://getlicense.guardant.ru:443 , для Guardant Station Retail (BOX) https://localhost:9000

Сохраняются только настройки, которые присутствуют в запросе. Остальные настройки не меняются.


Описание параметров настроек

allowAutoDetach  - разрешить/запретить автоматическое открепление лицензий.
allowDetach - разрешить/запретить открепление лицензий.
autoRefreshLocalDonglesTimeout - таймаут автоматической загрузки лицензий из локальных ключей в память менеджера лицензий (в минутах).
autoRefreshRemoteDonglesTimeout - таймаут автоматической загрузки лицензий из ключей расположенных в локальной сети в память менеджера лицензий (в минутах).
broadcastRemoteLicenses - использовать широковещательный поиск.
getLicenseUrl - адрес сервера активации.
keepAlive - поддержка активности TCP включена или отключена.
keepAliveTime - указывает тайм-аут в миллисекундах без активности, пока не будет отправлен первый пакет проверки активности.
keepAliveInterval - указывает интервал в миллисекундах между отправкой последовательных пакетов проверки активности, если подтверждение не получено.
logLevel - текущий уровень логирования. По умолчанию используется уровень логирования NOTICE (5).
logRotationSize - максимальный размер файла лога (в мегабайтах).
logPurgeCount - количество хранимых файлов.
logAssociatedTags - шаблон строки для форматирования событий бизнес-логики при записи в лог.
logTags - массив имён допустимых тегов логирования с их описанием.
maxAutoDetachHours - максимальный период автоматического открепления лицензии в часах.
maxDetachDays - максимальный период открепления лицензии в днях.
offlineDetachAdminRequired - требовать авторизацию для открепления лицензии на другие компьютеры.
remotehosts - дополнительный список адресов для поиска лицензий.
showRemoteLicenses - показывать сетевые лицензии с других серверов в локальной сети.
showRemoteSessions - показывать сессии с других ПК в локальной сети.
useRemoteHosts - использовать дополнительный список адресов для поиска лицензий.
userRestrictionRules - правила ограничения доступа к лицензиям.

Детальная информация о некоторых параметрах


Уровни логирования позволяют выводить только сообщения с приоритетом, равным или выше указанного уровня. Наивысшем приоритетом является FATAL (1). Например, если уровень установлен на ERROR(3), то будут выводится только сообщения с приоритетом ERROR(3), CRITICAL(2) и FATAL(1). Если уровень установлен на ноль, то лог фактически выключен.

Доступны уровни логирования: 

  • FATAL (1)
  • CRTITCAL (2)
  • ERROR (3)
  • WARNING (4)
  • NOTICE (5)
  • INFORMATION (6)
  • DEBUG (7)
  • TRACE (8)

По умолчанию используется уровень NOTICE (5). На этом уровне  выводятся технические события GCC, такие как подключение / отключение ключей, активация новых лицензий, информация об оборудовании , открепление и возврат сетевых лицензий.  Уровень INFORMATION (6) позволяет выводить в лог помимо технических событий , также события бизнес-логики, такие как создание / закрытие сессий , информацию о параметрах вызова функций API. Уровни DEBUG (7) и TRACE (8) следует использовать только при возникновении каких-либо проблем с работой лицензий и сбора отладочной информации для разработчиков. Уровни FATAL (1), CRITICAL (2), ERROR(3) и WARNING (4) используется для вывода критически важных сообщений. 

Через WEB - интерфейс GCC можно переключаться между тремя уровнями логирования WARNING(4) , NOTICE (5)  и INFORMATION (6). Когда включен только переключатель "Технические события", то это соотвествует уровню NOTICE(5), если дополнительно включен переключатель "События бизнес -логики " ,то это соответствует уровню INFORMATION (6). Когда оба переключателя выключены, то устанавливается уровень WARNING (4). 

Каждое правило должно соответствовать следующему формату:


operator=[username][@hostname][,public:publicCODE][,license:licenseID][,product:productID][,feature:featureID]

operator  - следует указать allow (для разрешения доступа) или deny (для запрета доступа).
username - опционально. Имя пользователя для которого применяется правило доступа.
                   >  "*"  – означает все пользователи (значение по умолчанию).
                   >  Имя пользователя.
hostname - опционально. Имя машины для которой применяется правило. Введите следующие правила:
                   > "*" - означает все машины (значение по умолчанию).
                   > Имя хоста или IP адрес машины. 
                   > Маска подсети . Например 192.168.1.0/23
publicCode  - опционально. PUBLIC код вендора для которого применяется правило (по умолчанию все вендоры). 
license - опционально. Идентификатор лицензии для которой применяется правило (по умолчанию все лицензии).
product - опционально. Идентификатор продукта для которого применяется правило (по умолчанию все продукты).
feature - опционально. Идентификатор компонента для которого применяется правило (по умолчанию все компоненты).

Можно указывать несколько правил. Применяются все правила независимо от порядка их следования.
Если задать два взаимоисключающих условия, то приоритет за операцией allow.

Правила применяются только к новым сессиям, на ранее созданные сессии изменения в правилах доступа не распространяются.

Авторизация требуется. Входные параметры RAW JSON: 

PUT /v1.0/lm/settings


{
    "showRemoteLicenses" : "1",
    "broadcastRemoteLicenses" : 0,
    "remotehosts" : ["test-pc"],
    "useRemoteHosts": 1
}

Получение текущих настроек


GET /v1.0/lm/settings

Возвращает значение:

{
    "allowAutoDetach": 0,
	"allowDetach": 0,
    "autoRefreshLocalDonglesTimeout": 2,
    "autoRefreshRemoteHostsTimeout": 2,
    "broadcastRemoteLicenses" : 1,
    "getLicenseUrl": "https://getlicense.guardant.ru",
  	"keepAlive" : 1,
	"keepAliveTime" : 7200000,
	"keepAliveInterval" : 1000,
    "logAssociatedTags": "sessionid={sessionid} apiname='{apiname}' apiversion={apiversion} result='{result}' ip={clientaddr} user={clientid} licenseid={licenseid} productid={productid} featureid= 	{featureid} seats={seats}",
    "logLevel": 6,
    "logPurgeCount": 100,
    "logRotationSize": 1,
    "logTags": [
        {
            "description": "API function name",
            "name": "{apiname}"
        },
        {
            "description": "API version",
            "name": "{apiversion}"
        }
    ],
    "maxAutoDetachHours": 2,
    "maxDetachDays" : 10,
    "offlineDetachAdminRequire": 1,
    "remotehosts" : ["test-pc", "new-pc"],
    "showRemoteSessions" : 0,
    "showRemoteLicenses" : 0,
    "useRemoteHosts": 1,
    "userRestrictionRules": [
        "deny=*@b2291-pc",
        "allow=bma@b2291-pc,feature:0"
    ]
}

Сброс текущих настроек на значения по умолчанию


Авторизация требуется. Входные параметры RAW JSON: 

POST /v1.0/lm/settings/setdefault


По умолчанию адрес сервиса активации для Guardant Station Cloud  https://getlicense.guardant.ru:443 , для Guardant Station Retail (BOX) https://localhost:9000

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

Сброс текущих настроек логирования на значения по умолчанию


Авторизация требуется. Входные параметры RAW JSON: 

POST /v1.0/lm/settings/logtags/setdefault


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

Получение пользовательских настроек доступа


GET  /v1.0/lm/settings/user_restrictions?search=text_or_value_for_search

Доступен поиск по идентификатору лицензии, номеру продукта, имени продукта, номеру компонента, имени компонента, вендору, имени компьютера и имени пользователя.


Возвращает значение:

{
    "userRestrictions": [
        {
            "hostName": "b2291-pc",
            "rule": 0
        },
        {
            "featureName": "Главный уровень защиты",
            "featureNumber": 0,
            "hostName": "b2291-pc",
            "rule": 1,
            "userName": "bma"
        }
    ]
}


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

  • No labels