FortiVoice-7.0.2-FXS Gateway Deployment Guide
FortiVoice-7.0.2-FXS Gateway Deployment Guide
FortiVoice 7.0.2
FORTINET DOCUMENT LIBRARY
https://docs.fortinet.com
FORTINET BLOG
https://blog.fortinet.com
FORTIGUARD LABS
https://www.fortiguard.com
FEEDBACK
Email: techdoc@fortinet.com
March 7, 2024
FortiVoice 7.0.2 FXS Gateway Deployment Guide
26-702-879908-20240307
TABLE OF CONTENTS
Change log 4
Overview 5
Supported models 5
Topology 5
Deployment 7
Connecting to the FXS gateway 8
Configuring administrator and system settings 9
Upgrading the FXS gateway firmware 12
Adding an FXS gateway (auto-discovered) 13
Adding an FXS gateway (not auto-discovered) 15
Applying the FXS gateway configuration 17
Verifying the FXS gateway association 17
Editing a managed extension of the FXS gateway 17
2024-03-07 Initial release of the FortiVoice 7.0.2 FXS Gateway Deployment Guide.
The FortiVoice foreign exchange subscriber (FXS) gateway works in conjunction with the FortiVoice phone system, an
IP private branch exchange (PBX), to expand resources and support additional analog phone extensions. With the FXS
gateway, you can connect your traditional analog phones and fax machines to a FortiVoice phone system.
This document describes how to deploy a FortiVoice FXS gateway.
This section includes the following topics:
l Supported models on page 5
l Topology on page 5
Supported models
The supported Fortinet FXS gateway models are FortiVoice Gateway GS04 and GS16.
l GS04 has 4 FXS ports mapped to 4 analog phone extensions.
l GS16 has 16 FXS ports mapped to 16 analog phone extensions.
For more details about features and specifications, see the FortiVoice Gateways Data Sheet.
The following FortiVoice phone systems can manage an FXS gateway:
l FortiVoice 100E and larger
The FortiVoice 100E continues to support the management of FXS gateways. However,
this model has reached its end-of-order (EOO) date.
Topology
You can configure an FXS gateway to be on the same LAN as the FortiVoice phone system or over a VPN.
The FortiVoice phone system manages all configuration information for extensions and ports. However, the FXS
gateway manages the following system settings:
l Network settings
l Administrator accounts
l System options
l SIP settings
The following image shows an example topology of a FortiVoice phone system managing a FortiVoice Gateway GS16:
Before starting procedures in this guide, make sure to complete the basic setup of the
FortiVoice phone system and connect to the GUI of that system. For more details, see the
FortiVoice Phone System Administration Guide.
To deploy an FXS gateway and then manage that device with a FortiVoice phone system, review the tasks and perform
the procedures listed in the following workflow:
Task 2 Connect to the GUI of the FXS gateway. Connecting to the FXS gateway on page 8
Task 3 Configure the following system settings: Configuring administrator and system settings on
l Network interfaces page 9
l Static routes
l Administrator accounts
l System options
l SIP settings, optional
Task 4 Upgrade the firmware of the FXS gateway to Upgrading the FXS gateway firmware on page 12
the latest GA release.
Task 6 Apply the gateway configuration file from the Applying the FXS gateway configuration on page
FortiVoice phone system to the FXS 17
gateway.
Task 7 Verify that the FXS gateway is associated Verifying the FXS gateway association on page 17
correctly with the FortiVoice phone system.
Task 8 Optionally, edit any of the 16 default Optional - Editing a managed extension of the FXS
managed extensions. gateway on page 17
After physically installing the FXS gateway and connecting its Ethernet and FXS ports, review the following table and
perform the procedure that applies to your scenario to connect to the GUI of the FortiVoice Gateway.
Scenario Procedure
You are connecting to the device for Perform the steps in Connecting to the GUI of the FortiVoice Gateway on
the first time. page 8.
You have reset the device Perform the steps in Connecting to the GUI of the FortiVoice Gateway on
configuration to its default state. page 8.
You are a returning user who has Access the GUI using the IP address, administrative access protocol,
completed the basic configuration of administrator account, and password that you have already configured,
the device. instead of the default settings.
1. Start a web browser and enter the URL:
https://<IP_address>/admin
Where <IP_address> is the IP address of the FXS gateway that you
want to connect to. If the FXS gateway configuration is using a non-
default HTTPS port, then add :<port_number> after the IP address.
For example: https://<IP_address>:446/admin.
2. Enter the name and password associated with your account.
3. Click Login.
You have completed this procedure.
4. Go to Configuring administrator and system settings on page 9 to
make sure that you configure the required settings.
To connect to the GUI of the FortiVoice Gateway using its default settings, you must have the following hardware and
software:
l A computer with an RJ-45 Ethernet network port
l One of the recommended web browsers:
l Google Chrome version 121
l Microsoft Edge version 120
Enter an administrator password that is six characters or more. For better security,
enter a longer password with a complex combination of characters and numbers, and
change the password regularly. Failure to provide a strong password could
compromise the security of your FortiVoice FXS gateway.
Configure administrator and system settings on the FortiVoice Gateway by completing the following procedures:
If you need more details about the configuration of system settings presented in this section,
see the Configuring system settings section in the FortiVoice Gateway Administration Guide.
Perform this procedure to set the IP address, netmask, and administrative access protocols of the FXS gateway.
1. In the GUI of the FortiVoice Gateway, go to System > Network.
The Network tab displays the following ports:
Port 1 has a default IP address and netmask set to 192.168.1.99/24.
Port 2 has a default IP address set to 192.168.2.99/24.
2. Double-click a network interface that you want to use to set the IP address of the FXS gateway.
3. In Addressing Mode, Manual, go to IP/Netmask and edit the IP address and netmask of the interface. Make
sure that this IP address is outside of the FortiGate DHCP range.
4. In Advanced Setting, make sure to enable the protocols that you want the network interface to use to accept
connections to the FXS gateway.
5. In Administrative status, make sure that Up is selected for the network interface to be available to receive traffic.
6. Click OK.
Optionally, perform this procedure to create an additional administrator account with restricted permissions. By default,
the FXS gateway has a single administrator account called admin.
Before you begin
If you want to create or edit an admin profile, perform this task on the FortiVoice phone system first. For more details
about the admin profile, see the Configuring administrator profiles section in the FortiVoice Phone System
Administration Guide.
Procedure steps
1. In the GUI of the FortiVoice Gateway, go to System > Administrator.
2. Click New.
3. In Administrator, enter the name for this administrator account.
The name can contain numbers (0-9), uppercase and lowercase letters (A- Z, a- z), hyphens ( - ), and underscores (
_ ). Other special characters and spaces are not allowed.
4. In Email address, enter the email address of the administrator.
5. In Admin profile, select the admin profile. This profile determines which functional areas the administrator
account can view or affect.
6. In the New password and Confirm password, enter the password for this account.
The password can contain any character except spaces.
Do not enter an FXS gateway administrator password that is less than six characters long.
For better security, enter a longer password with a complex combination of characters and
numbers, and change the password regularly. Failure to provide a strong password can
compromise the security of your FXS gateway.
Perform this procedure to set the system idle timeout and administration ports.
1. In the GUI of the FortiVoice Gateway, go to System > Configuration, and then click the Option tab.
2. In Idle timeout, enter the amount of time in minutes that an administrator can be inactive before the FXS gateway
automatically logs out the administrator.
3. In Administration Ports, specify the TCP ports for the administrative access on all interfaces.
Default port numbers:
l HTTP port number: 80
l HTTPS port number: 443
l SSH port number: 22
l TELNET port number: 23
4. Click Apply.
The FortiVoice phone system can auto-discover an FXS gateway when they are on the same LAN. With an auto-
discovered device, you can create a new configuration for that gateway or replace an existing gateway configuration.
Procedure steps
1. Connect to the GUI of the FortiVoice phone system.
2. Go to Managed System > Gateway, and then click the FXS Gateway tab.
3. Click Actions > Unmanaged Gateway.
The dialog opens and displays all the gateways discovered on the LAN of the FortiVoice phone system.
4. Select the FXS gateway that you want to add.
5. In the Action drop-down list, select one of the following actions:
l Create New Device to add the gateway as a new entry into the FortiVoice phone system. Go to step 6.
l Replace Existing Device to choose which gateway to replace. You can use this option when a device is
defective. Go to step 9.
6. If you selected Create New Device, then configure the following settings:
Display name Not required. You can leave this field empty.
Admin user name Enter the user name of the administrator account used for logging in to the
FXS gateway.
The default is admin.
Admin password Enter the password associated with the Admin user name.
Serial number The serial number of the gateway that you are adding to the FortiVoice phone
system. For an auto-discovered FXS gateway, the FortiVoice phone system
autopopulates this field.
Type The type of gateway that you are adding to the FortiVoice phone system.
MAC address The MAC address of the gateway that you are adding to the FortiVoice phone
system.
Survivability branch The FortiVoice LSG solution can support a FortiVoice FXS gateway at a
branch office.
To link this FXS gateway with a survivability branch, select that branch from
the list.
For details about deploying a FortiVoice LSG unit, see the FortiVoice Local
Survivable Gateway Deployment Guide.
Physical location Select Internal if the FXS gateway and FortiVoice phone system are on the
same LAN. The FXS gateway connects to the internal IP address of the
FortiVoice phone system.
Select External if the FXS gateway connects to the FortiVoice phone system
with an external IP.
7. Click Finish.
The FortiVoice phone system creates 16 default managed extensions from 7801 to 7816 for your first FXS
gateway. With any subsequent FXS gateway addition, the FortiVoice phone system continues to add a range of 16
extensions to the existing managed extension list. For example, the FortiVoice phone system adds extensions
7817 to 7832 for the second FXS gateway.
If the FortiVoice phone system already has an extension that is included in the range of default managed
extensions to be created, the numbering of new extensions will account for the existing extension. For example,
the FortiVoice phone system has extension 7812. With the addition of the first FXS gateway, the FortiVoice phone
system would create 16 managed extensions from 7801 to 7817 (not 7816).
To access the extension list, go to Extension > Extension, and then click Managed Extension.
8. You have completed this procedure. You can now go to Applying the FXS gateway configuration on page 17.
9. If you selected Replace Existing Device, then follow the system prompts to choose which gateway configuration
you want to replace and then replace it. Both existing and replacement devices must be the same type.
10. You have completed this procedure. You can now go to Applying the FXS gateway configuration on page 17.
Perform this procedure to add an FXS gateway to the FortiVoice phone system in cases such as in the following
examples:
l You are preconfiguring the FortiVoice phone system before deploying the FXS gateway.
l You are setting up the FortiVoice phone system and locating the FXS gateway on a VPN. Therefore, the devices
are not on the same LAN.
Procedure steps
1. Connect to the GUI of the FortiVoice phone system.
2. Go to Managed System > Gateway, and then click the FXS Gateway tab.
3. Click New.
4. Configure the following settings:
Display name Not required. You can leave this field empty.
l Click this button to poll the FXS gateway to get the serial number and the
MAC address of the gateway. This action can confirm that the systems
can communicate and that the password is valid.
Connect Device: This procedure does not use this button (with this button,
you would access the FortiVoice Gateway GUI in a separate tab in your web
browser).
Admin user name Enter the user name of the administrator account used for logging in to the
FXS gateway.
The default is admin.
Admin password Enter the password associated with the Admin user name.
Serial number The serial number of the FXS gateway that you are adding to the FortiVoice
phone system.
Type The type of gateway that you are adding to the FortiVoice phone system.
MAC address The MAC address of the FXS gateway that you are adding to the FortiVoice
phone system.
Survivability branch The FortiVoice LSG solution can support a FortiVoice FXS gateway at a
branch office.
To link this FXS gateway with a survivability branch, select that branch from
the list.
For details about deploying a FortiVoice LSG unit, see the FortiVoice Local
Survivable Gateway Deployment Guide.
Physical location Select Internal if the FXS gateway and FortiVoice phone system are on the
same LAN. The FXS gateway connects to the internal IP address of the
FortiVoice phone system.
Select External if the FXS gateway connects to the FortiVoice phone system
with an external IP.
Description Optionally, add any applicable notes for this FXS gateway.
5. Click Create.
The FortiVoice phone system creates 16 default managed extensions from 7801 to 7816 for your first FXS
gateway. With any subsequent FXS gateway addition, the FortiVoice phone system continues to add a range of 16
extensions to the existing managed extension list. For example, the FortiVoice phone system adds extensions
7817 to 7832 for the second FXS gateway.
If the FortiVoice phone system already has an extension that is included in the range of default managed
extensions to be created, the numbering of new extensions will account for the existing extension. For example,
the FortiVoice phone system has extension 7812. With the addition of the first FXS gateway, the FortiVoice phone
system would create 16 managed extensions from 7801 to 7817 (not 7816).
To access the extension list, go to Extension > Extension, and then click Managed Extension.
6. Go to Applying the FXS gateway configuration on page 17.
The FortiVoice phone system stores a gateway configuration file. Perform this procedure to apply this gateway
configuration file to the FXS gateway.
Procedure steps
1. Connect to the GUI of the FortiVoice phone system.
2. Go to Managed System > Gateway, and then click the FXS Gateway tab.
3. In the list, select the gateway to which you want to apply the configuration file.
4. Click Actions > Apply Configuration.
If the FXS gateway is not linked to a survivability branch, the FortiVoice phone system displays the following
message:
Do you want to update the selected gateway?
If the FXS gateway is linked to a survivability branch, the FortiVoice phone system displays the following message:
Do you want to apply the configuration to both the selected LSG and associated gateway?
5. Click OK.
The FortiVoice phone system applies configuration changes to the extensions of the FXS gateway.
With a successful upgrade, the FXS gateway displays the following message:
The gateway update is complete.
Successful:<gateway_name>
6. Click OK.
You have completed this procedure.
7. Go to Verifying the FXS gateway association on page 17.
Perform this procedure to verify that the association of the FXS gateway with the FortiVoice phone system is successful.
Procedure steps
1. Connect to the GUI of the FortiVoice phone system.
2. Go to Extension > Extension, and then click the Managed Extension tab.
3. Verify that the Gateway Device column shows the gateway that the extension is associated with.
You have completed this procedure and the FXS gateway deployment.
4. If you want to edit a managed extension, go to Editing a managed extension of the FXS gateway on page 17.
After adding a FortiVoice Gateway to the FortiVoice phone system, each of its FXS port is associated with a generated
extension number. To edit an FXS gateway extension, perform this procedure.
Procedure steps
Number The extension number. For details about the extension number pattern, see
the Configuring PBX options section in the FortiVoice Phone System
Administration Guide.
Edit Preference: For details about extension user preferences, see the
Setting extension user preferences section in the FortiVoice Phone System
Administration Guide.
User ID The system automatically generates this ID based on the gateway and port.
This parameter is read only.
Device Setting
Gateway device The name of the gateway device.
This option is read only.
Gateway fxs port The gateway FXS port associated with the extension.
This option is read only.
Direct call If you want the phone to perform a direct call to a specified number after you
pick up the phone handset, enable this option.
Number: Enter the phone number for the direct call.
User Setting, Management
User privilege Select or add the user privilege that you want to apply to the extension.
A user privilege includes a collection of phone services and restrictions that
you can apply to each extension.
You can edit the default user privilege but you cannot delete it.
Department Select or add the department that the extension belongs to.
User Setting, Web Access Configure web user portal and soft client access from mobile or desktop
devices.
User password If you selected Local as the Authentication type, enter the password for
user web portal access. This password can be much longer and stronger to
mitigate the risk of password guess attack and preserve the voicemail PIN for
phone access only.
To let the system create the user password, click Generate.
LDAP profile If you selected LDAP as the Authentication type, select or create an LDAP
profile to apply to this extension.
For more details about the LDAP profile configuration, see the Configuring
LDAP profiles section in the FortiVoice Phone System Administration Guide.
Authentication ID During the configuration of the LDAP profile, you have two options for the user
authentication:
l If you select Try Common Name with Base DN as Bind DN, update
the authentication ID field to match the common name attribute
(example, uid) that you entered in the Common name ID field of the
LDAP profile. Example: jdoe.
l If you select Search User and Try Bind DN, leave the authentication
ID field blank.
Personal code Enter the extension specific account code used to restrict calls. To make a
restricted call, you need this code.
To let the system create the personal code, click Generate.
Copyright© 2024 Fortinet, Inc. All rights reserved. Fortinet®, FortiGate®, FortiCare® and FortiGuard®, and certain other marks are registered trademarks of Fortinet, Inc., and other Fortinet names herein may
also be registered and/or common law trademarks of Fortinet. All other product or company names may be trademarks of their respective owners. Performance and other metrics contained herein were attained in
internal lab tests under ideal conditions, and actual performance and other results may vary. Network variables, different network environments and other conditions may affect performance results. Nothing herein
represents any binding commitment by Fortinet, and Fortinet disclaims all warranties, whether express or implied, except to the extent Fortinet enters a binding written contract, signed by Fortinet’s Chief Legal
Officer, with a purchaser that expressly warrants that the identified product will perform according to certain expressly-identified performance metrics and, in such event, only the specific performance metrics
expressly identified in such binding written contract shall be binding on Fortinet. For absolute clarity, any such warranty will be limited to performance in the same ideal conditions as in Fortinet’s internal lab tests.
Fortinet disclaims in full any covenants, representations, and guarantees pursuant hereto, whether express or implied. Fortinet reserves the right to change, modify, transfer, or otherwise revise this publication
without notice, and the most current version of the publication shall be applicable.