Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

FortiVoice Gateway Administration Guide

Installing the firmware

Caution

If you are upgrading, the upgrade process may require a specific path. Very old versions of the firmware may not be supported by the configuration upgrade scripts that are used by the newest firmware. As a result, you may need to upgrade to an intermediate version of the firmware first, before upgrading to your intended version.

Before upgrading the firmware of the FortiVoice Gateway, review the Release Notes for the new firmware version. The Release Notes document includes the most current upgrade information such as the supported upgrade path and may contain details that were unavailable at the time this guide was created.

You can use either the web-based manager or the CLI to upgrade or downgrade the firmware of the FortiVoice Gateway.

Administrators whose access profile contains Read-Write access in the Others category, such as the admin administrator, can change the FortiVoice Gateway firmware.

Firmware changes are either:

  • An upgrade to a newer version.
  • A reversion to an earlier version.

To determine if you are upgrading or reverting your firmware image, examine the firmware version number. To access the firmware version in the FortiVoice Gateway web-based manager, go to Dashboard > Status and the System Information widget. You can find the firmware version details in the Firmware version row. For example, if your current firmware version is v6.4.4,build414 and you are changing to v6.4.5,build446, a later build number, indicates that you are upgrading.

To install the firmware using the web-based manager
Caution

Before upgrading or downgrading, make sure to back up the configuration and call data. For details, see Backing up the configuration.

Caution

Reverting to an earlier firmware version may cause the FortiVoice Gateway to remove parts of the configuration that are not valid for that earlier version. In some cases, you may lose all call data and configurations.

  1. Log in to the Fortinet Customer Service and Support website.
  2. Download the firmware image file to your management computer.
  3. Log in to the web-based manager as the admin administrator, or an administrator account that has system configuration read and write privileges.
  4. Go to Dashboard > Status.
  5. In the System Information widget, go to the Firmware version row, and click Update.
  6. Click Browse to locate the firmware and then click Upload.

    Your web browser uploads the firmware file to the FortiVoice Gateway. The FortiVoice Gateway installs the firmware and restarts. Time required varies by the size of the file and the speed of your network connection.

    If you are downgrading the firmware to a previous version, the FortiVoice Gateway reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice Gateway or restore the configuration file.

  7. Clear the cache of your web browser and restart it to ensure that it reloads the web-based manager and correctly displays all changes.
  8. To verify that the firmware was successfully installed, log in to the web UI and go to Dashboard > Status. Text appearing in the Firmware version row indicates the currently installed firmware version.
To install the firmware using the CLI
  1. Log in to the Fortinet Customer Service and Support website.
  2. Download the firmware image file to your management computer.
  3. Connect your management computer to the FortiVoice Gateway console port using an RJ-45 to DB-9 serial cable or a null-modem cable.
  4. Initiate a connection from your management computer to the CLI of the FortiVoice Gateway, and log in as the admin administrator, or an administrator account that has system configuration read and write privileges.
  5. Connect port1 of the FortiVoice Gateway directly or to the same subnet as a TFTP server.
  6. Copy the new firmware image file to the root directory of the TFTP server.
  7. Verify that the TFTP server is currently running, and that the FortiVoice Gateway can reach the TFTP server.

    To use the FortiVoice Gateway CLI to verify connectivity, enter the following command:

    execute ping 192.168.2.99

    where 192.168.2.99 is the IP address of the TFTP server.

  8. Enter the following command to download the firmware image from the TFTP server to the FortiVoice Gateway:

    execute restore image tftp <name_string> <tftp_ipv4>

    where <name_string> is the name of the firmware image file and <tftp_ipv4> is the IP address of the TFTP server. For example, if the firmware image file name is image.out and the IP address of the TFTP server is 192.168.2.99, enter:

    execute restore image tftp image.out 192.168.2.99

    One of the following messages appears:

    This operation will replace the current firmware version!

    Do you want to continue? (y/n)

    or:

    Get image from tftp server OK.

    Check image OK.

    This operation will downgrade the current firmware version!

    Do you want to continue? (y/n)

  9. Type y.

    The FortiVoice Gateway downloads the firmware image file from the TFTP server. The FortiVoice Gateway installs the firmware and restarts. Time required varies by the size of the file and the speed of your network connection.

    If you are downgrading the firmware to a previous version, the FortiVoice Gateway reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice Gateway or restore the configuration file.

  10. If you also use the web-based manager, clear the cache of your web browser and restart it to ensure that it reloads the web-based manager and correctly displays all tab, button, and other changes.
  11. To verify that the firmware was successfully installed, log in to the CLI and type:

    get system status

  12. If you have downgraded the firmware version, reconnect to the FortiVoice Gateway using its default IP address for port1, 192.168.1.99, and restore the configuration file. For details, see Reconnecting to the FortiVoice Gateway and Restoring the configuration.

    If you have upgraded the firmware version, to verify the conversion of the configuration file, see Verifying the configuration. If the upgrade is unsuccessful, you can downgrade the firmware to a previous version.

