Fortinet Document Library

Version:

Version:

Version:

Version:

Version:


Table of Contents

FortiVoice Phone System Administration Guide

Configuring local survivability

FortiVoice local survivability solution is designed to provide branch resiliency for centralized deployments with multi-sites. The FortiVoice unit at the central office sends the configuration files to the FortiVoice units and extensions at the branch offices. The central office handles all inbound calls thereby consolidating the number of lines required for an organization.

With this solution, you have one place to look for the routing rules, logs, call records, and call recordings. You can see the whole setup, make changes, or modify records on the fly. If an extension is added, it is operational immediately. Any users at any location will be able to call that new extension right away without waiting for configurations to sync up, or new policies required to be set at each location.

If the communication between the FortiVoice unit at the central office and the FortiVoice units and extensions at the branch offices is down, the FortiVoice units at the branch offices (survivability branches) will kick in to provide access to lines until the communication is restored between the central unit and the extensions.

A survivability branch is a local FortiVoice unit containing local extensions that is part of a centralized deployment.

FortiVoice models 300E and up and FortiVoice VM models 500 and up provide central management.

FVE-20E2, FVE-20E4, FVE-50E6, FVE-200F8, FVE-500F, and GS16 can serve as local survivability (survivability branch) models.

FVE models and supported number of survivability branches

 

FVE Model

Number of gateways supported

300E

10

VM500

15

500E & 500F

15

1000E & VM1000

20

200D

20

2000E, 2000F & VM2000

40

3000E & VM3000

40

5000F & VM5000

100

VM10000

100

VM50000

200

This topic includes:

Local survivability deployment

Follow these recommended general steps to deploy your local survivability network:

  • Set up HA on the central unit

    It is important to get your HA up and running and the correct virtual IP set as it is used throughout the local survivability setup. For information on setting up HA, see Using high availability.

  • Add or import extensions to the central unit

    Once each branch unit has been added, you can add or import their extensions to the central unit. For more information, see Configuring IP extensions.

  • Add and configure each branch unit:
  • Apply branch configuration from central unit

    Once the branch unit is set to the correct IP address, you can apply the configuration from the central system to each branch. See Adding, configuring, and viewing survivability branches.

  • Add phones to network at branch offices

    Once the branch unit has received the configuration file, add the phones to the network. They will automatically detect the branch unit and be redirected to the central office to get their configuration file.

    Note

    Adding the phones to the network too early will result in receiving an unassigned phone configuration file from the branch system. The phones need to be set to factory default for them to go to the central unit to get their configuration file.

Adding, configuring, and viewing survivability branches

Managed System > Survivability > Survivability Branch allows you to view and add survivability branches.

To view the list of added survivability branches

  1. Go to Managed System > Survivability > Survivability Branch.

GUI field

Description

Apply configuration

Select a branch FortiVoice unit from the list and click this option to apply the FortiVoice configuration file to this branch unit and reboot the unit immediately.

View configuration

Select a branch FortiVoice unit from the list and click this option to display the configuration file applied to this unit.

Fetch Device Info

Select a branch FortiVoice unit from the list and click this option to retrieve its information.

Upgrade

Select a branch FortiVoice unit and select this option to upgrade it now or later.

To add a survivability branch on the central unit

  1. Go to Managed System > Survivability > Survivability Branch.
  2. Click New and configure the following:

GUI field

Description

Name

Enter a unique name for the branch unit.

Enable

Select to activate the branch unit if required.

Display name

Not required. You can leave this field empty.

Hostname/IP address

Enter the hostname or IP address of the branch unit.

If the branch unit is configured to use a non-default HTTPS port, then

add :<port number> after the IP address. For example,

172.16.5.11:4430.

Get Device Information:

  • Before you click this button, make sure to enter the required information in the Admin user name and Admin password fields below.
  • Click this button to poll the provisioned branch unit and get the serial number, type, and MAC address of the branch unit. This action can confirm that the systems can communicate and that the password is valid.

Connect Device: Click to go to the Web GUI of the branch unit.

Admin user name

Enter the user name of the administrator account used for logging in to the branch unit.

The default is admin.

Admin password

Enter the password associated with the Admin user name.

Serial number

The serial number of the branch unit that you are adding to this survivability branch.

If you are configuring the survivability branch before deploying the branch unit, then manually update the serial number, type, and MAC address.

