Skip to content

Latest commit

 

History

History
337 lines (292 loc) · 14.9 KB

fortios_webfilter_override.rst

File metadata and controls

337 lines (292 loc) · 14.9 KB
Raw
source:fortios_webfilter_override.py
orphan:

fortios_webfilter_override -- Configure FortiGuard Web Filter administrative overrides in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_webfilter_override v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • webfilter_override - Configure FortiGuard Web Filter administrative overrides. type: dict more...
    Supported Version Ranges
    webfilter_override v6.0.0 -> latest
    • expires - Override expiration date and time, from 5 minutes to 365 from now (format: yyyy/mm/dd hh:mm:ss). type: str more...
      Supported Version Ranges
      expires v6.0.0 -> latest
    • id - Override rule ID. see Notes. type: int required: true more...
      Supported Version Ranges
      id v6.0.0 -> latest
    • initiator - Initiating user of override (read-only setting). type: str more...
      Supported Version Ranges
      initiator v6.0.0 -> latest
    • ip - IPv4 address which the override applies. type: str more...
      Supported Version Ranges
      ip v6.0.0 -> latest
    • ip6 - IPv6 address which the override applies. type: str more...
      Supported Version Ranges
      ip6 v6.0.0 -> latest
    • new_profile - Name of the new web filter profile used by the override. Source webfilter.profile.name. type: str more...
      Supported Version Ranges
      new_profile v6.0.0 -> latest
    • old_profile - Name of the web filter profile which the override applies. Source webfilter.profile.name. type: str more...
      Supported Version Ranges
      old_profile v6.0.0 -> latest
    • scope - Override either the specific user, user group, IPv4 address, or IPv6 address. type: str choices: user, user-group, ip, ip6 more...
      Supported Version Ranges
      scope v6.0.0 -> latest
      [user] v6.0.0 -> latest
      [user-group] v6.0.0 -> latest
      [ip] v6.0.0 -> latest
      [ip6] v6.0.0 -> latest
    • status - Enable/disable override rule. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • user - Name of the user which the override applies. type: str more...
      Supported Version Ranges
      user v6.0.0 -> latest
    • user_group - Specify the user group for which the override applies. Source user.group.name. type: str more...
      Supported Version Ranges
      user_group v6.0.0 -> latest

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure FortiGuard Web Filter administrative overrides.
  fortinet.fortios.fortios_webfilter_override:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      webfilter_override:
          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)"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.