Steampunk Ansible Documentation - drmofu.fortimanager.fmgr_dnsfilter_profile (2.2.2) - module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - hosts: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure DNS domain filter profiles.
      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'

Scanned by Steampunk Spotter

 - name: gathering fortimanager facts
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
   tasks:
    - name: retrieve all the profiles
      fmgr_fact:
        facts:
            selector: 'dnsfilter_profile'
            params:
                adom: 'ansible'
                profile: 'your_value'

Inputs

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
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:
- update
- set
- 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 FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool

dnsfilter_profile:
description: the top level parameters set
required: false
suboptions:
block-action:
choices:
- block
- redirect
- block-sevrfail
description: Action to take for blocked domains.
type: str
block-botnet:
choices:
- disable
- enable
description: Enable/disable blocking botnet C&C DNS lookups.
type: str
comment:
description: Comment.
type: str
dns-translation:
description: Dns-Translation.
elements: dict
suboptions:
addr-type:
choices:
- ipv4
- ipv6
description: 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: no description
required: false
suboptions:
domain-filter-table:
description: DNS domain filter table ID.
type: int
type: dict
external-ip-blocklist:
description: One or more external IP block lists.
type: str
ftgd-dns:
description: no description
required: false
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: Enable/disable logging of all domains visited
type: str
log-all-url:
choices:
- disable
- enable
description: Enable/disable log all URLs visited.
type: str
name:
description: Profile name.
type: str
redirect-portal:
description: IP address of the SDNS redirect portal.
type: str
redirect-portal6:
description: IPv6 address of the SDNS redirect portal.
type: str
safe-search:
choices:
- disable
- enable
description: Enable/disable Google, Bing, and YouTube safe search.
type: str
sdns-domain-log:
choices:
- disable
- enable
description: Enable/disable domain filtering and botnet domain logging.
type: str
sdns-ftgd-err-log:
choices:
- disable
- enable
description: Enable/disable FortiGuard SDNS rating error logging.
type: str
sdns-url-log:
choices:
- disable
- enable
description: Enable/disable logging of URL filtering and botnet domains.
type: str
urlfilter:
description: no description
required: false
suboptions:
urlfilter-table:
description: DNS URL filter table ID.
type: int
type: dict
youtube-restrict:
choices:
- strict
- moderate
description: 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.
required: false
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int

Outputs

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