Redundancy
The Redundancy menu is for editing, settings, and managing features of Auto Sync, Mirroring, and Heartbeat.
Thoses features provide High Availability (HA) functions and keep your SIP service alive.
Auto Sync
With Auto Sync feature, the changes of User Authentication accounts on primary server will be auto synchronized on secondary server.
Primary Server Settings
| Field Name | Explanation |
| Remote IP Address Filter | The remote Brekeke SIP Server IP address pattern to which userver authentication accounts update will be sent
Regular expression can be used to define remote server IP pattern |
Set up this field when Brekeke SIP Server mirroring role is “primary”
Secondary Server Settings
| Field Name | Explanation |
| URL of Primary Serve | URL of primary Brekeke SIP Server
Format: http://<primary_server_IP>:<port>/sip/ |
Set up this field when Brekeke SIP Server mirroring role is “secondary”
Mirroring
The Mirroring feature requires two Brekeke SIP Server Advanced Editions called the Primary server and the Secondary server (as a backup server). With this feature, the Primary server can mirror its SIP session data and registration data to the Secondary server in real-time and the Secondary server can take over the service with the mirrored data if the Primary server goes down.
Note: The Mirroring feature is available in the Advanced Edition only.
Server Status
If the server is inactive, “INACTIVE” will be shown. If the Mirroring Mode is disabled even if the server is active, “Disabled” will be shown. Otherwise, the following information will be shown.
| Field Name | Explanation |
| mirroring-role | Either “primary” or “secondary”. The Primary server provides the service while the Secondary server receives mirrored data. |
| mirroring-address | It is the shared IP address between the Primary server and Secondary server. Users of the service need to use this IP address as a proxy and registrar. |
| mirroring-pair | These are the pair’s IP addresses. For the Primary server, the secondary’s IP address should be set. For the Secondary server, the primary’s IP address should be set. |
Mirroring Settings
| Item | Default value | Explanation |
| On/Off | off | When set to “on”, the Mirroring Mode is enabled. |
| Role | secondary | When set to “primary”, the server works as the Primary server. When set to “secondary”, the server works as the Secondary server. |
| Virtual IP Address | It is the shared IP address between the Primary server and Secondary server. Users of the service need to use this IP address as a proxy and registrar.
This IP address should be unique and accessible to users. |
|
| Pair IP Address | These are the pair’s IP addresses. For the Primary server, the Secondary server’s IP address should be set. For the Secondary server, the Primary server’s IP address should be set. | |
| Mirroring Request Pattern | This defines a packet pattern for mirroring. With this setting, the Primary server mirrors only specified packets to the Secondary server. The blank means any SIP packets.
For example: |
| Button | Explanation |
| Save | Save changes |
| Update | Switch role setting after failover has happened to update Brekeke SIP Server mirroring role to recent one without restart server. |
Heartbeat
This section shows current Heartbeat settings and its actions and allows an administrator to add/edit them. Multiple Heartbeats can be defined and each Heartbeat can have multiple actions. Changes take effect when the Heartbeat feature is restarted.
Please refer to the sections “Heartbeat Settings” and “Action Settings” for more details.
Heartbeat Status
The list shows status of Heatbeats.
Auto Start
If the checkbox has been selected, heartbeat will start automatically at the time Brekeke SIP Server starts up.
Heartbeat Settings
It shows configred Heartbeats and actions. These actions are executed when the Heartbeat feature detects a target is down.
| Button | Explanation |
 Delete |