Reconnecting to the FortiVoice Gateway

After downgrading to a previous firmware version, the FortiVoice Gateway reverts to default settings for the installed firmware version, including the IP addresses of network interfaces through which you connect to the FortiVoice Gateway web-based manager, CLI, or both.

To reconnect using the CLI
  1. Connect your management computer to the FortiVoice Gateway console port using an RJ-45 to DB-9 serial cable or a null-modem cable.
  2. Start a terminal emulation software (such as PuTTY).
  3. Enter a name for the connection and click OK.
  4. Configure the terminal emulation software to connect directly to the communications (COM) port on your computer and click OK.
  5. Select the following port settings and click OK:

    Bits per second

    115200

    Data bits

    8

    Parity

    None

    Stop bits

    1

    Flow control

    None

  6. Press Enter to connect to the FortiVoice Gateway CLI.

    The login prompt appears.

  7. Type admin and press Enter twice.

    The following prompt appears:

    Welcome!

  8. Enter the following command:

    set system interface <interface_string> mode static ip <address_ipv4> <mask_ipv4>

    where:

    • <interface_string> is the name of the network interface, such as port1
    • <address_ipv4> is the IP address of the network interface, such as 192.168.1.10
    • <mask_ipv4> is the netmask of the network interface, such as 255.255.255.0

    Enter the following command:

    set system interface <interface_string> config allowaccess <accessmethods_string>

    where:

    • <interface_string> is the name of the network interface configured in the previous step, such as port1
    • <accessmethods_string> is a space-delimited list of the administrative access protocols that you want to allow on that network interface, such as ping ssh https

    The IP address and netmask of the network interface are saved. You can now reconnect to either the web UI or CLI using that network interface. For information about restoring the configuration, see Restoring the configuration.

Restoring the configuration

You can restore a backup copy of the configuration file from your local PC using either the web-based manager or CLI. For information about configuration backup, see Backing up the configuration.

If you have just downgraded or restored the firmware of the FortiVoice Gateway, restoring the configuration file can be used to reconfigure the FortiVoice Gateway from its default settings.

To restore the configuration file using the web UI
  1. Clear your browser’s cache. If your browser is currently displaying the web-based manager, also refresh the page.
  2. Log in to the web-based manager.
  3. Go to System > Maintenance > Configuration.
  4. Under Restore Configuration, click Browse to locate and select the configuration file that you want to restore, then click Restore.

    The FortiVoice Gateway restores the configuration file and reboots.Time required varies by the size of the file and the speed of your network connection.

  5. After restoring the configuration file, verify that the settings have been successfully loaded. For details on verifying the configuration restoration, see Verifying the configuration.
To restore the configuration file using the CLI
  1. Initiate a connection from your management computer to the CLI of the FortiVoice Gateway, and log in as the admin administrator, or an administrator account that has system configuration read and write privileges.
  2. Connect a network interface of the FortiVoice Gateway directly or to the same subnet as a TFTP server.
  3. Copy the new firmware image file to the root directory of the TFTP server.
  4. Verify that the TFTP server is currently running, and that the FortiVoice Gateway can reach the TFTP server.

    To use the FortiVoice Gateway CLI to verify connectivity, enter the following command:

    execute ping 192.168.2.99

    where 192.168.2.99 is the IP address of the TFTP server.

  5. Enter the following command:

    execute restore config tftp <file_name> <tftp_ipv4>

    The following message appears:

    This operation will overwrite the current settings!

    (The current admin password will be preserved.)

    Do you want to continue? (y/n)

  6. Enter y.

    The FortiVoice Gateway restores the configuration file and reboots. Time required varies by the size of the file and the speed of your network connection.

  7. After restoring the configuration file, verify that the settings have been successfully loaded. For details on verifying the configuration restoration, see Verifying the configuration.

Verifying the configuration

After installing a new firmware file, you should verify that the configuration has been successfully converted to the format required by the new firmware and that no configuration data has been lost.

In addition to verifying successful conversion, verifying the configuration also provides familiarity with new and changed features.

To verify the configuration upgrade
  1. Clear your browser’s cache and refresh the login page of the web-based manager.
  2. Log in to the web-based manager using the admin administrator account.

    Other administrator accounts may not have sufficient privileges to completely review the configuration.

  3. Review the configuration and compare it with your configuration backup to verify that the configuration has been correctly converted.

