Fortinet white logo
Fortinet white logo

Upgrade Information

Upgrade Information

Before upgrade

Before any firmware upgrade, save a copy of your FortiSandbox configuration by going to System > System Recovery.

If you intend to use the new VMs after upgrade:

Ensure you have the appropriate VM licenses. Activating a VM requires the license specific to the version you are using with the equal number of clones. For example, if you have Win11 and Office 2021 activation keys you can use those keys to run the Win11O21 VM. If you want to configure 10 clones, then you will need 10 licenses.

Keep the following considerations in mind:

  • We recommend purchasing a new license, downloading the VMs, and then reassigning the clones.
  • If you download the new VMs (without updating your license) and then remove existing clones to make room for new ones, the old license will not work.

For more information about license keys, see VM Settings > Optional VMs in the FortiSandbox Administration Guide.

For a list of supported hardware and VM models, see Supported models.

Downgrading to previous firmware versions

Downgrading to previous firmware versions is not supported.

Firmware image checksums

The MD5 checksums for all Fortinet software and firmware releases are available at the Fortinet Customer Service & Support portal located at https://support.fortinet.com. After logging in, select Support > Downloads > Firmware Image Checksums, enter the image file name including the extension, and select Get Checksum Code.

Upgrade procedure

When upgrading from 4.0.0 or later and the new firmware is ready, you will see a blinking New firmware available link on the dashboard. Click the link and you will be redirected to a page where you can either choose to download and install an available firmware or manually upload a new firmware.

Upgrading FortiSandbox firmware consists of the following steps:

  1. Download the firmware image from the Fortinet Customer Service & Support portal.
  2. When upgrading via the CLI, put the firmware image on a host that supports file copy with the SCP or FTP command. The FortiSandbox must be able to access the SCP or FTP server.

    In a console window, enter the following command string to download and install the firmware image:

    fw-upgrade -b -s<SCP/FTP server IP address> -u<user name> -t<ftp|scp> -f<file path>

  3. When upgrading via the GUI, go to Dashboard > Status. Click in the System Information widget, and click Update Firmware. The Firmware Upgrade page is displayed. Browse to the firmware image on the management computer and select the Submit button.
  4. Microsoft Windows Sandbox VMs must be activated against the Microsoft activation server if they have not been already. This is done automatically after a system reboot. To ensure the activation is successful, port3 of the system must be able to access the Internet and the DNS servers should be able to resolve the Microsoft activation servers.

Upgrade path

FortiSandbox5.0.5 officially supports the following upgrade path.

Upgrade from

Upgrade to

5.0.0 - 5.0.4

5.0.5

4.4.8

5.0.0

4.4.0 - 4.4.7

4.4.8

4.2.0 - 4.2.8

4.4.0

4.0.0 - 4.0.6

4.2.0

To download the latest engine:
  1. Log in to FortiCloud.
  2. In the banner, click Support > Service Updates.
  3. On the FortiGuard Updates page, click FortiSandbox and select the OS version.

Upgrade Notice

FortiSandbox 500G and 1500G models

For 500G and 1500G models, the upgrade path is v4.2.5 NPI build to v4.4.3 build 0380, then follow the official upgrade path to 5.0.5.

FortiSandbox Hyper-V model

  1. Delete all checkpoints of the Virtual Machine instance that will be upgraded.
  2. Power off the instance.
  3. In Hyper-V Manager, go to navigating to the instance Settings > IDE Controller > Hard Drive > Edit. Increase the fsa.vhdx value to be larger than 1GB .

FortiSandbox GCP

The upgrade path on FortiSandbox GCP recommended by the GUI is not supported when upgrading from v4.2.3 to v4.2.4 and higher. As a workaround, you may upgrade directly to 4.4.0, then follow the official upgrade path to 5.0.5.

Cluster environments

Before upgrading, it is highly recommended that you set up a cluster IP set so the failover between primary and secondary can occur smoothly.

In a cluster environment, use this upgrade order:

  1. Upgrade the workers and install the new rating and tracer engine. Then wait until the devices fully boot up.
  2. Upgrade the secondary and install the new rating and tracer engine. Then wait until the device fully boots up.
  3. Upgrade the primary. This causes HA failover.
  4. Install the new rating and tracer engine on the old primary node. This node might take over as primary node.

After upgrade

After any firmware upgrade, if you are using the web UI, clear the browser cache before logging into FortiSandbox so that web UI screens display properly.

Tracer and Rating Engines

The tracer and rating engines are automatically downloaded by the FortiSandbox from FortiGuard. For air-gapped mode, the engines are available for download from our Support site.

Rating engine

Every time FortiSandbox boots up, it checks FDN for the latest rating engine.

If the rating engine is not available, you get these notifications:

  • A warning message informs you that you must have an updated rating engine.
  • The Dashboard System Information widget displays a red blinking No Rating Engine message besides Unit Type.

If necessary, you can manually download an engine package from Fortinet Customer Service & Support.

If the rating engine is not available, FortiSandbox functions in the following ways:

  • FortiSandbox still accepts on-demand, network share, and RPC submissions, but all jobs are pending.
  • FortiSandbox does not accept new devices or FortiClients.
  • FortiSandbox does not accept new submissions from Sniffer, Device, FortiClient, or Adapter.

After upgrading, FortiSandbox might stop processing files until the latest rating engine is installed either by FDN update or manually. The rating engine is large so schedule time for the download.

