Welcome, and thank you for selecting Fortinet products.
The FortiVoice Gateway is a simple solution for adding analog phone lines to your SIP server
enabled PBX. With the easy to use and intuitive web interface, you can quickly create rules that
allow calls from analog lines, connected to the FortiVoice Gateway FXO ports, to communicate
directly to your SIP server enabled PBX. The FortiVoice Gateway also offers various usage
tracking options, such as call statistics and call detail records, so you can monitor the calls
coming through the system.
This document describes how to configure and use the FortiVoice Gateway through the
web-based manager.
This topic includes:
• Registering your Fortinet product
• Training
• Documentation
• Scope
• Conventions
Registering your Fortinet product
Customer service & technical support
Training
Before you begin, take a moment to register your Fortinet product at the Fortinet Technical
Support web site, https://support.fortinet.com.
Many Fortinet customer services, such as firmware updates and technical support,
require product registration.
For more information, see the Fortinet Knowledge Base article Registration Frequently Asked
Questions.
Fortinet Technical Support provides services designed to make sure that you can install your
Fortinet products quickly, configure them easily, and operate them reliably in your network.
To learn about the technical support services that Fortinet provides, visit the Fortinet Technical
Support web site at https://support.fortinet.com.
You can dramatically improve the time that it takes to resolve your technical support ticket by
providing your configuration file, a network diagram, and other specific information. For a list of
required information, see the Fortinet Knowledge Base article Technical Support Requirements.
Fortinet Training Services provides classes that orient you quickly to your new equipment, and
certifications to verify your knowledge level. Fortinet provides a variety of training programs to
serve the needs of our customers and partners world-wide.
To learn about the training services that Fortinet provides, visit the Fortinet Training Services
web site at http://training.fortinet.com, or email them at training@fortinet.com.
The Fortinet Technical Documentation web site, http://docs.fortinet.com, provides the most
up-to-date versions of Fortinet publications, as well as additional technical documentation such
as technical notes.
In addition to the Fortinet Technical Documentation web site, you can find Fortinet technical
documentation on the Fortinet Tools and Documentation CD, and on the Fortinet Knowledge
Base.
Fortinet Tools & Documentation CD
Many Fortinet publications are available on the Fortinet Tools and Documentation CD shipped
with your Fortinet product. The documents on this CD are current at shipping time. For current
versions of Fortinet documentation, visit the Fortinet Technical Documentation web site,
http://docs.fortinet.com.
Fortinet Knowledge Base
The Fortinet Knowledge Base provides additional Fortinet technical documentation, such as
troubleshooting and how-to-articles, examples, FAQs, technical notes, a glossary, and more.
Visit the Fortinet Knowledge Base at http://kb.fortinet.com.
Comments on Fortinet technical documentation
Please send information about any errors or omissions in this document to
techdoc@fortinet.com.
Scope
This document describes how to connect the FortiVoice Gateway to its web-based manager
and CLI and use the web-based manager to configure the FortiVocieGateway unit.
This document does not cover commands for the command line interface (CLI).
Conventions
Fortinet technical documentation uses the following conventions:
• IP addresses
• Cautions and notes
• Typographical conventions
• Command syntax conventions
IP addresses
To avoid publication of public IP addresses that belong to Fortinet or any other organization, the
IP addresses used in Fortinet technical documentation are fictional and follow the
documentation guidelines specific to Fortinet. The addresses used are from the private IP
address ranges defined in RFC 1918: Address Allocation for Private Internets, available at
Table 1: Typographical conventions in Fortinet technical documentation
NavigationGo to Monitor > Status > DHCP.
PublicationFor details, see the FortiGate Administration Guide.
Command syntax conventions
The command line interface (CLI) requires that you use valid syntax, and conform to expected
input constraints. It will reject invalid commands.
Brackets, braces, and pipes are used to denote valid permutations of the syntax. Constraint
notations, such as <address_ipv4>, indicate which data types or string patterns are
acceptable value input.
Table 2: Command syntax notation
ConventionDescription
Square brackets [ ] A non-required word or series of words. For example:
[verbose {1 | 2 | 3}]
indicates that you may either omit or type both the verbose
word and its accompanying option, such as:
Angle brackets < >A word constrained by data type.
To define acceptable input, the angled brackets contain a
descriptive name followed by an underscore ( _ ) and suffix
that indicates the valid data type. For example:
<retries_int>
indicates that you should enter a number of retries, such as 5.
Data types include:
• <xxx_name>: A name referring to another part of the
configuration, such as policy_A.
• <xxx_index>: An index number referring to another part
of the configuration, such as 0 for the first static route.
• <xxx_pattern>: A regular expression or word with wild
cards that matches possible variations, such as
*@example.com to match all email addresses ending in
@example.com.
• <xxx_fqdn>: A fully qualified domain name (FQDN), such
as mail.example.com.
• <xxx_email>: An email address, such as
admin@mail.example.com.
• <xxx_url>: A uniform resource locator (URL) and its
associated protocol and host name prefix, which together
form a uniform resource identifier (URI), such as
http://www.fortinet.com/.
• <xxx_ipv4>: An IPv4 address, such as 192.168.1.99.
• <xxx_v4mask>: A dotted decimal IPv4 netmask, such as
255.255.255.0.
• <xxx_ipv4mask>: A dotted decimal IPv4 address and
netmask separated by a space, such as
192.168.1.99 255.255.255.0.
• <xxx_ipv4/mask>: A dotted decimal IPv4 address and
CIDR-notation netmask separated by a slash, such as such
as 192.168.1.99/24.
• <xxx_ipv6>: A colon( : )-delimited hexadecimal IPv6
address, such as
3f2e:6a8b:78a3:0d82:1725:6a2f:0370:6234.
• <xxx_v6mask>: An IPv6 netmask, such as /96.
• <xxx_ipv6mask>: An IPv6 address and netmask
separated by a space.
• <xxx_str>: A string of characters that is not another data
type, such as P@ssw0rd. Strings containing spaces or
special characters must be surrounded in quotes or use
escape sequences.
• <xxx_int>: An integer number that is not another data
type, such as 15 for the number of minutes.
Curly braces { }A word or series of words that is constrained to a set of
options delimited by either vertical bars or spaces.
You must enter at least one of the options, unless the set of
options is surrounded by square brackets [ ].
Options
delimited by
vertical bars |
Options
delimited by
spaces
Mutually exclusive options. For example:
{enable | disable}
indicates that you must enter either enable or disable, but
must not enter both.
Non-mutually exclusive options. For example:
{http https ping snmp ssh telnet}
indicates that you may enter all or a subset of those options, in
any order, in a space-delimited list, such as:
ping https ssh
To change the options, you must re-type the entire list. For
example, to add snmp to the previous example, you would
type:
ping https snmp ssh
If the option adds to or subtracts from the existing list of
options, instead of replacing it, or if the list is
comma-delimited, the exception will be noted.
After physically installing the FortiVoice Gateway, you need to connect to its management tools
to configure, maintain, and administer the unit.
This topic includes:
• Connecting to the web-based manager or CLI
Connecting to the web-based manager or CLI
There are two methods to connect to the FortiVoice Gateway:
• use the web-based manager, a graphical user interface (GUI), from within a web browser
• use the command line interface (CLI), an interface similar to DOS or UNIX commands, from a
Secure Shell (SSH), Telnet terminal, or serial connection
Access to the CLI and/or web-based manager is not yet configured if:
• you are connecting for the first time
• you have just reset the configuration to its default state
• you have just restored the firmware
In these cases, you must access either interface using the default settings.
If the above conditions do not apply, access the web UI using the IP address, administrative
access protocol, administrator account and password already configured, instead of the
default settings.
After you connect, you can use the web-based manager or CLI to configure basic network
settings and access the CLI and/or web-based manager through your network. However, if you
want to update the firmware, you may want to do so before continuing. See “System
Information widget” on page 17.
Until the FortiVoice Gateway is configured with an IP address and connected to your network,
you may prefer to connect the FortiVoice Gateway directly to your management computer, or
through a switch, in a peer network that is isolated from your overall network. However,
isolation is not required.
To connect to the web-based manager using its default settings, you must have:
• a computer with an RJ-45 Ethernet network port
• a web browser such as Microsoft Internet Explorer version 6.0 or greater, or a recent version
of Mozilla Firefox
• a crossover network cable
Table 3: Default settings for connecting to the web-based manager
Network Interfaceport1
URLhttps://192.168.1.99/admin
Administrator Accountadmin
Password(none)
To connect to the web-based manager
1. On your management computer, configure the Ethernet port with the static IP address
192.168.1.2 with a netmask of 255.255.255.0.
2. Using the Ethernet cable, connect your computer’s Ethernet port to the FortiVoice’s port1.
3. Start your browser and enter the URL https://192.168.1.99/admin. (Remember to include the
“s” in https://.)
To support HTTPS authentication, the FortiVoice Gateway ships with a self-signed security
certificate, which it presents to clients whenever they initiate an HTTPS connection to the
FortiVoice. When you connect, depending on your web browser and prior access of the
FortiVoice, your browser might display two security warnings related to this certificate:
• The certificate is not automatically trusted because it is self-signed, rather than being
signed by a valid certificate authority (CA). Self-signed certificates cannot be verified with
a proper CA, and therefore might be fraudulent. You must manually indicate whether or
not to trust the certificate.
• The certificate might belong to another web site. The common name (CN) field in the
certificate, which usually contains the host name of the web site, does not exactly match
the URL you requested. This could indicate server identity theft, but could also simply
indicate that the certificate contains a domain name while you have entered an IP
address. You must manually indicate whether this mismatch is normal or not.
Both warnings are normal for the default certificate.
4. Verify and accept the certificate, either permanently (the web browser will not display the
self-signing warning again) or temporarily. You cannot log in until you accept the certificate.
For details on accepting the certificate, see the documentation for your web browser.
5. In the Name field, type admin, then click Login. (In its default state, there is no password for
this account.)
Login credentials entered are encrypted before they are sent to the FortiVoice. If your login is
successful, the web UI appears. To continue by updating the firmware, see “System
Information widget” on page 17. Otherwise, to continue by following the configuration
Using its default settings, you can access the CLI from your management computer in two
ways:
• a local serial console connection
• an SSH connection, either local or through the network
To connect to the CLI using a local serial console connection, you must have:
• a computer with a serial communications (COM) port
• the RJ-45-to-DB-9 serial or null modem cable included in your FortiVoice package
• terminal emulation software, such as HyperTerminal for Microsoft Windows
To connect to the CLI using an SSH connection, you must have:
• a computer with an RJ-45 Ethernet port
• a crossover Ethernet cable
• an SSH client, such as PuTTY
Table 4: Default settings for connecting to the CLI by SSH
Network Interfaceport1
IP Address192.168.1.99
SSH Port Number22
Administrator Accountadmin
Password(none)
If you are not connecting for the first time, nor have you just reset the configuration to its
default state or restored the firmware, administrative access settings may have already been
configured. In this case, access the CLI using the IP address, administrative access protocol,
administrator account and password already configured, instead of the default settings.
The following procedure uses Microsoft HyperTerminal. Steps may vary with other terminal
emulators.
To connect to the CLI using a local serial console connection
1. Using the RJ-45-to-DB-9 or null modem cable, connect your computer’s serial
communications (COM) port to the FortiVoice’s console port.
2. Verify that the FortiVoice is powered on.
3. On your management computer, start HyperTerminal.
4. On Connection Description, enter a Name for the connection and select OK.
5. On Connect To, from Connect using, select the communications (COM) port where you
connected the FortiVoice.
6. Select OK.
7. Select the following Port settings and select OK.
The terminal emulator connects to the CLI and the CLI displays a login prompt.
9. Type admin and press Enter twice. (In its default state, there is no password for this
account.)
The CLI displays a prompt, such as:
FortiVoice #
10.Type admin and press Enter twice. (In its default state, there is no password for this
account.)
The CLI displays the following text:
Type ? for a list of commands.
You can now enter commands.
The following procedure uses PuTTY. Steps may vary with other SSH clients.
To connect to the CLI using an SSH connection
1. On your management computer, configure the Ethernet port with the static IP address
192.168.1.2 with a netmask of 255.255.255.0.
2. Using the Ethernet cable, connect your computer’s Ethernet port to the FortiVoice’s port1.
3. Verify that the FortiVoice is powered on.
4. On your management computer, start your SSH client.
5. In Host Name (or IP Address), type 192.168.1.99.
6. In Port, type 22.
7. From Connection type, select SSH.
8. Select Open.
The SSH client connects to the FortiVoice.
The SSH client may display a warning if this is the first time you are connecting to the
FortiVoice and its SSH key is not yet recognized by your SSH client, or if you have previously
connected to the FortiVoice but it used a different IP address or SSH key. If your
management computer is directly connected to the FortiVoice with no network hosts
between them, this is normal.
9. Click Yes to verify the fingerprint and accept the FortiVoice’s SSH key. You cannot log in until
you accept the key.
The Status menu displays system usage, log messages, and other status-indicating items.
This topic includes:
• Viewing overall system status
• Viewing system status
• Viewing call records
• Viewing log messages
Viewing overall system status
The Status menu displays system status, most of which pertain to the entire system, such as
service status and system resource.
This topic includes:
• Viewing the dashboard
• Viewing the Call Statistics
• Using the CLI Console
Viewing the dashboard
Status > Dashboard displays first after you log in to the web-based manager. It contains a
dashboard with widgets that each indicates performance level or other statistics.
By default, widgets display the serial number and current system status of the FortiVoice
Gateway, including uptime, system resource usage, service status, firmware version, system
time, and statistics history.
To view the dashboard, go to Status > Dashboard > Dashboard.
Figure 1: Monitor system status
The dashboard is customizable. You can select which widgets to display, where they are
located on the tab, and whether they are minimized or maximized.
To move a widget, position your mouse cursor on the widget’s title bar, then click and drag the
widget to its new location.
To show or hide a widget, in the upper left-hand corner, click Add Content, then mark the check
boxes of widgets that you want to show.
Options vary slightly from widget to widget, but always include options to close or
minimize/maximize the widget.
Figure 2: A minimized widget on the dashboard
Disclosure arrow
Widget title
Refresh
Close
System Information widget
The System Information widget displays the serial number and basic system statuses such as
the firmware version, system time, and up time.
In addition to displaying basic system information, the System Information widget lets you
change the firmware. To change the firmware, click Update for Firmware version. For more
information, see “Installing firmware” on page 54.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add Content, and mark the check box for the widget.
Service Status widget
The Service Status widget displays the number of current calls, extension status, trunk status,
and device connection status.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add Content, and mark the check box for the widget.
Following is the connection status of the FXO ports:
• Connected: The port is connected to a device.
• Disconnected: The port is not connected to any device and is ready for use.
• Alarmed: The port has an error and is not usable.
• Occupied: The port is being used.
System Resource widget
The System Resource widget displays the CPU, memory, and disk space usage. It also displays
the system load and current number of IP sessions.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add Content, and mark the check box for the widget.
The system resources history can also be viewed in this widget by clicking History. The system
resources history contains four graphs. Each graph displays readings of one of the system
resources: CPU, memory, IP sessions, and network bandwidth usage. Each graph is divided by
a grid.
Statistics History widget
The Statistics History widget contains charts that summarize the number of calls in each time
period that the FortiVoice Gateway unit recorded.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add Content, and mark the check box for the widget.
Also see “Viewing the Call Statistics” on page 18.
System Command widget
The System Command widget lets you restart, shut down, or reload the configuration of the
FortiVoice Gateway unit.
To view the widget, go to Status > Dashboard. If the widget is not currently shown, click Add Content, and mark the check box for the widget.
Before rebooting or halting the FortiVoice Gateway unit, consider notifying your phone users, as
it could result in temporary interruptions to connectivity.
Reloading allows the FortiVoice Gateway to reload its configuration from its last saved version,
and log you out. Any changes that were in progress but not yet saved, such as GUI pages that
were not applied or CLI commands where you had not yet entered next or end, are lost. If you
want to continue configuring the FortiVoice Gateway, refresh your browser and log in again.
Viewing the Call Statistics
The Call Statistics tab contains summaries of the number of calls by time and direction that the
FortiVoice Gateway recorded.
To view call statistics, go to Status > Dashboard > Call Statistics.
Using the CLI Console
Go to Status > Dashboard > Console to access the CLI without exiting from the web-based
manager.
You can click the Open in New Window at the bottom of the page to move the CLI Console into
a pop-up window that you can resize and reposition.
Viewing system status
Status> System displays all the ongoing phone calls and trunks.
This topic includes:
• Viewing active calls
• Viewing trunk status
Viewing active calls
Status> System > Active Calls displays all the ongoing phone calls in realtime, including the
callers and receivers, the trunks through which phone calls are connected, the call status, and
the call duration.
You can stop a phone call by clicking the Hang up icon.
The call statuses include:
• Ringing: The receiver’s phone is ringing.
• Connected: Callers are connected. The voice channel is established.
Status> System > Trunks displays all the trunks in realtime, including their names, IP
addresses, types, status, and registration/connection status with the VoIP or PSTN service
provider.
The trunk statuses include:
• Not registered: The trunk is not registered with the VoIP or PSTN service provider and is not
in service.
• In service: The trunk is registered with the VoIP or PSTN service provider and is in service.
• Unavailable: The trunk is not reachable.
• Alarm detected: There is a problem with the trunk.
• Admin down: The trunk is disabled.
• Unmonitored: The trunk is not monitored.
When you click the IP address of a SIP extension, you can interface with the extension and
configure it remotely.
Registration/Connection indicates if a trunk has been registered with or connected to the VoIP
or PSTN service provider.
You can stop a phone call by clicking the Hang up icon.
For more information, see “Configuring FortiVoice Gateway” on page 43.
Viewing call records
Status > Call Detail Records (CDR) displays all the phone calls made during a certain time
period, including time of the call, caller and receiver, call duration, call status, and call direction.
Double-clicking a record displays the detailed call information, including the CDR flow.
You can filter the call records display by clicking the Search button and enter criteria that
records must match in order to be visible. You can also save the call records by clicking the
Download button.
Viewing log messages
The Logs submenu displays locally stored log files. If you configured the FortiVoice Gateway to
store log messages locally (that is, to the hard disk), you can view the log messages currently
stored in each log file.
Logs stored remotely cannot be viewed from the web-based manager of the FortiVoice
Gateway. If you want to view logs from the web-based manager, also enable local storage. For
details, see “Configuring Logs” on page 51.
Status > Logs displays the logs of administrator activities and system events as well as voice.
To view the list of log files and their contents
1. Go to Status > Logs > Event/Voice.
The list of log files appears with the beginning and end of a log file’s time range and the size
of a log file in bytes. The queue log files display more information.
2. To download an event, voice, fax, and call center log file, select it and click Download to
save it in one of the three formats:
• Normal Format for a log file that can be viewed with a plain text editor such as Microsoft
Notepad.
• CSV Format for a comma-separated value (.csv) file that can be viewed in a spreadsheet
application such as Microsoft Excel or OpenOffice Calc.
• Compressed Format for a plain text log file like Normal Format, except that it is
compressed and stored within a .gz archive.
3. To search the log files, click the Search button and enter criteria that records must match in
order to be visible.
Unlike the search when viewing the contents of an individual log file, this search displays
results regardless of which log file contains them. For more information, see “Searching log
messages” on page 22.
4. To view messages contained in logs, double-click a log file.
To view the current page’s worth of the log messages as an HTML table, right-click and
select Export to Table. The table appears in a new tab. To download the table, click and drag
to select the whole table, then copy and paste it into a rich text editor such as Microsoft
Word or OpenOffice Writer.
Log messages can appear in either raw or formatted views.
• Raw view displays log messages exactly as they appear in the plain text log file.
• Formatted view displays log messages in a columnar format. Each log field in a log
message appears in its own column, aligned with the same field in other log messages,
for rapid visual comparison.
By default, log messages always appear in columnar format, with one log field per column.
However, when viewing this columnar display, you can also view the log message in raw
format by hovering your mouse over the index number of the log message, in the # column,
as shown in Figure 3.
Figure 3: Log message view
Log message in raw format
Log message in columnar format
The log messages vary by levels. For more information, see “Configuring Logs” on page 51.
The log messages are also filtered by subtypes:
• Configuration: Display only log messages containing subtype=config.
• Administration: Display only log messages containing subtype=admin.
• System: Display only log messages containing subtype=system.
You can click the Save View button to save the customized view. Future log message reports
appear in this view.