System.NetworkManagement.ComputedPerfProvider

  • Article

Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager

The System.NetworkManagement.ComputedPerfProvider data source module type provides System.Performance.Data type data.

Usage

This module is commonly used to provide performance data for a specified SNMP object by retrieving raw performance data with an SMNP query, and then performing a specified calculation on that raw data.

Type Definition

<DataSourceModuleType ID="System.NetworkManagement.ComputedPerfProvider" Accessibility="Public" Batching="false">
  <Configuration>
    <IncludeSchemaTypes>
      <SchemaType>System!System.ParamListSchema</SchemaType>
      <SchemaType>System.ExpressionEvaluatorSchema</SchemaType>
      <SchemaType>Snmp!System.SnmpVarBindsSchema</SchemaType>
    </IncludeSchemaTypes>
    <xsd:element minOccurs="1" name="Interval" type="xsd:integer" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="0" maxOccurs="1" default="3" name="NoOfRetries" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="0" maxOccurs="1" default="1500" name="Timeout" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="SnmpVarBinds" type="SnmpVarBindsType" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="ComputedPerformanceValue" type="NumericValueExpressionType" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="ObjectName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="CounterName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="OutputOnError" type="xsd:string" minOccurs="0" maxOccurs="1" default="false" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="Interval" Selector="$Config/Interval$" ParameterType="int" />
    <OverrideableParameter ID="NoOfRetries" Selector="$Config/NoOfRetries$" ParameterType="int" />
    <OverrideableParameter ID="Timeout" Selector="$Config/Timeout$" ParameterType="int" />
  </OverrideableParameters>
  <ModuleImplementation Isolation="Any">
    <Composite>
      <MemberModules>
        <DataSource ID="SnmpDataSource" TypeID="System.NetworkManagement.Host.ExtendedSnmpQueryProvider">
          <Interval>$Config/Interval$</Interval>
          <NoOfRetries>$Config/NoOfRetries$</NoOfRetries>
          <Timeout>$Config/Timeout$</Timeout>
          <SnmpVarBinds>$Config/SnmpVarBinds$</SnmpVarBinds>
          <OutputOnError>$Config/OutputOnError$</OutputOnError>
        </DataSource>
        <ConditionDetection ID="ComputePerfValue" TypeID="System.NetworkManagement.Computation">
          <NumericValue>$Config/ComputedPerformanceValue$</NumericValue>
        </ConditionDetection>
        <ConditionDetection ID="Mapper" TypeID="Performance!System.Performance.DataGenericMapper">
          <ObjectName>$Config/ObjectName$</ObjectName>
          <CounterName>$Config/CounterName$</CounterName>
          <InstanceName />
          <Value>$Data/Value$</Value>
        </ConditionDetection>
      </MemberModules>
      <Composition>
        <Node ID="Mapper">
          <Node ID="ComputePerfValue">
            <Node ID="SnmpDataSource" />
          </Node>
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>Performance!System.Performance.Data</OutputType>
</DataSourceModuleType>

Parameters

The System.NetworkManagement.ComputedPerfProvider module supports the following configuration parameters:

Parameter Type Overrideable Description

Interval

Integer

True

Required parameter. Contains the interval, in seconds, at which the probe performs the SNMP operation.

NoOfRetries

Integer

True

Optional parameter. The number of times that an SNMP GET operation will retry if it times out.Defaults to 3.

Timeout

Integer

True

Optional parameter. The amount of time (in milliseconds) before an SNMP GET operation times out.Defaults to 1500.

SnmpVarBinds

SnmpVarBindsType

False

Required parameter. Contains a list of SNMP variable bindings as SnmpVarBind elements.

ComputedPerformanceValue

NumericValueExpressionType

False

Required parameter. Contains a numeric expression that calculates the performance value from the raw performance data.

ObjectName

String

False

Required parameter. Specifies the performance object name.

CounterName

String

False

Required parameter. Specifies the name of the performance counter.

OutputOnError

String

False

Optional parameter. Indicates whether the workflow should continue if the query returns an error.

