System.NetworkManagement.SnmpPerformanceProvider.Rate
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
The System.NetworkManagement.PerformanceProvider.Rate data source module type provides System.Performance.Data type data regarding the traffic on an interface, measured at a specified rate.
Usage
This module retrieves performance information regarding traffic on an interface. Depending on the MIB used by the device, the traffic data may be provided in octets, bytes, or some other measurement. If you know the units that the device provides, you can use this module with the proper unit factor parameter to convert the result to another unit, such as bits per second.
Type Definition
<DataSourceModuleType ID="System.NetworkManagement.SnmpPerformanceProvider.Rate" Accessibility="Public" Batching="false">
<Configuration>
<IncludeSchemaTypes>
<SchemaType>System!System.ParamListSchema</SchemaType>
<SchemaType>System.ExpressionEvaluatorSchema</SchemaType>
</IncludeSchemaTypes>
<xsd:element name="Interval" type="xsd:integer" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="NoOfRetries" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="Timeout" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="OID" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="ObjectName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="CounterName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="UnitFactor" type="xsd:decimal" 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="DS" TypeID="System.NetworkManagement.ComputedPerfProvider">
<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>
<ComputedPerformanceValue>
<Delta DeltaComputationType="RatePerSecond">
<NumericValue>
<Product>
<NumericValue>
<XPathQuery Type="Double">SnmpVarBinds/SnmpVarBind[OID="$Config/OID$"]/Value</XPathQuery>
</NumericValue>
<NumericValue>
<Value>$Config/UnitFactor$</Value>
</NumericValue>
</Product>
</NumericValue>
</Delta>
</ComputedPerformanceValue>
<ObjectName>$Config/ObjectName$</ObjectName>
<CounterName>$Config/CounterName$</CounterName>
</DataSource>
</MemberModules>
<Composition>
<Node ID="DS" />
</Composition>
</Composite>
</ModuleImplementation>
<OutputType>Performance!System.Performance.Data</OutputType>
</DataSourceModuleType>
Parameters
The System.NetworkManagement.PerformanceProvider.Rate 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 |
Required parameter. The number of times that an SNMP GET operation will retry if it times out. |
Timeout |
Integer |
True |
Required parameter. The amount of time (in milliseconds) before an SNMP GET operation times out. |
OID |
String |
False |
Required parameter. The OID for the desired traffic type on the SNMP node. |
ObjectName |
String |
False |
Required parameter. The object name to be used in the performance data output. |
CounterName |
String |
False |
Required parameter. The counter name to be used in the performance data output. |
UnitFactor |
Integer |
False |
Required parameter. The conversion factor by which to multiply the value returned from the SNMP device to produce the desired units. |
Composition
The System.NetworkManagement.PerformanceProvider.Rate module is a composite module that contains the member modules described in the following table.
Workflow Run Order | Module Type | Usage |
---|---|---|
1 |
Converts the returned value from the SNMP device to the specified rate. |
Related Modules
Module Type | Usage |
---|---|
Retrieves performance data for a given SNMP object. |
|
Used to retrieve SNMP information from the object directly, as opposed to the parent of the object. |
|
Used to retrieve SNMP information from the parent of the object. |
External Module References
none
Sample
The following XML example shows how System.NetworkManagement.PerformanceProvider.Rate is used in a rule to retrieve the input bits per second on an SNMP node using ifMIB. The device provides the inbound traffic in bytes, so a unit factor of 8 is used to convert the value to bits per second.
<Rule ID="System.NetworkManagement.DeltaRule.ifMIB.NetworkAdapter.ifInBitsRate" Enabled="false" Target="NetworkLibrary!System.NetworkManagement.ifMIB_Base_NetworkAdapter" ConfirmDelivery="false" Remotable="true" Priority="Normal" DiscardLevel="100">
<Category>PerformanceCollection</Category>
<DataSources>
<DataSource ID="DS" TypeID="System.NetworkManagement.SnmpPerformanceProvider.Rate">
<Interval>300</Interval>
<NoOfRetries>3</NoOfRetries>
<Timeout>3500</Timeout>
<OID>.1.3.6.1.2.1.31.1.1.1.6.$Target/Property[Type="NetworkLibrary!System.NetworkManagement.NetworkAdapter"]/Index$</OID>
<ObjectName>Interface</ObjectName>
<CounterName>Inbound Bits/sec</CounterName>
<UnitFactor>8</UnitFactor>
</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 |
|
Input Type |
None |
Output Type |
|
Implementation |
Composite |
Library |
System.NetworkManagement.Monitoring |