The LDAP SLA is used to configure a set of operational performance limits on a specific LDAP application.
The Metrics Engine will continually monitor the current performance of this application and compare its configured limits, producing alerts if the performance limits are not met. Each of the configured LDAP SLA objects will be reflected in the Metrics Engine REST API, enabling a client application to display the current status and performance of the LDAP application. An LDAP SLA is defined by the tracked application name on the Identity Proxy, one or more LDAP operations and one or more monitored servers.
↓Relations from This Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from LDAP Slas:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ sla-name | None |
| ↓ description | |
| ↓ enabled | |
| ↓ application-name | |
| ↓ ldap-op | |
| ↓ throughput-threshold-ops-per-second | |
| ↓ response-time-threshold-ms | |
| ↓ sla-server-query |
| Description | Specifies the name of the LDAP SLA. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Description of the LDAP SLA. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the LDAP SLA is enabled for use. If the LDAP SLA is enabled it will be actively monitored by the Metrics Engine, creating alerts when the configured threshold settings are exceeded. When disabled all monitoring of this LDAP SLA is stopped. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Name of the tracked application to monitor. Identity Data Store and Identity Proxy servers may be configured to track performance information on a per-tracked-application basis. This attribute must match one of the configured tracked applications. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Names of the LDAP operations this LDAP SLA monitors. Each LDAP SLA will monitor a set of LDAP operations made on a specific tracked application. Since the purpose of the LDAP SLA is to establish performance limits on the application, the monitored LDAP operations should all have the same response-time expectations. |
| Default Value | None |
| Allowed Values | add - Track performance of LDAP Add operations. bind - Track performance of LDAP Bind operations. compare - Track performance of LDAP Compare operations. delete - Track performance of LDAP Delete operations. modify - Track performance of LDAP Modify operations. modifydn - Track performance of LDAP ModifyDN operations. search - Track performance of LDAP Search operations. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
throughput-threshold-ops-per-second
| Description | Specifies the threshold for operation throughput. If a threshold is specified, the LDAP SLA will monitor the performance of operation throughput for this application and issue alerts if the performance is not compliant with the threshold settings. Typically an LDAP Service Level Agreement specifies a maximum average response time that must be met assuming a maximum number of operations per second. If the number of operations per second is exceeded, then the average response time is not assured. This setting allows the maximum number of operations per second to be defined. |
| Default Value | None |
| Allowed Values | The DN of any Monitoring Threshold. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the upper limit for average LDAP operation response time in milliseconds. If a threshold is specified the LDAP SLA will monitor the response time of LDAP operations for this application and issue alerts if the performance is not compliant with the threshold settings. This threshold is monitoring the average instantaneous response time with millisecond units. |
| Default Value | None |
| Allowed Values | The DN of any Monitoring Threshold. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the query that returns the servers that are part of this LDAP SLA. The query can simply return a static list of server names, or it can select servers based on server type and location. |
| Default Value | None |
| Allowed Values | The DN of any Server Query. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured LDAP Slas:
dsconfig list-ldap-slas
[--property {propertyName}] ...
To view the configuration for an existing LDAP SLA:
dsconfig get-ldap-sla-prop
--sla-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing LDAP SLA:
dsconfig set-ldap-sla-prop
--sla-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new LDAP SLA:
dsconfig create-ldap-sla
--sla-name {name}
--set application-name:{propertyValue}
--set ldap-op:{propertyValue}
--set sla-server-query:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing LDAP SLA:
dsconfig delete-ldap-sla
--sla-name {name}