Fortinet Document Library

Version:

Version:

Version:


Table of Contents

New Features

Download PDF
Copy Link

Firmware template

You can create a firmware template and assign the template to devices or device groups. In the firmware template, you can define what firmware version to install on FortiGate devices and all access devices, such as FortiAP, FortiSwitch, and FortiExtender. When you assign the template to one or more devices or to a device group, a firmware upgrade job is scheduled to rectify the firmware version on all affected devices.

This topic contains the following sections:

Creating firmware upgrade templates for FortiGates

To create a firmware template for FortiGates:
  1. Go to Device Manager > Device & Groups > Firmware Templates, and click Create New.

    The Create New Firmware Template pane is displayed.

  2. Create the FortiGate platform and specify the target FortiOS version:
    1. Under Upgrade Details, click Create New.

      The Create New Upgrade Firmware dialog box is displayed.

    2. In the Product list, select FortiGate.
    3. In the Platform list, select a platform, or select All Platforms.
    4. In the Upgrade to list, select the FortiOS version.
    5. Click OK.
  3. Under Install Window, select None, Once, Daily, or Weekly to specify when to start the upgrade. 

    For the Daily and Weekly options, the upgrade starts when the scheduled time arrives. If the upgrade fails or does not finish in one upgrade window, the upgrade ceases, and then starts again when the schedule time arrives again.

    Example of the Daily option:

    Example of the Weekly option:

    For example, create a firmware template with the Daily or Weekly option set to upgrade between 09:00 to 22:00, and assign the template to a device group with 98 devices at 21:45. FortiManager cannot finish upgrading all FortiGate devices in 15 minutes. As a result, the upgrade tasks fails for unfinished devices, but FortiManager resumes upgrading unfinished devices when the next scheduled upgrade window starts, which is 09:00 the next day.

  4. Set the remaining options, and click OK.

    The firmware template is created.

  5. Assign the firmware template to one or more devices.
    1. Right-click the template, and select Assign to Device.

      The Select Installation Targets dialog box is displayed.

    2. In the Available Entries list, select one or more devices, and click > to move them to the Selected Entries.
    3. Click OK.

      The template is assigned to the devices in the Selected Entries list. You can view the assigned devices on the Device Manager > Device & Groups pane.

  6. Preview the upgrade and view the upgrade path.
    1. Right-click the template, and select Upgrade Preview.

      The Firmware Upgrade Preview dialog box is displayed. If there is an upgrade path, the path is displayed in the Upgrade Path column.

    2. Click Close.
  7. After an upgrade completes, you can view upgrade history.
    1. Right-click the template, and select Upgrade History.

      The Firmware Upgrade History dialog box is displayed.

    2. Click Close.

Creating firmware templates for access devices

When access devices, such as FortiAP, FortiSwitch, and FortiExtender, are attached to a FortiGate, you can create a firmware template for the access devices, and assign the template to the FortiGate.

To create a firmware template for access devices:
  1. Go to Device Manager > Device & Groups > Firmware Templates, and click Create New.

    The Create New Firmware Template pane is displayed.

  2. Specify the firmware version for FortiSwitch, FortiAP, and FortiExtender, as well as the install window, and click OK.

  3. Assign the firmware template to the FortiGate.
    1. Right-click the template, and select Assign to Device.

      The Select Installation Targets dialog box is displayed.

    2. In the Available Entries list, select the FortiGate, and click > to move it to the Selected Entries.

    3. Click OK.

      The template is assigned to the FortiGate.

      When the install window for the upgrade arrives, the upgrade begins, and an upgrade task is created under System Settings > Task Monitor.

      When all firmware upgrades for the task complete, the task displays 100%.

      If any of the upgrades for the task fail, the entire upgrade task is stopped, and the upgrade failure is reported in the task.

Firmware template

You can create a firmware template and assign the template to devices or device groups. In the firmware template, you can define what firmware version to install on FortiGate devices and all access devices, such as FortiAP, FortiSwitch, and FortiExtender. When you assign the template to one or more devices or to a device group, a firmware upgrade job is scheduled to rectify the firmware version on all affected devices.

This topic contains the following sections:

Creating firmware upgrade templates for FortiGates

To create a firmware template for FortiGates:
  1. Go to Device Manager > Device & Groups > Firmware Templates, and click Create New.

    The Create New Firmware Template pane is displayed.

  2. Create the FortiGate platform and specify the target FortiOS version:
    1. Under Upgrade Details, click Create New.

      The Create New Upgrade Firmware dialog box is displayed.

    2. In the Product list, select FortiGate.
    3. In the Platform list, select a platform, or select All Platforms.
    4. In the Upgrade to list, select the FortiOS version.
    5. Click OK.
  3. Under Install Window, select None, Once, Daily, or Weekly to specify when to start the upgrade. 

    For the Daily and Weekly options, the upgrade starts when the scheduled time arrives. If the upgrade fails or does not finish in one upgrade window, the upgrade ceases, and then starts again when the schedule time arrives again.

    Example of the Daily option:

    Example of the Weekly option:

    For example, create a firmware template with the Daily or Weekly option set to upgrade between 09:00 to 22:00, and assign the template to a device group with 98 devices at 21:45. FortiManager cannot finish upgrading all FortiGate devices in 15 minutes. As a result, the upgrade tasks fails for unfinished devices, but FortiManager resumes upgrading unfinished devices when the next scheduled upgrade window starts, which is 09:00 the next day.

  4. Set the remaining options, and click OK.

    The firmware template is created.

  5. Assign the firmware template to one or more devices.
    1. Right-click the template, and select Assign to Device.

      The Select Installation Targets dialog box is displayed.

    2. In the Available Entries list, select one or more devices, and click > to move them to the Selected Entries.
    3. Click OK.

      The template is assigned to the devices in the Selected Entries list. You can view the assigned devices on the Device Manager > Device & Groups pane.

  6. Preview the upgrade and view the upgrade path.
    1. Right-click the template, and select Upgrade Preview.

      The Firmware Upgrade Preview dialog box is displayed. If there is an upgrade path, the path is displayed in the Upgrade Path column.

    2. Click Close.
  7. After an upgrade completes, you can view upgrade history.
    1. Right-click the template, and select Upgrade History.

      The Firmware Upgrade History dialog box is displayed.

    2. Click Close.

Creating firmware templates for access devices

When access devices, such as FortiAP, FortiSwitch, and FortiExtender, are attached to a FortiGate, you can create a firmware template for the access devices, and assign the template to the FortiGate.

To create a firmware template for access devices:
  1. Go to Device Manager > Device & Groups > Firmware Templates, and click Create New.

    The Create New Firmware Template pane is displayed.

  2. Specify the firmware version for FortiSwitch, FortiAP, and FortiExtender, as well as the install window, and click OK.

  3. Assign the firmware template to the FortiGate.
    1. Right-click the template, and select Assign to Device.

      The Select Installation Targets dialog box is displayed.

    2. In the Available Entries list, select the FortiGate, and click > to move it to the Selected Entries.

    3. Click OK.

      The template is assigned to the FortiGate.

      When the install window for the upgrade arrives, the upgrade begins, and an upgrade task is created under System Settings > Task Monitor.

      When all firmware upgrades for the task complete, the task displays 100%.

      If any of the upgrades for the task fail, the entire upgrade task is stopped, and the upgrade failure is reported in the task.