Try SpotterConfigure DNS domain filter profiles.
| "added in version" 1.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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure DNS domain filter profiles.
fortinet.fortimanager.fmgr_dnsfilter_profile:
bypass_validation: false
adom: ansible
state: present
dnsfilter_profile:
block-action: redirect
block-botnet: disable
comment: "ansible-test-comment"
log-all-domain: disable
name: "ansible-test"
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the profiles
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dnsfilter_profile"
params:
adom: "ansible"
profile: "your_value"
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
dnsfilter_profile:
description: The top level parameters set.
required: false
suboptions:
block-action:
choices:
- block
- redirect
- block-sevrfail
description: Deprecated, please rename it to block_action. Action to take for
blocked domains.
type: str
block-botnet:
choices:
- disable
- enable
description: Deprecated, please rename it to block_botnet. Enable/disable blocking
botnet C&C DNS lookups.
type: str
comment:
description: Comment.
type: str
dns-translation:
description: Deprecated, please rename it to dns_translation. Dns-Translation.
elements: dict
suboptions:
addr-type:
choices:
- ipv4
- ipv6
description: Deprecated, please rename it to addr_type. DNS translation type
type: str
dst:
description: IPv4 address or subnet on the external network to substitute
for the resolved address in DNS query replies.
type: str
dst6:
description: IPv6 address or subnet on the external network to substitute
for the resolved address in DNS query replies.
type: str
id:
description: ID.
type: int
netmask:
description: If src and dst are subnets rather than single IP addresses, enter
the netmask for both src and dst.
type: str
prefix:
description: If src6 and dst6 are subnets rather than single IP addresses,
enter the prefix for both src6 and dst6
type: int
src:
description: IPv4 address or subnet on the internal network to compare with
the resolved address in DNS query replies.
type: str
src6:
description: IPv6 address or subnet on the internal network to compare with
the resolved address in DNS query replies.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this DNS translation entry.
type: str
type: list
domain-filter:
description: Deprecated, please rename it to domain_filter.
suboptions:
domain-filter-table:
description: Deprecated, please rename it to domain_filter_table. DNS domain
filter table ID.
type: int
type: dict
external-ip-blocklist:
description: (list or str) Deprecated, please rename it to external_ip_blocklist.
One or more external IP block lists.
type: raw
ftgd-dns:
description: Deprecated, please rename it to ftgd_dns.
suboptions:
filters:
description: Filters.
elements: dict
suboptions:
action:
choices:
- monitor
- block
description: Action to take for DNS requests matching the category.
type: str
category:
description: Category number.
type: str
id:
description: ID number.
type: int
log:
choices:
- disable
- enable
description: Enable/disable DNS filter logging for this DNS profile.
type: str
type: list
options:
choices:
- error-allow
- ftgd-disable
description: FortiGuard DNS filter options.
elements: str
type: list
type: dict
log-all-domain:
choices:
- disable
- enable
description: Deprecated, please rename it to log_all_domain. Enable/disable logging
of all domains visited
type: str
log-all-url:
choices:
- disable
- enable
description: Deprecated, please rename it to log_all_url. Enable/disable log all
URLs visited.
type: str
name:
description: Profile name.
required: true
type: str
redirect-portal:
description: Deprecated, please rename it to redirect_portal. IP address of the
SDNS redirect portal.
type: str
redirect-portal6:
description: Deprecated, please rename it to redirect_portal6. IPv6 address of
the SDNS redirect portal.
type: str
safe-search:
choices:
- disable
- enable
description: Deprecated, please rename it to safe_search. Enable/disable Google,
Bing, and YouTube safe search.
type: str
sdns-domain-log:
choices:
- disable
- enable
description: Deprecated, please rename it to sdns_domain_log. Enable/disable domain
filtering and botnet domain logging.
type: str
sdns-ftgd-err-log:
choices:
- disable
- enable
description: Deprecated, please rename it to sdns_ftgd_err_log. Enable/disable
FortiGuard SDNS rating error logging.
type: str
sdns-url-log:
choices:
- disable
- enable
description: Deprecated, please rename it to sdns_url_log. Enable/disable logging
of URL filtering and botnet domains.
type: str
transparent-dns-database:
description: (list) Deprecated, please rename it to transparent_dns_database.
type: raw
urlfilter:
description: No description.
suboptions:
urlfilter-table:
description: Deprecated, please rename it to urlfilter_table. DNS URL filter
table ID.
type: int
type: dict
youtube-restrict:
choices:
- strict
- moderate
description: Deprecated, please rename it to youtube_restrict. Set safe search
for YouTube restriction level.
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