fortinet.fortimanager.fmgr_videofilter_profile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

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

Usage examples

Scanned by Steampunk Spotter

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

- 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, ...]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

videofilter_profile:
    description: The top level parameters set.
    required: false
    suboptions:
      comment:
        description: Comment.
        type: str
      dailymotion:
        choices:
        - disable
        - enable
        description: Enable/disable Dailymotion video source.
        type: str
      default-action:
        choices:
        - block
        - monitor
        - allow
        description: Deprecated, please rename it to default_action. Video filter default
          action.
        type: str
      filters:
        description: No description.
        elements: dict
        suboptions:
          action:
            choices:
            - block
            - monitor
            - allow
            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.
            type: int
          keyword:
            description: Video filter keyword ID.
            type: str
          log:
            choices:
            - disable
            - enable
            description: Enable/disable logging.
            type: str
          type:
            choices:
            - category
            - channel
            - title
            - description
            description: Filter type.
            type: str
        type: list
      fortiguard-category:
        description: Deprecated, please rename it to fortiguard_category.
        suboptions:
          filters:
            description: Filters.
            elements: dict
            suboptions:
              action:
                choices:
                - block
                - bypass
                - monitor
                - allow
                description: VideoFilter action.
                type: str
              category-id:
                description: Deprecated, please rename it to category_id. Category ID.
                type: int
              id:
                description: ID.
                type: int
              log:
                choices:
                - disable
                - enable
                description: Enable/disable logging.
                type: str
            type: list
        type: dict
      log:
        choices:
        - disable
        - enable
        description: Enable/disable logging.
        type: str
      name:
        description: Name.
        required: true
        type: str
      replacemsg-group:
        description: Deprecated, please rename it to replacemsg_group. Replacement message
          group.
        type: str
      vimeo:
        choices:
        - disable
        - enable
        description: Enable/disable Vimeo video source.
        type: str
      vimeo-restrict:
        description: Deprecated, please rename it to vimeo_restrict. Set Vimeo-restrict
        type: str
      youtube:
        choices:
        - disable
        - enable
        description: Enable/disable YouTube video source.
        type: str
      youtube-channel-filter:
        description: Deprecated, please rename it to youtube_channel_filter. Set YouTube
          channel filter.
        type: str
      youtube-restrict:
        choices:
        - strict
        - none
        - moderate
        description: Deprecated, please rename it to youtube_restrict. Set YouTube-restrict
          mode.
        type: str
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

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