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.8).
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Coordinate federated upgrades within the Security Fabric. |
|
Serial number of the node to include. |
|
Reason for upgrade failure. Choices:
|
|
Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster. |
|
Allow/reject use of FortiGate firmware images that are unsigned. Choices:
|
|
Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. |
|
Serial number of HA member |
|
The index of the next image to upgrade to. |
|
Nodes which will be included in the upgrade. |
|
Serial number of the FortiGate unit that controls this device. |
|
Fortinet device type. Choices:
|
|
Maximum number of minutes to allow for immediate upgrade preparation. |
|
Serial number of the node to include. |
|
Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC). |
|
Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC). |
|
Run immediately or at a scheduled time. Choices:
|
|
Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4. |
|
Source that set up the federated upgrade config. Choices:
|
|
Current status of the upgrade. Choices:
|
|
Unique identifier for this upgrade. |
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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>"
ignore_signing_errors: "enable"
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>"
source: "user"
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 number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |