security_dlp_fingerprint_databases - DLP Fingerprint Database Resource

Added in version 1.0.0.

Synopsis

DLP Fingerprint Database Resource.

Use API “/resource-api/v2/security/dlp-fingerprint-databases”.

Requirements

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

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means create or update the resource, "absent" means delete the resource.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • primary_key [Required]type: str
    • server type: str
    • sensitivity type: strchoices: ['Critical', 'Private', 'Warning']
    • include_subdirectories type: strchoices: ['disable', 'enable']
    • server_directory type: str
    • file_pattern type: str
    • schedule type: dict
      • period type: strchoices: ['daily', 'monthly', 'weekly']
      • sync_hour type: int
      • sync_minute type: int
      • weekday type: strchoices: ['friday', 'monday', 'saturday', 'sunday', 'thursday', 'tuesday', 'wednesday']
      • sync_day_of_the_month type: int
    • remove_deleted_file_fingerprints type: strchoices: ['disable', 'enable']
    • keep_modified type: strchoices: ['disable', 'enable']
    • scan_on_creation type: strchoices: ['disable', 'enable']
    • authentication type: dict
      • username type: str
      • password type: str

Examples

- name: Security DLP Fingerprint Databases
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "asbdatabases"
  tasks:
    - name: Create/Update Security DLP Fingerprint Databases
      fortinet.fortisase.security_dlp_fingerprint_databases:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          server: "example-server.com"
          sensitivity: "Warning"
          include_subdirectories: "enable"
          server_directory: "/path/to/directory/"
          file_pattern: "*.txt"
          schedule:
            period: "daily"
            sync_hour: 2
            sync_minute: 0
          remove_deleted_file_fingerprints: "enable"
          keep_modified: "enable"
          scan_on_creation: "enable"
          authentication:
            username: "admin"
            password: "password123"
    - name: Delete Security DLP Fingerprint Databases
      fortinet.fortisase.security_dlp_fingerprint_databases:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)