Fortinet white logo
Fortinet white logo

CLI Reference

fwm-setting

fwm-setting

Use this command to configure firmware management settings.

Syntax

config fmupdate fwm-setting

set auto-scan-fgt-disk {enable | disable}

set check-fgt-disk {enable | disable}

set fds-failover-fmg {enable | disable}

set fds-image-timeout <integer>

set health-check {enable | disable}

set immx-source {cloud | fgt | fmg}

set log {fwm | fwm_dm | fwm_dm_json}

set max-device-history <integer>

set-profile-history <integer>

set multiple-steps-interval <integer>

set retry-interval <integer>

set retry-max <integer>

set retrieve {enable | disable}

set revision-diff {enable | disable}

set send-image-retry <integer>

config upgrade-timeout

set check-status-timeout <integer>

set ctrl-check-status-timeout <integer>

set ctrl-put-image-by-fds-timeout <integer>

set ha-sync-timeout <integer>

set health-check-timeout <integer>

set license-check-timeout <integer>

set prepare-image-timeout <integer>

set put-image-by-fds-timeout <integer>

set put-image-timeout <integer>

set reboot-of-fsck-timeout <integer>

set reboot-of-upgrade-timeout <integer>

set retrieve-timeout <integer>

set rpc-timeout <integer>

set total-timeout <integer>

end

end

Variable

Description

auto-scan-fgt-disk {enable | disable}

Enable/disable automatic scanning of a FortiGate disk when required (default = enable).

check-fgt-disk {enable | disable}

Enable/disable checking a FortiGate disk prior to upgrading the image (default = enable).

fds-failover-fmg {enable | disable}

Enable/disable using the a local image file on the FortiManager when the FDS download fails (default = enable).

fds-image-timeout <integer>

Set the timer for FortiGate image downloads from FortiGuard, in seconds (300 - 3600, default = 1800).

immx-source {cloud | fgt | fmg}

Configure which of the IMMX file to be used for choosing the upgrade patch:

  • cloud: Use the IMMX file for FortiCloud.
  • fgt: Use the IMMX file for FortiGate.
  • fmg: Use the IMMX file for FortiManager.

The default file is the one for FortiManager (default = fmg).

log {fwm | fwm_dm | fwm_dm_json}

Configure log setting for the firmware manager daemon (default = fwm_dm):

  • fwm: Firmware Manager daemon log.

  • fwm_dm: Firmware Manager and deployment service log.

  • fwm_dm_json: Firmware Manager and Deployment service log with JSON data between FortiManager-FortiGate.

multiple-steps-interval <integer>

Set the waiting time between multiple step upgrades, in seconds (30 - 180, default = 60).

retry-interval <integer>

Waiting time for resending request to device (1 - 360, default = 60).

retry-max <integer>

Maximum number of retries for sending request to device (0 - 100, default = 10).

send-image-retry <integer>

Set to retry send image when failed. Set to 0 for no retry (0 - 2, default = 0).

Variables for config upgrade-timeout subcommand:

check-status-timeout <integer>

Set the timeout for checking status after tunnnel is up, in seconds. (1 - 6000, default = 600)

ctrl-check-status-timeout <integer>

Set the timeout for checking FortiAP/FortiSwitch/FortiExtender status after request upgrade, in seconds. (1 - 12000, default = 1200)

ctrl-put-image-by-fds-timeout <integer>

Set the timeout for waiting device get FortiAP/FortiSwitch/FortiExtender image from FortiGuard, in seconds. (1 - 9000, default = 900)

ha-sync-timeout <integer>

Set the timeout for waiting HA sync, in seconds. (1 - 18000, default = 1800)

health-check-timeout <interger>

Set the timeout for waiting retrieve, in seconds. (1 - 6000, default = 600).

license-check-timeout <integer>

Set the timeout for waiting FortiGate check license, in seconds. (1 - 6000, default = 600)

prepare-image-timeout <integer>

Set the timeout for preparing image, in seconds. (1 - 6000, default = 600)

put-image-by-fds-timeout <integer>

Set the timeout for waiting device get image from FortiGuard, in seconds. (1 - 18000, default = 1800)

put-image-timeout <integer>

Set the timeout for waiting send image over tunnel, in seconds. (1 - 18000, default = 1800)

reboot-of-fsck-timeout <integer>

Set the timeout for waiting FortiGate reboot, in seconds. (1 - 18000, default = 1800)

reboot-of-upgrade-timeout <integer>

Set the timeout for waiting FortiGate reboot after image upgrade, in seconds. (1 - 12000, default = 1200)

retrieve-timeout <integer>

Set the timeout for waiting retrieve, in seconds. (1 - 18000, default = 1800)

rpc-timeout <integer>

Set the timeout for waiting FortiGate rpc response, in seconds. (1 - 1800, default = 180)

total-timeout <integer>

Set the timeout for the whole FortiGate upgrade, in seconds. (1 - 86400, default = 3600)

