Skip to content

Latest commit

 

History

History
479 lines (435 loc) · 21.7 KB

fortios_dlp_fp_doc_source.rst

File metadata and controls

479 lines (435 loc) · 21.7 KB
Raw
source:fortios_dlp_fp_doc_source.py
orphan:

fortios_dlp_fp_doc_source -- Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints 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 fp_doc_source 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_fp_doc_source v6.0.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_fp_doc_source - Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. type: dict more...
    Supported Version Ranges
    dlp_fp_doc_source v6.0.0 -> latest
    • date - Day of the month on which to scan the server (1 - 31). type: int more...
      Supported Version Ranges
      date v6.0.0 -> latest
    • file_path - Path on the server to the fingerprint files (max 119 characters). type: str more...
      Supported Version Ranges
      file_path v6.0.0 -> latest
    • file_pattern - Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. type: str more...
      Supported Version Ranges
      file_pattern v6.0.0 -> latest
    • keep_modified - Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. type: str choices: enable, disable more...
      Supported Version Ranges
      keep_modified v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • name - Name of the DLP fingerprint database. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • password - Password required to log into the file server. type: str more...
      Supported Version Ranges
      password v6.0.0 -> latest
    • period - Frequency for which the FortiGate checks the server for new or changed files. type: str choices: none, daily, weekly, monthly more...
      Supported Version Ranges
      period v6.0.0 -> latest
      [none] v6.0.0 -> latest
      [daily] v6.0.0 -> latest
      [weekly] v6.0.0 -> latest
      [monthly] v6.0.0 -> latest
    • remove_deleted - Enable to keep the fingerprint database up to date when a file is deleted from the server. type: str choices: enable, disable more...
      Supported Version Ranges
      remove_deleted v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • scan_on_creation - Enable to keep the fingerprint database up to date when a file is added or changed on the server. type: str choices: enable, disable more...
      Supported Version Ranges
      scan_on_creation v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • scan_subdirectories - Enable/disable scanning subdirectories to find files to create fingerprints from. type: str choices: enable, disable more...
      Supported Version Ranges
      scan_subdirectories v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • sensitivity - Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using sensitivity. Source dlp .sensitivity.name. type: str more...
      Supported Version Ranges
      sensitivity v6.0.0 -> latest
    • server - IPv4 or IPv6 address of the server. type: str more...
      Supported Version Ranges
      server v6.0.0 -> latest
    • server_type - Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. type: str choices: samba more...
      Supported Version Ranges
      server_type v6.0.0 -> latest
      [samba] v6.0.0 -> latest
    • tod_hour - Hour of the day on which to scan the server (0 - 23). type: int more...
      Supported Version Ranges
      tod_hour v6.0.0 -> latest
    • tod_min - Minute of the hour on which to scan the server (0 - 59). type: int more...
      Supported Version Ranges
      tod_min v6.0.0 -> latest
    • username - User name required to log into the file server. type: str more...
      Supported Version Ranges
      username v6.0.0 -> latest
    • vdom - Select the VDOM that can communicate with the file server. type: str choices: mgmt, current more...
      Supported Version Ranges
      vdom v6.0.0 -> latest
      [mgmt] v6.0.0 -> latest
      [current] v6.0.0 -> latest
    • weekday - Day of the week on which to scan the server. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday more...
      Supported Version Ranges
      weekday v6.0.0 -> latest
      [sunday] v6.0.0 -> latest
      [monday] v6.0.0 -> latest
      [tuesday] v6.0.0 -> latest
      [wednesday] v6.0.0 -> latest
      [thursday] v6.0.0 -> latest
      [friday] v6.0.0 -> latest
      [saturday] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
  fortinet.fortios.fortios_dlp_fp_doc_source:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_fp_doc_source:
          date: "1"
          file_path: "<your_own_value>"
          file_pattern: "<your_own_value>"
          keep_modified: "enable"
          name: "default_name_7"
          password: "<your_own_value>"
          period: "none"
          remove_deleted: "enable"
          scan_on_creation: "enable"
          scan_subdirectories: "enable"
          sensitivity: "<your_own_value> (source dlp.sensitivity.name)"
          server: "192.168.100.40"
          server_type: "samba"
          tod_hour: "1"
          tod_min: "0"
          username: "<your_own_value>"
          vdom: "mgmt"
          weekday: "sunday"

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.