System.NetworkManagement.SnmpPerformanceDataSource
Updated: May 18, 2012
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
The System.NetworkManagement.SnmpPerformanceDataSource data source module type runs an SNMP probe against a target and provides System.Performance.Data type data.
Usage
This module is used to retrieve data from an SNMP object and map it to performance data.
Type Definition
<DataSourceModuleType ID="System.NetworkManagement.SnmpPerformanceDataSource" Accessibility="Public" Batching="false">
<Configuration>
<IncludeSchemaTypes>
<SchemaType>System!System.ParamListSchema</SchemaType>
<SchemaType>System!System.ExpressionEvaluatorSchema</SchemaType>
<SchemaType>Snmp!System.SnmpVarBindsSchema</SchemaType>
</IncludeSchemaTypes>
<xsd:element name="Interval" type="xsd:integer" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="NoOfRetries" type="xsd:unsignedInt" default="3" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="Timeout " type="xsd:unsignedInt" default="500" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="Port" type="xsd:unsignedInt" default="161" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="IP" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element minOccurs="0" maxOccurs="1" name="Version" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
<xsd:element name="SnmpVarBinds" type="SnmpVarBindsType" 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" />
<OverrideableParameter ID="Port" Selector="$Config/Port$" ParameterType="int" />
</OverrideableParameters>
<ModuleImplementation Isolation="Any">
<Composite>
<MemberModules>
<DataSource ID="SnmpDataSource" TypeID="System.NetworkManagement.SnmpDataSource">
<Scheduler>
<SimpleReccuringSchedule>
<Interval Unit="Seconds">$Config/Interval$</Interval>
</SimpleReccuringSchedule>
<ExcludeDates />
</Scheduler>
<NoOfRetries>$Config/NoOfRetries$</NoOfRetries>
<Timeout>$Config/Timeout$</Timeout>
<Port>$Config/Port$</Port>
<SNMPv3UserName>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/UserName$</SNMPv3UserName>
<SNMPv3AuthProtocol>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/AuthenticationProtocol$</SNMPv3AuthProtocol>
<SNMPv3AuthPassword>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/AuthenticationKey$</SNMPv3AuthPassword>
<SNMPv3PrivProtocol>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/PrivacyProtocol$</SNMPv3PrivProtocol>
<SNMPv3PrivPassword>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/PrivacyKey$</SNMPv3PrivPassword>
<SNMPv3ContextName>$RunAs[Name="System.NetworkManagement.SnmpV3.MonitoringAccount"]/ContextName$</SNMPv3ContextName>
<IP>$Config/IP$</IP>
<CommunityString>$RunAs[Name="System.NetworkManagement.Snmp.MonitoringAccount"]/CommunityString$</CommunityString>
<Version>$Config/Version$</Version>
<SnmpVarBinds>$Config/SnmpVarBinds$</SnmpVarBinds>
<OutputOnError>false</OutputOnError>
</DataSource>
<ConditionDetection ID="Mapper" TypeID="Performance!System.Performance.DataGenericMapper">
<ObjectName>$Config/ObjectName$</ObjectName>
<CounterName>$Config/CounterName$</CounterName>
<InstanceName />
<Value>$Data/SnmpVarBinds/SnmpVarBind[1]/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.SnmpPerformanceDataSource module supports the following configuration parameters:
| Parameter | Type | Overrideable | Description |
|---|---|---|---|
|
Interval |
Integer |
True |
Optional 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 500. |
|
Port |
Integer |
True |
Optional parameter. Specifies the port to use on the SNMP managed entity. Defaults to 161. |
|
IP |
String |
False |
Optional parameter. Specifies the IP address of the SNMP managed entity |
|
Version |
String |
False |
Optional parameter. Specifies the SNMP version. Valid values are 1, 2, and 3. |
|
SnmpVarBinds |
SnmpVarBindsType |
False |
Required parameter. Contains a list of SNMP variable bindings as SnmpVarBind elements. |
|
ObjectName |
String |
False |
Required parameter. Contains the performance object name to be retrieved. |
|
CounterName |
String |
False |
Required parameter. Contains the performance counter name to be retrieved. |
For more information about the SnmpVarBind element, see System.NetworkManagement.SnmpDataSource.
Composition
The System.NetworkManagement.SnmpPerformanceDataSource module is a composite module that contains the member modules described in the following table.
| Workflow Run Order | Module Type | Usage |
|---|---|---|
|
1 |
Provides SNMP data from the specified SNMP entity. |
|
|
2 |
Maps the SNMP data to System.Performance.Datatype data. |
Related Modules
| Module Type | Usage |
|---|---|
|
|
|
|
Provides SNMP event data. |
External Module References
None.
Sample
The following XML example shows how System.NetworkManagement.SnmpPerformanceDataSource is used in a simple rule. This rule checks the OID for device uptime (1.3.6.1.2.1.1.3.0) and writes that performance information to the database.
<Rule ID="MPAuthor.NetManagement.Rule.DeviceUptimePerformance" Enabled="true" Target="MPAuthor.NetManagement.Switch" ConfirmDelivery="false" Remotable="true" Priority="Normal" DiscardLevel="100">
<Category>Alert</Category>
<DataSources>
<DataSource ID="DS" TypeID="NetworkLibrary!System.NetworkManagement.SnmpPerformanceDataSource">
<Interval>120</Interval>
<NoOfRetries>3</NoOfRetries>
<Timeout />
<Port />
<IP>$Target/Property[Type="NetworkLibrary!System.NetworkManagement.Node"]/SNMPAddress$</IP>
<Version>$Target/Property[Type="NetworkLibrary!System.NetworkManagement.Node"]/SNMPVersion$</Version>
<SnmpVarBinds>
<SnmpVarBind>
<OID>1.3.6.1.2.1.1.3.0</OID>
<Syntax>0</Syntax>
<Value VariantType="8" />
</SnmpVarBind>
</SnmpVarBinds>
<ObjectName>Network</ObjectName>
<CounterName>Uptime</CounterName>
</DataSource>
</DataSources>
<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.Library |