fortinet.fortimanager.fmgr_fmupdate_fwmsetting – Configure firmware management settings.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_fmupdate_fwmsetting.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
fmupdate_fwmsetting
dictionary
the top level parameters set
auto-scan-fgt-disk
string
    Choices:
  • disable
  • enable ←
auto scan fgt disk if needed.
disable - Disable setting.
enable - Enable setting.
check-fgt-disk
string
    Choices:
  • disable
  • enable ←
check fgt disk before upgrade image.
disable - Disable setting.
enable - Enable setting.
fds-failover-fmg
string
    Choices:
  • disable
  • enable ←
using fmg local image file is download from fds fails.
disable - Disable setting.
enable - Enable setting.
fds-image-timeout
integer
Default:
1800
timer for fgt download image from fortiguard (300-3600s default=1800)
immx-source
string
    Choices:
  • fmg ←
  • fgt
  • cloud
Configure which of IMMX file to be used for choosing upgrade pach. Default is file for FortiManager
fmg - Use IMMX file for FortiManager
fgt - Use IMMX file for FortiGate
cloud - Use IMMX file for FortiCloud
max-fds-retry
integer
Default:
5
The retries when fgt download from fds fail (5-20, default=10)
multiple-steps-interval
integer
Default:
60
waiting time between multiple steps upgrade (30-180s, default=60)
skip-disk-check
string
    Choices:
  • disable ←
  • enable
skip disk check when upgrade image.
disable - Disable setting.
enable - Enable setting.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)