Identity Broker Documentation Index
Configuration Reference Home

Scripted LDAP Health Check

Note: this is an abstract component that cannot be instantiated.

Scripted LDAP Health Check provide LDAP health check implementations defined in a dynamically-loaded script which implements the ScriptedLDAPHealthCheck class defined in the UnboundID server SDK.

↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Scripted LDAP Health Checks are available in the server :

These Scripted LDAP Health Checks inherit from the properties described below.

Parent Component

The Scripted LDAP Health Check component inherits from the LDAP Health Check

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class
↓ use-for-all-servers
↓ script-argument

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

java-class (Read-Only)

Description
The fully-qualified name of the Java class that provides the logic for this LDAP Health Check.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.proxy.api.LDAPHealthCheck
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 Identity Broker. 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

script-argument

Description
The set of arguments used to customize the behavior for the Scripted LDAP Health Check. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
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 delete an existing LDAP Health Check:

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