Консольные утилиты

Примечание

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

  1. Аргументы утилиты;
  2. Предыдущая сохраненная сессия;
  3. Конфигурационный файл client.conf;
  4. Значения по умолчанию.

Консольные утилиты используются для работы с модулем RSclient в интерфейсе командной строки (CLI). Общий вид команд:

rs-client <subcommand>

Где <subcommand> - аргумент(ы) утилиты.

Аргументы утилиты
Параметр Описание Зависимости от других параметров
--help, -h Вывод справочной информации по утилите. Используется только самостоятельно.
--version Вывод версии модуля. Используется только самостоятельно.
--no-ui Подключение без графического интерфейса. При подключении будут использоваться ранее сохраненные параметры.

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

  • --username USERNAME;
  • --password PASSWORD;
  • --project PROJECT;
  • --domain DOMAIN;
  • --server-uri SERVER_URI;
  • --connect CONNECT;
  • --store-session.
--username USERNAME Имя пользователя. Используется только в сочетании с --no-ui.
--password PASSWORD Пароль пользователя. Используется только в сочетании с --no-ui.
--project PROJECT Наименование проекта. Необязательный параметр. Используется только в сочетании с --no-ui.
--domain DOMAIN Имя домена. Необязательный параметр (по умолчанию, default). Используется только в сочетании с --no-ui.
--server-uri SERVER_URI Адрес сервера либо в формате IP-адреса, либо в формате имени хоста. Например: localhost или 10.10.10.10. В случае использования протокола HTTPS, адрес сервера требуется указывать в формате https://<имя хоста>:<порт HTTPS>. Используется только в сочетании с --no-ui.
--connect CONNECT Изменение шаблона для подключения, в котором можно указать позиционное подставление параметров. Необязательный параметр. Используется только в сочетании с --no-ui.
--store-session

Изменение настройки записи параметров сессии, различаются:

  • True: сохранение параметров каждой сессии (используется по умолчанию);
  • False: удаление параметров каждой сессии.
 Используется только в сочетании с --no-ui.
--config-file Путь до файла конфигурации. Необязательный параметр.  
--diagnostic Запуск самодиагностики утилиты. Используется самостоятельно и в сочетании с --debug.
--debug Активация режима DEBUG при запуске самодиагностики клиента. Используется только в сочетании с --diagnostic.
--ikecfg Конфигурация IKE. Параметр используется для поддержки протокола IKE (Internet Key Exchange).  
--rds Параметр, позволяющий переопределить IP-адрес, полученный от службы Broker API и подключиться к нему.  

Пример запуска проверки версии утилиты:

rs-client --version

Пример ответа:

0.1.0

Пример запуска утилиты без GUI оболочки:

rs-client --no-ui --username admin --password 123456 --project default

Примечание

При запуске RSclient без графической оболочки с неверными авторизационными данными запуск формы смены учетных данных не предусмотрен!