Upgrade Information

Upgrade Information

Before upgrade

Before any firmware upgrade, save a copy of your FortiSandbox configuration by going to System > System Recovery.

If you intend to use the new VMs after upgrade:

Ensure you have the appropriate VM licenses. Activating a VM requires the license specific to the version you are using with the equal number of clones. For example, if you have Win11 and Office 2021 activation keys you can use those keys to run the Win11O21 VM. If you want to configure 10 clones, then you will need 10 licenses.

Keep the following considerations in mind:

  • We recommend purchasing a new license, downloading the VMs, and then reassigning the clones.
  • If you download the new VMs (without updating your license) and then remove existing clones to make room for new ones, the old license will not work.

For more information about license keys, see VM Settings > Optional VMs in the FortiSandbox Administration Guide.

For a list of supported hardware and VM models, see Supported models.

Downgrading to previous firmware versions

Downgrading to previous firmware versions is not supported.

Firmware image checksums

The MD5 checksums for all Fortinet software and firmware releases are available at the Fortinet Customer Service & Support portal located at https://support.fortinet.com. After logging in, select Support > Downloads > Firmware Image Checksums, enter the image file name including the extension, and select Get Checksum Code.

Upgrade procedure

When upgrading from 4.0.0 or later and the new firmware is ready, you will see a blinking New firmware available link on the dashboard. Click the link and you will be redirected to a page where you can either choose to download and install an available firmware or manually upload a new firmware.

Upgrading FortiSandbox firmware consists of the following steps:

  1. Download the firmware image from the Fortinet Customer Service & Support portal.
  2. When upgrading via the CLI, put the firmware image on a host that supports file copy with the SCP or FTP command. The FortiSandbox must be able to access the SCP or FTP server.

    In a console window, enter the following command string to download and install the firmware image:

    fw-upgrade -b -s<SCP/FTP server IP address> -u<user name> -t<ftp|scp> -f<file path>

  3. When upgrading via the GUI, go to Dashboard > Status. Click in the System Information widget, and click Update Firmware. The Firmware Upgrade page is displayed. Browse to the firmware image on the management computer and select the Submit button.
  4. Microsoft Windows Sandbox VMs must be activated against the Microsoft activation server if they have not been already. This is done automatically after a system reboot. To ensure the activation is successful, port3 of the system must be able to access the Internet and the DNS servers should be able to resolve the Microsoft activation servers.

Upgrade path

FortiSandbox5.0.5 officially supports the following upgrade path.

Upgrade from

Upgrade to

5.0.0 - 5.0.4

5.0.5

4.4.8

5.0.0

4.4.0 - 4.4.7

4.4.8

4.2.0 - 4.2.8

4.4.0

4.0.0 - 4.0.6

4.2.0

To download the latest engine:
  1. Log in to FortiCloud.
  2. In the banner, click Support > Service Updates.
  3. On the FortiGuard Updates page, click FortiSandbox and select the OS version.

Upgrade Notice

FortiSandbox 500G and 1500G models

For 500G and 1500G models, the upgrade path is v4.2.5 NPI build to v4.4.3 build 0380, then follow the official upgrade path to 5.0.5.

FortiSandbox Hyper-V model

  1. Delete all checkpoints of the Virtual Machine instance that will be upgraded.
  2. Power off the instance.
  3. In Hyper-V Manager, go to navigating to the instance Settings > IDE Controller > Hard Drive > Edit. Increase the fsa.vhdx value to be larger than 1GB .

FortiSandbox GCP

The upgrade path on FortiSandbox GCP recommended by the GUI is not supported when upgrading from v4.2.3 to v4.2.4 and higher. As a workaround, you may upgrade directly to 4.4.0, then follow the official upgrade path to 5.0.5.

Cluster environments

Before upgrading, it is highly recommended that you set up a cluster IP set so the failover between primary and secondary can occur smoothly.

In a cluster environment, use this upgrade order:

  1. Upgrade the workers and install the new rating and tracer engine. Then wait until the devices fully boot up.
  2. Upgrade the secondary and install the new rating and tracer engine. Then wait until the device fully boots up.
  3. Upgrade the primary. This causes HA failover.
  4. Install the new rating and tracer engine on the old primary node. This node might take over as primary node.

After upgrade

After any firmware upgrade, if you are using the web UI, clear the browser cache before logging into FortiSandbox so that web UI screens display properly.

Tracer and Rating Engines

The tracer and rating engines are automatically downloaded by the FortiSandbox from FortiGuard. For air-gapped mode, the engines are available for download from our Support site.

Rating engine

Every time FortiSandbox boots up, it checks FDN for the latest rating engine.

If the rating engine is not available, you get these notifications:

  • A warning message informs you that you must have an updated rating engine.
  • The Dashboard System Information widget displays a red blinking No Rating Engine message besides Unit Type.

If necessary, you can manually download an engine package from Fortinet Customer Service & Support.

If the rating engine is not available, FortiSandbox functions in the following ways:

  • FortiSandbox still accepts on-demand, network share, and RPC submissions, but all jobs are pending.
  • FortiSandbox does not accept new devices or FortiClients.
  • FortiSandbox does not accept new submissions from Sniffer, Device, FortiClient, or Adapter.

After upgrading, FortiSandbox might stop processing files until the latest rating engine is installed either by FDN update or manually. The rating engine is large so schedule time for the download.