Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config system federated-upgrade

Coordinate federated upgrades within the Security Fabric.

config system federated-upgrade

Description: Coordinate federated upgrades within the Security Fabric.

set status [disabled|initialized|...]

set failure-reason [none|internal|...]

set failure-device {string}

set upgrade-id {integer}

set next-path-index {integer}

config node-list

Description: Nodes which will be included in the upgrade.

edit <serial>

set timing [immediate|scheduled]

set time {user}

set setup-time {user}

set upgrade-path {user}

set device-type [fortigate|fortiswitch|...]

set coordinating-fortigate {string}

next

end

end

config system federated-upgrade

Parameter

Description

Type

Size

Default

status

Current status of the upgrade.

option

-

disabled

 

Option

Description

disabled

No federated upgrade has been configured.

initialized

The upgrade has been configured.

downloading

The image is downloading in preparation for the upgrade.

device-disconnected

The image downloads are complete, but one or more devices have disconnected.

ready

The image download finished and the upgrade is pending.

staging

The upgrade is confirmed and images are being staged.

final-check

The upgrade is ready and final checks are in progress.

upgrade-devices

The upgrade is ready and devices are being rebooted.

cancelled

The upgrade was cancelled due to the tree not being ready.

confirmed

The upgrade was confirmed and reboots are running.

done

The upgrade completed successfully.

failed

The upgrade failed due to a local issue.

failure-reason

Reason for upgrade failure.

option

-

none

 

Option

Description

none

No failure.

internal

An internal error occurred.

timeout

The upgrade timed out.

device-type-unsupported

The device type was not supported by the FortiGate.

download-failed

The image could not be downloaded.

device-missing

The device was disconnected from the FortiGate.

version-unavailable

An image matching the device and version could not be found.

staging-failed

The image could not be pushed to the device.

reboot-failed

The device could not be rebooted.

device-not-reconnected

The device did not reconnect after rebooting.

node-not-ready

A device in the CSF tree was not ready.

no-final-confirmation

The coordinating FortiGate did not confirm the upgrade.

no-confirmation-query

A downstream FortiGate did not initiate final confirmation.

failure-device

Serial number of the node to include.

string

Maximum length: 79

upgrade-id

Unique identifier for this upgrade.

integer

Minimum value: 0 Maximum value: 4294967295

0

next-path-index

The index of the next image to upgrade to.

integer

Minimum value: 0 Maximum value: 10

0

config node-list

Parameter

Description

Type

Size

Default

timing

Whether the upgrade should be run immediately, or at a scheduled time.

option

-

immediate

 

Option

Description

immediate

Begin the upgrade immediately.

scheduled

Begin the upgrade at a configured time.

time

Scheduled time for the upgrade. Format hh:mm yyyy/mm/dd UTC.

user

Not Specified

setup-time

When the upgrade was configured. Format hh:mm yyyy/mm/dd UTC.

user

Not Specified

upgrade-path

Image IDs to upgrade through.

user

Not Specified

device-type

What type of device this node represents.

option

-

fortigate

 

Option

Description

fortigate

This device is a FortiGate.

fortiswitch

This device is a FortiSwitch.

fortiap

This device is a FortiAP.

coordinating-fortigate

Serial number of the FortiGate unit that controls this device.

string

Maximum length: 79

config system federated-upgrade

Coordinate federated upgrades within the Security Fabric.

config system federated-upgrade

Description: Coordinate federated upgrades within the Security Fabric.

set status [disabled|initialized|...]

set failure-reason [none|internal|...]

set failure-device {string}

set upgrade-id {integer}

set next-path-index {integer}

config node-list

Description: Nodes which will be included in the upgrade.

edit <serial>

set timing [immediate|scheduled]

set time {user}

set setup-time {user}

set upgrade-path {user}

set device-type [fortigate|fortiswitch|...]

set coordinating-fortigate {string}

next

end

end

config system federated-upgrade

Parameter

Description

Type

Size

Default

status

Current status of the upgrade.

option

-

disabled

 

Option

Description

disabled

No federated upgrade has been configured.

initialized

The upgrade has been configured.

downloading

The image is downloading in preparation for the upgrade.

device-disconnected

The image downloads are complete, but one or more devices have disconnected.

ready

The image download finished and the upgrade is pending.

staging

The upgrade is confirmed and images are being staged.

final-check

The upgrade is ready and final checks are in progress.

upgrade-devices

The upgrade is ready and devices are being rebooted.

cancelled

The upgrade was cancelled due to the tree not being ready.

confirmed

The upgrade was confirmed and reboots are running.

done

The upgrade completed successfully.

failed

The upgrade failed due to a local issue.

failure-reason

Reason for upgrade failure.

option

-

none

 

Option

Description

none

No failure.

internal

An internal error occurred.

timeout

The upgrade timed out.

device-type-unsupported

The device type was not supported by the FortiGate.

download-failed

The image could not be downloaded.

device-missing

The device was disconnected from the FortiGate.

version-unavailable

An image matching the device and version could not be found.

staging-failed

The image could not be pushed to the device.

reboot-failed

The device could not be rebooted.

device-not-reconnected

The device did not reconnect after rebooting.

node-not-ready

A device in the CSF tree was not ready.

no-final-confirmation

The coordinating FortiGate did not confirm the upgrade.

no-confirmation-query

A downstream FortiGate did not initiate final confirmation.

failure-device

Serial number of the node to include.

string

Maximum length: 79

upgrade-id

Unique identifier for this upgrade.

integer

Minimum value: 0 Maximum value: 4294967295

0

next-path-index

The index of the next image to upgrade to.

integer

Minimum value: 0 Maximum value: 10

0

config node-list

Parameter

Description

Type

Size

Default

timing

Whether the upgrade should be run immediately, or at a scheduled time.

option

-

immediate

 

Option

Description

immediate

Begin the upgrade immediately.

scheduled

Begin the upgrade at a configured time.

time

Scheduled time for the upgrade. Format hh:mm yyyy/mm/dd UTC.

user

Not Specified

setup-time

When the upgrade was configured. Format hh:mm yyyy/mm/dd UTC.

user

Not Specified

upgrade-path

Image IDs to upgrade through.

user

Not Specified

device-type

What type of device this node represents.

option

-

fortigate

 

Option

Description

fortigate

This device is a FortiGate.

fortiswitch

This device is a FortiSwitch.

fortiap

This device is a FortiAP.

coordinating-fortigate

Serial number of the FortiGate unit that controls this device.

string

Maximum length: 79