fortinet.fortios.fortios_webfilter_urlfilter (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and urlfilter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure URL filter lists.
  fortinet.fortios.fortios_webfilter_urlfilter:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      webfilter_urlfilter:
          comment: "Optional comments."
          entries:
              -
                  action: "exempt"
                  antiphish_action: "block"
                  dns_address_family: "ipv4"
                  exempt: "av"
                  id: "9"
                  referrer_host: "myhostname"
                  status: "enable"
                  type: "simple"
                  url: "myurl.com"
                  web_proxy_profile: "<your_own_value> (source web-proxy.profile.name)"
          id: "15"
          ip_addr_block: "enable"
          ip4_mapped_ip6: "enable"
          name: "default_name_18"
          one_arm_ips_urlfilter: "enable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

webfilter_urlfilter:
    default: null
    description:
    - Configure URL filter lists.
    suboptions:
      comment:
        description:
        - Optional comments.
        type: str
      entries:
        description:
        - URL filter entries.
        elements: dict
        suboptions:
          action:
            choices:
            - exempt
            - block
            - allow
            - monitor
            description:
            - Action to take for URL filter matches.
            type: str
          antiphish_action:
            choices:
            - block
            - log
            description:
            - Action to take for AntiPhishing matches.
            type: str
          dns_address_family:
            choices:
            - ipv4
            - ipv6
            - both
            description:
            - Resolve IPv4 address, IPv6 address, or both from DNS server.
            type: str
          exempt:
            choices:
            - av
            - web-content
            - activex-java-cookie
            - dlp
            - fortiguard
            - range-block
            - pass
            - antiphish
            - all
            description:
            - If action is set to exempt, select the security profile operations that
              exempt URLs skip. Separate multiple options with a space.
            elements: str
            type: list
          id:
            description:
            - Id. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          referrer_host:
            description:
            - Referrer host name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable this URL filter.
            type: str
          type:
            choices:
            - simple
            - regex
            - wildcard
            description:
            - Filter type (simple, regex, or wildcard).
            type: str
          url:
            description:
            - URL to be filtered.
            type: str
          web_proxy_profile:
            description:
            - Web proxy profile. Source web-proxy.profile.name.
            type: str
        type: list
      id:
        description:
        - ID. see <a href='#notes'>Notes</a>.
        required: true
        type: int
      ip4_mapped_ip6:
        choices:
        - enable
        - disable
        description:
        - Enable/disable matching of IPv4 mapped IPv6 URLs.
        type: str
      ip_addr_block:
        choices:
        - enable
        - disable
        description:
        - Enable/disable blocking URLs when the hostname appears as an IP address.
        type: str
      name:
        description:
        - Name of URL filter list.
        type: str
      one_arm_ips_urlfilter:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DNS resolver for one-arm IPS URL filter operation.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str