The Client IP Server Affinity Provider provides a mechanism for consistently routing requests from clients with the same IP address to the same backend server. The types of operations for which affinity may be set and the types of operations for which that affinity may be used can be customized, as well as the length of time for which the affinity should persist.
↓Parent Component
↓Properties
↓dsconfig Usage
The Client IP Server Affinity Provider component inherits from the Server Affinity Provider
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ affinity-duration | |
| ↓ set-affinity-operation | |
| ↓ use-affinity-operation |
| Description | A description for this Server Affinity Provider |
| 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 Server Affinity Provider is enabled for use in the Identity Broker. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum length of time after the last operation which may set the server affinity that the affinity should remain in effect. |
| Default Value | 30 seconds |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of operations for which a server affinity should be set or updated. |
| Default Value | add delete modify modify-dn |
| Allowed Values | add - Server affinity should be set or updated after a successful add operation. bind - Server affinity should be set or updated after a successful bind operation. compare - Server affinity should be set or updated after a successful compare operation. delete - Server affinity should be set or updated after a successful delete operation. modify - Server affinity should be set or updated after a successful modify operation. modify-dn - Server affinity should be set or updated after a successful modify DN operation. search - Server affinity should be set or updated after a successful search operation. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of operations for which a server affinity should be used if it is set. |
| Default Value | add bind compare delete modify modify-dn search |
| Allowed Values | add - Any defined server affinity should be used for add operations. bind - Any defined server affinity should be used for bind operations. compare - Any defined server affinity should be used for compare operations. delete - Any defined server affinity should be used for delete operations. modify - Any defined server affinity should be used for modify operations. modify-dn - Any defined server affinity should be used for modify DN operations. search - Any defined server affinity should be used for search operations. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Server Affinity Providers:
dsconfig list-server-affinity-providers
[--property {propertyName}] ...
To view the configuration for an existing Server Affinity Provider:
dsconfig get-server-affinity-provider-prop
--provider-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Server Affinity Provider:
dsconfig set-server-affinity-provider-prop
--provider-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Client IP Server Affinity Provider:
dsconfig create-server-affinity-provider
--provider-name {name}
--type client-ip
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Server Affinity Provider:
dsconfig delete-server-affinity-provider
--provider-name {name}