Generated Documentation for Snapshot Changelog

In a nutshell, this changelog provides the full entry before and after change.

Allowed Arguments

Argument Name: base-dn
Description: The base DN where the enhanced changelog should be written (Default: cn=snapshot-changelog)
Data Type: LDAP Distinguished Name
Is Required: true
Maximum Occurrences: 1

Argument Name: include-attribute
Description: zero or more attributes to explicitly whitelist. All other attributes will be removed from the entries committed in this changelog.
Data Type: String
Is Required: false
Maximum Occurrences: 2147483647

Argument Name: exclude-attribute
Description: zero or more attributes to explicitly blacklist. These attributes will be removed from the entries committed to this changelog
Data Type: String
Is Required: false
Maximum Occurrences: 2147483647

Argument Name: do-not-log-if-modify-only-attributes
Description: zero or more special attributes. Special attributes are attributes that may be included in the changelog only if other attributes of interest are present. This is only evaluated for modify operations.
Data Type: String
Is Required: false
Maximum Occurrences: 2147483647

Argument Name: filter-entry-before
Description: zero or more filters that the entry prior to the modification(s) must match for the change to be committed to the changelog. This is not evaluated for add operations.
Data Type: LDAP Search Filter
Is Required: false
Maximum Occurrences: 2147483647

Argument Name: filter-entry-after
Description: zero or more filters that the entry after the modification(s) must match for the change to be committed to the changelog. This is not evaluated for delete operations.
Data Type: LDAP Search Filter
Is Required: false
Maximum Occurrences: 2147483647

Argument Name: failed-persistence-folder
Description: The path to write snapshot entries in case there is an issue writing to the changelog
Data Type: File Path
Is Required: false
Maximum Occurrences: 1

Argument Name: failed-persistence-date-format
Description: The Date format for the persistence failed file name suffix
Data Type: String
Is Required: false
Maximum Occurrences: 1

Argument Name: failed-persistence-use-formatted-date
Description: By default the failed persistence file will be appended with a suffix equal to the changelog number. This option allows to override this behaviour to append a formatted timestamp instead
Data Type: Boolean
Is Required: false
Maximum Occurrences: 1