System.NetworkManagement.TrapTriggerProvider

  • Article

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

The System.NetworkManagement.TrapTriggerProvider data source module type is used to return SNMP traps as a device-specific System.Event.Data data type.

Usage

Use this module to receive successful SNMP trap events and convert them into event data. This module can be implemented in a rule or monitor where you want to monitor for traps on a specific OID to use the trap as a trigger for an action, and the event data is not important. If you want to record the event data, use the System.NetworkManagement.SnmpEventDataSource module instead.

Type Definition

<DataSourceModuleType ID="System.NetworkManagement.TrapTriggerProvider" Accessibility="Public" Batching="false">
  <Configuration>
    <xsd:element minOccurs="1" maxOccurs="1" name="IP" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" maxOccurs="1" name="TriggerOID" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
  </Configuration>
  <ModuleImplementation Isolation="Any">
    <Composite>
      <MemberModules>
        <DataSource ID="TrapDS" TypeID="System.NetworkManagement.SnmpTrapEventProvider">
          <IP>$Config/IP$</IP>
          <OIDProps>
            <OIDProp>$Config/TriggerOID$</OIDProp>
          </OIDProps>
          <EventOriginId>$Target/Id$</EventOriginId>
          <PublisherId>$MPElement$</PublisherId>
          <PublisherName />
          <Channel />
          <LoggingComputer />
          <EventNumber>1</EventNumber>
          <EventCategory>0</EventCategory>
          <EventLevel>0</EventLevel>
          <UserName />
          <Params>
            <Param>$Target/Id$</Param>
          </Params>
        </DataSource>
      </MemberModules>
      <Composition>
        <Node ID="TrapDS" />
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>System!System.Event.Data</OutputType>
</DataSourceModuleType>

Parameters

The System.NetworkManagement.TrapTriggerProvider module supports the following configuration parameters:

Parameter Type Overrideable Description

IP

String

False

Required parameter. Specifies the IP address of the SNMP managed entity

TriggerOID

String

False

Required parameter. Contains the OIDs of the trap to trigger the module.

Composition

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

Workflow Run Order Module Type Usage

1

System.NetworkManagement.SnmpTrapEventProvider

Provides SNMP traps from the specified SNMP entity in the form of System.Event.Data.
Module Type Usage

System.NetworkManagement.SnmpTrapEventProvider

Used to return SNMP traps as a device-specific System.Event.Data data type. Use this module when recording the trap data.

External Module References

Module Type Usage

System.NetworkManagement.TrapOIDTriggerProvider

Internal module for Microsoft use only.

Sample

The following XML example shows how System.NetworkManagement.TrapTriggerProvider is used in a rule to watch for the configuration management event trap from any Cisco device. The OID for this trap is known and is hard-coded in the rule. There are no other parameters, because the event data is not recorded. The purpose of the module is to use the trap to trigger the write action.

<Rule ID="System.NetworkManagement.Cisco.Node.ConfigurationManagementEvent" Enabled="true" Target="NetworkLibrary!System.NetworkManagement.Cisco_Node" ConfirmDelivery="false" Remotable="true" Priority="Normal" DiscardLevel="100">
  <Category>Discovery</Category>
  <DataSources>
    <DataSource ID="Trap" TypeID="NetworkLibrary!System.NetworkManagement.TrapTriggerProvider">
      <IP>$Target/Property[Type="NetworkLibrary!System.NetworkManagement.Node"]/SNMPAddress$</IP>
      <TriggerOID>.1.3.6.1.4.1.9.9.43.2.0.1</TriggerOID>
    </DataSource>
  </DataSources>
  <WriteActions>
    <WriteAction ID="WA" TypeID="NetworkLibrary!System.NetworkManagement.TrapDiscoveryRequestPublishData" />
  </WriteActions>
</Rule>

Information

   

Module Type

DataSourceModuleType

Input Type

None

Output Type

System.Event.Data

Implementation

Native

Library

System.NetworkManagement.Library