Skip to content

Latest commit

 

History

History
466 lines (422 loc) · 20.2 KB

fortios_videofilter_profile.rst

File metadata and controls

466 lines (422 loc) · 20.2 KB
Raw
source:fortios_videofilter_profile.py
orphan:

fortios_videofilter_profile -- Configure VideoFilter profile 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 videofilter feature and profile 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_videofilter_profile v7.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
  • videofilter_profile - Configure VideoFilter profile. type: dict more...
    Supported Version Ranges
    videofilter_profile v7.0.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v7.0.0 -> latest
    • dailymotion - Enable/disable Dailymotion video source. type: str choices: enable, disable more...
      Supported Version Ranges
      dailymotion v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • default_action - Video filter default action. type: str choices: allow, monitor, block more...
      Supported Version Ranges
      default_action v7.4.0 -> latest
      [allow] v6.0.0 -> latest
      [monitor] v6.0.0 -> latest
      [block] v6.0.0 -> latest
    • fortiguard_category - Configure FortiGuard categories. type: dict more...
      Supported Version Ranges
      fortiguard_category v7.0.0 -> latest
      • filters - Configure VideoFilter FortiGuard category. type: list member_path: fortiguard_category/filters:id more...
        Supported Version Ranges
        filters v7.0.0 -> latest
        • action - VideoFilter action. type: str choices: allow, monitor, block, bypass more...
          Supported Version Ranges
          action v7.0.0 -> latest
          [allow] v7.0.1 -> latest
          [monitor] v6.0.0 -> latest
          [block] v6.0.0 -> latest
          [bypass] v7.0.0 -> v7.0.0
        • category_id - Category ID. type: int more...
          Supported Version Ranges
          category_id v7.0.0 -> latest
        • id - ID. see Notes. type: int required: true more...
          Supported Version Ranges
          id v7.0.0 -> latest
        • log - Enable/disable logging. type: str choices: enable, disable more...
          Supported Version Ranges
          log v7.0.0 -> latest
          [enable] v6.0.0 -> latest
          [disable] v6.0.0 -> latest
    • log - Enable/disable logging. type: str choices: enable, disable more...
      Supported Version Ranges
      log v7.4.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • name - Name. type: str required: true more...
      Supported Version Ranges
      name v7.0.0 -> latest
    • replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str more...
      Supported Version Ranges
      replacemsg_group v7.0.1 -> latest
    • vimeo - Enable/disable Vimeo video source. type: str choices: enable, disable more...
      Supported Version Ranges
      vimeo v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • vimeo_restrict - Set Vimeo-restrict ("7" = don"t show mature content, "134" = don"t show unrated and mature content). A value of cookie "content_rating". type: str more...
      Supported Version Ranges
      vimeo_restrict v7.0.0 -> v7.0.0
    • youtube - Enable/disable YouTube video source. type: str choices: enable, disable more...
      Supported Version Ranges
      youtube v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • youtube_channel_filter - Set YouTube channel filter. Source videofilter.youtube-channel-filter.id. type: int more...
      Supported Version Ranges
      youtube_channel_filter v7.0.0 -> latest
    • youtube_restrict - Set YouTube-restrict mode. type: str choices: none, strict, moderate more...
      Supported Version Ranges
      youtube_restrict v7.0.0 -> v7.0.0
      [none] v6.0.0 -> latest
      [strict] v6.0.0 -> latest
      [moderate] v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure VideoFilter profile.
  fortinet.fortios.fortios_videofilter_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      videofilter_profile:
          comment: "Comment."
          dailymotion: "enable"
          default_action: "allow"
          fortiguard_category:
              filters:
                  -
                      action: "allow"
                      category_id: "0"
                      id: "10"
                      log: "enable"
          log: "enable"
          name: "default_name_13"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          vimeo: "enable"
          vimeo_restrict: "<your_own_value>"
          youtube: "enable"
          youtube_channel_filter: "0"
          youtube_restrict: "none"

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.