Configuration Reference Home
OpenDS - Monitor Backend

Monitor Backend

The Monitor Backend allows clients to access the information made available by Directory Server monitor providers.

Parent Component

The Monitor Backend component inherits from the Backend




This page describes the Monitor Backend:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ backend-id ↓ java-class
↓ base-dn
↓ enabled
↓ writability-mode

Basic Properties

backend-id

Description
Specifies a name to identify the associated backend. 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 Property
No
Read-only
Yes

base-dn

Description
Specifies the base DN(s) for the data that the backend handles. 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 Property
No
Read-only
No

enabled

Description
Indicates whether the backend is enabled in the server. 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 Property
No
Read-only
No

writability-mode

Description
Specifies the behavior that the backend should use when processing write operations.
Default Value
disabled
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 Property
No
Read-only
No


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the backend implementation.
Default Value
org.opends.server.backends.MonitorBackend
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.Backend
Multi-valued
No
Required
Yes
Admin Action Required
The Monitor Backend must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=Backends,cn=config
objectclass name
ds-cfg-monitor-backend
objectclass superior
ds-cfg-backend

Property
LDAP attribute
backend-id
ds-cfg-backend-id
base-dn
ds-cfg-base-dn
enabled
ds-cfg-enabled
java-class
ds-cfg-java-class
writability-mode
ds-cfg-writability-mode