perm

DS logging configuration (LOG) properties

Description

Directory Server writes to three main types of log files you can configure, the INSTANCE_PATH/logs/access, INSTANCE_PATH/logs/audit, and INSTANCE_PATH/logs/errors logs, where INSTANCE_PATH is the full path where the server instance is located, such as /local/dsInst.

When you specify one of these properties with dsconf get-log-prop or dsconf set-log-prop, you must specify which type of log configuration, access, audit, or error, you want to examine. For example, to see whether audit logging is enabled for a server instance:

$ dsconf get-log-prop audit enabled
enabled  :  off
$

PROPERTY: buffering-enabled

Characteristic	Value
Syntax	`on \| off`
Default Value	`on` for `access`, not applicable to `audit` and `errors` logs
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property indicates whether Directory Server writes access log entries directly to disk, or use a buffer, by default.

PROPERTY: enabled

Characteristic	Value
Syntax	`on \| off`
Default Value	`on` for `access`, `off` for `audit`, `on` for `errors`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property indicates whether the specified log type is enabled.

PROPERTY: level

Characteristic	Value
Syntax	See the description that follows.
Default Value	`default`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	Yes

This property defines which kinds of messages get logged. This property is applicable only to access and errors logs.

access log levels

The following settings are supported:

acc-internal: Log access information for internal operations.
default: Log client access to entries.
acc-default_plus_referrals: As default, but also log access to referrals.
acc-timing: Use precise timing for microsecond resolution of elapsed times.

errors log levels

The following settings are supported:

default: Log startup, shutdown, errors, and warnings.
err-function-calls: Log when server enters or exits a function.
err-search-args: Log search arguments.
err-connection: Connection management.
err-packets: Log packets sent and received.
err-search-filter: Log search filter information.
err-config-file: Log information for changes to the configuration file dse.ldif.
err-acl: Log access control processing information.
err-ldbm: Log information from the ldbm database plugin.
err-entry-parsing: Log LDIF parsing errors.
err-housekeeping: Log event queue information.
err-replication: Log information about replication operations.
err-entry-cache: Log entry cache information.
err-plugins: Log information from server plug-ins.
err-dsml: Log information from DSML front end.
err-dsml-advanced: Debugging information for DSML.

PROPERTY: max-age

Characteristic	Value
Syntax	`DURATION \| unlimited`
Default Value	`1M` (one month)
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the age beyond which the specified type of log file is deleted.

PROPERTY: max-disk-space-size

Characteristic	Value
Syntax	`MEMORY_SIZE \| unlimited`
Default Value	`500M`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the maximum disk space the specified type of log is allowed to consume. When the limit is reached, the server deletes the oldest log file to reclaim disk space.

PROPERTY: max-file-count

Characteristic	Value
Syntax	`Integer`
Default Value	`10` for `access`, `2` for `errors`, `1` for `audit`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the maximum number of log files, including rotated logs, of the specified type that the server allows to be created in the log file directory. When the limit is reached, the server deletes the oldest log file to reclaim disk space.

When you set this property to 1, the specified log is not rotated.

PROPERTY: max-size

Characteristic	Value
Syntax	`MEMORY_SIZE \| unlimited`
Default Value	`100M`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the maximum file size for the specified log. When the limit is reached, the server rotates the log file, unless max-file-count is set to 1.

PROPERTY: min-free-disk-space-size

Characteristic	Value
Syntax	`MEMORY_SIZE`
Default Value	`5M`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the minimum free space allowed on the disk where the specified log is stored. When the limit is reached, the server deletes the oldest log files until enough space is available.

PROPERTY: path

Characteristic	Value
Syntax	`PATH`
Default Value	`INSTANCE_PATH/logs/access`, `INSTANCE_PATH/logs/audit`, `INSTANCE_PATH/logs/errors`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the full path to the specified log file type.

PROPERTY: perm

Characteristic	Value
Syntax	`OCTAL_MODE`
Default Value	`600`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the read, write, and execute permissions on the specified log file.

PROPERTY: rotation-interval

Characteristic	Value
Syntax	`DURATION \| unlimited`
Default Value	`1d` (one day) for `access`, `1w` (one week) for `audit` and `errors`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the duration between rotations of the specified log file.

PROPERTY: rotation-min-file-size

Characteristic	Value
Syntax	`MEMORY_SIZE \| undefined`
Default Value	`undefined`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the minimum size the specified log file must have before the server rotates it.

PROPERTY: rotation-time

Characteristic	Value
Syntax	`TIME \| undefined`
Default Value	`undefined`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the time of day when the server rotates the specified log file.

PROPERTY: verbose-enabled

Characteristic	Value
Syntax	`on\|off`
Default Value	`off`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property determines whether extra informational messages are written to the errors log.

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	Evolving