faz_cli_fmupdate_fdssetting – Configure FortiGuard settings.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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.9.0

FortiAnalyzer Version Compatibility ¶

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

cli_fmupdate_fdssetting yes yes yes yes yes yes yes yes yes yes yes yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

User-Agent True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fds-clt-ssl-protocol True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fds-ssl-protocol True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fmtr-log True True True True True True True True True True True True
fortiguard-anycast - Enable/disable use of FortiGuards anycast network type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fortiguard-anycast True False False False False True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fortiguard-anycast-source True False False False False True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

linkd-log True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-av-ips-version True True True True True True True True True True True True
max-work - The maximum number of worker processing download requests (1 - 32, default = 1). type: int default: 1 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-work True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

status True True True True True True True True True True True True

push-override-to-client type: dict

announce-ip - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

announce-ip True True True True True True True True True True True True
- id - ID of the announce IP address (1 - 10). type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True True True True
- ip - Announce IPv4 address. type: str default: 0.0.0.0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  ip True True True True True True True True True True True True
- port - Announce IP port (1 - 65535, default = 8890). type: int default: 8890 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  port True True True True True True True True True True True True
status - Enable/disable push updates (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

status True True True True True True True True True True True True

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

send_setup True True True True True True True True True True True True
server-override type: dict

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

servlist True True True True True True True True True True True True
- id - Override server ID (1 - 10). type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True True True True
- ip - IPv4 address of the override server. type: str default: 0.0.0.0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  ip True True True True True True True True True True True True
- ip6 - IPv6 address of the override server. type: str default: :: more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  ip6 True True True True True True True True True True True True
- port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  port True True True True True True True True True True True True
- service-type - Override service type. type: str choices: [fct, fds] default: fds more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  service-type True True True True True True True True True True True True
status - Override status. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

status True True True True True True True True True 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] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

system-support-fct True True True True True True True True True 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] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

system-support-fgt True True True True True True True True True 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] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

system-support-fml True True True True True True True True True True True True
system-support-fsa - No description for the parameter type: array choices: [1.x, 2.x, 3.x, 4.x, 3.0, 3.1, 3.2] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

system-support-fsa True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

system-support-fsw True True True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

umsvc-log True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

unreg-dev-option True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

day True True True True True True True True True 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.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

time True True True True True True True True True True True True

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wanip-query-mode True True True True True True True True True True True True
system-support-fdc - No description for the parameter type: array choices: [3.x, 4.x] more...

7.2.0

system-support-fdc True
system-support-fts - No description for the parameter type: array choices: [3.x, 4.x, 7.x] more...

7.2.0

system-support-fts 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 ¶

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_fmupdate_fdssetting:
      cli_fmupdate_fdssetting:
        umsvc-log: emergency
        wanip-query-mode: disable
    name: Configure FortiGuard settings.
  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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

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

Authors ¶

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.

	`7.2.0`
system-support-fdc	True