fmgr_webfilter_urlfilter – Configure URL filter lists.¶
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| webfilter_urlfilter | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- webfilter_urlfilter - no description type: dict
- comment - Optional comments. type: str more...
- entries - Entries. type: array
more...
- action - Action to take for URL filter matches. type: str choices: [exempt, block, allow, monitor, pass] more...
- dns-address-family - Resolve IPv4 address, IPv6 address, or both from DNS server. type: str choices: [ipv4, ipv6, both] more...
- exempt - If action is set to exempt, select the security profile operations that exempt URLs skip. type: array choices: [av, web-content, activex-java-cookie, dlp, fortiguard, all, filepattern, pass, range-block, antiphish] more...
- id - Id. type: int more...
- referrer-host - Referrer host name. type: str more...
- status - Enable/disable this URL filter. type: str choices: [disable, enable] more...
- type - Filter type (simple, regex, or wildcard). type: str choices: [simple, regex, wildcard] more...
- url - URL to be filtered. type: str more...
- web-proxy-profile - Web proxy profile. type: str more...
- antiphish-action - Action to take for AntiPhishing matches. type: str choices: [block, log] more...
- id - ID. type: int more...
- ip-addr-block - Enable/disable blocking URLs when the hostname appears as an IP address. type: str choices: [disable, enable] more...
- name - Name of URL filter list. type: str more...
- one-arm-ips-urlfilter - Enable/disable DNS resolver for one-arm IPS URL filter operation. type: str choices: [disable, enable] 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¶
- 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: no description
fmgr_webfilter_urlfilter:
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>
state: <value in [present, absent]>
webfilter_urlfilter:
comment: <value of string>
entries:
-
action: <value in [exempt, block, allow, ...]>
dns-address-family: <value in [ipv4, ipv6, both]>
exempt:
- av
- web-content
- activex-java-cookie
- dlp
- fortiguard
- all
- filepattern
- pass
- range-block
- antiphish
id: <value of integer>
referrer-host: <value of string>
status: <value in [disable, enable]>
type: <value in [simple, regex, wildcard]>
url: <value of string>
web-proxy-profile: <value of string>
antiphish-action: <value in [block, log]>
id: <value of integer>
ip-addr-block: <value in [disable, enable]>
name: <value of string>
one-arm-ips-urlfilter: <value in [disable, enable]>
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