Type

Select the branch unit brand and model.

MAC address

Enter the MAC address of the branch unit.

Description

Enter any comments for the branch unit.

Survivability

Click to configure the branch unit details.

 

Management mode

Make sure to select Fully Managed.

Fully managed - without branch paging

With the fully managed mode and without branch paging configured, the main office pushes the following configurations to the branch unit.

  • Extension user
  • Extension preferences
  • Global system Setting
  • PBX setting
  • Profile location
  • Survivability branch
  • System auto-provisioning
  • System PSTN channels
  • Trunk PSTN

Fully managed - with branch paging

With the fully managed mode and branch paging configured, the main office pushes the following configurations to the branch unit.

  • Call handling
  • Dialplan FXO gateway mapping
  • Dialplan outbound
  • Extension user
  • Extension preferences
  • Global system Setting
  • PBX account code
  • PBX setting
  • Profile location
  • Survivability branch
  • System auto-provisioning
  • System PSTN channels
  • Trunk PSTN
  • Trunk SIP peer

 

Heartbeat server address

Select the heartbeat server on the central unit used to monitor the status of each branch unit in the network and enable communication between the main office unit and the branch unit.

Internal provisioning address: The SIP server IP address of the main office unit which the branch unit sends OPTIONS SIP message to.

External host IP: The external static IP address of the main office unit which the branch unit sends OPTIONS SIP messages to.

 

Branch SIP server

Enter the branch unit’s SIP server hostname or IP address for local extensions (phones) to reach.

 

Branch SIP port

Enter the SIP server port number of the branch unit which local extensions (phones) can reach.

The range is from 1 to 65535. The default is 5060.

 

SIP phone registration interval

To keep the extensions’ registration status with the central unit, enter the extension registration time interval in minutes as required by the FortiVoice unit.

The range is from 1 to 120 minutes.

The default is 5 minutes.

 

Emergency call

Choose the branch or central unit to handle emergency calls.

It is recommended to choose the branch unit to ensure the call is routed to the correct locations due to regional or international boundaries.

Handled by Branch: The branch office intercepts the EMS call and sends it out on one of the local lines.

Handled by Central: The main office handles the EMS call based on its configuration.

 

Central trunk fallback to branch

Select if you want the branch unit to handle the call locally if the central unit fails to handle the calls, for example, when SIP trunk is down.

 

External caller ID option

Choose the system default or branch specific caller ID for outgoing calls originating from branch offices instead of the FortiVoice main number (see Main number) or the trunk phone number (see Phone Number).

 

External caller ID

If you choose Use branch caller ID for External caller ID option, enter the caller ID.

 

Phone directory option

Choose the system default or branch phone directory.

 

Branch failover trunk FXO ports

This option only activates when you edit a survivability branch.

Enter the FXO failover port in the event of internet failure or a network crash by connecting the branch unit to an outside telephone line.

For a port range, enter the starting and ending ports separated by a dash. For separate ports, use a comma.

Port list example: 1-4,6.

 

Branch extensions

Select the extensions to add to the branch.

 

Gateway

The FortiVoice survivability branch solution can support a FortiVoice FXS gateway at the

branch office.

To link the branch unit with a deployed FortiVoice FXS gateway, select the FortiVoice FXS gateway from the Available list and use the right arrow to move it to the Selected list.

Branch Paging

Use branch paging to broadcast an audio message to branch extensions (phones) or an overhead paging system.

 

FXO port

This option only activates when you edit a survivability branch.

Enter the FXO port that the paging system is plugged in to at the branch office, if applicable.

 

Max duration

Enter the maximum time period in seconds for each overhead paging session. When the maximum duration is reached, the branch paging session automatically ends.

The duration range is from 0 to 64800 seconds.

 

Number

This option only activates when you edit a survivability branch.

Enter the number to engage the paging system. For example, 0110.

 

Accept same branch paging

Select to allow all extensions at the same branch to connect to the paging system without a user privilege and complete a paging call.

 

Reject paging by default

Select to allow extensions at the same branch to connect to the paging system using

a user privilege and account code, and complete a paging call.

 

Accept failover local paging

If the main office is down and you want to do paging from the branch office, select this option.

with authentication code: This code is not required.

Speed Dial Rule

This option is only available when you edit a branch.

Click to add a speed dial rule for the branch.

