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.
The Logging Change Subscription Handler may be used to write information about operations matching registered change subscriptions to a log file.
The Logging Change Subscription Handler component inherits from the Change Subscription Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| change-subscription | |
| log-file |
| Description | A description for this Change Subscription Handler |
| 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 change subscription handler is enabled within the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of change subscriptions for which this change subscription handler should be notified. If no values are provided then it will be notified for all change subscriptions defined in the server. |
| Default Value | This change subscription handler will be notified of changes matching any change subscription defined in the server. |
| Allowed Values | The DN of any Change Subscription. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the log file in which the change notification messages will be written. |
| Default Value | logs/change-notifications.log |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Logging Change Subscription Handler must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
To list the configured Change Subscription Handlers:
dsconfig list-change-subscription-handlers
[--property {propertyName}] ...
To view the configuration for an existing Change Subscription Handler:
dsconfig get-change-subscription-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Change Subscription Handler:
dsconfig set-change-subscription-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Logging Change Subscription Handler:
dsconfig create-change-subscription-handler
--handler-name {name}
--type logging
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Change Subscription Handler:
dsconfig delete-change-subscription-handler
--handler-name {name}