fortinet.fortimanager.fmgr_dlp_sensor_filter (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: Set up DLP filters for this sensor.
      fortinet.fortimanager.fmgr_dlp_sensor_filter:
        # 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>
        sensor: <your own value>
        state: present # <value in [present, absent]>
        dlp_sensor_filter:
          action: <value in [log-only, block, exempt, ...]>
          archive: <value in [disable, enable, summary-only]>
          company_identifier: <string>
          expiry: <string>
          file_size: <integer>
          file_type: <string>
          filter_by: <value in [credit-card, ssn, regexp, ...]>
          fp_sensitivity: <list or string>
          id: <integer>
          match_percentage: <integer>
          name: <string>
          proto:
            - imap
            - smtp
            - pop3
            - ftp
            - nntp
            - mm1
            - mm3
            - mm4
            - mm7
            - mapi
            - aim
            - icq
            - msn
            - yahoo
            - http-get
            - http-post
            - ssh
            - cifs
          regexp: <string>
          severity: <value in [info, low, medium, ...]>
          type: <value in [file, message]>
          sensitivity: <list or string>

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

sensor:
    description: The parameter (sensor) in requested url.
    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

dlp_sensor_filter:
    description: The top level parameters set.
    required: false
    suboptions:
      action:
        choices:
        - log-only
        - block
        - exempt
        - ban
        - ban-sender
        - quarantine-ip
        - quarantine-port
        - none
        - allow
        description: Action to take with content that this DLP sensor matches.
        type: str
      archive:
        choices:
        - disable
        - enable
        - summary-only
        description: Enable/disable DLP archiving.
        type: str
      company-identifier:
        description: Deprecated, please rename it to company_identifier. Enter a company
          identifier watermark to match.
        type: str
      expiry:
        description: Quarantine duration in days, hours, minutes format
        type: str
      file-size:
        description: Deprecated, please rename it to file_size. Match files this size
          or larger
        type: int
      file-type:
        description: Deprecated, please rename it to file_type. Select the number of a
          DLP file pattern table to match.
        type: str
      filter-by:
        choices:
        - credit-card
        - ssn
        - regexp
        - file-type
        - file-size
        - fingerprint
        - watermark
        - encrypted
        - file-type-and-size
        description: Deprecated, please rename it to filter_by. Select the type of content
          to match.
        type: str
      fp-sensitivity:
        description: (list or str) Deprecated, please rename it to fp_sensitivity. Select
          a DLP file pattern sensitivity to match.
        type: raw
      id:
        description: ID.
        required: true
        type: int
      match-percentage:
        description: Deprecated, please rename it to match_percentage. Percentage of fingerprints
          in the fingerprint databases designated with ...
        type: int
      name:
        description: Filter name.
        type: str
      proto:
        choices:
        - imap
        - smtp
        - pop3
        - ftp
        - nntp
        - mm1
        - mm3
        - mm4
        - mm7
        - mapi
        - aim
        - icq
        - msn
        - yahoo
        - http-get
        - http-post
        - ssh
        - cifs
        description: No description.
        elements: str
        type: list
      regexp:
        description: Enter a regular expression to match
        type: str
      sensitivity:
        description: (list or str) Select a DLP file pattern sensitivity to match.
        type: raw
      severity:
        choices:
        - info
        - low
        - medium
        - high
        - critical
        description: Select the severity or threat level that matches this filter.
        type: str
      type:
        choices:
        - file
        - message
        description: Select whether to check the content of messages
        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