Try SpotterConfigure URL filter lists.
| "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 community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This 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: Configure URL filter lists.
fortinet.fortimanager.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: present # <value in [present, absent]>
webfilter_urlfilter:
comment: <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: <integer>
referrer_host: <string>
status: <value in [disable, enable]>
type: <value in [simple, regex, wildcard]>
url: <string>
web_proxy_profile: <string>
antiphish_action: <value in [block, log]>
id: <integer>
ip_addr_block: <value in [disable, enable]>
name: <string>
one_arm_ips_urlfilter: <value in [disable, enable]>
ip4_mapped_ip6: <value in [disable, enable]>
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
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
webfilter_urlfilter:
description: The top level parameters set.
required: false
suboptions:
comment:
description: Optional comments.
type: str
entries:
description: Entries.
elements: dict
suboptions:
action:
choices:
- exempt
- block
- allow
- monitor
- pass
description: Action to take for URL filter matches.
type: str
antiphish-action:
choices:
- block
- log
description: Deprecated, please rename it to antiphish_action. Action to take
for AntiPhishing matches.
type: str
dns-address-family:
choices:
- ipv4
- ipv6
- both
description: Deprecated, please rename it to dns_address_family. Resolve IPv4
address, IPv6 address, or both from DNS server.
type: str
exempt:
choices:
- av
- web-content
- activex-java-cookie
- dlp
- fortiguard
- all
- filepattern
- pass
- range-block
- antiphish
description: If action is set to exempt, select the security profile operations
that exempt URLs skip.
elements: str
type: list
id:
description: Id.
type: int
referrer-host:
description: Deprecated, please rename it to referrer_host. Referrer host
name.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this URL filter.
type: str
type:
choices:
- simple
- regex
- wildcard
description: Filter type
type: str
url:
description: URL to be filtered.
type: str
web-proxy-profile:
description: Deprecated, please rename it to web_proxy_profile. Web proxy
profile.
type: str
type: list
id:
description: ID.
required: true
type: int
ip-addr-block:
choices:
- disable
- enable
description: Deprecated, please rename it to ip_addr_block. Enable/disable blocking
URLs when the hostname appears as an IP address.
type: str
ip4-mapped-ip6:
choices:
- disable
- enable
description: Deprecated, please rename it to ip4_mapped_ip6. Enable/disable matching
of IPv4 mapped IPv6 URLs.
type: str
name:
description: Name of URL filter list.
type: str
one-arm-ips-urlfilter:
choices:
- disable
- enable
description: Deprecated, please rename it to one_arm_ips_urlfilter. Enable/disable
DNS resolver for one-arm IPS URL filter operation.
type: str
type: dict
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
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