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 support in order to understand the potential impact of that change.
The Root DSE Backend contains the Directory Server 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 Directory Server 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 server's root DSE should reflect current or legacy values for the vendorName and vendorVersion attributes. Both the name and the vendor for this product have changed over time. Some clients may look at the vendorName and vendorVersion attributes in the root DSE to tailor some aspects of their behavior to the type of director server being used, and changes to these values may adversely impact clients that depend on certain values. If this property is configured with a value of true, then the vendorName attribute will have a value of "UnboundID Corp." and the vendorVersion attribute will have a value of "UnboundID Directory Server 8.0.0.0". If this property is configured with a value of false, then the vendorName attribute will have a value of "Ping Identity Corporation" and the vendorVersion attribute will have a value of "Ping Identity Directory Server 8.0.0.0". If you desire a different vendorName or vendorVersion value than the server provides through this configuration property, you can explicitly specify the value that the server should use by directly adding the vendorName or vendorVersion attribute to the "cn=Root DSE,cn=config" entry in the server configuration. If either attribute is present in this entry, it will override the value that the server would have otherwise generated. Because they are operational attributes defined with the NO-USER-MODIFICATION constraint, this change cannot be made with the server online. The only way to make this change is to stop the server and edit the config.ldif file to add either or both of these attributes to the "cn=Root DSE,cn=config" entry with the desired values. |
| 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}] ...