fortinet.fortios.fortios_system_federated_upgrade module – Coordinate federated upgrades within the Security Fabric in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_system_federated_upgrade.

New in fortinet.fortios 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and federated_upgrade category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

system_federated_upgrade

dictionary

Coordinate federated upgrades within the Security Fabric.

failure_device

string

Serial number of the node to include.

failure_reason

string

Reason for upgrade failure.

Choices:

  • "none"

  • "internal"

  • "timeout"

  • "device-type-unsupported"

  • "download-failed"

  • "device-missing"

  • "version-unavailable"

  • "staging-failed"

  • "reboot-failed"

  • "device-not-reconnected"

  • "node-not-ready"

  • "no-final-confirmation"

  • "no-confirmation-query"

  • "config-error-log-nonempty"

  • "node-failed"

ha_reboot_controller

string

Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.

next_path_index

integer

The index of the next image to upgrade to.

node_list

list / elements=dictionary

Nodes which will be included in the upgrade.

coordinating_fortigate

string

Serial number of the FortiGate unit that controls this device.

device_type

string

Fortinet device type.

Choices:

  • "fortigate"

  • "fortiswitch"

  • "fortiap"

  • "fortiextender"

maximum_minutes

integer

Maximum number of minutes to allow for immediate upgrade preparation.

serial

string / required

Serial number of the node to include.

setup_time

string

Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).

time

string

Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).

timing

string

Run immediately or at a scheduled time.

Choices:

  • "immediate"

  • "scheduled"

upgrade_path

string

Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.

status

string

Current status of the upgrade.

Choices:

  • "disabled"

  • "initialized"

  • "downloading"

  • "device-disconnected"

  • "ready"

  • "coordinating"

  • "staging"

  • "final-check"

  • "upgrade-devices"

  • "cancelled"

  • "confirmed"

  • "done"

  • "failed"

  • "download-failed"

upgrade_id

integer

Unique identifier for this upgrade.

vdom

string

Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Coordinate federated upgrades within the Security Fabric.
    fortios_system_federated_upgrade:
      vdom:  "{{ vdom }}"
      system_federated_upgrade:
        failure_device: "<your_own_value>"
        failure_reason: "none"
        ha_reboot_controller: "<your_own_value>"
        next_path_index: "0"
        node_list:
         -
            coordinating_fortigate: "<your_own_value>"
            device_type: "fortigate"
            maximum_minutes: "15"
            serial: "<your_own_value>"
            setup_time: "<your_own_value>"
            time: "<your_own_value>"
            timing: "immediate"
            upgrade_path: "<your_own_value>"
        status: "disabled"
        upgrade_id: "0"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)