fmgr_fmupdate_fdssetting – Configure FortiGuard settings.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.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 FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- fmupdate_fdssetting - Configure FortiGuard settings. type: dict
- User_Agent (Alias name: 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...
- fds_clt_ssl_protocol (Alias name: 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...
- fds_ssl_protocol (Alias name: 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...
- fmtr_log (Alias name: fmtr-log) Fmtr log level type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
- linkd_log (Alias name: linkd-log) The linkd log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
- max_av_ips_version (Alias name: max-av-ips-version) The maximum number of downloadable, full version av/ips packages (1 - 1000, default = 20). type: int default: 20 more...
- max_work (Alias name: max-work) The maximum number of worker processing download requests (1 - 32, default = 1). type: int default: 1 more...
- push_override (Alias name: push-override) Push override. type: dict
more...
- 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...
- port Receiving port number on the nat device (1 - 65535, default = 9443). type: int default: 9443 more...
- status Enable/disable push updates for clients (default = disable). type: str choices: [disable, enable] default: disable more...
- push_override_to_client (Alias name: push-override-to-client) Push override to client. type: dict more...
- send_report Send report/fssi to fds server. type: str choices: [disable, enable] default: enable more...
- send_setup Forward setup to fds server. type: str choices: [disable, enable] default: disable more...
- server_override (Alias name: server-override) Server override. type: dict
more...
- servlist Servlist. type: list
more...
- id Override server id (1 - 10). type: int default: 0 more...
- ip Ipv4 address of the override server. type: str default: 0.0.0.0 more...
- ip6 Ipv6 address of the override server. type: str default: :: more...
- port Port number to use when contacting fortiguard (1 - 65535, default = 443). type: int default: 443 more...
- service_type (Alias name: service-type) Override service type. type: list or str choices: [fds, fct, fai] more...
- status Override status. type: str choices: [disable, enable] default: disable more...
- servlist Servlist. type: list
more...
- system_support_fct (Alias name: system-support-fct) Supported forticlient versions. type: list choices: [4.x, 5.0, 5.2, 5.4, 5.6, 6.0, 6.2, 6.4, 7.0, 7.2] more...
- system_support_fgt (Alias name: system-support-fgt) Supported fortios versions. type: list choices: [5.4, 5.6, 6.0, 6.2, 6.4, 7.0, 7.2, 7.4, 7.6] more...
- system_support_fml (Alias name: system-support-fml) Supported fortimail versions. type: list choices: [4.x, 5.x, 6.x, 6.0, 6.2, 6.4, 7.0, 7.2, 7.x] more...
- system_support_fsa (Alias name: system-support-fsa) Supported fortisandbox versions. type: list choices: [1.x, 2.x, 3.x, 4.x, 3.0, 3.1, 3.2] more...
- system_support_fsw (Alias name: system-support-fsw) Supported fortiswitch versions. type: list choices: [5.4, 5.6, 6.0, 6.2, 4.x, 5.0, 5.2, 6.4] more...
- umsvc_log (Alias name: umsvc-log) The um_service log level (default = info). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: info more...
- unreg_dev_option (Alias name: unreg-dev-option) Set the option for unregister devices type: str choices: [ignore, svc-only, add-service] default: add-service more...
- update_schedule (Alias name: update-schedule) Update schedule. type: dict
more...
- 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...
- 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...
- status Enable/disable scheduled updates. type: str choices: [disable, enable] default: enable more...
- time Time interval between updates, or the hour and minute when the update occurs (hh: 0 - 23, mm: 0 - 59 or 60 = random, default = 00:10). type: list more...
- wanip_query_mode (Alias name: wanip-query-mode) Public ip query mode type: str choices: [disable, ipify] default: disable more...
- fortiguard_anycast (Alias name: fortiguard-anycast) Enable/disable use of fortiguards anycast network type: str choices: [disable, enable] default: disable more...
- fortiguard_anycast_source (Alias name: fortiguard-anycast-source) Configure which of fortinets servers to provide fortiguard services in fortiguards anycast network. type: str choices: [fortinet, aws] default: fortinet more...
- system_support_fdc (Alias name: system-support-fdc) Supported fortideceptor versions. type: list choices: [3.x, 4.x, 5.x, 6.x] more...
- system_support_fts (Alias name: system-support-fts) Supported fortitester versions. type: list choices: [3.x, 4.x, 7.x] more...
- system_support_faz (Alias name: system-support-faz) Supported fortianalyzer versions. type: list choices: [6.x, 7.x] more...
- system_support_fis (Alias name: system-support-fis) Supported fortiisolator versions. type: list choices: [1.x, 2.x] more...
- system_support_fai (Alias name: system-support-fai) Supported fortindr versions. type: list choices: [7.x] more...
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
- 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: 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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.