fortinet.fortimanager.fmgr_fmupdate_fdssetting module – Configure FortiGuard settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fmupdate_fdssetting
.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
The SSL protocols version for connecting fds server sslv3 - set SSLv3 as the client version. tlsv1. tlsv1. tlsv1. Choices:
|
|
The SSL protocols version for receiving fgt connection sslv3 - set SSLv3 as the lowest version. tlsv1. tlsv1. tlsv1. Choices:
|
|
fmtr log level emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log Choices:
|
|
Enable/disable use of FortiGuards anycast network disable - Disable setting. enable - Enable setting. Choices:
|
|
Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. fortinet - Use Fortinets servers to provide FortiGuard services in FortiGuards anycast network. aws - Use Fortinets AWS servers to provide FortiGuard services in FortiGuards anycast network. Choices:
|
|
The linkd log level emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log Choices:
|
|
The maximum number of downloadable, full version AV/IPS packages |
|
The maximum number of worker processing download requests |
|
Push override. |
|
External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. |
|
Receiving port number on the NAT device |
|
Enable/disable push updates for clients disable - Disable setting. enable - Enable setting. Choices:
|
|
Push override to client. |
|
Announce ip. |
|
ID of the announce IP address |
|
Announce IPv4 address. |
|
Announce IP port |
|
Enable/disable push updates disable - Disable setting. enable - Enable setting. Choices:
|
|
send report/fssi to fds server. disable - Disable setting. enable - Enable setting. Choices:
|
|
forward setup to fds server. disable - Disable setting. enable - Enable setting. Choices:
|
|
Server override. |
|
Servlist. |
|
Override server ID |
|
IPv4 address of the override server. |
|
IPv6 address of the override server. |
|
Port number to use when contacting FortiGuard |
|
(list or str) Override service type. fds - Server override config for fds fct - Server override config for fct Choices:
|
|
Override status. disable - Disable setting. enable - Enable setting. Choices:
|
|
Supported FortiNDR versions. Choices:
|
|
Supported FortiAnalyzer versions. Choices:
|
|
Supported FortiClient versions. Choices:
|
|
Supported FortiDeceptor versions. Choices:
|
|
Supported FortiOS versions. Choices:
|
|
Supported FortiIsolator versions. Choices:
|
|
Supported FortiMail versions. Choices:
|
|
Supported FortiSandbox versions. Choices:
|
|
Supported FortiSwitch versions. Choices:
|
|
Supported FortiTester versions. Choices:
|
|
The um_service log level emergency - Log level - emergency alert - Log level - alert critical - Log level - critical error - Log level - error warn - Log level - warn notice - Log level - notice info - Log level - info debug - Log level - debug disable - Disable linkd log Choices:
|
|
set the option for unregister devices ignore - Ignore all unregistered devices. svc-only - Allow update requests without adding the device. add-service - Add unregistered devices and allow update request. Choices:
|
|
Update schedule. |
|
Configure the day the update will occur, if the freqnecy is weekly Sunday - Update every Sunday. Monday - Update every Monday. Tuesday - Update every Tuesday. Wednesday - Update every Wednesday. Thursday - Update every Thursday. Friday - Update every Friday. Saturday - Update every Saturday. Choices:
|
|
Configure update frequency every - Time interval. daily - Every day. weekly - Every week. Choices:
|
|
Enable/disable scheduled updates. disable - Disable setting. enable - Enable setting. Choices:
|
|
(list) Time interval between updates, or the hour and minute when the update occurs |
|
Configure the user agent string. |
|
public ip query mode disable - Do not query public ip ipify - Get public IP through https Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
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 (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 FortiGuard settings.
fortinet.fortimanager.fmgr_fmupdate_fdssetting:
# 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_fdssetting:
User_Agent: <string>
fds_clt_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
fds_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
fmtr_log: <value in [emergency, alert, critical, ...]>
linkd_log: <value in [emergency, alert, critical, ...]>
max_av_ips_version: <integer>
max_work: <integer>
push_override:
ip: <string>
port: <integer>
status: <value in [disable, enable]>
push_override_to_client:
announce_ip:
-
id: <integer>
ip: <string>
port: <integer>
status: <value in [disable, enable]>
send_report: <value in [disable, enable]>
send_setup: <value in [disable, enable]>
server_override:
servlist:
-
id: <integer>
ip: <string>
ip6: <string>
port: <integer>
service_type: # <list or string>
- "fds"
- "fct"
- "fai"
status: <value in [disable, enable]>
system_support_fct:
- "4.x"
- "5.0"
- "5.2"
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
system_support_fgt:
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
- "7.4"
- "7.6"
system_support_fml:
- "4.x"
- "5.x"
- "6.x"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
- "7.x"
system_support_fsa:
- "1.x"
- "2.x"
- "3.x"
- "4.x"
- "3.0"
- "3.1"
- "3.2"
system_support_fsw:
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "4.x"
- "5.0"
- "5.2"
- "6.4"
umsvc_log: <value in [emergency, alert, critical, ...]>
unreg_dev_option: <value in [ignore, svc-only, add-service]>
update_schedule:
day: <value in [Sunday, Monday, Tuesday, ...]>
frequency: <value in [every, daily, weekly]>
status: <value in [disable, enable]>
time: <list or string>
wanip_query_mode: <value in [disable, ipify]>
fortiguard_anycast: <value in [disable, enable]>
fortiguard_anycast_source: <value in [fortinet, aws]>
system_support_fdc:
- "3.x"
- "4.x"
- "5.x"
- "6.x"
system_support_fts:
- "3.x"
- "4.x"
- "7.x"
system_support_faz:
- "6.x"
- "7.x"
system_support_fis:
- "1.x"
- "2.x"
system_support_fai:
- "7.x"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |