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 UnboundID support for assistance if you believe that you have a need to create or modify this type of object.
The Client Connection Monitor Provider exposes monitor information about the set of client connections that are established to the Metrics Engine.
↓Parent Component
↓Properties
↓dsconfig Usage
The Client Connection Monitor Provider component inherits from the Monitor Provider
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled |
| Description | A description for this Monitor 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 the Monitor Provider is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Monitor Providers:
dsconfig list-monitor-providers
[--property {propertyName}] ...
To view the configuration for an existing Monitor Provider:
dsconfig get-monitor-provider-prop
--provider-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Monitor Provider:
dsconfig set-monitor-provider-prop
--provider-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Client Connection Monitor Provider:
dsconfig create-monitor-provider
--provider-name {name}
--type client-connection
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Monitor Provider:
dsconfig delete-monitor-provider
--provider-name {name}