fmgr_fmupdate_fwmsetting – Configure firmware management settings.
Added in version 2.1.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.2.2 -> latest
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 (Alias name: fds-image-timeout) Timer for fgt download image from fortiguard (300-3600s default=1800) type: int default: 1800 more...
- max_fds_retry (Alias name: max-fds-retry) The retries when fgt download from fds fail (5-20, default=10) type: int default: 5 more...
- multiple_steps_interval (Alias name: multiple-steps-interval) Waiting time between multiple steps upgrade (30-180s, default=60) type: int default: 60 more...
- skip_disk_check (Alias name: skip-disk-check) Skip disk check when upgrade image. type: str choices: [disable, enable] default: disable more...
- auto_scan_fgt_disk (Alias name: auto-scan-fgt-disk) Auto scan fgt disk if needed. type: str choices: [disable, enable] default: enable more...
- check_fgt_disk (Alias name: check-fgt-disk) Check fgt disk before upgrade image. type: str choices: [disable, enable] default: enable more...
- fds_failover_fmg (Alias name: fds-failover-fmg) Using fmg local image file is download from fds fails. type: str choices: [disable, enable] default: enable more...
- immx_source (Alias name: 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 (Alias name: upgrade-timeout) type: dict
- check_status_timeout (Alias name: check-status-timeout) Timeout for checking status after tunnnel is up. type: int default: 600 more...
- ctrl_check_status_timeout (Alias name: 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 (Alias name: 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 (Alias name: ha-sync-timeout) Timeout for waiting ha sync. type: int default: 1800 more...
- license_check_timeout (Alias name: license-check-timeout) Timeout for waiting fortigate check license. type: int default: 600 more...
- prepare_image_timeout (Alias name: prepare-image-timeout) Timeout for preparing image. type: int default: 600 more...
- put_image_by_fds_timeout (Alias name: put-image-by-fds-timeout) Timeout for waiting device get image from fortiguard. type: int default: 1800 more...
- put_image_timeout (Alias name: put-image-timeout) Timeout for waiting send image over tunnel. type: int default: 1800 more...
- reboot_of_fsck_timeout (Alias name: reboot-of-fsck-timeout) Timeout for waiting fortigate reboot. type: int default: 1800 more...
- reboot_of_upgrade_timeout (Alias name: reboot-of-upgrade-timeout) Timeout for waiting fortigate reboot after image upgrade. type: int default: 1200 more...
- retrieve_timeout (Alias name: retrieve-timeout) Timeout for waiting retrieve. type: int default: 1800 more...
- rpc_timeout (Alias name: rpc-timeout) Timeout for waiting fortigate rpc response. type: int default: 180 more...
- total_timeout (Alias name: total-timeout) Timeout for the whole fortigate upgrade(1-86400s, default=3600) type: int default: 3600 more...
- health_check_timeout (Alias name: health-check-timeout) Timeout for waiting retrieve. type: int default: 600 more...
- retry_interval (Alias name: retry-interval) Waiting time for resending request to device(1-360s, default=60) type: int default: 60 more...
- retry_max (Alias name: retry-max) Max retry times(0-100, default=10) type: int default: 10 more...
- health_check (Alias name: health-check) Do health check after upgrade type: str choices: [disable, enable] default: enable more...
- max_device_history (Alias name: max-device-history) Max number of device upgrade report(1-10000, default=100) type: int default: 100 more...
- max_profile_history (Alias name: max-profile-history) Max number of profile upgrade report(1-10000, default=100) type: int default: 100 more...
- retrieve Do retrieve after upgrade type: str choices: [disable, enable] default: enable more...
- revision_diff (Alias name: revision-diff) Calculate diff script after upgrade type: str choices: [disable, enable] default: enable 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
- 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: 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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.