Skip to content

Latest commit

 

History

History
491 lines (446 loc) · 15.8 KB

fortios_system_device_upgrade.rst

File metadata and controls

491 lines (446 loc) · 15.8 KB
Raw
source:fortios_system_device_upgrade.py
orphan:

fortios_system_device_upgrade -- Independent upgrades for managed devices in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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 device_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

Tips

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

FortiOS Version Compatibility


v7.2.4 v7.4.0
fortios_system_device_upgrade 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_device_upgrade - Independent upgrades for managed devices. type: dict more...
    v7.2.4 v7.4.0
    system_device_upgrade yes yes
    • device_type - Fortinet device type. type: str choices: fortiswitch, fortiap, fortiextender more...
      v7.2.4 v7.4.0
      device_type yes yes
      [fortiswitch] yes yes
      [fortiap] yes yes
      [fortiextender] yes yes
    • failure_reason - Upgrade failure reason. 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 more...
      v7.2.4 v7.4.0
      failure_reason yes yes
      [none] yes yes
      [internal] yes yes
      [timeout] yes yes
      [device-type-unsupported] yes yes
      [download-failed] yes yes
      [device-missing] yes yes
      [version-unavailable] yes yes
      [staging-failed] yes yes
      [reboot-failed] yes yes
      [device-not-reconnected] yes yes
      [node-not-ready] yes yes
      [no-final-confirmation] yes yes
      [no-confirmation-query] yes yes
      [config-error-log-nonempty] yes yes
      [node-failed] yes yes
    • maximum_minutes - Maximum number of minutes to allow for immediate upgrade preparation. type: int more...
      v7.2.4 v7.4.0
      maximum_minutes no yes
    • serial - Serial number of the node to include. type: str required: true more...
      v7.2.4 v7.4.0
      serial yes yes
    • setup_time - Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC). type: str more...
      v7.2.4 v7.4.0
      setup_time yes yes
    • 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 more...
      v7.2.4 v7.4.0
      status yes yes
      [disabled] yes yes
      [initialized] yes yes
      [downloading] yes yes
      [device-disconnected] yes yes
      [ready] yes yes
      [coordinating] yes yes
      [staging] yes yes
      [final-check] yes yes
      [upgrade-devices] yes yes
      [cancelled] yes yes
      [confirmed] yes yes
      [done] yes yes
      [failed] yes yes
    • time - Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC). type: str more...
      v7.2.4 v7.4.0
      time yes yes
    • timing - Run immediately or at a scheduled time. type: str choices: immediate, scheduled more...
      v7.2.4 v7.4.0
      timing yes yes
      [immediate] yes yes
      [scheduled] yes yes
    • upgrade_path - Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4. type: str more...
      v7.2.4 v7.4.0
      upgrade_path 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: Independent upgrades for managed devices.
    fortios_system_device_upgrade:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_device_upgrade:
        device_type: "fortiswitch"
        failure_reason: "none"
        maximum_minutes: "15"
        serial: "<your_own_value>"
        setup_time: "<your_own_value>"
        status: "disabled"
        time: "<your_own_value>"
        timing: "immediate"
        upgrade_path: "<your_own_value>"

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.