Console utilities

Note

The priority of variables sources used in the operation of the console utility:

  1. Utility arguments;
  2. Previous saved session;
  3. Configuration file client.conf;
  4. Default values.

Console utilities are used for working with RSclient module in command line interface (CLI). General view of commands:

rs-client <subcommand>

Where <subcommand> is utility argument(s).

Utility arguments
Name Description Dependencies on other parameters
--help, -h Displaying help information for utility. It is used only alone.
--version Displaying module version. It is used only alone.
--no-ui Connection without graphical interface. When connecting, previously saved parameters will be used.

Arguments are available to override parameters:

  • --username USERNAME;
  • --password PASSWORD;
  • --project PROJECT;
  • --domain DOMAIN;
  • --server-uri SERVER_URI;
  • --connect CONNECT;
  • --store-session.
--username USERNAME Username. It is used only with --no-ui.
--password PASSWORD User password. It is used only with --no-ui.
--project PROJECT Project name. Optional parameter. It is used only with --no-ui.
--domain DOMAIN Domain name. Optional parameter (by default, default). It is used only with --no-ui.
--server-uri SERVER_URI The server address is either in the format of an IP address or in the format of a hostname. For example: localhost or 10.10.10.10. In case of using the HTTPS protocol, the server address must be specified in format https://<hostname>:<HTTPS port>. It is used only with --no-ui.
--connect CONNECT Modifying connection template where you can specify positional substitution of parameters. Optional parameter. It is used only with --no-ui.
--store-session

Changing the configuration of recording session parameters, there are the following:

  • True: saving parameters of each session (used by default);
  • False: deleting parameters of each session.
 It is used only with --no-ui.
--config-file The path to the configuration file. Optional parameter.  
--diagnostic Self-diagnosis utility launching. It is used alone and with --debug.
--debug Activation of the DEBUG mode when starting the client self-test. It is used only with --diagnostic.
--ikecfg IKE configuration. The parameter is used to support the protocol IKE (Internet Key Exchange).  
--rds Parameter that allows to override the IP address obtained from the Broker API service and connect to it.  

Example of running utility version check:

rs-client --version

Example of responce:

0.1.0

Example of running utility without GUI shell:

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

Note

When starting RSclient without a graphical shell with incorrect authorization data, the form for changing credentials is not provided!