fmgd_system_federatedupgrade – Coordinate federated upgrades within the Security Fabric.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • system_federatedupgrade - Coordinate federated upgrades within the Security Fabric. type: dict
    • failure_device (Alias name: failure-device) Serial number of the node to include. type: str more...
    • failure_reason (Alias name: 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, node-failed, csf-tree-not-supported, firmware-changed, image-missing] more...
    • ha_reboot_controller (Alias name: 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...
    • ignore_signing_errors (Alias name: ignore-signing-errors) Allow/reject use of fortigate firmware images that are unsigned. type: str choices: [disable, enable] more...
    • known_ha_members (Alias name: known-ha-members) Known ha members. type: list more...
      • serial Serial number of ha member type: str more...
    • next_path_index (Alias name: next-path-index) The index of the next image to upgrade to. type: int more...
    • node_list (Alias name: node-list) Node list. type: list more...
      • coordinating_fortigate (Alias name: coordinating-fortigate) Serial number of the fortigate unit that controls this device. type: str more...
      • device_type (Alias name: device-type) Fortinet device type. type: str choices: [fortigate, fortiswitch, fortiap, fortiproxy, fortiextender] more...
      • maximum_minutes (Alias name: maximum-minutes) Maximum number of minutes to allow for immediate upgrade preparation. type: int more...
      • serial Serial number of the node to include. type: str more...
      • setup_time (Alias name: setup-time) Upgrade preparation start time in utc (hh:mm yyyy/mm/dd utc). type: list more...
      • time Scheduled upgrade execution time in utc (hh:mm yyyy/mm/dd utc). type: list more...
      • timing Run immediately or at a scheduled time. type: str choices: [immediate, scheduled] more...
      • upgrade_path (Alias name: upgrade-path) Fortinet os image versions to upgrade through in major-minor-patch format, such as 7-0-4. type: str more...
      • failure_reason (Alias name: failure-reason) Upgrade failure reason. type: str choices: [timeout, none, internal, 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, firmware-changed, node-failed, image-missing] more...
      • coordinating_fortiproxy (Alias name: coordinating-fortiproxy) Coordinating fortiproxy. type: str more...
      • allow_download (Alias name: allow-download) Enable/disable download firmware images. type: str choices: [disable, enable] more...
    • status Current status of the upgrade. type: str choices: [disabled, initialized, downloading, download-failed, ready, cancelled, confirmed, done, failed, device-disconnected, staging, final-check, upgrade-devices, coordinating, dry-run-done] more...
    • upgrade_id (Alias name: upgrade-id) Unique identifier for this upgrade. type: int more...
    • dry_run (Alias name: dry-run) Perform federated upgrades as a dry run. type: str choices: [disable, enable] more...
    • source Source that set up the federated upgrade config. type: str choices: [user, auto-firmware-upgrade, forced-upgrade] more...
    • initial_version (Alias name: initial-version) Firmware version when the upgrade was set up. type: str more...
    • starter_admin (Alias name: starter-admin) Admin that started the upgrade. type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Coordinate federated upgrades within the Security Fabric.
      fortinet.fmgdevice.fmgd_system_federatedupgrade:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        system_federatedupgrade:
          # failure_device: <string>
          # failure_reason: <value in [none, internal, timeout, ...]>
          # ha_reboot_controller: <string>
          # ignore_signing_errors: <value in [disable, enable]>
          # known_ha_members:
          #   - serial: <string>
          # next_path_index: <integer>
          # node_list:
          #   - coordinating_fortigate: <string>
          #     device_type: <value in [fortigate, fortiswitch, fortiap, ...]>
          #     maximum_minutes: <integer>
          #     serial: <string>
          #     setup_time: <list or string>
          #     time: <list or string>
          #     timing: <value in [immediate, scheduled]>
          #     upgrade_path: <string>
          #     failure_reason: <value in [timeout, none, internal, ...]>
          #     coordinating_fortiproxy: <string>
          #     allow_download: <value in [disable, enable]>
          # status: <value in [disabled, initialized, downloading, ...]>
          # upgrade_id: <integer>
          # dry_run: <value in [disable, enable]>
          # source: <value in [user, auto-firmware-upgrade, forced-upgrade]>
          # initial_version: <string>
          # starter_admin: <string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)