Fortinet black logo

Adding a survivability branch

Copy Link
Copy Doc ID 24f0a5fd-260c-11ec-8c53-00505692583a:467836
Download PDF

Adding a survivability branch

Use this procedure to add a survivability branch to the FortiVoice phone system at the main office.

Procedure steps
  1. Connect to the web-based manager of the primary FortiVoice phone system at the main office.
  2. Go to Managed System > Survivability.
  3. On the Survivability Branch tab, click New and configure the following parameters:
  4. GUI field

    Description

    Name

    Enter a unique name for this survivability branch.

    Enable

    Select to enable the configuration of the branch unit (FortiVoice LSG).

    Display name

    Not required. You can leave this field empty.

    Host name/IP address

    Enter the hostname or IP address of the branch unit (FortiVoice LSG).

    If the FortiVoice LSG 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: This procedure does not use this button.

    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.

    To show the password, click the eye icon .

    Serial number

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

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

    Type

    Select the model of the FortiVoice LSG unit that you are adding to this survivability branch.

    MAC address

    The MAC address of the FortiVoice LSG unit that you are adding to this survivability branch.

    If you are configuring the survivability branch before deploying the FortiVoice LSG unit, then manually update the MAC address.

    Description

    Optionally, add any applicable notes for this survivability branch.

    Survivability

    This section includes settings related to how the branch unit operates.

    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 settings
    • 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 settings
    • 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 main office unit that is used to monitor the status of each branch unit in the network and enable communications 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 SIP hostname or local IP address of the branch unit which local extensions (phones) can 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 extension registration status with the main office unit, enter the extension registration time interval (in minutes) as required by the FortiVoice phone system.

    The range is from 1 to 120 minutes.

    The default is 5 minutes.

    Emergency call

    Choose how to handle EMS calls. The recommendation is to choose the branch unit to make sure calls are 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

    If the main office fails to process a call (for example, all lines busy or trunk down) and you want the branch office unit to locally handle the call, then select this option.

    To create an outbound call route for the branch office unit to handle this failover scenario, see Creating an outbound call route for failover scenarios.

    External caller ID option

    Select one of the following options:

    • Use Default Caller ID: This is the caller ID associated with the extension.
    • Use Branch Caller ID: If you select this option, you must fill in the next field (External caller ID).

    External caller ID

    If you select the Use Branch Caller ID option, then enter the external caller ID. Use the name<phone_number> format, such as HR<222134>.

    Phone directory option

    Select one of the following phone directories:

    • Branch directory
    • System directory

    Branch failover trunk FXO ports

    This option only activates when you edit a survivability branch.

    Enter the trunk FXO ports to be used for outbound calls in the event of a failover scenario.

    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.

    Note

    Branch failover trunk FXO ports is applicable for all FortiVoice LSG models except FVE-100E, FVE-500F (and FVE 1000E which is still supported but has reached its end-of-order [EOO] date).

    Branch WSS port

    Enter a WebSocket Secure (WSS) port to allow the FortiVoice LSG unit to support the FortiFone softclient for desktop application. The default port is 8089.

    Branch extensions

    Click + and select the extensions from the list.

    Gateway

    The FortiVoice LSG solution can support a FortiVoice FXS gateway at the branch office.

    To link the FortiVoice LSG unit with a deployed FortiVoice FXS gateway, click + and select the FortiVoice FXS gateway from the list.

    Branch Paging

    Options in this section are only available when you edit a survivability branch.

    If you want your deployment to use branch paging, you can complete the configuration later in Branch paging.

    Note

    Branch paging using an FXO port is applicable for all FortiVoice LSG models except FVE-100E, FVE-500F (and FVE 1000E which is still supported but has reached its EOO date).

  5. Click Create.

    You have completed this procedure.

  6. Go to Applying the branch configuration.

Adding a survivability branch

Use this procedure to add a survivability branch to the FortiVoice phone system at the main office.

Procedure steps
  1. Connect to the web-based manager of the primary FortiVoice phone system at the main office.
  2. Go to Managed System > Survivability.
  3. On the Survivability Branch tab, click New and configure the following parameters:
  4. GUI field

    Description

    Name

    Enter a unique name for this survivability branch.

    Enable

    Select to enable the configuration of the branch unit (FortiVoice LSG).

    Display name

    Not required. You can leave this field empty.

    Host name/IP address

    Enter the hostname or IP address of the branch unit (FortiVoice LSG).

    If the FortiVoice LSG 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: This procedure does not use this button.

    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.

    To show the password, click the eye icon .

    Serial number

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

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

    Type

    Select the model of the FortiVoice LSG unit that you are adding to this survivability branch.

    MAC address

    The MAC address of the FortiVoice LSG unit that you are adding to this survivability branch.

    If you are configuring the survivability branch before deploying the FortiVoice LSG unit, then manually update the MAC address.

    Description

    Optionally, add any applicable notes for this survivability branch.

    Survivability

    This section includes settings related to how the branch unit operates.

    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 settings
    • 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 settings
    • 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 main office unit that is used to monitor the status of each branch unit in the network and enable communications 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 SIP hostname or local IP address of the branch unit which local extensions (phones) can 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 extension registration status with the main office unit, enter the extension registration time interval (in minutes) as required by the FortiVoice phone system.

    The range is from 1 to 120 minutes.

    The default is 5 minutes.

    Emergency call

    Choose how to handle EMS calls. The recommendation is to choose the branch unit to make sure calls are 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

    If the main office fails to process a call (for example, all lines busy or trunk down) and you want the branch office unit to locally handle the call, then select this option.

    To create an outbound call route for the branch office unit to handle this failover scenario, see Creating an outbound call route for failover scenarios.

    External caller ID option

    Select one of the following options:

    • Use Default Caller ID: This is the caller ID associated with the extension.
    • Use Branch Caller ID: If you select this option, you must fill in the next field (External caller ID).

    External caller ID

    If you select the Use Branch Caller ID option, then enter the external caller ID. Use the name<phone_number> format, such as HR<222134>.

    Phone directory option

    Select one of the following phone directories:

    • Branch directory
    • System directory

    Branch failover trunk FXO ports

    This option only activates when you edit a survivability branch.

    Enter the trunk FXO ports to be used for outbound calls in the event of a failover scenario.

    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.

    Note

    Branch failover trunk FXO ports is applicable for all FortiVoice LSG models except FVE-100E, FVE-500F (and FVE 1000E which is still supported but has reached its end-of-order [EOO] date).

    Branch WSS port

    Enter a WebSocket Secure (WSS) port to allow the FortiVoice LSG unit to support the FortiFone softclient for desktop application. The default port is 8089.

    Branch extensions

    Click + and select the extensions from the list.

    Gateway

    The FortiVoice LSG solution can support a FortiVoice FXS gateway at the branch office.

    To link the FortiVoice LSG unit with a deployed FortiVoice FXS gateway, click + and select the FortiVoice FXS gateway from the list.

    Branch Paging

    Options in this section are only available when you edit a survivability branch.

    If you want your deployment to use branch paging, you can complete the configuration later in Branch paging.

    Note

    Branch paging using an FXO port is applicable for all FortiVoice LSG models except FVE-100E, FVE-500F (and FVE 1000E which is still supported but has reached its EOO date).

  5. Click Create.

    You have completed this procedure.

  6. Go to Applying the branch configuration.