System.SnmpEventProvider
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
The System.SnmpQuery.EventProvider composite data source module type is used to perform SNMP GET actions at the specified interval and convert the response System.SnmpData data to the System.Event.Data data type. The module returns only data that has been successfully retrieved and processed.
Warning
The System.SNMPEventProvider module is included in System Center Operations Manager 2012 for backward compatibility only. Its functionality has been superseded by the System.NetworkManagement.SnmpEventDataSource module.
Usage
Use this module to get SNMP data and convert it into event data at a scheduled, recurring interval. This module can be implemented in a rule or monitor where the data can be collected and stored in the database and/or data warehouse or trigger alert and state changes.
Type Definition
<DataSourceModuleType ID="System.SnmpQuery.EventProvider" Accessibility="Public">
<Configuration>
<xsd:element name="Interval" type="xsd:integer" />
<xsd:element name="IsWriteAction" type="xsd:boolean" />
<xsd:element name="IP" type="xsd:string" />
<xsd:element name="CommunityString" type="xsd:string" />
<xsd:element minOccurs="0" maxOccurs="1" name="Version" type="xsd:string" />
<xsd:element name="SnmpVarBinds">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="1" maxOccurs="unbounded" name="SnmpVarBind">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="OID" type="xsd:string" />
<xsd:element name="Syntax" type="xsd:integer" />
<xsd:element name="Value">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="VariantType" type="xsd:integer" use="optional" />
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</Configuration>
<ModuleImplementation>
<Composite>
<MemberModules>
<DataSource TypeID="System.SnmpQueryProvider" ID="DataSource">
<Interval>$Config/Interval$</Interval>
<IsWriteAction>$Config/IsWriteAction$</IsWriteAction>
<IP>$Config/IP$</IP>
<CommunityString>$Config/CommunityString$</CommunityString>
<Version>$Config/Version$</Version>
<SnmpVarBinds>$Config/SnmpVarBinds$</SnmpVarBinds>
</DataSource>
<ConditionDetection TypeID="System!System.Event.GenericDataMapper" ID="Mapper">
<EventOriginId>$Target/Id$</EventOriginId>
<PublisherId>$MPElement$</PublisherId>
<PublisherName>SnmpQuery</PublisherName>
<Channel>SnmpQuery</Channel>
<LoggingComputer />
<EventNumber>0</EventNumber>
<EventCategory>3</EventCategory>
<EventLevel>0</EventLevel>
<UserName />
<Params />
</ConditionDetection>
</MemberModules>
<Composition>
<Node ID="Mapper">
<Node ID="DataSource" />
</Node>
</Composition>
</Composite>
</ModuleImplementation>
<OutputType>System!System.Event.Data</OutputType>
</DataSourceModuleType>
Parameters
The System.SnmpQuery.EventProvider module supports the configuration parameters described in the following table.
| Parameter | Type | Description |
|---|---|---|
Interval |
Integer |
Contains the interval, in seconds, at which the probe performs the SNMP operation. |
IsWriteAction |
Boolean |
Setting this value has no effect. The module performs only GET operations and is therefore hard-coded to false. |
IP |
String |
Specifies the IP address of the SNMP managed computer. |
CommunityString |
String |
Contains the SNMP Community String. |
Version |
String |
Optional. Specifies the SNMP version. The default value is “2”. To perform an SNMP version 1 transaction, the value must be “1”. |
SnmpVarBinds |
Complex |
Contains a list of SNMP variable bindings as SnmpVarBindelements. For more information, see System.SnmpProbe. |
For more information about the Intervalconfiguration parameter, see System.Scheduler.
For more information about the IP, IsWriteAction, CommunityString, Version, and SNMPVarBinds configuration parameters, see System.SnmpProbe.
Composition
The System.SnmpQuery.EventProvider module is a composite module that contains the member modules described in the following table.
| Workflow Run Order | Module Type | Usage |
|---|---|---|
1 |
Performs SNMP GET actions at the specified interval and returns the SNMP data as a System.SnmpData data type |
|
3 |
Maps the incoming System.SnmpData data to System.Event.Data data. |
Related Modules
| Module Type | Usage |
|---|---|
Performs SNMP GET actions at the specified interval and converts the response System.SnmpData data to the System.Event.Data data type |
|
Performs SNMP GET actions in the context of an IP range and at a specified interval. The module returns the filtered System.SnmpData data as a System.Event.Data data type. |
|
Performs SNMP GET actions at the specified interval and converts the filtered response System.SnmpData data to a System.Event.Data data type. |
External Module References
None.
Sample
The following example illustrates how you can use the System.SnmpQuery.EventProvider module in a rule that writes an event for each System.Event.Data received.
<Rule ID="Microsoft.Samples.Snmp.WriteEvent" Enabled="true" Target="MicrosoftSystemCenterNetworkDeviceLibrary!Microsoft.SystemCenter.NetworkDevice" Remotable="true">
<Category>Custom</Category>
<DataSources>
<DataSource ID="SnmpEventData" TypeID="Snmp!System.SnmpQuery.EventProvider">
<Interval>3600</Interval>
<IsWriteAction>false</IsWriteAction>
<IP>$Target/Property[Type="MicrosoftSystemCenterNetworkDeviceLibrary!Microsoft.SystemCenter.NetworkDevice"]/IPAddress$</IP>
<CommunityString>public</CommunityString>
<SnmpVarBinds>
<SnmpVarBind>
<OID>.1.3.6.1.2.1.2.2.1.8.8</OID>
<Syntax>1</Syntax>
<Value VariantType="8"></Value>
</SnmpVarBind>
<SnmpVarBind>
<OID>.1.3.6.1.2.1.2.2.1.8.9</OID>
<Syntax>1</Syntax>
<Value VariantType="8"></Value>
</SnmpVarBind>
</SnmpVarBinds>
</DataSource>
</DataSources>
<WriteActions>
<WriteAction ID="WriteToDB" TypeID="SC!Microsoft.SystemCenter.CollectEvent"/>
</WriteActions>
</Rule>
Information
Module Type |
|
Output Type |
|
Implementation |
Composite |
Library |
System.Snmp.Library |