fortios_system_federated_upgrade.rst

source:	fortios_system_federated_upgrade.py
orphan:

fortios_system_federated_upgrade -- Coordinate federated upgrades within the Security Fabric in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_federated_upgrade	v7.0.0 -> latest

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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• system_federated_upgrade - Coordinate federated upgrades within the Security Fabric. type: dict more...

  	Supported Version Ranges
  system_federated_upgrade	v7.0.0 -> latest

• failure_device - Serial number of the node to include. type: str more...

  	Supported Version Ranges
  failure_device	v7.0.2 -> latest

• failure_reason - Reason for upgrade failure. type: str 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 more...

  	Supported Version Ranges
  failure_reason	v7.0.2 -> latest
  [none]	v6.0.0 -> latest
  [internal]	v6.0.0 -> latest
  [timeout]	v6.0.0 -> latest
  [device-type-unsupported]	v6.0.0 -> latest
  [download-failed]	v6.0.0 -> latest
  [device-missing]	v6.0.0 -> latest
  [version-unavailable]	v6.0.0 -> latest
  [staging-failed]	v6.0.0 -> latest
  [reboot-failed]	v6.0.0 -> latest
  [device-not-reconnected]	v6.0.0 -> latest
  [node-not-ready]	v6.0.0 -> latest
  [no-final-confirmation]	v6.0.0 -> latest
  [no-confirmation-query]	v6.0.0 -> latest
  [config-error-log-nonempty]	v7.2.4 -> latest
  [csf-tree-not-supported]	v7.4.1 -> latest
  [node-failed]	v7.2.4 -> latest

• ha_reboot_controller - Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster. type: str more...

  	Supported Version Ranges
  ha_reboot_controller	v7.4.0 -> latest

• next_path_index - The index of the next image to upgrade to. type: int more...

  	Supported Version Ranges
  next_path_index	v7.0.4 -> latest

• node_list - Nodes which will be included in the upgrade. type: list member_path: node_list:serial more...

  	Supported Version Ranges
  node_list	v7.0.0 -> latest

• coordinating_fortigate - Serial number of the FortiGate unit that controls this device. type: str more...

  	Supported Version Ranges
  coordinating_fortigate	v7.0.0 -> latest

• device_type - Fortinet device type. type: str choices: fortigate, fortiswitch, fortiap, fortiextender more...

  	Supported Version Ranges
  device_type	v7.0.0 -> latest
  [fortigate]	v6.0.0 -> latest
  [fortiswitch]	v6.0.0 -> latest
  [fortiap]	v6.0.0 -> latest
  [fortiextender]	v7.2.1 -> latest

• maximum_minutes - Maximum number of minutes to allow for immediate upgrade preparation. type: int more...

  	Supported Version Ranges
  maximum_minutes	v7.4.0 -> latest

• serial - Serial number of the node to include. type: str required: true more...

  	Supported Version Ranges
  serial	v7.0.0 -> latest

• setup_time - Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC). type: str more...

  	Supported Version Ranges
  setup_time	v7.0.0 -> latest

• time - Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC). type: str more...

  	Supported Version Ranges
  time	v7.0.0 -> latest

• timing - Run immediately or at a scheduled time. type: str choices: immediate, scheduled more...

  	Supported Version Ranges
  timing	v7.0.0 -> latest
  [immediate]	v6.0.0 -> latest
  [scheduled]	v6.0.0 -> latest

• upgrade_path - Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4. type: str more...

  	Supported Version Ranges
  upgrade_path	v7.0.0 -> latest

• status - Current status of the upgrade. type: str choices: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed, download-failed more...

  	Supported Version Ranges
  status	v7.0.0 -> latest
  [disabled]	v6.0.0 -> latest
  [initialized]	v6.0.0 -> latest
  [downloading]	v6.0.0 -> latest
  [device-disconnected]	v6.0.0 -> latest
  [ready]	v6.0.0 -> latest
  [coordinating]	v7.2.4 -> latest
  [staging]	v6.0.0 -> latest
  [final-check]	v7.0.1 -> latest
  [upgrade-devices]	v7.0.2 -> latest
  [cancelled]	v6.0.0 -> latest
  [confirmed]	v6.0.0 -> latest
  [done]	v6.0.0 -> latest
  [failed]	v6.0.0 -> latest
  [download-failed]	v7.0.0 -> v7.0.1

• upgrade_id - Unique identifier for this upgrade. type: int more...

  	Supported Version Ranges
  upgrade_id	v7.0.0 -> latest

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>"
          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: 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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.