This is an abstract object type that cannot be instantiated.
Backends are responsible for providing access to the underlying data presented by the server.
The data may be stored locally in an embedded database, remotely in an external system, or generated on the fly (for example, calculated from other information that is available).
The following Backends are available:
These Backends inherit the properties described below.
Use the --advanced
option to access advanced properties.
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 |
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 |
Synopsis | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
Default Value | None |
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 | No |
Read-Only | No |