fortinet.fortimanager.fmgr_dlp_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 DLP profiles.
      fortinet.fortimanager.fmgr_dlp_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]>
        dlp_profile:
          comment: <string>
          dlp_log: <value in [disable, enable]>
          extended_log: <value in [disable, enable]>
          feature_set: <value in [flow, proxy]>
          full_archive_proto:
            - smtp
            - pop3
            - imap
            - http-post
            - http-get
            - ftp
            - nntp
            - mapi
            - ssh
            - cifs
          nac_quar_log: <value in [disable, enable]>
          name: <string>
          replacemsg_group: <string>
          rule:
            -
              action: <value in [log-only, block, quarantine-ip, ...]>
              archive: <value in [disable, enable]>
              expiry: <string>
              file_size: <integer>
              file_type: <string>
              filter_by: <value in [fingerprint, sensor, encrypted, ...]>
              id: <integer>
              label: <string>
              match_percentage: <integer>
              name: <string>
              proto:
                - smtp
                - pop3
                - imap
                - http-post
                - http-get
                - ftp
                - nntp
                - mapi
                - ssh
                - cifs
              sensitivity: <list or string>
              sensor: <list or string>
              severity: <value in [info, low, medium, ...]>
              type: <value in [file, message]>
          summary_proto:
            - smtp
            - pop3
            - imap
            - http-post
            - http-get
            - ftp
            - nntp
            - mapi
            - ssh
            - cifs

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

dlp_profile:
    description: The top level parameters set.
    required: false
    suboptions:
      comment:
        description: Comment.
        type: str
      dlp-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dlp_log. Enable/disable DLP logging.
        type: str
      extended-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to extended_log. Enable/disable extended
          logging for data leak prevention.
        type: str
      feature-set:
        choices:
        - flow
        - proxy
        description: Deprecated, please rename it to feature_set. Flow/proxy feature set.
        type: str
      full-archive-proto:
        choices:
        - smtp
        - pop3
        - imap
        - http-post
        - http-get
        - ftp
        - nntp
        - mapi
        - ssh
        - cifs
        description: Deprecated, please rename it to full_archive_proto.
        elements: str
        type: list
      nac-quar-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to nac_quar_log. Enable/disable NAC
          quarantine logging.
        type: str
      name:
        description: Name of the DLP profile.
        required: true
        type: str
      replacemsg-group:
        description: Deprecated, please rename it to replacemsg_group. Replacement message
          group used by this DLP profile.
        type: str
      rule:
        description: No description.
        elements: dict
        suboptions:
          action:
            choices:
            - log-only
            - block
            - quarantine-ip
            - allow
            description: Action to take with content that this DLP profile matches.
            type: str
          archive:
            choices:
            - disable
            - enable
            description: Enable/disable DLP archiving.
            type: str
          expiry:
            description: Quarantine duration in days, hours, minutes
            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:
            - fingerprint
            - sensor
            - encrypted
            - none
            - mip
            description: Deprecated, please rename it to filter_by. Select the type of
              content to match.
            type: str
          id:
            description: ID.
            type: int
          label:
            description: MIP label dictionary.
            type: str
          match-percentage:
            description: Deprecated, please rename it to match_percentage. Percentage
              of fingerprints in the fingerprint databases designat...
            type: int
          name:
            description: Filter name.
            type: str
          proto:
            choices:
            - smtp
            - pop3
            - imap
            - http-post
            - http-get
            - ftp
            - nntp
            - mapi
            - ssh
            - cifs
            description: No description.
            elements: str
            type: list
          sensitivity:
            description: (list) No description.
            type: raw
          sensor:
            description: (list) No description.
            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: list
      summary-proto:
        choices:
        - smtp
        - pop3
        - imap
        - http-post
        - http-get
        - ftp
        - nntp
        - mapi
        - ssh
        - cifs
        description: Deprecated, please rename it to summary_proto.
        elements: str
        type: list
    type: dict

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

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