The Entry Counter Placement Algorithm is a placement algorithm that selects the backend set with the minimum number of entries or the smallest database size in order to achieve equal distribution as much as possible.
↓Parent Component
↓Properties
↓dsconfig Usage
The Entry Counter Placement Algorithm component inherits from the Placement Algorithm
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ prefer-lowest-value |
| ↓ enabled | ↓ monitored-entry |
| ↓ rebalancing-enabled | ↓ monitored-attribute |
| ↓ rebalancing-scope | |
| ↓ rebalancing-subtree-size-limit | |
| ↓ placement-criteria | |
| ↓ poll-interval | |
| ↓ rebalancing-minimum-percentage |
| Description | A description for this Placement Algorithm |
| 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 placement algorithm 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 rebalancing is enabled for this placement algorithm. When rebalancing is enabled, the placement algorithm is consulted after certain update operations to determine whether the target entry should be moved to a different backend set. The update operations that can trigger rebalancing are (1) any MODIFY of an existing entry-balanced entry, and (2) any ADD of a new child entry below an existing entry-balanced entry. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates which modified entries are candidates for rebalancing. |
| Default Value | any |
| Allowed Values | top-level - Only entries immediately below the entry balancing base. any - Entries at any level below the entry balancing base. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
rebalancing-subtree-size-limit
| Description | Specifies the maximum number of entries in a sub-tree that may be migrated from one backend set to another during rebalancing. The method by which entries are to be migrated from one backend set to another depends on the value of this property. If the property value is greater than 1 then the restricted accessibility method is used, whereby the subtree to be moved is set read-only on the source server and hidden on the target server while the entries are moved. If the property value is equal to 1 then a pair of interactive transactions are used to move the entry. With this method the target server transaction is committed immediately before the source server transaction is committed. |
| Default Value | 50 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 1000 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The criteria for selecting the appropriate backend set. These pre-defined criterias are only applicable to the Ping Identity Directory Server instances. If the backend sets are not Ping Identity Directory Server instances, then the value should be set to custom, and the monitor-entry and monitor-attribute properties should be specified. |
| Default Value | entry-count |
| Allowed Values | backend-size - Indicates that the smallest backend in size will be preferred by the algorithm. entry-count - Indicates that the backend with the least number of entries will be preferred by the algorithm. custom - Indicates that a backend set will be selected based on the value of an attribute specified by the monitor-entry and monitor-attribute properties. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The placement algorithm will poll each backend set once every polling interval to update the information about the backend sets. Between polls, the algorithm keeps track where entries are placed and routes the request accordingly. |
| Default Value | 1m |
| Allowed Values | A duration. Lower limit is 0 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
rebalancing-minimum-percentage
| Description | Specifies the minimum threshold for entries to be migrated from one backend set to a preferred backend set with a smaller size (or better value). Entries will not be migrated unless the percentage difference between the value of the current backend set and the value of the preferred backend set exceeds this threshold. This setting is used to prevent unnecessary migration of entries back and forth between backend sets of similar size. |
| Default Value | 10 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 100 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
prefer-lowest-value (Advanced Property)
| Description | If true, the backend set that returns the lowest value will become the candidate for placing the next entry. Otherwise, the backend set with the highest value will be selected. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
monitored-entry (Advanced Property)
| Description | If defined, the placement algorithm will monitor this entry from each backend set. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
monitored-attribute (Advanced Property)
| Description | If defined, the placement algorithm will monitor this attribute from the monitored entry from each backend set. The attribute must have numerical value. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Placement Algorithms:
dsconfig list-placement-algorithms
[--property {propertyName}] ...
To view the configuration for an existing Placement Algorithm:
dsconfig get-placement-algorithm-prop
--algorithm-name {name}
--processor-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Placement Algorithm:
dsconfig set-placement-algorithm-prop
--algorithm-name {name}
--processor-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Entry Counter Placement Algorithm:
dsconfig create-placement-algorithm
--algorithm-name {name}
--processor-name {name}
--type entry-counter
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Placement Algorithm:
dsconfig delete-placement-algorithm
--algorithm-name {name}
--processor-name {name}