Section servers

Description

Server List.

The section contains a list of all servers of the current configuration and their parameters. Roles are not related to parameters. Binding of servers to sites and roles to servers is performed in the section structure.

Partition parameters

Table 1. Partition parameters
Specification Description

Key: name
Mandatory: yes
Default: — 

The site name specified when setting other configuration items.
CThe name of the troika, may consist of Latin letters and numbers, and must begin with a letter.
Short speaking values are recommended.

Key: logiface
Mandatory: yes
Default: "eth0"

The alias of the interface on the server on which the servershell node is raised is the server’s central node.

Key: ifaces
Mandatory: yes
Default: — 

IPv4 network interfaces available on the server.


[
{
"Key":"IPv4_Address", …​
}, ..
]
---
, where

  • Key – Interface alias used to specify interfaces when configuring roles;

  • IPv4_Address - IPv4 interface address. The addresses must be present on the server.

Key: descr
Mandatory: no
Default: — 

Server Description.
The default value is not set.

Key: erlangtcp
Mandatory: no
Default: 4369

Port for erlang virtual machine nodes to communicate with each other.
Must be the same across all configuration servers.

Key: nodesportrange
Mandatory: no
Default: 9310:90

The range of ports to be used for role nodes.
Format: PortFrom:PortCnt, where PortFrom is the initial port value, PortCnt is the number of ports.

Key: globalsharepath
Mandatory: no
Default: "/var/lib/era/files/globalshare"

Path to the globalshare directory on the server.
In case the parameter is not specified, the specified default path on the disk will actually be used.

Key: sitesharepath
Mandatory: no
Default: "/var/lib/era/files/siteshare"

Path to the siteshare directory on the server.
In case the parameter is not specified, the specified default path on the disk will actually be used.

Key: localpath
Mandatory: no
Default: "/var/lib/era/files/local"

Path to the local directory on the server.
In case the parameter is not specified, the specified default path on the disk will actually be used.

Key: syncrootpath
Mandatory: no
Default: "/var/lib/era/files/syncroot"

Path to the :SYNC directory on the server (synchronized by the fsync role and the application syncthing).
In case the parameter is not specified, the specified default path on the disk will actually be used.

Key: recstorepaths
Mandatory: no
Default: []

Enumeration of directories for storing call recordings on the current server.


[
{
"Key":"AbsPath", …​
}, …​
]
---
, where

  • Key – key used to specify paths on the server when configuring roles;

  • AbsPath – The absolute path on the server to the directory or its alias (for example, alias://paths/c).

Key: logging_default_level
Mandatory: no
Default: empty

Default logging level applied to nodes served on this server.

The current logging level of a specific node can be changed using the API and from the master domain administrator application. Such changes are reset when the corresponding node is restarted.

If no level is specified, the value of this parameter from configuration settings of the current site is applied.

Possible values:

  • CRASH

  • ERROR

  • WARNING

  • INFO

  • TRACE

  • DEBUG

Key: sip_stat_timeout_callinfo
Mandatory: no
Default: 1200

Storage time in seconds for call statistical information. Applies to monitoring requests /api/monitor/v1/trace/calls.
By default, data is saved for 20 minutes.
The longer the time - the longer in time from the moment of making a call the data can be provided by the monitoring request. At the same time, more RAM is required in the nodes of the cip alarm system.

If no value is specified, the value of this parameter from configuration settings of the current site is applied.

Possible values from 0 to 86400. 0 - no saving is performed.

Key: sip_stat_timeout_closure
Mandatory: no
Default: 12600

Time to store in seconds the statistical information about the mappings between Call-Id of phone calls of one session to calculate closures. It is used when building call diagrams.
Also stores information about Call-Id call relationships to system domains to enable diagramming in work domains on their own calls.
By default, data is saved for 3.5 hours.
The longer the time - the longer in time from the moment of making a call can be built closures and diagrams on SIP-signaling session. At the same time, more RAM is required in the SIP signaling nodes.

If no value is specified, the value of this parameter from the configuration settings of the current site is applied.

Possible values from 0 to 86400. 0 - no saving is performed.

Example of field value

{
  ...
  "servers": [
    {
      "descr": "Central server1. Srv2",
      "erlangtcp": 4369,
      "ifaces": [
        {
          "key": "eth0",
          "value": "192.168.0.124"
        }
      ],
      "logiface": "eth0",
      "name": "worksrv1",
      "recstorepaths": [
        {
          "key": "main5",
          "value": "alias://paths/h"
        },
        {
          "key": "main4",
          "value": "alias://paths/g"
        }
      ]
    },
    {
      "descr": "admin srv 101 ipshnik. Srv2",
      "erlangtcp": 4369,
      "ifaces": [
        {
          "key": "eth0",
          "value": "192.168.0.123"
        }
      ],
      "logiface": "eth0",
      "name": "lwm123",
      "recstorepaths": [
        {
          "key": "main4",
          "value": "alias://paths/f"
        }
      ],
      "sitesharepath": "alias://paths/e"
    },
    {
      "descr": "admin srv 101 ipshnik. Srv22222",
      "erlangtcp": 4369,
      "ifaces": [
        {
          "key": "eth0",
          "value": "192.168.0.127"
        }
      ],
      "logiface": "eth0",
      "name": "lwm101",
      "recstorepaths": [
        {
          "key": "main4",
          "value": "alias://paths/f"
        }
      ],
      "sitesharepath": "alias://paths/e"
    }
  ],
  ...
}