faz_cli_fmupdate_fwmsetting – Configure firmware management settings.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

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

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_fmupdate_fwmsetting yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • cli_fmupdate_fwmsetting - Configure firmware management settings. type: dict
    • 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...
    • fds-image-timeout - timer for fgt download image from fortiguard (300-3600s default=1800) type: int default: 1800 more...
    • multiple-steps-interval - waiting time between multiple steps upgrade (30-180s, default=60) type: int default: 60 more...
    • max-fds-retry - The retries when fgt download from fds fail (5-20, default=10) type: int default: 5 more...
    • skip-disk-check - skip disk check when upgrade image. type: str choices: [disable, enable] default: disable 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...

Notes

Note

  • 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

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_fmupdate_fwmsetting:
      cli_fmupdate_fwmsetting:
        auto-scan-fgt-disk: disable
        check-fgt-disk: disable
        fds-failover-fmg: disable
        #fds-image-timeout: <value of integer>
        #immx-source: <value in [fmg, fgt, cloud]>
        #max-fds-retry: <value of integer>
        #multiple-steps-interval: <value of integer>
        #skip-disk-check: disable
    name: Configure firmware management settings.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • 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.