Note: this is an abstract component that cannot be instantiated.
A Gauge Data Source defines the source of gauge data obtained from the monitor backend.
Gauge data is obtained at regular, defined intervals from the monitor backend. Each gauge is configured with a Gauge Data Source that defines the object class, attribute, and other data type attributes about the value, upon which the gauge's status is derived.
↓Direct Subcomponents
↓Properties
↓dsconfig Usage
The following Gauge Data Sources are available in the server :
These Gauge Data Sources inherit from the properties described below.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ additional-text | |
| ↓ monitor-objectclass | |
| ↓ monitor-attribute | |
| ↓ include-filter | |
| ↓ resource-attribute | |
| ↓ resource-type | |
| ↓ minimum-update-interval |
| Description | A description for this Gauge Data Source |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Additional information about the source of this data that is added to alerts sent as a result of gauges that use this Gauge Data Source. Information may include tips related to diagnosing alarms, caveats related to particular platforms or environments, and additional instructions useful for configuring gauges to use this Gauge Data Source. The string may either be plain text or, to facilitate internationalization of text that appear in alarm and alert notification messages, a reference to a resource message declaration class and message descriptor, formatted as ${message.class.name:MESSAGE_DESCRIPTOR}. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The object class name of the monitor entries to examine for generating gauge data. |
| Default Value | None |
| Allowed Values | The object class name of the monitor entries to examine for generating gauge data. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the attribute on the monitor entries from which to derive the current gauge value. This attribute must appear in the entry specified by the object class. |
| Default Value | None |
| Allowed Values | An attribute of the specified monitor entry object class. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | An optional LDAP filter that can be used restrict which monitor entries are used to compute output. If an LDAP filter is specified, only monitor entries that match the filter, in addition to including the object class specified by the monitor-objectclass property, will be included in the gauge data. |
| Default Value | None |
| Allowed Values | A valid LDAP search filter |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the attribute whose value is used to identify the specific resource being monitored (e.g. device name). Gauges that represent data for multiple resources will provide monitor data in multiple monitor entries. This property specifies the attribute that is used to specifically identify the resource that is being monitored. A gauge that conveys information about disk devices for example would specify the attribute that contains the name of the devices in monitor entries. When SNMP alerts are used to convey alarm status, this information will appear as part of the 'Specific Problems' field. |
| Default Value | cn |
| Allowed Values | An attribute of the specified monitor entry object class. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A string indicating the type of resource being monitored. The string should describe the type of object referred to by the resource attribute, and is intended to add clarity to resource name. For example a gauge for measuring the number of entries for each backend should have a label 'Backend'. If not defined, the resource will be generically be referred to as 'Resource'. The string may either be plain text or, to facilitate internationalization of text that appears in alarm and alert notification messages, a reference to a resource message declaration class and message descriptor, formatted as ${message.class.name:MESSAGE_DESCRIPTOR}. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
minimum-update-interval (Read-Only)
| Description | The minimum frequency with which gauges using this Gauge Data Source can be configured for update. In order to prevent undesirable side effects, some Gauge Data Sources may use this property to impose a higher bound on the update frequency of gauges. |
| Default Value | 10 ms |
| Allowed Values | A duration. Lower limit is 10 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Gauge Data Sources:
dsconfig list-gauge-data-sources
[--property {propertyName}] ...
To view the configuration for an existing Gauge Data Source:
dsconfig get-gauge-data-source-prop
--source-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Gauge Data Source:
dsconfig set-gauge-data-source-prop
--source-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Gauge Data Source:
dsconfig delete-gauge-data-source
--source-name {name}