Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This section describes shell tools required for the deployment management of the system. All these tools are shipped with part of the JeraSoft Billing distributive. You In order to use the tools you will need either SSH or direct access to the server in order to use them. Please notice that most console. Some of the given tools require root  access and show inline help when running without argumentspermissions to run.

Panel
borderColor#FFBABA
bgColor#FFBABA
borderWidth2px
borderStylesolid

Important!

Please use these tools only if you have a clear understanding of what you are doing. Misuse of the tools may cause improper functioning of the system.

...

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

To free our clients from confusion while trying to indicate a path to JeraSoft Billing system, we introduce the <VCSPlease note, for simplification we introduced <APP_PATH> variable that differs depending on refers to the JeraSoft Billing version:

  • <VCS_PATH> before version 3.13.0 is “/usr/local/vcs”
  • <VCS_PATH> after version 3.13.0 is “/opt/jerasoft/vcs”

/The example is as follows:
To restart RADIUS Server, you need to execute <VCSapplication files location. This location may differ, but typically it is "/opt/jerasoft/vcs". So whenever you see an example with path like "<APP_PATH>/bin/service bbradiusd restart, which will look like
/usr/local/vcs/bin/service bbradiusd restart for clients with VCS version 3.12.0 and lower orsystem/cluster" it means "/opt/jerasoft/vcs/bin/service bbradiusd restart for VCS version 3.13.0 and higher/system/cluster".

Requirements Checker

The tool is aimed to check minimal requirements and security recommendations at of your server before and after installation. 

Code Block
languagebash
titleUsage
<VCS<APP_PATH>/bin/system/setup-checker

The tool should be run under root permissions without any arguments. When the tool is run, it will perform a list of checks and show results for each of them. Use it:

...

requires root permissions and takes no arguments. It should be executed before installation of the system in order to check minimal hardware and software requirements

...

.

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

The tool checks only minimal requirements. Real hardware requirements highly depend on your traffic and deployment model.

Safety Checker

The tool is aimed to check configuration of the main server settings after installation.

Code Block
languagebash
titleUsage
<APP_PATH>/bin/system/security-checks

The tool takes no arguments. When executed it performs numerous checks for the correctness of the network and server configuration.

Services Manager

The tool is used for managing the JeraSoft Billing management of System Services. It allows to correctly start, stop , get status of the and perform other actions over various JeraSoft Billing Services such as RADIUS Server, SIP Server, Calculator, etc.

Code Block
languagebash
titleUsage
<VCS<APP_PATH>/bin/system/service <ACTION> [<service-name> <action>] [<options>]

The tool should be run under root or vcs user.  Service manager takes 2 arguments:The tool typically takes 2 arguments – action to perform and related system service. Actions prefixed with "all-*" do not require service name and operate over all services.

ActionDescription
<start>

Start System Service

Takes "--wait" argument in order to wait and exit only when service finishes its execution.

<action>

Action to perform, one of the following:

  • start - start the service
  • stop - stop the service
  • restart - stop and then start the service
  • reload - force config re-read without restart
  • status - return current status of the tool


ArgumentDescription
<service-name>
Short name of the service. Run the tool without arguments to get a list of the services at your system. 
<action>

Action to perform, one of the following:

  • start - start the service
  • stop - stop the service
  • restart - stop and then start the service
  • reload - force config re-read without restart
  • status - return current status of the tool

...