security_dlp_file_patterns - DLP File Pattern Resource

Added in version 1.0.0.

Synopsis

DLP File Pattern Resource.

Use API “/resource-api/v2/security/dlp-file-patterns”.

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
  • tag type: str
  • entries type: listelements: dict
    • pattern type: str
    • filter_type type: strchoices: ['pattern', 'type']
    • file_type type: strchoices: ['.net', '7z', 'activemime', 'arj', 'aspack', 'avi', 'base64', 'bat', 'binhex', 'bmp', 'bzip', 'bzip2', 'cab', 'chm', 'class', 'cod', 'crx', 'dmg', 'elf', 'exe', 'flac', 'fsg', 'gif', 'gzip', 'hibun', 'hlp', 'hta', 'html', 'iso', 'jad', 'javascript', 'jpeg', 'lzh', 'mach-o', 'mime', 'mov', 'mp3', 'mpeg', 'msi', 'msoffice', 'msofficex', 'pdf', 'petite', 'png', 'rar', 'rm', 'sis', 'tar', 'tiff', 'torrent', 'unknown', 'upx', 'uue', 'wav', 'wma', 'xar', 'xz', 'zip']

Examples

- name: Security DLP File Patterns
  hosts: fortisase
  gather_facts: false
  vars:
    dlp_file_pattern_name: "dlp_file_patterns_example"
  tasks:
    # The primary_key is a digital id, it is "result.response.primaryKey"
    # Please use the primaryKey in the result to update/delete the target resource
    - name: Create Security DLP File Patterns
      fortinet.fortisase.security_dlp_file_patterns:
        state: present
        params:
          primary_key: "Placeholder, not in use in create"
          tag: "{{ dlp_file_pattern_name }}"
          entries:
            - pattern: "string"
              filter_type: "type"
              file_type: "7z"
      register: result
    - name: Update Security DLP File Patterns
      fortinet.fortisase.security_dlp_file_patterns:
        state: present
        params:
          primary_key: "{{ result.response.primaryKey }}"
          tag: "{{ dlp_file_pattern_name }}"
          entries:
            - pattern: "string_modified"
              filter_type: "type"
              file_type: "7z"
    - name: Delete Security DLP File Patterns
      fortinet.fortisase.security_dlp_file_patterns:
        state: absent
        params:
          primary_key: "{{ result.response.primaryKey }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)