fmgr_fmupdate_fwmsetting – Configure firmware management settings.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| fmupdate_fwmsetting | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- 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
- 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
- fmupdate_fwmsetting - no description 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...
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: no description
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]>
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