Try SpotterCoordinate federated upgrades within the Security Fabric in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This 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
- name: Coordinate federated upgrades within the Security Fabric.
fortinet.fortios.fortios_system_federated_upgrade:
vdom: "{{ vdom }}"
system_federated_upgrade:
failure_device: "<your_own_value>"
failure_reason: "none"
ha_reboot_controller: "<your_own_value>"
known_ha_members:
-
serial: "<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"
vdom:
default: root
description:
- 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.
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- 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.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
system_federated_upgrade:
default: null
description:
- Coordinate federated upgrades within the Security Fabric.
suboptions:
failure_device:
description:
- Serial number of the node to include.
type: str
failure_reason:
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
- csf-tree-not-supported
- node-failed
description:
- Reason for upgrade failure.
type: str
ha_reboot_controller:
description:
- Serial number of the FortiGate unit that will control the reboot process for
the federated upgrade of the HA cluster.
type: str
known_ha_members:
description:
- Known members of the HA cluster. If a member is missing at upgrade time, the
upgrade will be cancelled.
elements: dict
suboptions:
serial:
description:
- Serial number of HA member
required: true
type: str
type: list
next_path_index:
description:
- The index of the next image to upgrade to.
type: int
node_list:
description:
- Nodes which will be included in the upgrade.
elements: dict
suboptions:
coordinating_fortigate:
description:
- Serial number of the FortiGate unit that controls this device.
type: str
device_type:
choices:
- fortigate
- fortiswitch
- fortiap
- fortiextender
description:
- Fortinet device type.
type: str
maximum_minutes:
description:
- Maximum number of minutes to allow for immediate upgrade preparation.
type: int
serial:
description:
- Serial number of the node to include.
required: true
type: str
setup_time:
description:
- Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
type: str
time:
description:
- Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
type: str
timing:
choices:
- immediate
- scheduled
description:
- Run immediately or at a scheduled time.
type: str
upgrade_path:
description:
- Fortinet OS image versions to upgrade through in major-minor-patch format,
such as 7-0-4.
type: str
type: list
status:
choices:
- disabled
- initialized
- downloading
- device-disconnected
- ready
- coordinating
- staging
- final-check
- upgrade-devices
- cancelled
- confirmed
- done
- failed
- download-failed
description:
- Current status of the upgrade.
type: str
upgrade_id:
description:
- Unique identifier for this upgrade.
type: int
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str