Directory Proxy Server Documentation Index
Configuration Reference Home

Global Referential Integrity Plugin

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.

This Global Referential Integrity Plugin provides a mechanism for intercepting delete and modify DN operations and updating any references to the target entry. For a delete operation, any references to the target entry will be removed. For modify DN operations, any references to the target entry will be updated to reflect the new DN of the entry.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Global Referential Integrity Plugin component inherits from the Plugin

Relations from This Component

The following components have a direct aggregation relation from Global Referential Integrity Plugins:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ attribute-type
↓ subtree-view

Basic Properties

description

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

enabled

Description
Indicates whether the plug-in is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

attribute-type

Description
The attribute type(s) for which to maintain referential integrity. The attribute must have a distinguished name or a name and optional UID syntax and must be indexed for equality searches in all subtree views for which referential integrity is to be maintained.
Default Value
None
Allowed Values
The name or OID of an attribute type defined in the server schema.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

subtree-view

Description
The subtree view(s) for which to maintain referential integrity.
Default Value
None
Allowed Values
The DN of any Subtree View.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Plugins:

dsconfig list-plugins
     [--property {propertyName}] ...

To view the configuration for an existing Plugin:

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

To update the configuration for an existing Plugin:

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

To create a new Global Referential Integrity Plugin:

dsconfig create-plugin
     --plugin-name {name}
     --type global-referential-integrity
     --set enabled:{propertyValue}
     --set attribute-type:{propertyValue}
     --set subtree-view:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Plugin:

dsconfig delete-plugin
     --plugin-name {name}