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 Admin Alert LDAP Health Check may be used to watch for administrative alerts generated by the Ping Identity Directory Server in order to determine whether the server might be entering a DEGRADED or UNAVAILABLE state.
↓Parent Component
↓Properties
↓dsconfig Usage
The Admin Alert LDAP Health Check component inherits from the LDAP Health Check
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 |
| 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 |
| 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 |
| Description | Indicates whether this LDAP Health Check should be automatically used for all LDAP external servers defined in the Data Governance 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 Data Governance 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 Data Governance 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 |
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 Admin Alert LDAP Health Check:
dsconfig create-ldap-health-check
--check-name {name}
--type admin-alert
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing LDAP Health Check:
dsconfig delete-ldap-health-check
--check-name {name}