fortios_system_federated_upgrade – Coordinate federated upgrades within the Security Fabric in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: False
- vdom - 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 default: root
- system_federated_upgrade - Coordinate federated upgrades within the Security Fabric. type: dict more...
- node_list - Nodes which will be included in the upgrade. type: list more...
- coordinating_fortigate - The serial of the FortiGate that controls this device type: str more...
- device_type - What type of device this node represents. type: str choices: fortigate, fortiswitch, fortiap more...
- serial - Serial number of the node to include. type: str required: True more...
- setup_time - When the upgrade was configured. Format hh:mm yyyy/mm/dd UTC. type: str more...
- time - Scheduled time for the upgrade. Format hh:mm yyyy/mm/dd UTC. type: str more...
- timing - Whether the upgrade should be run immediately, or at a scheduled time. type: str choices: immediate, scheduled more...
- upgrade_path - Image IDs to upgrade through. type: str more...
- status - Current status of the upgrade. type: str choices: disabled, initialized, downloading, download-failed, device-disconnected, ready, staging, cancelled, confirmed, done, failed more...
- upgrade_id - Unique identifier for this upgrade. type: int more...
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:
node_list:
-
coordinating_fortigate: "<your_own_value>"
device_type: "fortigate"
serial: "<your_own_value>"
setup_time: "<your_own_value>"
time: "<your_own_value>"
timing: "immediate"
upgrade_path: "<your_own_value>"
status: "disabled"
upgrade_id: "12"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3