For details, see Mapping speed dials.

Click Create and Create.

Configuring local survivability

FortiVoice local survivability solution is designed to provide branch resiliency for centralized deployments with multi-sites. The FortiVoice unit at the central office sends the configuration files to the FortiVoice units and extensions at the branch offices. The central office handles all inbound calls thereby consolidating the number of lines required for an organization.

With this solution, you have one place to look for the routing rules, logs, call records, and call recordings. You can see the whole setup, make changes, or modify records on the fly. If an extension is added, it is operational immediately. Any users at any location will be able to call that new extension right away without waiting for configurations to sync up, or new policies required to be set at each location.

If the communication between the FortiVoice unit at the central office and the FortiVoice units and extensions at the branch offices is down, the FortiVoice units at the branch offices (survivability branches) will kick in to provide access to lines until the communication is restored between the central unit and the extensions.

A survivability branch is a local FortiVoice unit containing local extensions that is part of a centralized deployment.

FortiVoice models 300E and up and FortiVoice VM models 500 and up provide central management.

FVE-20E2, FVE-20E4, FVE-50E6, FVE-200F8, FVE-500F, and GS16 can serve as local survivability (survivability branch) models.

FVE models and supported number of survivability branches

 

FVE Model

Number of gateways supported

300E

10

VM500

15

500E & 500F

15

1000E & VM1000

20

200D

20

2000E, 2000F & VM2000

40

3000E & VM3000

40

5000F & VM5000

100

VM10000

100

VM50000

200

This topic includes:

Local survivability deployment

Follow these recommended general steps to deploy your local survivability network:

  • Set up HA on the central unit

    It is important to get your HA up and running and the correct virtual IP set as it is used throughout the local survivability setup. For information on setting up HA, see Using high availability.

  • Add or import extensions to the central unit

    Once each branch unit has been added, you can add or import their extensions to the central unit. For more information, see Configuring IP extensions.

  • Add and configure each branch unit:
  • Apply branch configuration from central unit

    Once the branch unit is set to the correct IP address, you can apply the configuration from the central system to each branch. See Adding, configuring, and viewing survivability branches.

  • Add phones to network at branch offices

    Once the branch unit has received the configuration file, add the phones to the network. They will automatically detect the branch unit and be redirected to the central office to get their configuration file.

    Note

    Adding the phones to the network too early will result in receiving an unassigned phone configuration file from the branch system. The phones need to be set to factory default for them to go to the central unit to get their configuration file.

Adding, configuring, and viewing survivability branches

Managed System > Survivability > Survivability Branch allows you to view and add survivability branches.

To view the list of added survivability branches

  1. Go to Managed System > Survivability > Survivability Branch.

GUI field

Description

Apply configuration

Select a branch FortiVoice unit from the list and click this option to apply the FortiVoice configuration file to this branch unit and reboot the unit immediately.

View configuration

Select a branch FortiVoice unit from the list and click this option to display the configuration file applied to this unit.

Fetch Device Info

Select a branch FortiVoice unit from the list and click this option to retrieve its information.

Upgrade

Select a branch FortiVoice unit and select this option to upgrade it now or later.

To add a survivability branch on the central unit

  1. Go to Managed System > Survivability > Survivability Branch.
  2. Click New and configure the following:

GUI field

Description

Name

Enter a unique name for the branch unit.

Enable

Select to activate the branch unit if required.

Display name

Not required. You can leave this field empty.

Hostname/IP address

Enter the hostname or IP address of the branch unit.

If the branch unit is configured to use a non-default HTTPS port, then

add :<port number> after the IP address. For example,

172.16.5.11:4430.

Get Device Information:

  • Before you click this button, make sure to enter the required information in the Admin user name and Admin password fields below.
  • Click this button to poll the provisioned branch unit and get the serial number, type, and MAC address of the branch unit. This action can confirm that the systems can communicate and that the password is valid.

Connect Device: Click to go to the Web GUI of the branch unit.

Admin user name

Enter the user name of the administrator account used for logging in to the branch unit.

The default is admin.

Admin password

Enter the password associated with the Admin user name.

Serial number

The serial number of the branch unit that you are adding to this survivability branch.

If you are configuring the survivability branch before deploying the branch unit, then manually update the serial number, type, and MAC address.

Type

Select the branch unit brand and model.

MAC address

Enter the MAC address of the branch unit.

Description

Enter any comments for the branch unit.

Survivability

Click to configure the branch unit details.

 

Management mode

Make sure to select Fully Managed.

Fully managed - without branch paging

With the fully managed mode and without branch paging configured, the main office pushes the following configurations to the branch unit.

  • Extension user
  • Extension preferences
  • Global system Setting
  • PBX setting
  • Profile location
  • Survivability branch
  • System auto-provisioning
  • System PSTN channels
  • Trunk PSTN

Fully managed - with branch paging

With the fully managed mode and branch paging configured, the main office pushes the following configurations to the branch unit.

  • Call handling
  • Dialplan FXO gateway mapping
  • Dialplan outbound
  • Extension user
  • Extension preferences
  • Global system Setting
  • PBX account code
  • PBX setting
  • Profile location
  • Survivability branch
  • System auto-provisioning
  • System PSTN channels
  • Trunk PSTN
  • Trunk SIP peer

 

Heartbeat server address

Select the heartbeat server on the central unit used to monitor the status of each branch unit in the network and enable communication between the main office unit and the branch unit.

Internal provisioning address: The SIP server IP address of the main office unit which the branch unit sends OPTIONS SIP message to.

External host IP: The external static IP address of the main office unit which the branch unit sends OPTIONS SIP messages to.

 

Branch SIP server

Enter the branch unit’s SIP server hostname or IP address for local extensions (phones) to reach.

 

Branch SIP port

Enter the SIP server port number of the branch unit which local extensions (phones) can reach.

The range is from 1 to 65535. The default is 5060.

 

SIP phone registration interval

To keep the extensions’ registration status with the central unit, enter the extension registration time interval in minutes as required by the FortiVoice unit.

The range is from 1 to 120 minutes.

The default is 5 minutes.

 

Emergency call

Choose the branch or central unit to handle emergency calls.

It is recommended to choose the branch unit to ensure the call is routed to the correct locations due to regional or international boundaries.

Handled by Branch: The branch office intercepts the EMS call and sends it out on one of the local lines.

Handled by Central: The main office handles the EMS call based on its configuration.

 

Central trunk fallback to branch

Select if you want the branch unit to handle the call locally if the central unit fails to handle the calls, for example, when SIP trunk is down.

 

External caller ID option

Choose the system default or branch specific caller ID for outgoing calls originating from branch offices instead of the FortiVoice main number (see Main number) or the trunk phone number (see Phone Number).

 

External caller ID

If you choose Use branch caller ID for External caller ID option, enter the caller ID.

 

Phone directory option

Choose the system default or branch phone directory.

 

Branch failover trunk FXO ports

This option only activates when you edit a survivability branch.

Enter the FXO failover port in the event of internet failure or a network crash by connecting the branch unit to an outside telephone line.

For a port range, enter the starting and ending ports separated by a dash. For separate ports, use a comma.

Port list example: 1-4,6.

 

Branch extensions

Select the extensions to add to the branch.

 

Gateway

The FortiVoice survivability branch solution can support a FortiVoice FXS gateway at the

branch office.

To link the branch unit with a deployed FortiVoice FXS gateway, select the FortiVoice FXS gateway from the Available list and use the right arrow to move it to the Selected list.

Branch Paging

Use branch paging to broadcast an audio message to branch extensions (phones) or an overhead paging system.

 

FXO port

This option only activates when you edit a survivability branch.

Enter the FXO port that the paging system is plugged in to at the branch office, if applicable.

 

Max duration

Enter the maximum time period in seconds for each overhead paging session. When the maximum duration is reached, the branch paging session automatically ends.

The duration range is from 0 to 64800 seconds.

 

Number

This option only activates when you edit a survivability branch.

Enter the number to engage the paging system. For example, 0110.

 

Accept same branch paging

Select to allow all extensions at the same branch to connect to the paging system without a user privilege and complete a paging call.

 

Reject paging by default

Select to allow extensions at the same branch to connect to the paging system using

a user privilege and account code, and complete a paging call.

 

Accept failover local paging

If the main office is down and you want to do paging from the branch office, select this option.

with authentication code: This code is not required.

Speed Dial Rule

This option is only available when you edit a branch.

Click to add a speed dial rule for the branch.

For details, see Mapping speed dials.

Click Create and Create.