fortinet.fortimanager.fmgr_fmupdate_fwmsetting module – Configure firmware management settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fmupdate_fwmsetting.
New in fortinet.fortimanager 2.1.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to auto_scan_fgt_disk. auto scan fgt disk if needed. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to check_fgt_disk. check fgt disk before upgrade image. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to fds_failover_fmg. using fmg local image file is download from fds fails. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to fds_image_timeout. Timer for fgt download image from fortiguard |
|
Deprecated, please rename it to health_check. do health check after upgrade disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to immx_source. Configure which of IMMX file to be used for choosing upgrade pach. fmg - Use IMMX file for FortiManager fgt - Use IMMX file for FortiGate cloud - Use IMMX file for FortiCloud Choices:
|
|
Configure log setting for fwm daemon fwm - FWM daemon log fwm_dm - FWM and Deployment service log fwm_dm_json - FWM and Deployment service log with JSON data between FMG-FGT Choices:
|
|
Deprecated, please rename it to max_device_history. Max number of device upgrade report |
|
Deprecated, please rename it to max_fds_retry. The retries when fgt download from fds fail |
|
Deprecated, please rename it to max_profile_history. Max number of profile upgrade report |
|
Deprecated, please rename it to multiple_steps_interval. Waiting time between multiple steps upgrade |
|
do retrieve after upgrade disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to retry_interval. Waiting time for resending request to device |
|
Deprecated, please rename it to retry_max. Max retry times |
|
Deprecated, please rename it to revision_diff. calculate diff script after upgrade disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to skip_disk_check. skip disk check when upgrade image. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to upgrade_timeout. |
|
Deprecated, please rename it to check_status_timeout. Timeout for checking status after tunnnel is up. |
|
Deprecated, please rename it to ctrl_check_status_timeout. Timeout for checking fap/fsw/fext status after request … |
|
Deprecated, please rename it to ctrl_put_image_by_fds_timeout. Timeout for waiting device get fap/fsw/fext image f… |
|
Deprecated, please rename it to ha_sync_timeout. Timeout for waiting HA sync. |
|
Deprecated, please rename it to health_check_timeout. Timeout for waiting retrieve. |
|
Deprecated, please rename it to license_check_timeout. Timeout for waiting fortigate check license. |
|
Deprecated, please rename it to prepare_image_timeout. Timeout for preparing image. |
|
Deprecated, please rename it to put_image_by_fds_timeout. Timeout for waiting device get image from fortiguard. |
|
Deprecated, please rename it to put_image_timeout. Timeout for waiting send image over tunnel. |
|
Deprecated, please rename it to reboot_of_fsck_timeout. Timeout for waiting fortigate reboot. |
|
Deprecated, please rename it to reboot_of_upgrade_timeout. Timeout for waiting fortigate reboot after image upgrade. |
|
Deprecated, please rename it to retrieve_timeout. Timeout for waiting retrieve. |
|
Deprecated, please rename it to rpc_timeout. Timeout for waiting fortigate rpc response. |
|
Deprecated, please rename it to total_timeout. Timeout for the whole fortigate upgrade |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure firmware management settings.
fortinet.fortimanager.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: <integer>
max_fds_retry: <integer>
multiple_steps_interval: <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: <integer>
ctrl_check_status_timeout: <integer>
ctrl_put_image_by_fds_timeout: <integer>
ha_sync_timeout: <integer>
license_check_timeout: <integer>
prepare_image_timeout: <integer>
put_image_by_fds_timeout: <integer>
put_image_timeout: <integer>
reboot_of_fsck_timeout: <integer>
reboot_of_upgrade_timeout: <integer>
retrieve_timeout: <integer>
rpc_timeout: <integer>
total_timeout: <integer>
health_check_timeout: <integer>
retry_interval: <integer>
retry_max: <integer>
health_check: <value in [disable, enable]>
max_device_history: <integer>
max_profile_history: <integer>
retrieve: <value in [disable, enable]>
revision_diff: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |