PingAuthorize Server Documentation Index
Configuration Reference Home

Replication Backlog LDAP Health Check

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 Replication Backlog LDAP Health Check may be used to monitor the replication backlog in Ping Identity Directory Server instances. Servers which fall too far behind (based on the replication backlog or the age of the oldest backlog change) may be classified as DEGRADED or UNAVAILABLE.

Parent Component
Properties
dsconfig Usage

Parent Component

The Replication Backlog 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
↓ use-for-all-servers
↓ base-dn
↓ maximum-available-missing-changes
↓ minimum-degraded-missing-changes
↓ maximum-degraded-missing-changes
↓ minimum-unavailable-missing-changes
↓ maximum-available-missing-change-age
↓ minimum-degraded-missing-change-age
↓ maximum-degraded-missing-change-age
↓ minimum-unavailable-missing-change-age
↓ maximum-allowed-local-response-time
↓ maximum-allowed-nonlocal-response-time

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 PingAuthorize 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

base-dn

Description
The base DN of the backend for which the replication backlog should be monitored.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-available-missing-changes

Description
The maximum replication backlog for a backend server to remain classified as AVAILABLE. If the server's replication backlog is larger than this, then it will be reclassified as DEGRADED or UNAVAILABLE. This value must be less than or equal to the value of the maximum-degraded-missing-changes property.
Default Value
5000
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-degraded-missing-changes

Description
The minimum replication backlog for a backend server to remain classified as DEGRADED. If the server's replication backlog is smaller than this, then it will be reclassified as AVAILABLE. This value must be less than or equal to the value of the maximum-available-missing-changes property.
Default Value
1000
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-degraded-missing-changes

Description
The maximum replication backlog for a backend server to be classified as DEGRADED. If server's replication backlog is greater than this, then it will be reclassified as UNAVAILABLE. This value must be greater than or equal to the value of the maximum-available-missing-changes property.
Default Value
1000000
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-unavailable-missing-changes

Description
The minimum replication backlog for a backend server to remain classified as UNAVAILABLE. If server's replication backlog is lower than this, then it will be reclassified as either DEGRADED or AVAILABLE. This value must be greater than or equal to the value of the minimum-degraded-missing-changes property and less than or equal to the value of the maximum-degraded-missing-changes property.
Default Value
100000
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-available-missing-change-age

Description
The maximum age of the oldest backlog change allowed for a backend server to remain classified as AVAILABLE. If the oldest backlog change in a server is older than this value, then the server will be reclassified as DEGRADED or UNAVAILABLE. This value must be less than or equal to the value of the maximum-degraded-missing-change-age property.
Default Value
60 minutes
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-degraded-missing-change-age

Description
The minimum age of the oldest backlog change for a backend server to remain classified as DEGRADED. If the oldest backlog change in a server is younger than this value, then the server will be reclassified as AVAILABLE. This value must be less than or equal to the value of the maximum-available-missing-change-age property.
Default Value
10 minutes
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-degraded-missing-change-age

Description
The maximum age of the oldest backlog change allowed for a backend server to be classified as DEGRADED. If the oldest backlog change in a server is older than this value, then the server will be reclassified as UNAVAILABLE. This value must be greater than or equal to the value of the maximum-available-missing-change-age property.
Default Value
20 hours
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-unavailable-missing-change-age

Description
The minimum change of the oldest backlog change for a backend server to remain classified as UNAVAILABLE. If the oldest backlog change in a server is younger than this value, then the server will be reclassified as either DEGRADED or AVAILABLE. This value must be greater than or equal to the value of the minimum-degraded-missing-change-age property and less than or equal to the value of the maximum-degraded-missing-change-age property.
Default Value
5 hours
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-allowed-local-response-time

Description
The maximum length of time to wait for a response from a server in the same location as the PingAuthorize Server. If no response is received in this length of time, then the server will be classified as "unavailable".
Default Value
10 seconds
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-allowed-nonlocal-response-time

Description
The maximum length of time to wait for a response from a server in a different location from the PingAuthorize Server. If no response is received in this length of time, then the server will be classified as "unavailable".
Default Value
10 seconds
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
Yes
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 Replication Backlog LDAP Health Check:

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

To delete an existing LDAP Health Check:

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