fmgr_videofilter_profile – Configure VideoFilter profile.

Added in version 2.1.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • videofilter_profile - Configure VideoFilter profile. type: dict
    • comment Comment. type: str more...
    • dailymotion Enable/disable dailymotion video source. type: str choices: [disable, enable] more...
    • fortiguard_category (Alias name: fortiguard-category) type: dict
      • filters Filters. type: list more...
        • action Videofilter action. type: str choices: [block, bypass, monitor, allow] more...
        • category_id (Alias name: category-id) Category id. type: int more...
        • id Id. type: int more...
        • log Enable/disable logging. type: str choices: [disable, enable] more...
    • name Name. type: str more...
    • vimeo Enable/disable vimeo video source. type: str choices: [disable, enable] more...
    • vimeo_restrict (Alias name: vimeo-restrict) Set vimeo-restrict (7 = dont show mature content, 134 = dont show unrated and mature content). type: str more...
    • youtube Enable/disable youtube video source. type: str choices: [disable, enable] more...
    • youtube_channel_filter (Alias name: youtube-channel-filter) Set youtube channel filter. type: str more...
    • youtube_restrict (Alias name: youtube-restrict) Set youtube-restrict mode. type: str choices: [strict, none, moderate] more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
    • default_action (Alias name: default-action) Video filter default action. type: str choices: [block, monitor, allow] more...
    • log Enable/disable logging. type: str choices: [disable, enable] more...
    • filters type: list more...
      • action Video filter action. type: str choices: [block, monitor, allow] more...
      • category Fortiguard category id. type: str more...
      • channel Channel id. type: str more...
      • comment Comment. type: str more...
      • id Id. type: int more...
      • keyword Video filter keyword id. type: str more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
      • type Filter type. type: str choices: [category, channel, title, description] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure VideoFilter profile.
      fortinet.fortimanager.fmgr_videofilter_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        videofilter_profile:
          comment: <string>
          dailymotion: <value in [disable, enable]>
          fortiguard_category:
            filters:
              -
                action: <value in [block, bypass, monitor, ...]>
                category_id: <integer>
                id: <integer>
                log: <value in [disable, enable]>
          name: <string>
          vimeo: <value in [disable, enable]>
          vimeo_restrict: <string>
          youtube: <value in [disable, enable]>
          youtube_channel_filter: <string>
          youtube_restrict: <value in [strict, none, moderate]>
          replacemsg_group: <string>
          default_action: <value in [block, monitor, allow]>
          log: <value in [disable, enable]>
          filters:
            -
              action: <value in [block, monitor, allow]>
              category: <string>
              channel: <string>
              comment: <string>
              id: <integer>
              keyword: <string>
              log: <value in [disable, enable]>
              type: <value in [category, channel, title, ...]>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)