Delete the action |
| New Heartbeat | Add new Heartbeat setting. Please refer to “3.8.10. Heartbeat Settings” |
| Add Action | Add new action setting. Please refer to “3.8.11. Action Settings” |
| Delete Heartbeat | Delete the Heartbeat setting. |
Remote Access
The server accepts an action request only from the remote IP addresses defined in the IP Address Pattern. If this is undefined, the server accepts action requests from any remote IP address.
| Field Name | Explanation |
| IP Address Pattern | Desired remote IP address pattern defined by Regular Expressions. |
[New Heartbeat]
Heartbeat Settings page allows an administrator to define and edit Heartbeat settings. Changes take effect when the Heartbeat feature is restarted.
Heartbeat – (Monitoring Method = Network)
| Item | Default value | Explanation |
| Monitoring Method | Network | Heartbeat will monitor Network connection status to the target IP |
| IP Address | IP address of the target entity. | |
| Timeout | 3000 | After the timeout period expires without any response from the target entity, specified actions will be executed. [milliseconds] |
| Interval | 500 | Broadcast interval for ICMP packet
[milliseconds] |
| Retry | 2 | Maximum retries for ICMP packet |
Heartbeat – (Monitoring Method = SIP)
| Item | Default value | Explanation |
| Monitoring Method | SIP | Heartbeat will monitor SIP connection status to the target SIP URI |
| SIP URI | Target SIP URI | |
| Interval | 10000 | Time interval for sending SIP packet to target SIP URI
[milliseconds] |
| Response Codes | Response codes which will trigger heartbeat failure
By default setting, heartbeat fails on no response. |
| Button | Explanation |
| Save | Save changes and return to the previous page. |
| Cancel | Cancel changes and return to the previous page. |
[Add Action]
There are several action types which may be launched when the Heartbeat feature detects a target entity failure. Changes take effect when the Heartbeat feature is restarted.
| Type | Explanation |
| Send Email | Send a notification e-mail to the specified e-mail address. |
| Re-initialize as primary | Re-initialize the server as the Primary server |
| Add IP Address (Linux/Win) | Add an interface IP address |
| Delete IP Address (Linux/Win) | Delete an interface IP address |
| Execute Command | Execute an external command |
| Management Command | Execute an internal server management command |
Send Email
Send a notification e-mail to the specified e-mail address when the Heartbeat feature detects a target entity failure.
| Item | Default value | Explanation |
| Type | Send Email | Send a notification e-mail to the specified e-mail address. |
| Position | The operation order | |
| To | Receiver’s e-mail address. | |
| From | Sender’s e-mail address. | |
| Subject | E-mail subject | |
| Body | E-mail body | |
| SMTP Server | SMTP Server’s address and port | |
| POP3 Server | POP Server’s address and port
(If the SMTP server requires POP before SMTP.) |
|
| User | User Name | |
| Password | Password | |
| SMTP authentication | off | If the SMTP server requires an authentication, please set to “on”. |
| Encrypted Connection (SSL) |
off | If the SMTP server requires a SSL connection, please set to “on”. |
- From v3.6, The fields for connecting to mail server are divided from “Heartbeat Settings” section and they are put under the “Email” menu.
Re-initialize as primary
Re-initialize the Brekeke SIP Server as the Primary server when the Heartbeat feature detects a target entity failure. This action is used by the Secondary server when the original Primary server goes down.
| Item | Default value | Explanation |
| Type | Re-initialize as primary | Re-initialize the server as the Primary server |
| Position | The operation order | |
| Remote URL | The URL address of the desired server in which you want to execute the action.
Please leave blank if the remote server is localhost. |
Add IP Address
Add an interface IP address in the Brekeke SIP when the Heartbeat feature detects a target entity failure. Generally, this action is used to add the Virtual IP address defined in the Mirroring settings of the Secondary server when the original Primary server goes down.
| Item | Default value | Explanation |
| Type | Add IP Address (Linux/Win) | Add an interface IP address |
| Position | The operation order | |
| Interface Name | Name of the interface on the desired server which you want to execute the action.
(for example, “Local Area Connection”, or “eth0”) |
|
| IP Address | IP address | |
| Subnet mask | Subnet Mask | |
| Remote URL | The URL address of the desired server which you want to execute the action.
Please leave blank if the remote server is localhost. |
Delete IP Address
Delete an interface IP address from Brekeke SIP Server when the Heartbeat feature detects a target entity failure.
| Item | Default value | Explanation |
| Type | Delete IP Address (Linux/Win) | Delete an interface IP address |
| Position | The operation order | |
| Interface Name | Name of the interface on the desired server which you want to execute the action. | |
| IP Address | IP address | |
| Subnet mask | Subnet Mask | |
| Remote URL | The URL address of the desired server in which you want to execute the action.
Please leave blank if the remote server is localhost. |
Execute Command
Execute an external command when the Heartbeat feature detects a target entity failure.
| Item | Default value | Explanation |
| Type | Execute Command | Execute an external command |
| Position | The operation order | |
| Command | Command name and its parameters | |
| Remote URL | The URL address of the desired server in which you want to execute the action.
Please leave blank if the remote server is localhost. |
Management Command
Execute an internal server management command at the Brekeke SIP Server when the Heartbeat feature detects a target entity failure.
| Item | Default value | Explanation |
| Type | Management Command | Execute an internal server management command |
| Position | The operation order | |
| Target Address | ||
| Parameters | Command name and its parameters | |
| Text | ||
| Remote URL | The URL address of the desired server in which you want to execute the action.
Please leave blank if the remote server is localhost. |
Script
Execute a specified script.
| Item | Default value | Explanation |
| Type | Script | Execute a script. |
| Position | 2 | The operation order |
| Script | Script |