faz_cli_fmupdate_fdssetting – Configure FortiGuard settings.

New in version 1.0.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

• Possible variable names before 2.0.0: variable-name, variable name, variable.name

• Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.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 FortiAnalyzer 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.15.0

FortiAnalyzer Version Compatibility

6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
None	True	True	True	None	True	True	True	True	True	True	True	True
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
True	True	True	True	True	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
True	True	True	True	True
7.4.0	7.4.1	7.4.2
True	True	True

Parameters

• access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
• enable_log - Enable/Disable logging for task type: bool required: false default: False
• forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
• log_path - 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.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
• 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 FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
• 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
• cli_fmupdate_fdssetting - Configure FortiGuard settings. type: dict
• User_Agent - Configure the user agent string. type: str default: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0) more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fds_clt_ssl_protocol - The SSL protocols version for connecting fds server (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fds_ssl_protocol - The SSL protocols version for receiving fgt connection (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fmtr_log - fmtr log level type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fortiguard_anycast - Enable/disable use of FortiGuards anycast network type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fortiguard_anycast_source - Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. type: str choices: [fortinet, aws] default: fortinet more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• linkd_log - The linkd log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• max_av_ips_version - The maximum number of downloadable, full version AV/IPS packages (1 - 1000, default = 20). type: int default: 20 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• max_work - The maximum number of worker processing download requests (1 - 32, default = 1). type: int default: 1 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• push_override type: dict
• ip - External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. type: str default: 0.0.0.0 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• port - Receiving port number on the NAT device (1 - 65535, default = 9443). type: int default: 9443 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• status - Enable/disable push updates for clients (default = disable). type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• push_override_to_client type: dict
• announce_ip - No description for the parameter type: array more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

  • id - ID of the announce IP address (1 - 10). type: int default: 0 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • ip - Announce IPv4 address. type: str default: 0.0.0.0 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • port - Announce IP port (1 - 65535, default = 8890). type: int default: 8890 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

• status - Enable/disable push updates (default = disable). type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• send_report - send report/fssi to fds server. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• send_setup - forward setup to fds server. type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• server_override type: dict
• servlist - No description for the parameter type: array more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

  • id - Override server ID (1 - 10). type: int default: 0 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • ip - IPv4 address of the override server. type: str default: 0.0.0.0 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • ip6 - IPv6 address of the override server. type: str default: :: more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • service_type - Override service type. type: str choices: [fct, fds] default: fds more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	True	True	True	None	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

• status - Override status. type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fct - No description for the parameter type: array choices: [4.x, 5.0, 5.2, 5.4, 5.6, 6.0, 6.2, 6.4, 7.0, 7.2] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fgt - No description for the parameter type: array choices: [5.4, 5.6, 6.0, 6.2, 6.4, 7.0, 7.2, 7.4] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fml - No description for the parameter type: array choices: [4.x, 5.x, 6.x, 6.0, 6.2, 6.4, 7.0, 7.2, 7.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fsa - No description for the parameter type: array choices: [1.x, 2.x, 3.x, 3.0, 3.1, 3.2, 4.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fsw - No description for the parameter type: array choices: [4.x, 5.0, 5.2, 5.4, 5.6, 6.0, 6.2, 6.4] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	False	False

• umsvc_log - The um_service log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• unreg_dev_option - set the option for unregister devices type: str choices: [ignore, svc-only, add-service] default: add-service more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• update_schedule type: dict
• day - Configure the day the update will occur, if the freqnecy is weekly (Sunday - Saturday, default = Monday). type: str choices: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday] default: Monday more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• frequency - Configure update frequency: every - time interval, daily - once a day, weekly - once a week (default = every). type: str choices: [every, daily, weekly] default: every more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• status - Enable/disable scheduled updates. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• time - No description for the parameter type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• wanip_query_mode - public ip query mode type: str choices: [disable, ipify] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	True	True	True	None	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fdc - No description for the parameter type: array choices: [3.x, 4.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fts - No description for the parameter type: array choices: [4.x, 3.x, 7.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_faz - No description for the parameter type: array choices: [6.x, 7.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• system_support_fis - No description for the parameter type: array choices: [1.x, 2.x] more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  True	True	True

Notes

Note

• 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
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Configure FortiGuard settings.
      fortinet.fortianalyzer.faz_cli_fmupdate_fdssetting:
        cli_fmupdate_fdssetting:
          umsvc_log: emergency
          wanip_query_mode: disable
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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 fortianalyzer version. returned: if params are not supported in the current version type: list

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Xinwei Du (@dux-fortinet)

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.