Fortinet black logo

FortiVoice Phone System Administration Guide

Upgrading the firmware

Upgrading the firmware

Caution

Before upgrading the firmware of the FortiVoice unit, 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.

Older 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.

You can use either the GUI or the CLI to upgrade the firmware of the FortiVoice unit.

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

To determine if you are upgrading your firmware image, examine the firmware version number. For example, if your current firmware version is v64,build0446 and you are changing to v64,build0469, then the later build number indicates that you are upgrading your firmware image.

To upgrade the firmware using the GUI

  1. Download the firmware image files from the Fortinet Support website. For details, see Downloading the firmware image file.
  2. Back up the configuration and call data. For details, see Backing up the configuration.
  3. Log in to the GUI as the admin administrator, or an administrator account that has system configuration read and write privileges.
  4. To upload the firmware for an upgrade:
    1. Go to Dashboard > Status.
    2. In the System Information widget, go to Firmware version and click Update.
    3. Locate and select the file, and then click Open.
    4. To confirm the upload, click Yes.

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

  5. Clear the cache of your web browser and restart it to ensure that it reloads the GUI and correctly displays all changes.
  6. To verify that the firmware was successfully installed, log in to the GUI and go to Dashboard > Status and in the System Information area. Text appearing in the Firmware version row indicates the currently installed firmware version. [

To install firmware using the CLI

  1. Download the firmware image files from the Fortinet Support website. For details, see Downloading the firmware image file.
  2. Back up the configuration and call data. For details, see Backing up the configuration.
  3. Connect your management computer to the FortiVoice 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 unit, 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 unit 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 unit can reach the TFTP server.

    To use the FortiVoice 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 unit:

    execute restore image tftp <name_str> <tftp_ipv4>

    where <name_str> 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 unit downloads the firmware image file from the TFTP server. The FortiVoice unit 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 unit reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice unit or restore the configuration file.

  10. If you also use the GUI, clear the cache of your web browser and restart it to ensure that it reloads the GUI 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. Go to Verifying the configuration after an upgrade.

Verifying the configuration after an upgrade

After upgrading to a new firmware image, 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 the 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 GUI.
  2. Log in to the GUI 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.

Upgrading the firmware

Caution

Before upgrading the firmware of the FortiVoice unit, 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.

Older 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.

You can use either the GUI or the CLI to upgrade the firmware of the FortiVoice unit.

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

To determine if you are upgrading your firmware image, examine the firmware version number. For example, if your current firmware version is v64,build0446 and you are changing to v64,build0469, then the later build number indicates that you are upgrading your firmware image.

To upgrade the firmware using the GUI

  1. Download the firmware image files from the Fortinet Support website. For details, see Downloading the firmware image file.
  2. Back up the configuration and call data. For details, see Backing up the configuration.
  3. Log in to the GUI as the admin administrator, or an administrator account that has system configuration read and write privileges.
  4. To upload the firmware for an upgrade:
    1. Go to Dashboard > Status.
    2. In the System Information widget, go to Firmware version and click Update.
    3. Locate and select the file, and then click Open.
    4. To confirm the upload, click Yes.

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

  5. Clear the cache of your web browser and restart it to ensure that it reloads the GUI and correctly displays all changes.
  6. To verify that the firmware was successfully installed, log in to the GUI and go to Dashboard > Status and in the System Information area. Text appearing in the Firmware version row indicates the currently installed firmware version. [

To install firmware using the CLI

  1. Download the firmware image files from the Fortinet Support website. For details, see Downloading the firmware image file.
  2. Back up the configuration and call data. For details, see Backing up the configuration.
  3. Connect your management computer to the FortiVoice 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 unit, 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 unit 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 unit can reach the TFTP server.

    To use the FortiVoice 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 unit:

    execute restore image tftp <name_str> <tftp_ipv4>

    where <name_str> 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 unit downloads the firmware image file from the TFTP server. The FortiVoice unit 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 unit reverts the configuration to default values for that version of the firmware. You must either reconfigure the FortiVoice unit or restore the configuration file.

  10. If you also use the GUI, clear the cache of your web browser and restart it to ensure that it reloads the GUI 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. Go to Verifying the configuration after an upgrade.

Verifying the configuration after an upgrade

After upgrading to a new firmware image, 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 the 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 GUI.
  2. Log in to the GUI 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.