Search Shutdown 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.

The Search Shutdown Plugin may be used to invoke an internal search within the Directory Server at shutdown and write the results to a specified file in LDIF form.

Parent Component Properties dsconfig Usage

Parent Component

The Search Shutdown Plugin component inherits from the Plugin

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled
 base-dn
 scope
 filter
 include-attribute
 output-file
 previous-file-extension

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

base-dn

Description
The base DN to use for the search.
Default Value
The search will be based at the server root DSE.
Allowed Values
A valid DN.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

scope

Description
The scope to use for the search.
Default Value
None
Allowed Values
base - Indicates that only the entry targeted by the base DN should be examined.

one - Indicates that only entries that are immediate children of the entry targeted by the base DN (but not the base entry itself) should be examined.

sub - Indicates that the entry targeted by the base DN and all of its subordinates (to any depth) should be examined.

subordinate-subtree - Indicates that all of the subordinates (to any depth) of the entry targeted by the base DN (but not the base entry itself) should be examined.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

filter

Description
The filter to use for the search.
Default Value
None
Allowed Values
A valid LDAP search filter
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

include-attribute

Description
The name of an attribute that should be included in the results. This may include any token which is allowed as a requested attribute in search requests, including the name of an attribute, an asterisk (to indicate all user attributes), a plus sign (to indicate all operational attributes), an object class name preceded with an at symbol (to indicate all attributes associated with that object class), an attribute name preceded by a caret (to indicate that attribute should be excluded), or an object class name preceded by a caret and an at symbol (to indicate that all attributes associated with that object class should be excluded).
Default Value
All user attributes will be included.
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

output-file

Description
The path of an LDIF file that should be created with the results of the search.
Default Value
None
Allowed Values
A filesystem path
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

previous-file-extension

Description
An extension that should be appended to the name of an existing output file rather than deleting it. If a file already exists with the full previous file name, then it will be deleted before the current file is renamed to become the previous file.
Default Value
No previous file will be maintained.
Allowed Values
The extension to append to the file created during the previous shutdown. Only ASCII letters, numbers, period, dash, and underscore characters may be used.
Multi-Valued
No
Required
No
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 Search Shutdown Plugin:

dsconfig create-plugin
     --plugin-name {name}
     --type search-shutdown
     --set enabled:{propertyValue}
     --set scope:{propertyValue}
     --set filter:{propertyValue}
     --set output-file:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Plugin:

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