For more information about the SnmpVarBind element, see System.NetworkManagement.SnmpDataSource.

For more information about the NumericValueExpressionType parameter, see System.NetworkManagement.Computation.

Composition

The Microsoft.SystemCenter.CollectPerformanceData module is a composite module that contains the member modules described in the following table.

Workflow Run Order Module Type Usage

1

System.NetworkManagement.Host.ExtendedSnmpQueryProvider

Retrieves the raw performance data from the SNMP source.

2

System.NetworkManagement.Computation

Performs a computation on the raw performance data.

3

System.Performance.DataGenericMapper

Maps the computed performance value to System.Performance.Data.
Module Type Usage

System.NetworkManagement.ComputedPerfProvider.Division

Similar to System.NetworkManagement.ComputedPerfProvider, but accounts for possible division by zero in the computation.

External Module References

Module Type Usage

System.NetworkManagement.ComputedPerfProvider.Division

Similar to System.NetworkManagement.ComputedPerfProvider, but accounts for possible division by zero in the computation.

System.NetworkManagement.LargestFreeBufferProvider

Data source module that provides the largest free memory buffer.

System.NetworkManagement.SnmpPerformanceProvider.ProcessorUtilization

Internal module for Microsoft use only.

System.NetworkManagement.SnmpPerformanceProvider.Rate

Data source module that provides information on the traffic on an interface.

Sample

The following XML example shows how System.NetworkManagement.ComputedPerfProvider is used to calculate the free memory percentage on a Force10 device. Note that the value retrieved from the device is subtracted from 100 to determine the computed performance value.

<Rule ID="System.NetworkManagement.Force10Rsc.Memory.FreeMemoryPct" Enabled="true" Target="NetworkLibrary!System.NetworkManagement.Force10Rsc_Performance_Memory" ConfirmDelivery="false" Remotable="true" Priority="Normal" DiscardLevel="100">
  <Category>PerformanceCollection</Category>
  <DataSources>
    <DataSource ID="DS" TypeID="System.NetworkManagement.ComputedPerfProvider">
      <Interval>300</Interval>
      <NoOfRetries>3</NoOfRetries>
      <Timeout>3500</Timeout>
      <SnmpVarBinds>
        <SnmpVarBind>
          <OID>.1.3.6.1.4.1.6027.3.1.1.3.7.1.6.$Target/Property[Type="NetworkLibrary!System.NetworkManagement.LogicalDevice"]/Index$</OID>
          <Syntax>0</Syntax>
          <Value VariantType="8" />
        </SnmpVarBind>
      </SnmpVarBinds>
      <ComputedPerformanceValue>
        <Subtraction>
          <NumericValue>
            <Value>100</Value>
          </NumericValue>
          <NumericValue>
            <XPathQuery Type="Double">SnmpVarBinds/SnmpVarBind[OID=".1.3.6.1.4.1.6027.3.1.1.3.7.1.6.$Target/Property[Type="NetworkLibrary!System.NetworkManagement.LogicalDevice"]/Index$"]/Value</XPathQuery>
          </NumericValue>
        </Subtraction>
      </ComputedPerformanceValue>
      <ObjectName>Memory</ObjectName>
      <CounterName>Free Memory %</CounterName>
    </DataSource>
  </DataSources>
  <ConditionDetection ID="CollectionFilter" TypeID="System.NetworkManagement.ExpressionFilter">
    <Expression />
    <SuppressionSettings>
      <MatchCount>3</MatchCount>
      <SampleCount>3</SampleCount>
    </SuppressionSettings>
  </ConditionDetection>
  <WriteActions>
    <WriteAction ID="WriteToDB" TypeID="SystemCenter!Microsoft.SystemCenter.CollectPerformanceData" />
    <WriteAction ID="WriteToDW" TypeID="SCDW!Microsoft.SystemCenter.DataWarehouse.PublishPerformanceData" />
  </WriteActions>
</Rule>

Information

   

Module Type

DataSourceModuleType

Input Type

None

Output Type

System.Performance.Data

Implementation

Composite

Library

System.NetworkManagement.Monitoring