fmgr_fmupdate_fdssetting – Configure FortiGuard settings.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- 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
- 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)
- fds-clt-ssl-protocol - The SSL protocols version for connecting fds server (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2] default: tlsv1.2
- fds-ssl-protocol - The SSL protocols version for receiving fgt connection (default = tlsv1. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2] default: tlsv1.2
- fmtr-log - fmtr log level type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info
- linkd-log - The linkd log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info
- max-av-ips-version - The maximum number of downloadable, full version AV/IPS packages (1 - 1000, default = 20). type: int default: 20
- max-work - The maximum number of worker processing download requests (1 - 32, default = 1). type: int default: 1
- 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
- port - Receiving port number on the NAT device (1 - 65535, default = 9443). type: int default: 9443
- status - Enable/disable push updates for clients (default = disable). type: str choices: [disable, enable] default: disable
- push-override-to-client type: dict
- announce-ip - No description for the parameter type: array
- id - ID of the announce IP address (1 - 10). type: int default: 0
- ip - Announce IPv4 address. type: str default: 0.0.0.0
- port - Announce IP port (1 - 65535, default = 8890). type: int default: 8890
- status - Enable/disable push updates (default = disable). type: str choices: [disable, enable] default: disable
- send_report - send report/fssi to fds server. type: str choices: [disable, enable] default: enable
- send_setup - forward setup to fds server. type: str choices: [disable, enable] default: disable
- server-override type: dict
- servlist - No description for the parameter type: array
- id - Override server ID (1 - 10). type: int default: 0
- ip - IPv4 address of the override server. type: str default: 0.0.0.0
- ip6 - IPv6 address of the override server. type: str default: ::
- port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443
- service-type - No description for the parameter type: array choices: [fds, fct]
- status - Override status. type: str choices: [disable, enable] default: disable
- system-support-fct - No description for the parameter type: array choices: [4.x, 5.0, 5.2, 5.4, 5.6, 6.0]
- system-support-fgt - No description for the parameter type: array choices: [5.4, 5.6, 6.0, 6.2]
- system-support-fml - No description for the parameter type: array choices: [4.x, 5.x, 6.x]
- system-support-fsa - No description for the parameter type: array choices: [1.x, 2.x, 3.x]
- system-support-fsw - No description for the parameter type: array choices: [5.4, 5.6, 6.0, 6.2]
- umsvc-log - The um_service log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info
- unreg-dev-option - set the option for unregister devices type: str choices: [ignore, svc-only, add-service] default: add-service
- 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
- 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
- status - Enable/disable scheduled updates. type: str choices: [disable, enable] default: enable
- time - No description for the parameter type: str
- wanip-query-mode - public ip query mode type: str choices: [disable, ipify] default: disable
Notes¶
Note
- 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.
- 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¶
- 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 FortiGuard settings.
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: <value of 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: <value of integer>
max-work: <value of integer>
push-override:
ip: <value of string>
port: <value of integer>
status: <value in [disable, enable]>
push-override-to-client:
announce-ip:
-
id: <value of integer>
ip: <value of string>
port: <value of integer>
status: <value in [disable, enable]>
send_report: <value in [disable, enable]>
send_setup: <value in [disable, enable]>
server-override:
servlist:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
port: <value of integer>
service-type:
- fds
- fct
status: <value in [disable, enable]>
system-support-fct:
- 4.x
- 5.0
- 5.2
- 5.4
- 5.6
- 6.0
system-support-fgt:
- 5.4
- 5.6
- 6.0
- 6.2
system-support-fml:
- 4.x
- 5.x
- 6.x
system-support-fsa:
- 1.x
- 2.x
- 3.x
system-support-fsw:
- 5.4
- 5.6
- 6.0
- 6.2
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: <value of string>
wanip-query-mode: <value in [disable, ipify]>
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