Monitor Backend
The Monitor Backend allows clients to access the information made available by directory server monitor providers.
Parent
The Monitor Backend object inherits from Local Backend.
Monitor Backend properties
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 |
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 |
writability-mode
Synopsis |
Specifies the behavior that the backend should use when processing write operations. |
Default value |
disabled |
Allowed values |
|
Multi-valued |
No |
Required |
Yes |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
Advanced properties
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.MonitorBackend |
Allowed values |
A Java class that extends or implements:
|
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 |