System.NetworkManagement.SnmpEventDataSource

  • Article

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

The System.NetworkManagement.SnmpEventDataSource data source module type runs an SNMP probe against a target and provides System.Event.Data type data.

Usage

This module is used to retrieve data from an SNMP object and map it to an event.

Type Definition

<DataSourceModuleType ID="System.NetworkManagement.SnmpEventDataSource" 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 name="EventOriginId" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="PublisherId" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="PublisherName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="Channel" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="LoggingComputer" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="EventNumber" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="EventCategory" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="EventLevel" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="UserName" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="Description" type="xsd:string" minOccurs="0" maxOccurs="1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="Params" type="ParamListType" 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="System!System.Event.GenericDataMapper">
          <EventOriginId>$Target/Id$</EventOriginId>
          <PublisherId>$MPElement$</PublisherId>
          <PublisherName>$Config/PublisherName$</PublisherName>
          <Channel>$Config/Channel$</Channel>
          <LoggingComputer>$Config/LoggingComputer$</LoggingComputer>
          <EventNumber>$Config/EventNumber$</EventNumber>
          <EventCategory>$Config/EventCategory$</EventCategory>
          <EventLevel>$Config/EventLevel$</EventLevel>
          <UserName>$Config/UserName$</UserName>
          <Description>$Config/Description$</Description>
          <Params>$Config/Params$</Params>
        </ConditionDetection>
      </MemberModules>
      <Composition>
        <Node ID="Mapper">
          <Node ID="SnmpDataSource" />
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>System!System.Event.Data</OutputType>
</DataSourceModuleType>

Parameters

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

EventOriginId

String

False

Required parameter. Identifies the source of the event by a GUID. The value of this parameter is commonly set to a $Target/Id$ variable that contains a GUID that represents the ID of the object that the rule that is running against.

PublisherId

String

False

Identifies the event publisher by a GUID. This parameter is commonly set to a $Target/Id$ variable that contains a GUID that represents the ID of the object that the rule is running against.

PublisherName

String

False

Contains the event source.

Channel

String

False

Contains the name of the event log

LoggingComputer

String

False

Contains the name of the computer the event was logged from.

EventNumber

String

False

Contains the event ID.

EventCategory

String

False

Contains the category of the event that is used to help correlate events to the components of an application.

EventLevel

String

False

Contains the numeric severity level of the event (for example, 4 for Information, 2 for Warning, or 1 for Error).

UserName

String

False

Contains the user name of the user that generated the event.

Description

String

False

Contains a text description of the event.

Params

ParamListType

False

Optional. Specifies one or more event parameters.

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

For more information on the EventOriginId, PublisherId, PublisherName, Channel, LoggingComputer, EventCategory, EventLevel, and UserName configuration parameters, see System.Event.GenericDataMapper.

Composition

The System.NetworkManagement.SnmpEventDataSource module is a composite module that contains the member modules described in the following table.

Workflow Run Order Module Type Usage

1

System.NetworkManagement.SnmpDataSource

Provides SNMP data from the specified SNMP entity.

System.Event.GenericDataMapper

Maps the SNMP data to System.Event.Data type data.
Module Type Usage

System.NetworkManagement.SnmpPerformanceDataSource

Provides SNMP performance data.

External Module References

None.

Sample

The following XML example shows how System.NetworkManagement.SnmpDataSource is used.

Information

   

Module Type

DataSourceModuleType

Input Type

None

Output Type

System.Event.Data

Implementation

Composite

Library

System.NetworkManagement.Library