Directory Proxy Server Documentation Index
Configuration Reference Home

LDAP Health Check

The LDAP Health Check is used to determine whether an LDAP external server is available for use by the Directory Proxy Server. It can proactively check the status of the server on a regular basis, and it can reactively examine failures to determine whether any failure may indicate that the server has become unavailable.

↓Direct Subcomponents
↓Relations to This Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following LDAP Health Checks are available in the server :

These LDAP Health Checks inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to LDAP Health Checks:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ use-for-all-servers

Basic Properties

description

Description
A description for this LDAP Health Check
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 this LDAP Health Check is enabled for use in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

use-for-all-servers

Description
Indicates whether this LDAP Health Check should be automatically used for all LDAP external servers defined in the Directory Proxy Server. If this is false, then this LDAP Health Check will only be used by servers which have been explicitly configured to use it.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured LDAP Health Checks:

dsconfig list-ldap-health-checks
     [--property {propertyName}] ...

To view the configuration for an existing LDAP Health Check:

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

To update the configuration for an existing LDAP Health Check:

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

To create a new LDAP Health Check:

dsconfig create-ldap-health-check
     --check-name {name}
     --type {type}
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing LDAP Health Check:

dsconfig delete-ldap-health-check
     --check-name {name}