Monitoring Endpoint

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Note: this is an abstract component that cannot be instantiated.

A Monitoring Endpoint defines a destination where server metric data should be sent for monitoring, such as a Splunk indexer or a StatsD daemon.

Direct Subcomponents Properties dsconfig Usage

Direct Subcomponents

The following Monitoring Endpoints are available in the server :

These Monitoring Endpoints inherit from the properties described below.

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 enabled  None

Basic Properties

enabled

Description
Indicates whether this Monitoring Endpoint is enabled for use in the Directory Server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Monitoring Endpoints:

dsconfig list-monitoring-endpoints
     [--property {propertyName}] ...

To view the configuration for an existing Monitoring Endpoint:

dsconfig get-monitoring-endpoint-prop
     --endpoint-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Monitoring Endpoint:

dsconfig set-monitoring-endpoint-prop
     --endpoint-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Monitoring Endpoint:

dsconfig delete-monitoring-endpoint
     --endpoint-name {name}