Skip to content

Latest commit

 

History

History
295 lines (251 loc) · 12.9 KB

fortios_dlp_data_type.rst

File metadata and controls

295 lines (251 loc) · 12.9 KB
Raw
source:fortios_dlp_data_type.py
orphan:

fortios_dlp_data_type -- Configure predefined data type used by DLP blocking in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Tips

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

FortiOS Version Compatibility


Supported Version Ranges
fortios_dlp_data_type v7.2.0 -> latest

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_data_type - Configure predefined data type used by DLP blocking. type: dict more...
    Supported Version Ranges
    dlp_data_type v7.2.0 -> latest
    • comment - Optional comments. type: str more...
      Supported Version Ranges
      comment v7.2.0 -> latest
    • look_ahead - Number of characters to obtain in advance for verification (1 - 255). type: int more...
      Supported Version Ranges
      look_ahead v7.2.0 -> latest
    • look_back - Number of characters required to save for verification (1 - 255). type: int more...
      Supported Version Ranges
      look_back v7.2.0 -> latest
    • match_around - Dictionary to check whether it has a match around (Only support match-any and basic types, no repeat supported). Source dlp.dictionary .name. type: str more...
      Supported Version Ranges
      match_around v7.4.0 -> latest
    • name - Name of table containing the data type. type: str required: true more...
      Supported Version Ranges
      name v7.2.0 -> latest
    • pattern - Regular expression pattern string without look around. type: str more...
      Supported Version Ranges
      pattern v7.2.0 -> latest
    • transform - Template to transform user input to a pattern using capture group from "pattern". type: str more...
      Supported Version Ranges
      transform v7.2.0 -> latest
    • verify - Regular expression pattern string used to verify the data type. type: str more...
      Supported Version Ranges
      verify v7.2.0 -> latest
    • verify_transformed_pattern - Enable/disable verification for transformed pattern. type: str choices: enable, disable more...
      Supported Version Ranges
      verify_transformed_pattern v7.2.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure predefined data type used by DLP blocking.
  fortinet.fortios.fortios_dlp_data_type:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_data_type:
          comment: "Optional comments."
          look_ahead: "1"
          look_back: "1"
          match_around: "<your_own_value> (source dlp.dictionary.name)"
          name: "default_name_7"
          pattern: "<your_own_value>"
          transform: "<your_own_value>"
          verify: "<your_own_value>"
          verify_transformed_pattern: "enable"

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.