Table of Contents

LDAPDeleteValve

Warning

This valve is blocking - this may hurt throughput and cause performance issues since other pipes won't be able to execute while this valve is waiting on a long-running operation in the same instance of the pipes module, for example due to a network request, disk access or similar. Try to limit the usage of blocking valves, try to ensure that they are fast to execute, and if needed, consider deploying multiple instances of the pipes module.

Note

Valve for deleting entries in an LDAP Directory.

Valve operates on the Current Item Set and will process all items surviving the common item filtering rules.

Note: Processed items will not be removed from CIS. To remove items, use RemoveItemValve.

Properties

Name Description Default value Mandatory Supports property expansion
connection_ref Id of LDAP connection to use. Must refer to a connection of type 'LDAP'. Yes No
item_id_pattern Regex pattern for item id's to perform operations on. Items with id's that doesnt match the regex will be filter out. '.*' (include all items ) No No

Example Configuration

{
    "name": "LDAPDeleteValve",
    "config": { 
        "connection_ref":"b0f2ddff-9585-47c5-9286-2bee2b731197",
        "item_id_pattern" : ".*"
    }
}

Requirements

Item set must have at least one entry.

The id of the item has to be set to the distinguished name of the object to be deleted.