drmofu / drmofu.fortianalyzer / 1.3.0 / module / faz_cli_fmupdate_fdssetting Configure FortiGuard settings. | "added in version" 1.0.0 of drmofu.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortianalyzer.faz_cli_fmupdate_fdssetting (1.3.0) — module
Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0
collections: - name: drmofu.fortianalyzer version: 1.3.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
log_path: default: /tmp/fortianalyzer.ansible.log description: - 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.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool cli_fmupdate_fdssetting: description: the top level parameters set required: false suboptions: User-Agent: description: Configure the user agent string. type: str fds-clt-ssl-protocol: choices: - sslv3 - tlsv1.0 - tlsv1.1 - tlsv1.2 - tlsv1.3 description: - The SSL protocols version for connecting fds server (default = tlsv1.2). - sslv3 - set SSLv3 as the client version. - tlsv1.0 - set TLSv1.0 as the client version. - tlsv1.1 - set TLSv1.1 as the client version. - tlsv1.2 - set TLSv1.2 as the client version (default). - tlsv1.3 - set TLSv1.3 as the client version. type: str fds-ssl-protocol: choices: - sslv3 - tlsv1.0 - tlsv1.1 - tlsv1.2 - tlsv1.3 description: - The SSL protocols version for receiving fgt connection (default = tlsv1.2). - sslv3 - set SSLv3 as the lowest version. - tlsv1.0 - set TLSv1.0 as the lowest version. - tlsv1.1 - set TLSv1.1 as the lowest version. - tlsv1.2 - set TLSv1.2 as the lowest version (default). - tlsv1.3 - set TLSv1.3 as the lowest version. type: str fmtr-log: choices: - emergency - alert - critical - error - warn - notice - info - debug - disable description: - 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 type: str fortiguard-anycast: choices: - disable - enable description: - Enable/disable use of FortiGuards anycast network - disable - Disable setting. - enable - Enable setting. type: str fortiguard-anycast-source: choices: - fortinet - aws description: - Configure which of Fortinets servers to provide FortiGuard services in FortiGuards anycast network. Default is Fortinet - 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. type: str linkd-log: choices: - emergency - alert - critical - error - warn - notice - info - debug - disable description: - The linkd log level (default = info). - 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 type: str max-av-ips-version: description: The maximum number of downloadable, full version AV/IPS packages (1 - 1000, default = 20). type: int max-work: description: The maximum number of worker processing download requests (1 - 32, default = 1). type: int push-override: description: no description required: false suboptions: ip: description: External or virtual IP address of the NAT device that will forward push messages to the FortiManager unit. type: str port: description: Receiving port number on the NAT device (1 - 65535, default = 9443). type: int status: choices: - disable - enable description: - Enable/disable push updates for clients (default = disable). - disable - Disable setting. - enable - Enable setting. type: str type: dict push-override-to-client: description: no description required: false suboptions: announce-ip: description: no description elements: dict suboptions: id: description: ID of the announce IP address (1 - 10). type: int ip: description: Announce IPv4 address. type: str port: description: Announce IP port (1 - 65535, default = 8890). type: int type: list status: choices: - disable - enable description: - Enable/disable push updates (default = disable). - disable - Disable setting. - enable - Enable setting. type: str type: dict send_report: choices: - disable - enable description: - send report/fssi to fds server. - disable - Disable setting. - enable - Enable setting. type: str send_setup: choices: - disable - enable description: - forward setup to fds server. - disable - Disable setting. - enable - Enable setting. type: str server-override: description: no description required: false suboptions: servlist: description: no description elements: dict suboptions: id: description: Override server ID (1 - 10). type: int ip: description: IPv4 address of the override server. type: str ip6: description: IPv6 address of the override server. type: str port: description: Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int service-type: choices: - fct - fds description: - Override service type. - fct - Server override config for fct - fds - Server override config for fds type: str type: list status: choices: - disable - enable description: - Override status. - disable - Disable setting. - enable - Enable setting. type: str type: dict system-support-faz: choices: - 6.x - 7.x description: no description elements: str type: list system-support-fct: choices: - 4.x - '5.0' - '5.2' - '5.4' - '5.6' - '6.0' - '6.2' - '6.4' - '7.0' description: no description elements: str type: list system-support-fdc: choices: - 3.x - 4.x description: no description elements: str type: list system-support-fgt: choices: - '5.4' - '5.6' - '6.0' - '6.2' - '6.4' - '7.0' - '7.2' - '7.4' description: no description elements: str type: list system-support-fis: choices: - 1.x - 2.x description: no description elements: str type: list system-support-fml: choices: - 4.x - 5.x - 6.x - '6.0' - '6.2' - '6.4' - '7.0' - '7.2' description: no description elements: str type: list system-support-fsa: choices: - 1.x - 2.x - 3.x - '3.0' - '3.1' - '3.2' - 4.x description: no description elements: str type: list system-support-fsw: choices: - 4.x - '5.0' - '5.2' - '5.4' - '5.6' - '6.0' - '6.2' - '6.4' description: no description elements: str type: list system-support-fts: choices: - 4.x - 3.x - 7.x description: no description elements: str type: list umsvc-log: choices: - emergency - alert - critical - error - warn - notice - info - debug - disable description: - The um_service log level (default = info). - 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 type: str unreg-dev-option: choices: - ignore - svc-only - add-service description: - 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. type: str update-schedule: description: no description required: false suboptions: day: choices: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday description: - Configure the day the update will occur, if the freqnecy is weekly (Sunday - Saturday, default = Monday). - 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. type: str frequency: choices: - every - daily - weekly description: - 'Configure update frequency: every - time interval, daily - once a day, weekly - once a week (default = every).' - every - Time interval. - daily - Every day. - weekly - Every week. type: str status: choices: - disable - enable description: - Enable/disable scheduled updates. - disable - Disable setting. - enable - Enable setting. type: str time: description: no description type: str type: dict wanip-query-mode: choices: - disable - ipify description: - public ip query mode - disable - Do not query public ip - ipify - Get public IP through https://api.ipify.org type: str type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
meta: contains: request_url: description: The full url requested returned: always sample: /sys/login/user type: str response_code: description: The status of api request returned: always sample: 0 type: int response_data: description: The api response returned: always type: list response_message: description: The descriptive message of the api response returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: complex type: list