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
• 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.9

FortiOS Version Compatibility

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.2.0

v7.2.1

v7.2.2

fortios_system_federated_upgrade

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  system_federated_upgrade

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  failure_device

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• 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 more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  failure_reason

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [none]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [internal]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [timeout]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [device-type-unsupported]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [download-failed]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [device-missing]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [version-unavailable]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [staging-failed]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [reboot-failed]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [device-not-reconnected]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [node-not-ready]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [no-final-confirmation]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [no-confirmation-query]

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  next_path_index

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  node_list

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  coordinating_fortigate

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• device_type - What type of device this node represents. type: str choices: fortigate, fortiswitch, fortiap, fortiextender more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  device_type

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fortigate]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fortiswitch]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fortiap]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fortiextender]

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  serial

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• setup_time - When the upgrade was configured. Format hh:mm yyyy/mm/dd UTC. type: str more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  setup_time

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• time - Scheduled time for the upgrade. Format hh:mm yyyy/mm/dd UTC. type: str more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  time

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• timing - Whether the upgrade should be run immediately, or at a scheduled time. type: str choices: immediate, scheduled more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  timing

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [immediate]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [scheduled]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• upgrade_path - Image IDs to upgrade through. type: str more...

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  upgrade_path

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  status

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disabled]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [initialized]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [downloading]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [device-disconnected]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ready]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [staging]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [final-check]

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [upgrade-devices]

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [cancelled]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [confirmed]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [done]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [failed]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [download-failed]

  yes

  yes

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

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

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  upgrade_id

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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"
        next_path_index: "0"
        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: "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.