Directory Proxy Server Documentation Index
Configuration Reference Home

Subtree View

A Subtree View is used to define the request processor that should be used to process operations for a specified portion of the DIT.

Some Subtree Views may be automatically inferred by the server (e.g., those used to process operations in backends), while others (e.g., those used to forward requests to other servers) may need to be explicitly configured.

Relations from This Component
Relations to This Component
Properties
dsconfig Usage

Relations from This Component

The following components have a direct aggregation relation from Subtree Views:

Relations to This Component

The following components have a direct aggregation relation to Subtree Views:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ base-dn
↓ request-processor

Basic Properties

description

Description
A description for this Subtree View
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

base-dn (Read-Only)

Description
The DN of the entry that is at the base of the subtree for this Subtree View.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

request-processor (Read-Only)

Description
The request processor that will be used to process requests in portions of the DIT managed by this Subtree View.
Default Value
None
Allowed Values
The DN of any Request Processor. The request processor for this Subtree View must be enabled.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Subtree Views:

dsconfig list-subtree-views
     [--property {propertyName}] ...

To view the configuration for an existing Subtree View:

dsconfig get-subtree-view-prop
     --view-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Subtree View:

dsconfig set-subtree-view-prop
     --view-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Subtree View:

dsconfig create-subtree-view
     --view-name {name}
     --set base-dn:{propertyValue}
     --set request-processor:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Subtree View:

dsconfig delete-subtree-view
     --view-name {name}