Installing the firmware

Caution

If you are upgrading, the upgrade process may require a specific path. Very old versions of the firmware may not be supported by the configuration upgrade scripts that are used by the newest firmware. As a result, you may need to upgrade to an intermediate version of the firmware first, before upgrading to your intended version.

Before upgrading the firmware of the FortiVoice Gateway, review the Release Notes for the new firmware version. The Release Notes document includes the most current upgrade information such as the supported upgrade path and may contain details that were unavailable at the time this guide was created.

You can use either the web-based manager or the CLI to upgrade or downgrade the firmware of the FortiVoice Gateway.

Administrators whose access profile contains Read-Write access in the Others category, such as the admin administrator, can change the FortiVoice Gateway firmware.

Firmware changes are either:

  • An upgrade to a newer version.
  • A reversion to an earlier version.

To determine if you are upgrading or reverting your firmware image, examine the firmware version number. To access the firmware version in the FortiVoice Gateway web-based manager, go to Dashboard > Status and the System Information widget. You can find the firmware version details in the Firmware version row. For example, if your current firmware version is v6.4.4,build414 and you are changing to v6.4.5,build446, a later build number, indicates that you are upgrading.

To install the firmware using the web-based manager
Caution

Before upgrading or downgrading, make sure to back up the configuration and call data. For details, see Backing up the configuration.

Caution

Reverting to an earlier firmware version may cause the FortiVoice Gateway to remove parts of the configuration that are not valid for that earlier version. In some cases, you may lose all call data and configurations.

  1. Log in to the Fortinet Customer Service and Support website.
  2. Download the firmware image file to your management computer.
  3. Log in to the web-based manager as the admin administrator, or an administrator account that has system configuration read and write privileges.
  4. Go to Dashboard > Status.
  5. In the System Information widget, go to the Firmware version row, and click Update.
  6. Click Browse to locate the firmware and then click Upload.

    Your web browser uploads the firmware file to the FortiVoice Gateway. The FortiVoice Gateway installs the firmware and restarts. Time required varies by the size of the file and the speed of your network connection.

    If you are downgrading the firmware to a previous version, the FortiVoice Gateway reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice Gateway or restore the configuration file.

  7. Clear the cache of your web browser and restart it to ensure that it reloads the web-based manager and correctly displays all changes.
  8. To verify that the firmware was successfully installed, log in to the web UI and go to Dashboard > Status. Text appearing in the Firmware version row indicates the currently installed firmware version.
To install the firmware using the CLI
  1. Log in to the Fortinet Customer Service and Support website.
  2. Download the firmware image file to your management computer.
  3. Connect your management computer to the FortiVoice Gateway console port using an RJ-45 to DB-9 serial cable or a null-modem cable.
  4. Initiate a connection from your management computer to the CLI of the FortiVoice Gateway, and log in as the admin administrator, or an administrator account that has system configuration read and write privileges.
  5. Connect port1 of the FortiVoice Gateway directly or to the same subnet as a TFTP server.
  6. Copy the new firmware image file to the root directory of the TFTP server.
  7. Verify that the TFTP server is currently running, and that the FortiVoice Gateway can reach the TFTP server.

    To use the FortiVoice Gateway CLI to verify connectivity, enter the following command:

    execute ping 192.168.2.99

    where 192.168.2.99 is the IP address of the TFTP server.

  8. Enter the following command to download the firmware image from the TFTP server to the FortiVoice Gateway:

    execute restore image tftp <name_string> <tftp_ipv4>

    where <name_string> is the name of the firmware image file and <tftp_ipv4> is the IP address of the TFTP server. For example, if the firmware image file name is image.out and the IP address of the TFTP server is 192.168.2.99, enter:

    execute restore image tftp image.out 192.168.2.99

    One of the following messages appears:

    This operation will replace the current firmware version!

    Do you want to continue? (y/n)

    or:

    Get image from tftp server OK.

    Check image OK.

    This operation will downgrade the current firmware version!

    Do you want to continue? (y/n)

  9. Type y.

    The FortiVoice Gateway downloads the firmware image file from the TFTP server. The FortiVoice Gateway installs the firmware and restarts. Time required varies by the size of the file and the speed of your network connection.

    If you are downgrading the firmware to a previous version, the FortiVoice Gateway reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice Gateway or restore the configuration file.

  10. If you also use the web-based manager, clear the cache of your web browser and restart it to ensure that it reloads the web-based manager and correctly displays all tab, button, and other changes.
  11. To verify that the firmware was successfully installed, log in to the CLI and type:

    get system status

  12. If you have downgraded the firmware version, reconnect to the FortiVoice Gateway using its default IP address for port1, 192.168.1.99, and restore the configuration file. For details, see Reconnecting to the FortiVoice Gateway and Restoring the configuration.

    If you have upgraded the firmware version, to verify the conversion of the configuration file, see Verifying the configuration. If the upgrade is unsuccessful, you can downgrade the firmware to a previous version.

