Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact support for assistance if you believe that you have a need to create or modify this type of object.
Change Subscriptions define sets of criteria for changes of interest for which further processing should be performed. Whenever a change is processed that matches the associated criteria, the change subscription handlers configured in the server will be allowed to perform their associated processing for that operation.
The following components have a direct aggregation relation from Change Subscriptions:
The following components have a direct aggregation relation to Change Subscriptions:
The properties supported by this managed object are as follows:
Basic Properties: | Advanced Properties: |
---|---|
description | None |
connection-criteria | |
request-criteria | |
result-criteria | |
expiration-time |
Description | A description for this Change Subscription |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | Specifies a set of connection criteria that must match the client connection associated with an operation in order for that operation to be processed by a change subscription handler. |
Default Value | None |
Allowed Values | The DN of any Connection Criteria. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | Specifies a set of request criteria that must match the request associated with an operation in order for that operation to be processed by a change subscription handler. |
Default Value | None |
Allowed Values | The DN of any Request Criteria. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | Specifies a set of result criteria that must match the result associated with an operation in order for that operation to be processed by a change subscription handler. |
Default Value | None |
Allowed Values | The DN of any Result Criteria. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | Specifies a timestamp that provides an expiration time for this change subscription. If an expiration time is provided, then the change subscription will not be active after that time has passed. Timestamp values should be specified using the generalized time syntax (e.g., in a form like "YYYYMMDDhhmmssZ"). |
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 Change Subscriptions:
dsconfig list-change-subscriptions [--property {propertyName}] ...
To view the configuration for an existing Change Subscription:
dsconfig get-change-subscription-prop --subscription-name {name} [--tab-delimited] [--script-friendly] [--property {propertyName}] ...
To update the configuration for an existing Change Subscription:
dsconfig set-change-subscription-prop --subscription-name {name} (--set|--add|--remove) {propertyName}:{propertyValue} [(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Change Subscription:
dsconfig create-change-subscription --subscription-name {name} [--set {propertyName}:{propertyValue}] ...
To delete an existing Change Subscription:
dsconfig delete-change-subscription --subscription-name {name}