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 Subtree Accessibility Extended Operation Handler may be used to perform operations which deal with subtree accessibility, including making subtrees read-only or hidden, restoring normal subtree accessibility, and retrieving information about subtrees with accessibility restrictions.
If a subtree is made read-only, then attempts to process add, delete, modify, modify DN, and optionally bind operations targeting entries in that subtree will be rejected. If a subtree is made hidden, then attempts to process any operation targeting entries in that subtree will be rejected, and search operations matching entries in that subtree will not be returned to the client.
If a subtree is made read-only or hidden, then one user (specified in the set subtree accessibility request) will be allowed to bypass the restrictions put in place.
↓Parent Component
↓Properties
↓dsconfig Usage
The Subtree Accessibility Extended Operation Handler component inherits from the Extended Operation Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled |
| Description | A description for this Extended Operation Handler |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server). |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Extended Operation Handlers:
dsconfig list-extended-operation-handlers
[--property {propertyName}] ...
To view the configuration for an existing Extended Operation Handler:
dsconfig get-extended-operation-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Extended Operation Handler:
dsconfig set-extended-operation-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Subtree Accessibility Extended Operation Handler:
dsconfig create-extended-operation-handler
--handler-name {name}
--type subtree-accessibility
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Extended Operation Handler:
dsconfig delete-extended-operation-handler
--handler-name {name}