security_dlp_sensors - DLP Sensor Resource

Added in version 1.0.0.

Synopsis

DLP Sensor Resource.

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

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
    • entry_matches_to_trigger_sensor type: strchoices: ['all', 'any']
    • sensor_dictionaries type: listelements: dict
      • dictionary_id type: int
      • dictionary type: dict
        • primary_key type: str
        • datasource type: str
      • dictionary_matches_to_consider_risk type: int
      • status type: strchoices: ['disable', 'enable']

Examples

- name: Security DLP Sensors
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "asbsensors"
  tasks:
    - name: Create/Update Security DLP Sensors
      fortinet.fortisase.security_dlp_sensors:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          entry_matches_to_trigger_sensor: "all"
          sensor_dictionaries:
            - dictionary_id: 1
              dictionary:
                primary_key: "example_dlp_dictionary"
                datasource: "security/dlp-dictionaries"
              dictionary_matches_to_consider_risk: 255
              status: "enable"
    - name: Delete Security DLP Sensors
      fortinet.fortisase.security_dlp_sensors:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

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

Authors

  • Xinwei Du (@dux-fortinet)