fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_webfilter_profile_ftgdwf_filters FortiGuard filters. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_filters (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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: FortiGuard filters. fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf_filters: # 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, ...] adom: <your own value> profile: <your own value> state: present # <value in [present, absent]> webfilter_profile_ftgdwf_filters: action: <value in [block, monitor, warning, ...]> auth_usr_grp: <list or string> category: <string> id: <integer> log: <value in [disable, enable]> override_replacemsg: <string> warn_duration: <string> warning_duration_type: <value in [session, timeout]> warning_prompt: <value in [per-domain, per-category]>
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str profile: description: The parameter (profile) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int webfilter_profile_ftgdwf_filters: description: The top level parameters set. required: false suboptions: action: choices: - block - monitor - warning - authenticate description: Action to take for matches. type: str auth-usr-grp: description: (list or str) Deprecated, please rename it to auth_usr_grp. Groups with permission to authenticate. type: raw category: description: Categories and groups the filter examines. type: str id: description: ID number. required: true type: int log: choices: - disable - enable description: Enable/disable logging. type: str override-replacemsg: description: Deprecated, please rename it to override_replacemsg. Override replacement message. type: str warn-duration: description: Deprecated, please rename it to warn_duration. Duration of warnings. type: str warning-duration-type: choices: - session - timeout description: Deprecated, please rename it to warning_duration_type. Re-display warning after closing browser or after a timeout. type: str warning-prompt: choices: - per-domain - per-category description: Deprecated, please rename it to warning_prompt. Warning prompts in each category or each domain. type: str type: dict
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 FortiManager version. returned: complex type: list