drmofu.fortianalyzer.faz_cli_fmupdate_fwmsetting (1.3.0) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0

Add to requirements.yml

  collections:
    - name: drmofu.fortianalyzer
      version: 1.3.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- collections:
    - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer_inventory
  tasks:
    - faz_cli_fmupdate_fwmsetting:
        cli_fmupdate_fwmsetting:
          auto-scan-fgt-disk: disable
          check-fgt-disk: disable
          fds-failover-fmg: disable
          #fds-image-timeout: <value of integer>
          #immx-source: <value in [fmg, fgt, cloud]>
          #max-fds-retry: <value of integer>
          #multiple-steps-interval: <value of integer>
          #skip-disk-check: disable
      name: Configure firmware management settings.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Inputs

    
log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - The path to save log. Used if enable_log is true.
    - Please use absolute path instead of relative path.
    - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
    required: false
    type: str

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:
    - set
    - update
    - 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 FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

cli_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 (300-3600s default=1800)
        type: int
      immx-source:
        choices:
        - fmg
        - fgt
        - cloud
        description:
        - Configure which of IMMX file to be used for choosing upgrade pach. Default is
          file for FortiManager
        - 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 (5-20, default=10)
        type: int
      multiple-steps-interval:
        description: waiting time between multiple steps upgrade (30-180s, default=60)
        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.(1-6000s, default=600)
            type: int
          ctrl-check-status-timeout:
            description: timeout for checking fap/fsw/fext status after request upgrade.(1-12000s,
              default=1200)
            type: int
          ctrl-put-image-by-fds-timeout:
            description: timeout for waiting device get fap/fsw/fext image from fortiguard.(1-9000ss,
              default=900)
            type: int
          ha-sync-timeout:
            description: timeout for waiting HA sync.(1-18000s, default=1800)
            type: int
          license-check-timeout:
            description: timeout for waiting fortigate check license.(1-6000s, default=600)
            type: int
          prepare-image-timeout:
            description: timeout for preparing image.(1-6000s, default=600)
            type: int
          put-image-by-fds-timeout:
            description: timeout for waiting device get image from fortiguard.(1-18000s,
              default=1800)
            type: int
          put-image-timeout:
            description: timeout for waiting send image over tunnel.(1-18000s, default=1800)
            type: int
          reboot-of-fsck-timeout:
            description: timeout for waiting fortigate reboot.(1-18000s, default=1800)
            type: int
          reboot-of-upgrade-timeout:
            description: timeout for waiting fortigate reboot after image upgrade.(1-12000s,
              default=1200)
            type: int
          retrieve-timeout:
            description: timeout for waiting retrieve.(1-18000s, default=1800)
            type: int
          rpc-timeout:
            description: timeout for waiting fortigate rpc response.(1-1800s, default=180)
            type: int
          total-timeout:
            description: timeout for the whole fortigate upgrade(1-86400s, default=3600)
            type: int
        type: dict
    type: dict

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

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 fortianalyzer version.
  returned: complex
  type: list