LDIF Backend

The LDIF Backend provides a mechanism for interacting with data stored in an LDIF file.

All basic LDAP operations are supported in the LDIF backend although it has minimal support for custom controls.

Parent

The LDIF Backend object inherits from Local Backend.

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

Advanced Properties

backend-id

Synopsis	Specifies a name to identify the associated backend.
Description	The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	Yes

base-dn

Synopsis	Specifies the base DN(s) for the data that the backend handles.
Description	A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.
Default Value	None
Allowed Values	A valid DN.
Multi-valued	Yes
Required	Yes
Admin Action Required	None No administrative action is required by default although some action may be required on a per-backend basis before the new base DN may be used.
Advanced	No
Read-Only	No

enabled

Synopsis	Indicates whether the backend is enabled in the server.
Description	If a backend is not enabled, then its contents are not accessible when processing operations.
Default Value	None
Allowed Values	true false
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

is-private-backend

Synopsis	Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information.
Default Value	false
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The object must be disabled and re-enabled for changes to take effect.
Advanced	No
Read-Only	No

ldif-file

Synopsis	Specifies the path to the LDIF file containing the data for this backend.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	The object must be disabled and re-enabled for changes to take effect.
Advanced	No
Read-Only	No

writability-mode

Synopsis	Specifies the behavior that the backend should use when processing write operations.
Default Value	enabled
Allowed Values	disabled: Causes all write attempts to fail. enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled). internal-only: Causes external write attempts to fail but allows writes by replication and internal operations.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

Use the --advanced option to access advanced properties.

java-class

Synopsis	Specifies the fully-qualified name of the Java class that provides the backend implementation.
Default Value	org.opends.server.backends.LDIFBackend
Allowed Values	A Java class that extends or implements: org.opends.server.api.Backend
Multi-valued	No
Required	Yes
Admin Action Required	The object must be disabled and re-enabled for changes to take effect.
Advanced	Yes
Read-Only	No