Reconnecting to the FortiVoice Gateway

After downgrading to a previous firmware version, the FortiVoice Gateway reverts to default settings for the installed firmware version, including the IP addresses of network interfaces through which you connect to the FortiVoice Gateway web-based manager, CLI, or both.

To reconnect using the CLI
  1. Connect your management computer to the FortiVoice Gateway console port using an RJ-45 to DB-9 serial cable or a null-modem cable.
  2. Start a terminal emulation software (such as PuTTY).
  3. Enter a name for the connection and click OK.
  4. Configure the terminal emulation software to connect directly to the communications (COM) port on your computer and click OK.
  5. Select the following port settings and click OK:

    Bits per second

    115200

    Data bits

    8

    Parity

    None

    Stop bits

    1

    Flow control

    None

  6. Press Enter to connect to the FortiVoice Gateway CLI.

    The login prompt appears.

  7. Type admin and press Enter twice.

    The following prompt appears:

    Welcome!

  8. Enter the following command:

    set system interface <interface_string> mode static ip <address_ipv4> <mask_ipv4>

    where:

    • <interface_string> is the name of the network interface, such as port1
    • <address_ipv4> is the IP address of the network interface, such as 192.168.1.10
    • <mask_ipv4> is the netmask of the network interface, such as 255.255.255.0

    Enter the following command:

    set system interface <interface_string> config allowaccess <accessmethods_string>

    where:

    • <interface_string> is the name of the network interface configured in the previous step, such as port1
    • <accessmethods_string> is a space-delimited list of the administrative access protocols that you want to allow on that network interface, such as ping ssh https

    The IP address and netmask of the network interface are saved. You can now reconnect to either the web UI or CLI using that network interface. For information about restoring the configuration, see Restoring the configuration.

Restoring the configuration

You can restore a backup copy of the configuration file from your local PC using either the web-based manager or CLI. For information about configuration backup, see Backing up the configuration.

If you have just downgraded or restored the firmware of the FortiVoice Gateway, restoring the configuration file can be used to reconfigure the FortiVoice Gateway from its default settings.

To restore the configuration file using the web UI
  1. Clear your browser’s cache. If your browser is currently displaying the web-based manager, also refresh the page.
  2. Log in to the web-based manager.
  3. Go to System > Maintenance > Configuration.
  4. Under Restore Configuration, click Browse to locate and select the configuration file that you want to restore, then click Restore.

    The FortiVoice Gateway restores the configuration file and reboots.Time required varies by the size of the file and the speed of your network connection.

  5. After restoring the configuration file, verify that the settings have been successfully loaded. For details on verifying the configuration restoration, see Verifying the configuration.
To restore the configuration file using the CLI
  1. Initiate a connection from your management computer to the CLI of the FortiVoice Gateway, and log in as the admin administrator, or an administrator account that has system configuration read and write privileges.
  2. Connect a network interface of the FortiVoice Gateway directly or to the same subnet as a TFTP server.
  3. Copy the new firmware image file to the root directory of the TFTP server.
  4. Verify that the TFTP server is currently running, and that the FortiVoice Gateway can reach the TFTP server.

    To use the FortiVoice Gateway CLI to verify connectivity, enter the following command:

    execute ping 192.168.2.99

    where 192.168.2.99 is the IP address of the TFTP server.

  5. Enter the following command:

    execute restore config tftp <file_name> <tftp_ipv4>

    The following message appears:

    This operation will overwrite the current settings!

    (The current admin password will be preserved.)

    Do you want to continue? (y/n)

  6. Enter y.

    The FortiVoice Gateway restores the configuration file and reboots. Time required varies by the size of the file and the speed of your network connection.

  7. After restoring the configuration file, verify that the settings have been successfully loaded. For details on verifying the configuration restoration, see Verifying the configuration.

Verifying the configuration

After installing a new firmware file, you should verify that the configuration has been successfully converted to the format required by the new firmware and that no configuration data has been lost.

In addition to verifying successful conversion, verifying the configuration also provides familiarity with new and changed features.

To verify the configuration upgrade
  1. Clear your browser’s cache and refresh the login page of the web-based manager.
  2. Log in to the web-based manager using the admin administrator account.

    Other administrator accounts may not have sufficient privileges to completely review the configuration.

  3. Review the configuration and compare it with your configuration backup to verify that the configuration has been correctly converted.