security_dns_filter_profile - DNS Filter Profile Resource

Added in version 1.0.0.

Synopsis

DNS Filter Profile Resource.

Use API “/resource-api/v2/security/dns-filter-profile/{direction}/{primaryKey}”.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means update the resource. This resource can't be deleted, and does not support "absent" state.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • direction [Required]type: str
    • primary_key [Required]type: str
    • use_for_edge_devices type: bool
    • use_fortiguard_filters type: strchoices: ['disable', 'enable']
    • enable_all_logs type: strchoices: ['disable', 'enable']
    • enable_botnet_blocking type: strchoices: ['disable', 'enable']
    • enable_safe_search type: strchoices: ['disable', 'enable']
    • allow_dns_requests_on_rating_error type: strchoices: ['disable', 'enable']
    • dns_translation_entries type: listelements: dict
      • src type: str
      • dst type: str
      • netmask type: str
      • status type: strchoices: ['disable', 'enable']
    • domain_filters type: listelements: dict
      • url type: str
      • type type: strchoices: ['regex', 'simple', 'wildcard']
      • action type: strchoices: ['allow', 'block', 'exempt', 'monitor']
      • enabled type: bool
    • fortiguard_filters type: listelements: dict
      • action type: strchoices: ['allow', 'block', 'monitor', 'warning']
      • category type: dict
        • primary_key type: str
        • datasource type: str
    • domain_threat_feed_filters type: listelements: dict
      • action type: strchoices: ['allow', 'block', 'disable', 'monitor', 'warning']
      • category type: dict
        • primary_key type: str
        • datasource type: str

Examples

- name: Update security dns filter profile
  hosts: fortisase
  gather_facts: false
  vars:
    direction: "outbound-profiles" # outbound-profiles or internal-profiles
    profile_group: "profile_ansible"
  tasks:
    - name: Ensure security group exists, otherwise create it
      fortinet.fortisase.security_profile_group:
        params:
          direction: "{{ direction }}"
          primary_key: "{{ profile_group }}"
    - name: Update security dns filter profile
      fortinet.fortisase.security_dns_filter_profile:
        params:
          direction: "{{ direction }}"
          primary_key: "{{ profile_group }}"
          use_for_edge_devices: false
          allow_dns_requests_on_rating_error: "enable"
          dns_translation_entries: []
          domain_filters: []
          domain_threat_feed_filters: []
          enable_all_logs: "disable"
          enable_botnet_blocking: "enable"
          enable_safe_search: "disable"
          use_fortiguard_filters: "enable"
          fortiguard_filters:
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Alternative Beliefs
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Abortion
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Other Adult Materials
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Advocacy Organizations
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Gambling
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Extremist Groups
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Nudity and Risque
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Pornography
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Dating
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: "Weapons (Sales)"
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Unrated
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Marijuana
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Sex Education
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Alcohol
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Tobacco
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Lingerie and Swimsuit
            - action: monitor
              category:
                datasource: security/fortiguard-categories
                primary_key: Sports Hunting and War Games
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Malicious Websites
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Phishing
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Spam URLs
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Dynamic DNS
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Newly Observed Domain
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Newly Registered Domain
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Terrorism
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Crypto Mining
            - action: block
              category:
                datasource: security/fortiguard-categories
                primary_key: Potentially Unwanted Program
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Drug Abuse
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Hacking
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Illegal or Unethical
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Discrimination
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Explicit Violence
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Proxy Avoidance
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Plagiarism
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Child Sexual Abuse
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Freeware and Software Downloads
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: File Sharing and Storage
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Streaming Media and Download
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Peer-to-peer File Sharing
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Internet Radio and TV
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Internet Telephony
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Advertising
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Brokerage and Trading
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Games
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Web-based Email
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Entertainment
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Arts and Culture
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Education
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Health and Wellness
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Job Search
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Medicine
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: News and Media
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Social Networking
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Political Organizations
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Reference
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Global Religion
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Shopping
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Society and Lifestyles
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Sports
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Travel
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Personal Vehicles
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Dynamic Content
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Meaningless Content
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Folklore
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Web Chat
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Instant Messaging
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Newsgroups and Message Boards
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Digital Postcards
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Child Education
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Real Estate
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Restaurant and Dining
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Personal Websites and Blogs
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Content Servers
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Domain Parking
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Personal Privacy
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Auction
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Finance and Banking
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Search Engines and Portals
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: General Organizations
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Business
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Information and Computer Security
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Government and Legal Organizations
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Information Technology
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Armed Forces
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Web Hosting
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Secure Websites
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Web-based Applications
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Charitable Organizations
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Remote Access
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Web Analytics
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Online Meeting
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: URL Shortening
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Artificial Intelligence Technology
            - action: allow
              category:
                datasource: security/fortiguard-categories
                primary_key: Cryptocurrency

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)