Reference Guide › Command-Line Scripting › Collection Engine Commands › dpmce ceconfig -configuremetricfilter Command--Configure Metric Filter

dpmce ceconfig -configuremetricfilter Command--Configure Metric Filter

The dpmce ceconfig -configuremetricfilter command lets you add, change, and delete the metric filter.

This command has the following format:

dpmce ceconfig -configuremetricfilter [-sc sc_url] -host_name hostname -operation add|delete -sourceType 3 -metric_os_type metricOStype -metric_type metrictype -metric_subtype metricsubtype -metric_instance metricinstance [-metric_method exact|complement] [-metric_datatype metricdatatype] [-metric_filter_default 0|1] [-include_for_overall yes|no] [-lower_threshold lowerthreshold] [-upper_threshold upperthreshold] [-metric_enabled yes|no] [-ws_user username -ws_password password][-locale iso629value]

-sc sc_url

(Optional) Defines the URL for the service controller host.

Example: https://hostname:port/...

hostname

Defines the fully qualified host where the service controller is installed.

Example: localhost.ca.com

port

Defines the listening port for the service controller server.

Example: 80

-host_name hostname

Defines the name of the host computer.

-operation add|delete

Adds or deletes an alias (-setalias) or metric (-configuremetric).

-sourceType

Defines the source for collecting metrics. Valid entries: 1 = System Metrics (Performance Lite metrics), 3 = collection from SNMP interface.

-metric_os_type metricOStype

Defines the operating system type for metric. Valid entries: WINDOWS, AIX, HPUX, LINUX, or SOLARIS.

-metricname metricname

Defines a name for the metric.

-metric_subtype MIBOID

Defines the MIB Object Identifier (OID) that uniquely identifies managed objects.

-metric_instance metricinstance

The column number for collecting data.

-metric_method exact|complement|exact_delta|exact_complement

Defines the methods for calculation and collection. Valid entries:

• exact = uses the exact metric value. As the value of the metric increases, it contributes to a higher overall usage. Example: Memory.
• complement = uses the metric in a complementary way. The higher the value, it contributes to a lower overall usage. Example: CPU Idle Percent.
• exact_delta = uses the difference between consecutive values. Example: MIB2.Instance.ifInOctets (number of incoming bytes).
• complement_delta = uses the difference between consecutive values in a complementary way. Example: CPU Total Idle.

-metric_datatype metricdatatype

Defines the data type for the metric. Valid entries: integer, floating-point, or double.

-metric_filter_default yes|no

Defines whether the metric is collected by default. Valid entries: yes or no.

-include_for_overall Yes|No

Defines whether the metric is included in the overall calculation.

Yes

Includes the metric in the overall calculation.

No

Excludes the metric from the overall calculation.

-lower_threshold lowerthreshold

Defines the lower overall usage threshold for the Data Center. The lower threshold must always be less than the upper threshold.

Limits: 0-100%

-upper_threshold upperthreshold

Defines the upper overall usage threshold for the Data Center. The upper threshold must always be greater than the lower threshold.

Limits: 1-100%

-metric_enabled yes|no

Defines if the metric is enabled for collection. Valid entries: yes or no.

-ws_user username -ws_password password

(Optional) Specifies the credentials to use for the web service security check. If you do not include credentials, you are prompted to enter them. Avoid the prompt for credentials by setting up your own session using caaipsecurity.

-locale iso639value

(Optional) Specifies an IS0 639_3166 combination to override the default English output, for example, fr_FR for French. To use the locale of the command prompt, specify "native".

Example: Configure Metric Filter

This example adds a metric filter.

dpmce ceconfig -configuremetricfilter -operation add -sourceType 3 -metric_os_type WINDOWS -metricname "Fake.cpuTotalUserPercent" -metric_subtype "xxxxxxxxxxxxxxxxx" -metric_method complement_delta -ws_user dcauser -ws_password dcapassword