security_dlp_dictionaries - DLP Dictionary Resource

Added in version 1.0.0.

Synopsis

DLP Dictionary Resource.

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

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
  • dictionary_type type: strchoices: ['mip-label', 'sensor']
  • sensitivity_label_guid type: str
  • entries_to_evaluate type: strchoices: ['all', 'any']
  • entries type: listelements: dict
    • dlp_data_type type: dict
      • primary_key type: str
      • datasource type: str
    • status type: strchoices: ['disable', 'enable']
    • repeat type: strchoices: ['disable', 'enable']
    • pattern type: str
    • case_sensitive type: strchoices: ['disable', 'enable']

Examples

- name: Security DLP Dictionaries
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "example_dlp_dictionary"
  tasks:
    - name: Create/Update Security DLP Dictionaries
      fortinet.fortisase.security_dlp_dictionaries:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          dictionary_type: "sensor"
          entries_to_evaluate: "all"
          entries:
            - dlp_data_type:
                primary_key: "regex"
                datasource: "security/dlp-data-types"
              pattern: "string"
              status: "enable"
              repeat: "enable"
    - name: Delete Security DLP Dictionaries
      fortinet.fortisase.security_dlp_dictionaries:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)