ansible.builtin.fortios_webfilter_override (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure webfilter feature and override category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure FortiGuard Web Filter administrative overrides.
    fortios_webfilter_override:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      webfilter_override:
        state: "present"
        expires: "<your_own_value>"
        id:  "4"
        initiator: "<your_own_value>"
        ip: "<your_own_value>"
        ip6: "<your_own_value>"
        new-profile: "<your_own_value> (source webfilter.profile.name)"
        old-profile: "<your_own_value> (source webfilter.profile.name)"
        scope: "user"
        status: "enable"
        user: "<your_own_value>"
        user-group: "<your_own_value> (source user.group.name)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

webfilter_override:
    default: null
    description:
    - Configure FortiGuard Web Filter administrative overrides.
    suboptions:
      expires:
        description:
        - 'Override expiration date and time, from 5 minutes to 365 from now (format:
          yyyy/mm/dd hh:mm:ss).'
      id:
        description:
        - Override rule ID.
        required: true
      initiator:
        description:
        - Initiating user of override (read-only setting).
      ip:
        description:
        - IPv4 address which the override applies.
      ip6:
        description:
        - IPv6 address which the override applies.
      new-profile:
        description:
        - Name of the new web filter profile used by the override. Source webfilter.profile.name.
      old-profile:
        description:
        - Name of the web filter profile which the override applies. Source webfilter.profile.name.
      scope:
        choices:
        - user
        - user-group
        - ip
        - ip6
        description:
        - Override either the specific user, user group, IPv4 address, or IPv6 address.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable override rule.
      user:
        description:
        - Name of the user which the override applies.
      user-group:
        description:
        - Specify the user group for which the override applies. Source user.group.name.

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: key1
  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