PingAuthorize Server Documentation Index
Configuration Reference Home

Work Queue Busyness 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 Work Queue Busyness LDAP Health Check may be used to assess the health of an LDAP external server by looking at the recent-worker-thread-percent-busy value of the work queue monitor entry. The value returned will be used to obtain the health check score, and if the value is too high, then the server may be considered degraded or unavailable.

Parent Component
Properties
dsconfig Usage

Parent Component

The Work Queue Busyness 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
↓ maximum-allowed-local-response-time
↓ maximum-allowed-nonlocal-response-time
↓ maximum-available-percent-busy
↓ minimum-degraded-percent-busy
↓ maximum-degraded-percent-busy
↓ minimum-unavailable-percent-busy

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

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

maximum-available-percent-busy

Description
The maximum recent-worker-thread-percent-busy value that may be returned by a server in order for that server to remain classified as "available". Values greater than this will cause the server to be reclassified as "degraded" or "unavailable". This value must be greater than or equal to the value of the minimum-available-percent-busy property and less than or equal to the value of the maximum-degraded-percent-busy property.
This value will only be evaluated for servers with a last-known state of "available". For servers with a last-known state of "degraded" or "unavailable", then the response time must be less than the value of the minimum-degraded-percent-busy property for a server to be reclassified as "available".
Default Value
75
Allowed Values
An integer value. Lower limit is 1. Upper limit is 100 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-degraded-percent-busy

Description
The minimum recent-worker-thread-percent-busy value that may be returned by a server in order for that server to remain classified as "degraded". Values less than this will cause the server to be reclassified as "available". This value must be greater than or equal to one and less than or equal to the value of the minimum-unavailable-percent-busy property.
This value will only be evaluated for servers with a last-known state of "degraded" or "unavailable". For servers with a last-known state of "available", then the response time must be less than the value of the maximum-available-percent-busy property for a server to remain classified as "available".
Default Value
50
Allowed Values
An integer value. Lower limit is 1. Upper limit is 100 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

maximum-degraded-percent-busy

Description
The maximum recent-worker-thread-percent-busy value that may be returned by a server in order for that server to be classified as "degraded". Values greater than this will cause the server to be reclassified as "unavailable". This value must be greater than or equal to the value of the maximum-available-percent-busy property and less than or equal to 100. A value of 100 indicates that the server should never be classified as "unavailable" as a result of the work queue busyness.
This value will only be evaluated for servers with a last-known state of "available" or "degraded". For servers with a last-known state of "unavailable", then the response time must be less than the value of the minimum-unavailable-percent-busy property for a server to be reclassified as "degraded" or "available".
Default Value
100
Allowed Values
An integer value. Lower limit is 1. Upper limit is 100 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

minimum-unavailable-percent-busy

Description
The minimum recent-worker-thread-percent-busy value that may be returned by a server in order for that server to remain classified as "unavailable". Values less than this will cause the server to be reclassified as "degraded" or "available". This value must be greater than or equal to the value of the minimum-degraded-percent-busy property and less than or equal to the value of the maximum-degraded-percent-busy property.
This value will only be evaluated for servers with a last-known state of "unavailable".
Default Value
100
Allowed Values
An integer value. Lower limit is 1. Upper limit is 100 .
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 Work Queue Busyness LDAP Health Check:

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

To delete an existing LDAP Health Check:

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