Share via

System.NetworkManagement.ExtendedSnmpPerformanceProvider

  • Article

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

The System.NetworkManagement.ExtendedSnmpPerformanceProvider 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.

Type Definition

<DataSourceModuleType ID="System.NetworkManagement.ExtendedSnmpPerformanceProvider" Accessibility="Public" Batching="false">
  <Configuration>
    <IncludeSchemaTypes>
      <SchemaType>System!System.ParamListSchema</SchemaType>
      <SchemaType>System.ExpressionEvaluatorSchema</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="OID" type="xsd:string" 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" />
  </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>
            <SnmpVarBind>
              <OID>$Config/OID$</OID>
              <Syntax>0</Syntax>
              <Value VariantType="8" />
            </SnmpVarBind>
          </SnmpVarBinds>
        </DataSource>
        <ConditionDetection ID="Mapper" TypeID="Performance!System.Performance.DataGenericMapper">
          <ObjectName>$Config/ObjectName$</ObjectName>
          <CounterName>$Config/CounterName$</CounterName>
          <InstanceName />
          <Value>$Data/SnmpVarBinds/SnmpVarBind[OID="$Config/OID$"]/Value$</Value>
        </ConditionDetection>
      </MemberModules>
      <Composition>
        <Node ID="Mapper">
          <Node ID="SnmpDataSource" />
        </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.

OID

String

False

Required parameter. The OID of the SNMP object being targeted.

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 device returns an error.

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.Performance.DataGenericMapper

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

System.NetworkManagement.ComputedPerfProvider

Provides performance data for the specified SNMP object, after performing a calculation on the raw data.

System.NetworkManagement.ComputedPerfProvider.Division

Like System.NetworkManagement.ComputedPerfProvider, but allows for the possibility of division by zero in the computation.

External Module References

None

Sample

The following XML example shows how System.NetworkManagement.ExtendedSnmpPerformanceProvider is used to calculate the current processor utilization on a Cisco device.

<Rule ID="System.NetworkManagement.CiscoSystem.Processor.CurrentUtilization" Enabled="true" Target="NetworkLibrary!System.NetworkManagement.CiscoSystem_Performance_Processor" ConfirmDelivery="false" Remotable="true" Priority="Normal" DiscardLevel="100">
  <Category>PerformanceCollection</Category>
  <DataSources>
    <DataSource ID="DS" TypeID="System.NetworkManagement.ExtendedSnmpPerformanceProvider">
      <Interval>300</Interval>
      <NoOfRetries>3</NoOfRetries>
      <Timeout>3500</Timeout>
      <OID>.1.3.6.1.4.1.9.9.305.1.1.1.$Target/Property[Type="NetworkLibrary!System.NetworkManagement.LogicalDevice"]/Index$</OID>
      <ObjectName>Processor</ObjectName>
      <CounterName>% Processor Time</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