fmgr_fmupdate_fwmsetting – Configure firmware management settings.

New in version 2.1.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 v6.x and v7.x.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
False
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
False False True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

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
  • fmupdate_fwmsetting - Configure firmware management settings. type: dict
    • fds-image-timeout - timer for fgt download image from fortiguard (300-3600s default=1800) type: int default: 1800 more...
    • max-fds-retry - The retries when fgt download from fds fail (5-20, default=10) type: int default: 5 more...
    • multiple-steps-interval - waiting time between multiple steps upgrade (30-180s, default=60) type: int default: 60 more...
    • skip-disk-check - skip disk check when upgrade image. type: str choices: [disable, enable] default: disable more...
    • auto-scan-fgt-disk - auto scan fgt disk if needed. type: str choices: [disable, enable] default: enable more...
    • check-fgt-disk - check fgt disk before upgrade image. type: str choices: [disable, enable] default: enable more...
    • fds-failover-fmg - using fmg local image file is download from fds fails. type: str choices: [disable, enable] default: enable more...
    • immx-source - Configure which of IMMX file to be used for choosing upgrade pach. type: str choices: [fmg, fgt, cloud] default: fmg more...
    • log - Configure log setting for fwm daemon type: str choices: [fwm, fwm_dm, fwm_dm_json] default: fwm_dm more...
    • upgrade-timeout type: dict
      • check-status-timeout - timeout for checking status after tunnnel is up. type: int default: 600 more...
      • ctrl-check-status-timeout - timeout for checking fap/fsw/fext status after request upgrade. type: int default: 1200 more...
      • ctrl-put-image-by-fds-timeout - timeout for waiting device get fap/fsw/fext image from fortiguard. type: int default: 900 more...
      • ha-sync-timeout - timeout for waiting HA sync. type: int default: 1800 more...
      • license-check-timeout - timeout for waiting fortigate check license. type: int default: 600 more...
      • prepare-image-timeout - timeout for preparing image. type: int default: 600 more...
      • put-image-by-fds-timeout - timeout for waiting device get image from fortiguard. type: int default: 1800 more...
      • put-image-timeout - timeout for waiting send image over tunnel. type: int default: 1800 more...
      • reboot-of-fsck-timeout - timeout for waiting fortigate reboot. type: int default: 1800 more...
      • reboot-of-upgrade-timeout - timeout for waiting fortigate reboot after image upgrade. type: int default: 1200 more...
      • retrieve-timeout - timeout for waiting retrieve. type: int default: 1800 more...
      • rpc-timeout - timeout for waiting fortigate rpc response. type: int default: 180 more...
      • total-timeout - timeout for the whole fortigate upgrade(1-86400s, default=3600) type: int default: 3600 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure firmware management settings.
     fmgr_fmupdate_fwmsetting:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        fmupdate_fwmsetting:
           fds-image-timeout: <value of integer>
           max-fds-retry: <value of integer>
           multiple-steps-interval: <value of integer>
           skip-disk-check: <value in [disable, enable]>
           auto-scan-fgt-disk: <value in [disable, enable]>
           check-fgt-disk: <value in [disable, enable]>
           fds-failover-fmg: <value in [disable, enable]>
           immx-source: <value in [fmg, fgt, cloud]>
           log: <value in [fwm, fwm_dm, fwm_dm_json]>
           upgrade-timeout:
              check-status-timeout: <value of integer>
              ctrl-check-status-timeout: <value of integer>
              ctrl-put-image-by-fds-timeout: <value of integer>
              ha-sync-timeout: <value of integer>
              license-check-timeout: <value of integer>
              prepare-image-timeout: <value of integer>
              put-image-by-fds-timeout: <value of integer>
              put-image-timeout: <value of integer>
              reboot-of-fsck-timeout: <value of integer>
              reboot-of-upgrade-timeout: <value of integer>
              retrieve-timeout: <value of integer>
              rpc-timeout: <value of integer>
              total-timeout: <value of integer>

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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

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