init-func

DS plug-in configuration (PLG) properties

Description

Directory Server implements some key functionality as plug-ins. Plug-ins take the form of libraries loaded when the server starts, and called at different points in the processing of client application requests. When you create custom plug-ins, you must configure the server to load and use them, then restart Directory Server to load the newly configured plug-ins.

PROPERTY: argument

Characteristic	Value
Syntax	`STRING`
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	Yes

This property specifies arguments passed to the plug-in when it is loaded by Directory Server. Arguments are passed in the order you specify them. Updating the list of arguments replaces all the existing arguments previously specified when the plug-in is loaded again.

PROPERTY: depends-on-named

Characteristic	Value
Syntax	`STRING`
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	Yes

This property specifies names of plug-ins that must be available and loaded before Directory Server loads the current plug-in.

PROPERTY: depends-on-type

Characteristic	Value
Syntax	`STRING` (See the description that follows.)
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	Yes

This property specifies types of plug-ins that must be available and loaded before Directory Server loads the current plug-in. The value must be the value of a plug-in type property.

PROPERTY: feature

Characteristic	Value
Syntax	`STRING`
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the plug-in identifier from the Slapi_PluginDesc structure.

PROPERTY: init-func

Characteristic	Value
Syntax	`STRING`
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the name of function called by Directory Server to initialize the plug-in.

PROPERTY: lib-path

Characteristic	Value
Syntax	`PATH`
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the absolute file system path to the library containing plug-in.

PROPERTY: type

Characteristic	Value
Syntax	`STRING` (See the description that follows.)
Default Value	`None`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the plug-in type. The following plug-in types are supported.

ldbmentryfetchstore: Entry store and fetch plug-in
extendedop: Extended operation plug-in
passwordcheck: Password check plug-in
postoperation: Post-operation plug-in
preoperation: Pre-operation plug-in
internalpostoperation: Internal post-operation plug-in
internalpreoperation: Internal pre-operation plug-in
matchingrule: Matching rule plug-in for extensible match search filters
object: Generic plug-in type, sometimes used to register other plug-ins
passwordcheck: Strong password check plug-in
pwdstoragescheme: Password storage scheme plug-in

PROPERTY: vendor

Characteristic	Value
Syntax	`STRING`
Default Value	Vendor name in plug-in configuration
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the plug-in vendor from the Slapi_PluginDesc structure.

PROPERTY: version

Characteristic	Value
Syntax	`STRING`
Default Value	Version string in plug-in configuration
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property specifies the plug-in version from the Slapi_PluginDesc structure.

Syntax Values

Syntax values shown in lower case or partly in lower case are literal values.

Those shown in upper case are syntax types, defined as follows:

ATTR_NAME

A valid attribute type name such as cn or objectClass.

BOOLEAN

true or false.

DN

A valid distinguished name such as ou=People,dc=example,dc=com.

DURATION

A duration specified in months (M), weeks (w), days (d), hours (h), minutes (m), seconds (s), and miliseconds (ms), or some combination with multiple specifiers. For example, you can specify one week as 1w, 7d, 168h, 10080m, or 604800s. You can also specify one week as 1w0d0h0m0s.

DURATION properties typically do not each support all duration specifiers (Mwdhms). Examine the output of dsconf help-properties for the property to determine which duration specifiers are supported.

EMAIL_ADDRESS

A valid e-mail address.

HOST_NAME

An IP address or host name.

INTEGER

A positive integer value between 0 and the maximum supported integer value in the system address space. On 32-bit systems, 2147483647. On 64-bit systems, 9223372036854775807.

INTERVAL

An interval value of the form hhmm-hhmm 0123456, where the first element specifies the starting hour, the next element the finishing hour in 24-hour time format, from 0000-2359, and the second specifies days, starting with Sunday (0) to Saturday (6).

IP_RANGE

An IP address or range of address in one of the following formats:

IP address in dotted decimal form.
IP address and bits, in the form of network number/mask bits.
IP address and quad, in the form of a pair of dotted decimal quads.
All address. A catch-all for clients that are note placed into other, higher priority groups.
0.0.0.0. This address is for groups to which initial membership is not considered. For example, for groups that clients switch to after their initial bind.
IP address of the local host.

LDAP_URL

A valid LDAP URL as specified by RFC 2255 (http://www.ietf.org/rfc/rfc2255.txt).

MEMORY_SIZE

A memory size specified in gigabytes (G), megabytes (M),kilobytes (k), or bytes (b). Unlike DURATION properties, MEMORY_SIZE properties cannot combine multiple specifiers. However, MEMORY_SIZE properties allow decimal values, for example, 1.5M.

NAME

A valid cn (common name).

OCTAL_MODE

A three-digit, octal file permissions specifier. The first digit specifies permissions for the server user ID, the second for the server group ID, the last for other users. Each digit consists of a bitmask defining read (4), write (2), execute (1), or no access (0) permissions, thus 640 specifies read-write access for the server user, read-only access for other users of the server group, and no access for other users.

PASSWORD_FILE

The full path to the file from which the bind password should be read.

PATH

A valid, absolute file system path.

STRING

A DirectoryString value, as specified by RFC 2252 (http://www.ietf.org/rfc/rfc2252.txt).

SUPPORTED_SSL_CIPHER

An SSL cipher supported by the server. See the Reference for a list of supported ciphers.

SUPPORTED_SSL_PROTOCOL

An SSL protocol supported by the server. See the Reference for a list of supported protocols.

TIME

A time of the form hhmm in 24-hour format, where hh stands for hours and mm stands for minutes.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWdsee7
Stability Level	Stable