fortinet.fortios.fortios_videofilter_profile (2.3.6) — module

Configure VideoFilter profile in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

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

preview | supported by community

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
          filters:
              -
                  action: "allow"
                  category: "<your_own_value>"
                  channel: "<your_own_value>"
                  comment: "Comment."
                  id: "11"
                  keyword: "0"
                  log: "enable"
                  type: "category"
          fortiguard_category:
              filters:
                  -
                      action: "allow"
                      category_id: "0"
                      id: "19"
                      log: "enable"
          log: "enable"
          name: "default_name_22"
          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"

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

videofilter_profile:
    default: null
    description:
    - Configure VideoFilter profile.
    suboptions:
      comment:
        description:
        - Comment.
        type: str
      dailymotion:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Dailymotion video source.
        type: str
      default_action:
        choices:
        - allow
        - monitor
        - block
        description:
        - Video filter default action.
        type: str
      filters:
        description:
        - YouTube filter entries.
        elements: dict
        suboptions:
          action:
            choices:
            - allow
            - monitor
            - block
            description:
            - Video filter action.
            type: str
          category:
            description:
            - FortiGuard category ID.
            type: str
          channel:
            description:
            - Channel ID.
            type: str
          comment:
            description:
            - Comment.
            type: str
          id:
            description:
            - ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          keyword:
            description:
            - Video filter keyword ID. Source videofilter.keyword.id.
            type: int
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
          type:
            choices:
            - category
            - channel
            - title
            - description
            description:
            - Filter type.
            type: str
        type: list
      fortiguard_category:
        description:
        - Configure FortiGuard categories.
        suboptions:
          filters:
            description:
            - Configure VideoFilter FortiGuard category.
            elements: dict
            suboptions:
              action:
                choices:
                - allow
                - monitor
                - block
                - bypass
                description:
                - VideoFilter action.
                type: str
              category_id:
                description:
                - Category ID.
                type: int
              id:
                description:
                - ID. see <a href='#notes'>Notes</a>.
                required: true
                type: int
              log:
                choices:
                - enable
                - disable
                description:
                - Enable/disable logging.
                type: str
            type: list
        type: dict
      log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging.
        type: str
      name:
        description:
        - Name.
        required: true
        type: str
      replacemsg_group:
        description:
        - Replacement message group. Source system.replacemsg-group.name.
        type: str
      vimeo:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Vimeo video source.
        type: str
      vimeo_restrict:
        description:
        - 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
      youtube:
        choices:
        - enable
        - disable
        description:
        - Enable/disable YouTube video source.
        type: str
      youtube_channel_filter:
        description:
        - Set YouTube channel filter. Source videofilter.youtube-channel-filter.id.
        type: int
      youtube_restrict:
        choices:
        - none
        - strict
        - moderate
        description:
        - Set YouTube-restrict mode.
        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