Steampunk Ansible Documentation - fortinet.fortimanager.fmgr_fmupdate_fwmsetting (2.4.0) - module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

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

Inputs

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list

enable_log:
default: false
description: Enable/Disable logging for task.
type: bool

access_token:
description: The token to access FortiManager without using username and password.
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool

fmupdate_fwmsetting:
description: The top level parameters set.
required: false
suboptions:
auto-scan-fgt-disk:
choices:
- disable
- enable
description:
- Deprecated, please rename it to auto_scan_fgt_disk.
- auto scan fgt disk if needed.
- disable - Disable setting.
- enable - Enable setting.
type: str
check-fgt-disk:
choices:
- disable
- enable
description:
- Deprecated, please rename it to check_fgt_disk.
- check fgt disk before upgrade image.
- disable - Disable setting.
- enable - Enable setting.
type: str
fds-failover-fmg:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fds_failover_fmg.
- using fmg local image file is download from fds fails.
- disable - Disable setting.
- enable - Enable setting.
type: str
fds-image-timeout:
description: Deprecated, please rename it to fds_image_timeout. Timer for fgt
download image from fortiguard
type: int
health-check:
choices:
- disable
- enable
description:
- Deprecated, please rename it to health_check.
- do health check after upgrade
- disable - Disable setting.
- enable - Enable setting.
type: str
immx-source:
choices:
- fmg
- fgt
- cloud
description:
- 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
type: str
log:
choices:
- fwm
- fwm_dm
- fwm_dm_json
description:
- 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
type: str
max-device-history:
description: Deprecated, please rename it to max_device_history. Max number of
device upgrade report
type: int
max-fds-retry:
description: Deprecated, please rename it to max_fds_retry. The retries when fgt
download from fds fail
type: int
max-profile-history:
description: Deprecated, please rename it to max_profile_history. Max number of
profile upgrade report
type: int
multiple-steps-interval:
description: Deprecated, please rename it to multiple_steps_interval. Waiting
time between multiple steps upgrade
type: int
retrieve:
choices:
- disable
- enable
description:
- do retrieve after upgrade
- disable - Disable setting.
- enable - Enable setting.
type: str
retry-interval:
description: Deprecated, please rename it to retry_interval. Waiting time for
resending request to device
type: int
retry-max:
description: Deprecated, please rename it to retry_max. Max retry times
type: int
revision-diff:
choices:
- disable
- enable
description:
- Deprecated, please rename it to revision_diff.
- calculate diff script after upgrade
- disable - Disable setting.
- enable - Enable setting.
type: str
skip-disk-check:
choices:
- disable
- enable
description:
- Deprecated, please rename it to skip_disk_check.
- skip disk check when upgrade image.
- disable - Disable setting.
- enable - Enable setting.
type: str
upgrade-timeout:
description: Deprecated, please rename it to upgrade_timeout.
suboptions:
check-status-timeout:
description: Deprecated, please rename it to check_status_timeout. Timeout
for checking status after tunnnel is up.
type: int
ctrl-check-status-timeout:
description: Deprecated, please rename it to ctrl_check_status_timeout. Timeout
for checking fap/fsw/fext status after request ...
type: int
ctrl-put-image-by-fds-timeout:
description: Deprecated, please rename it to ctrl_put_image_by_fds_timeout.
Timeout for waiting device get fap/fsw/fext image f...
type: int
ha-sync-timeout:
description: Deprecated, please rename it to ha_sync_timeout. Timeout for
waiting HA sync.
type: int
health-check-timeout:
description: Deprecated, please rename it to health_check_timeout. Timeout
for waiting retrieve.
type: int
license-check-timeout:
description: Deprecated, please rename it to license_check_timeout. Timeout
for waiting fortigate check license.
type: int
prepare-image-timeout:
description: Deprecated, please rename it to prepare_image_timeout. Timeout
for preparing image.
type: int
put-image-by-fds-timeout:
description: Deprecated, please rename it to put_image_by_fds_timeout. Timeout
for waiting device get image from fortiguard.
type: int
put-image-timeout:
description: Deprecated, please rename it to put_image_timeout. Timeout for
waiting send image over tunnel.
type: int
reboot-of-fsck-timeout:
description: Deprecated, please rename it to reboot_of_fsck_timeout. Timeout
for waiting fortigate reboot.
type: int
reboot-of-upgrade-timeout:
description: Deprecated, please rename it to reboot_of_upgrade_timeout. Timeout
for waiting fortigate reboot after image upgrade.
type: int
retrieve-timeout:
description: Deprecated, please rename it to retrieve_timeout. Timeout for
waiting retrieve.
type: int
rpc-timeout:
description: Deprecated, please rename it to rpc_timeout. Timeout for waiting
fortigate rpc response.
type: int
total-timeout:
description: Deprecated, please rename it to total_timeout. Timeout for the
whole fortigate upgrade
type: int
type: dict
type: dict

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list