Steampunk Ansible Documentation - drmofu.fortimanager.fmgr_fmupdate_fwmsetting (2.2.2) - module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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

 - 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]>
            log: <value in [fwm, fwm_dm, fwm_dm_json]>
            upgrade-timeout:
               check-status-timeout: <value of integer>
               ctrl-check-status-timeout: <value of integer>
               ctrl-put-image-by-fds-timeout: <value of integer>
               ha-sync-timeout: <value of integer>
               license-check-timeout: <value of integer>
               prepare-image-timeout: <value of integer>
               put-image-by-fds-timeout: <value of integer>
               put-image-timeout: <value of integer>
               reboot-of-fsck-timeout: <value of integer>
               reboot-of-upgrade-timeout: <value of integer>
               retrieve-timeout: <value of integer>
               rpc-timeout: <value of integer>
               total-timeout: <value of integer>

Inputs

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

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

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

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

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
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.
required: false
type: bool

fmupdate_fwmsetting:
description: the top level parameters set
required: false
suboptions:
auto-scan-fgt-disk:
choices:
- disable
- enable
description:
- auto scan fgt disk if needed.
- disable - Disable setting.
- enable - Enable setting.
type: str
check-fgt-disk:
choices:
- disable
- enable
description:
- check fgt disk before upgrade image.
- disable - Disable setting.
- enable - Enable setting.
type: str
fds-failover-fmg:
choices:
- disable
- enable
description:
- using fmg local image file is download from fds fails.
- disable - Disable setting.
- enable - Enable setting.
type: str
fds-image-timeout:
description: timer for fgt download image from fortiguard
type: int
immx-source:
choices:
- fmg
- fgt
- cloud
description:
- 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-fds-retry:
description: The retries when fgt download from fds fail
type: int
multiple-steps-interval:
description: waiting time between multiple steps upgrade
type: int
skip-disk-check:
choices:
- disable
- enable
description:
- skip disk check when upgrade image.
- disable - Disable setting.
- enable - Enable setting.
type: str
upgrade-timeout:
description: no description
required: false
suboptions:
check-status-timeout:
description: timeout for checking status after tunnnel is up.
type: int
ctrl-check-status-timeout:
description: timeout for checking fap/fsw/fext status after request upgrade.
type: int
ctrl-put-image-by-fds-timeout:
description: timeout for waiting device get fap/fsw/fext image from fortiguard.
type: int
ha-sync-timeout:
description: timeout for waiting HA sync.
type: int
license-check-timeout:
description: timeout for waiting fortigate check license.
type: int
prepare-image-timeout:
description: timeout for preparing image.
type: int
put-image-by-fds-timeout:
description: timeout for waiting device get image from fortiguard.
type: int
put-image-timeout:
description: timeout for waiting send image over tunnel.
type: int
reboot-of-fsck-timeout:
description: timeout for waiting fortigate reboot.
type: int
reboot-of-upgrade-timeout:
description: timeout for waiting fortigate reboot after image upgrade.
type: int
retrieve-timeout:
description: timeout for waiting retrieve.
type: int
rpc-timeout:
description: timeout for waiting fortigate rpc response.
type: int
total-timeout:
description: 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.
required: false
type: str

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

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
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