Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
The Root DSE Backend contains the Identity Data Store root DSE.
This is a special meta-backend that dynamically generates the root DSE entry for base-level searches and simply redirects to other backends for operations in other scopes.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ subordinate-base-dn | ↓ use-legacy-vendor-version |
| ↓ additional-supported-control-oid | |
| ↓ show-all-attributes |
| Description | Specifies the set of base DNs used for singleLevel, wholeSubtree, and subordinateSubtree searches based at the root DSE. |
| Default Value | The set of all user-defined suffixes is used. |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
additional-supported-control-oid
| Description | Specifies an additional OID that should appear in the list of supportedControl values in the server's root DSE. This may be used to satisfy some applications which expect specific OIDs to appear in the root DSE. For example, even though the supportedControl attribute is supposed to only include request controls, some applications may not operate properly unless certain response control OIDs are present. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether all attributes in the root DSE are to be treated like user attributes (and therefore returned to clients by default) regardless of the Identity Data Store schema configuration. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
use-legacy-vendor-version (Advanced Property)
| Description | Indicates whether the Identity Data Store should expose the legacy value of the server's vendorVersion attribute in the root DSE to avoid affecting clients that depend on this older value. UnboundID has renamed this product from Directory Server to Identity Data Store. To maintain backwards compatibility with clients that depend on the vendorVersion attribute of the root DSE, this property is set to true by default, which will retain the legacy value of "UnboundID Directory Server 4.5.1.12". UnboundID will likely change the default for this property to false in the future so that the vendorVersion will align with the official product name: "UnboundID Identity Data Store 4.5.1.12". During this transition period, we recommend updating clients to accept either vendorVersion value. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To view the Root DSE Backend configuration:
dsconfig get-root-dse-backend-prop
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the Root DSE Backend configuration:
dsconfig set-root-dse-backend-prop
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...