fwm-setting

fwm-setting

Use this command to configure firmware management settings.

Syntax

config fmupdate fwm-setting

set auto-scan-fgt-disk {enable | disable}

set check-fgt-disk {enable | disable}

set fds-failover-fmg {enable | disable}

set fds-image-timeout <integer>

set health-check {enable | disable}

set immx-source {cloud | fgt | fmg}

set log {fwm | fwm_dm | fwm_dm_json}

set max-device-history <integer>

set-profile-history <integer>

set multiple-steps-interval <integer>

set retry-interval <integer>

set retry-max <integer>

set retrieve {enable | disable}

set revision-diff {enable | disable}

set send-image-retry <integer>

config upgrade-timeout

set check-status-timeout <integer>

set ctrl-check-status-timeout <integer>

set ctrl-put-image-by-fds-timeout <integer>

set ha-sync-timeout <integer>

set health-check-timeout <integer>

set license-check-timeout <integer>

set prepare-image-timeout <integer>

set put-image-by-fds-timeout <integer>

set put-image-timeout <integer>

set reboot-of-fsck-timeout <integer>

set reboot-of-upgrade-timeout <integer>

set retrieve-timeout <integer>

set rpc-timeout <integer>

set total-timeout <integer>

end

end

Variable

Description

auto-scan-fgt-disk {enable | disable}

Enable/disable automatic scanning of a FortiGate disk when required (default = enable).

check-fgt-disk {enable | disable}

Enable/disable checking a FortiGate disk prior to upgrading the image (default = enable).

fds-failover-fmg {enable | disable}

Enable/disable using the a local image file on the FortiManager when the FDS download fails (default = enable).

fds-image-timeout <integer>

Set the timer for FortiGate image downloads from FortiGuard, in seconds (300 - 3600, default = 1800).

immx-source {cloud | fgt | fmg}

Configure which of the IMMX file to be used for choosing the upgrade patch:

  • cloud: Use the IMMX file for FortiCloud.
  • fgt: Use the IMMX file for FortiGate.
  • fmg: Use the IMMX file for FortiManager.

The default file is the one for FortiManager (default = fmg).

log {fwm | fwm_dm | fwm_dm_json}

Configure log setting for the firmware manager daemon (default = fwm_dm):

  • fwm: Firmware Manager daemon log.

  • fwm_dm: Firmware Manager and deployment service log.

  • fwm_dm_json: Firmware Manager and Deployment service log with JSON data between FortiManager-FortiGate.

multiple-steps-interval <integer>

Set the waiting time between multiple step upgrades, in seconds (30 - 180, default = 60).

retry-interval <integer>

Waiting time for resending request to device (1 - 360, default = 60).

retry-max <integer>

Maximum number of retries for sending request to device (0 - 100, default = 10).

send-image-retry <integer>

Set to retry send image when failed. Set to 0 for no retry (0 - 2, default = 0).

Variables for config upgrade-timeout subcommand:

check-status-timeout <integer>

Set the timeout for checking status after tunnnel is up, in seconds. (1 - 6000, default = 600)

ctrl-check-status-timeout <integer>

Set the timeout for checking FortiAP/FortiSwitch/FortiExtender status after request upgrade, in seconds. (1 - 12000, default = 1200)

ctrl-put-image-by-fds-timeout <integer>

Set the timeout for waiting device get FortiAP/FortiSwitch/FortiExtender image from FortiGuard, in seconds. (1 - 9000, default = 900)

ha-sync-timeout <integer>

Set the timeout for waiting HA sync, in seconds. (1 - 18000, default = 1800)

health-check-timeout <interger>

Set the timeout for waiting retrieve, in seconds. (1 - 6000, default = 600).

license-check-timeout <integer>

Set the timeout for waiting FortiGate check license, in seconds. (1 - 6000, default = 600)

prepare-image-timeout <integer>

Set the timeout for preparing image, in seconds. (1 - 6000, default = 600)

put-image-by-fds-timeout <integer>

Set the timeout for waiting device get image from FortiGuard, in seconds. (1 - 18000, default = 1800)

put-image-timeout <integer>

Set the timeout for waiting send image over tunnel, in seconds. (1 - 18000, default = 1800)

reboot-of-fsck-timeout <integer>

Set the timeout for waiting FortiGate reboot, in seconds. (1 - 18000, default = 1800)

reboot-of-upgrade-timeout <integer>

Set the timeout for waiting FortiGate reboot after image upgrade, in seconds. (1 - 12000, default = 1200)

retrieve-timeout <integer>

Set the timeout for waiting retrieve, in seconds. (1 - 18000, default = 1800)

rpc-timeout <integer>

Set the timeout for waiting FortiGate rpc response, in seconds. (1 - 1800, default = 180)

total-timeout <integer>

Set the timeout for the whole FortiGate upgrade, in seconds. (1 - 86400, default = 3600)