Fortinet Document Library

Version:


Table of Contents

5.3.0
Download PDF
Copy Link

Adding a survivability branch

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

  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.

    Enabled

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

    Display name

    Not required. You can leave this field empty.

    Hostname/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: Do not click this button at this time.

    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 view the password, select View password.

    Change password

    You can use the FortiVoice phone system at the main office to directly change the administrator password used for logging in to the branch unit instead of changing that password in the web-based manager of the branch unit.

    1. Select the check box to change the administrator password for logging in to the branch unit.
    2. Click Change password to show the New password and Confirm password fields.
    3. Enter the new password in both fields.
    4. Click OK.

    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.

    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 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 fall back 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.

    Branch extensions

    To select extensions that reside at the branch location, click Configure Members. Select extensions from the Available list and use the right arrow to move them to the Selected list. When you are done, click OK.

    Branch paging

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

    FXO port

    This option is only available 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 duration for the branch 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 is only available when you edit a survivability branch.

    Enter the number to engage the paging system. You must use the same number that you entered in the Create a paging user privilege section (step 2 i., Area code/Number) of Configuring an account code and user privilege for branch paging.

    For example, 12$.

    Accept same branch paging

    Reject paging by default

    To allow all extensions at the same branch to connect to the paging system without a user privilege and complete a paging call, select the following option:

     

    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, select the following option:

    Note: The Reject paging by default option requires that you completed the Configuring an account code and user privilege for branch paging procedure.

    Accept failover local paging

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

    Authentication code: This code is not required.

    Speed Dials

    This option is only available when you edit a survivability branch.

    Use this section to add a paging speed dial rule.

    Name

    Enter a name for the speed dial mapping.

    Code

    Enter a code for the speed dial pattern that you completed in Configuring a speed dial pattern for branch paging.

    For example, 0XXX.

    Number

    The speed dial number is comprised of the following:

    For example, 12,XXX.

    Description

    Optionally, add a description for the speed dial.

    Description

    Optionally, add any applicable notes for this survivability branch.

  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.

  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.

    Enabled

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

    Display name

    Not required. You can leave this field empty.

    Hostname/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: Do not click this button at this time.

    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 view the password, select View password.

    Change password

    You can use the FortiVoice phone system at the main office to directly change the administrator password used for logging in to the branch unit instead of changing that password in the web-based manager of the branch unit.

    1. Select the check box to change the administrator password for logging in to the branch unit.
    2. Click Change password to show the New password and Confirm password fields.
    3. Enter the new password in both fields.
    4. Click OK.

    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.

    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 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 fall back 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.

    Branch extensions

    To select extensions that reside at the branch location, click Configure Members. Select extensions from the Available list and use the right arrow to move them to the Selected list. When you are done, click OK.

    Branch paging

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

    FXO port

    This option is only available 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 duration for the branch 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 is only available when you edit a survivability branch.

    Enter the number to engage the paging system. You must use the same number that you entered in the Create a paging user privilege section (step 2 i., Area code/Number) of Configuring an account code and user privilege for branch paging.

    For example, 12$.

    Accept same branch paging

    Reject paging by default

    To allow all extensions at the same branch to connect to the paging system without a user privilege and complete a paging call, select the following option:

     

    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, select the following option:

    Note: The Reject paging by default option requires that you completed the Configuring an account code and user privilege for branch paging procedure.

    Accept failover local paging

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

    Authentication code: This code is not required.

    Speed Dials

    This option is only available when you edit a survivability branch.

    Use this section to add a paging speed dial rule.

    Name

    Enter a name for the speed dial mapping.

    Code

    Enter a code for the speed dial pattern that you completed in Configuring a speed dial pattern for branch paging.

    For example, 0XXX.

    Number

    The speed dial number is comprised of the following:

    For example, 12,XXX.

    Description

    Optionally, add a description for the speed dial.

    Description

    Optionally, add any applicable notes for this survivability branch.

  5. Click Create.

    You have completed this procedure.

  6. Go to Applying the branch configuration.