fortios_dlp_profile.rst

source:	fortios_dlp_profile.py
orphan:

fortios_dlp_profile -- Configure DLP profiles in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp 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

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

• ansible>=2.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
fortios_dlp_profile	yes	yes	yes	yes	yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• dlp_profile - Configure DLP profiles. type: dict more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dlp_profile	yes	yes	yes	yes	yes

• comment - Comment. type: str more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  comment	yes	yes	yes	yes	yes

• dlp_log - Enable/disable DLP logging. type: str choices: enable, disable more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dlp_log	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes

• extended_log - Enable/disable extended logging for data leak prevention. type: str choices: enable, disable more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  extended_log	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes

• feature_set - Flow/proxy feature set. type: str choices: flow, proxy more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  feature_set	yes	yes	yes	yes	yes
  [flow]	yes	yes	yes	yes	yes
  [proxy]	yes	yes	yes	yes	yes

• full_archive_proto - Protocols to always content archive. type: list choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  full_archive_proto	yes	yes	yes	yes	yes
  [smtp]	yes	yes	yes	yes	yes
  [pop3]	yes	yes	yes	yes	yes
  [imap]	yes	yes	yes	yes	yes
  [http-get]	yes	yes	yes	yes	yes
  [http-post]	yes	yes	yes	yes	yes
  [ftp]	yes	yes	yes	yes	yes
  [nntp]	yes	yes	yes	yes	yes
  [mapi]	yes	yes	yes	yes	yes
  [ssh]	yes	yes	yes	yes	yes
  [cifs]	yes	yes	yes	yes	yes

• nac_quar_log - Enable/disable NAC quarantine logging. type: str choices: enable, disable more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  nac_quar_log	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes

• name - Name of the DLP profile. type: str required: true more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes	yes

• replacemsg_group - Replacement message group used by this DLP profile. Source system.replacemsg-group.name. type: str more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  replacemsg_group	yes	yes	yes	yes	yes

• rule - Set up DLP rules for this profile. type: list member_path: rule:id more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  rule	yes	yes	yes	yes	yes

• action - Action to take with content that this DLP profile matches. type: str choices: allow, log-only, block, quarantine-ip more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  action	yes	yes	yes	yes	yes
  [allow]	yes	yes	yes	yes	yes
  [log-only]	yes	yes	yes	yes	yes
  [block]	yes	yes	yes	yes	yes
  [quarantine-ip]	yes	yes	yes	yes	yes

• archive - Enable/disable DLP archiving. type: str choices: disable, enable more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  archive	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes

• expiry - Quarantine duration in days, hours, minutes (format = dddhhmm). type: str more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  expiry	yes	yes	yes	yes	yes

• file_size - Match files greater than or equal to this size (KB). type: int more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  file_size	yes	yes	yes	yes	yes

• file_type - Select the number of a DLP file pattern table to match. Source dlp.filepattern.id. type: int more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  file_type	yes	yes	yes	yes	yes

• filter_by - Select the type of content to match. type: str choices: sensor, mip, fingerprint, encrypted, none more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  filter_by	yes	yes	yes	yes	yes
  [sensor]	yes	yes	yes	yes	yes
  [mip]	yes	yes	yes	yes	yes
  [fingerprint]	yes	yes	yes	yes	yes
  [encrypted]	yes	yes	yes	yes	yes
  [none]	yes	yes	yes	yes	yes

• id - ID. type: int required: true more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  id	yes	yes	yes	yes	yes

• label - MIP label dictionary. Source dlp.dictionary.name. type: str more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  label	yes	yes	yes	yes	yes

• match_percentage - Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match. type: int more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  match_percentage	yes	yes	yes	yes	yes

• name - Filter name. type: str more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes	yes

• proto - Check messages or files over one or more of these protocols. type: list choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  proto	yes	yes	yes	yes	yes
  [smtp]	yes	yes	yes	yes	yes
  [pop3]	yes	yes	yes	yes	yes
  [imap]	yes	yes	yes	yes	yes
  [http-get]	yes	yes	yes	yes	yes
  [http-post]	yes	yes	yes	yes	yes
  [ftp]	yes	yes	yes	yes	yes
  [nntp]	yes	yes	yes	yes	yes
  [mapi]	yes	yes	yes	yes	yes
  [ssh]	yes	yes	yes	yes	yes
  [cifs]	yes	yes	yes	yes	yes

• sensitivity - Select a DLP file pattern sensitivity to match. type: list member_path: rule:id/sensitivity:name more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sensitivity	yes	yes	yes	yes	yes

• name - Select a DLP sensitivity. Source dlp.sensitivity.name. type: str required: true more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes	yes

• sensor - Select DLP sensors. type: list member_path: rule:id/sensor:name more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sensor	yes	yes	yes	yes	yes

• name - Address name. Source dlp.sensor.name. type: str required: true more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes	yes

• severity - Select the severity or threat level that matches this filter. type: str choices: info, low, medium, high, critical more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  severity	yes	yes	yes	yes	yes
  [info]	yes	yes	yes	yes	yes
  [low]	yes	yes	yes	yes	yes
  [medium]	yes	yes	yes	yes	yes
  [high]	yes	yes	yes	yes	yes
  [critical]	yes	yes	yes	yes	yes

• type - Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). type: str choices: file, fos_message more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  type	yes	yes	yes	yes	yes
  [file]	yes	yes	yes	yes	yes
  [fos_message]	yes	yes	yes	yes	yes

• summary_proto - Protocols to always log summary. type: list choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs more...

  	v7.2.0	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  summary_proto	yes	yes	yes	yes	yes
  [smtp]	yes	yes	yes	yes	yes
  [pop3]	yes	yes	yes	yes	yes
  [imap]	yes	yes	yes	yes	yes
  [http-get]	yes	yes	yes	yes	yes
  [http-post]	yes	yes	yes	yes	yes
  [ftp]	yes	yes	yes	yes	yes
  [nntp]	yes	yes	yes	yes	yes
  [mapi]	yes	yes	yes	yes	yes
  [ssh]	yes	yes	yes	yes	yes
  [cifs]	yes	yes	yes	yes	yes

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure DLP profiles.
    fortios_dlp_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_profile:
        comment: "Comment."
        dlp_log: "enable"
        extended_log: "enable"
        feature_set: "flow"
        full_archive_proto: "smtp"
        nac_quar_log: "enable"
        name: "default_name_9"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        rule:
         -
            action: "allow"
            archive: "disable"
            expiry: "<your_own_value>"
            file_size: "0"
            file_type: "0"
            filter_by: "sensor"
            id:  "18"
            label: "<your_own_value> (source dlp.dictionary.name)"
            match_percentage: "10"
            name: "default_name_21"
            proto: "smtp"
            sensitivity:
             -
                name: "default_name_24 (source dlp.sensitivity.name)"
            sensor:
             -
                name: "default_name_26 (source dlp.sensor.name)"
            severity: "info"
            type: "file"
        summary_proto: "smtp"

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:

• build - Build number of the fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
• name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
• path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.