System.SnmpScanProbe

  • Article

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

The System.SnmpScanProbe native probe action module type is used to perform SNMP GET actions in the context of an IP range. The module returns a System.SnmpData data type.

Usage

Use this module to receive SNMP data from within an IP range inside a workflow such as a rule or monitor.

Type Definition

<ProbeActionModuleType ID="System.SnmpScanProbe" Accessibility="Public">
  <Configuration>
    <xsd:element name="IPStart" type="xsd:string" />
    <xsd:element name="IPEnd" type="xsd:string" />
    <xsd:element name="CommunityString" type="xsd:string" />
    <xsd:element name="Timeout" type="xsd:unsignedInt" />
    <xsd:element minOccurs="0" maxOccurs="1" name="Version" type="xsd:string" />
    <xsd:element name="OIDProps">
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element minOccurs="0" maxOccurs="unbounded" name="OIDProp" type="xsd:string" />
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
  </Configuration>
  <ModuleImplementation>
    <Native>
      <ClassID>2B72C327-CDBB-421a-ACC3-A1994DBD52BB</ClassID>
    </Native>
  </ModuleImplementation>
  <OutputType>System.SnmpData</OutputType>
  <InputType>System!System.BaseData</InputType>
</ProbeActionModuleType>

Parameters

The System.SnmpScanProbe module supports the following configuration parameters:

Parameter Type Description

CommunityString

String

Contains the SNMP Community String .

IPStart

String

Specifies the start address of the IP range.

IPEnd

String

Specifies the end address of the IP range.

OIDProps

Complex

Contains a list of OIDs upon which to perform the GET action.

Timeout

Unsigned Integer

Specifies the timeout in seconds of the probe action.

Version

String

Optional. Specifies the SNMP version. The default value is “2”. To perform an SNMP v1 transaction, the value must be “1”.

OIDProps

Contains a list of at least one OIDProp element. Each OIDProp element represents an OID from which to send traps to Operations Manager.

<OIDProps>
   <OIDProp>1.3.6.1.2.1.4.1.0</OIDProp>
</OIDProps>

Composition

The System.SnmpScanProbe module is a native module.

The System.SnmpScanProbe module wraps portions of the WinSNMP API. For more information about how the module works internally, see the WinSNMP API topic.

Errors

The following errors can occur from within the System.SnmpScanProbe module.

Exception Reason

11001

An SNMP GET message failed.

11002

An SNMP SET message failed.

11004

The module failed to retrieve PDU data.

11006

The module was unable to initialize the SNMP session.

11007

The SNMP discovery over an IP range was aborted.

11008

The IP range for the SNMP discovery is too wide.
Module Type Usage

System.SnmpProbe

Performs SNMP GET, GET-NEXT and SET actions and returns a System.SnmpData data type.

System.SnmpTrapProvider

Returns SNMP trap events as a System.SnmpData data type.

External Module References

The System.SnmpScanProbe module is a member of the following modules:

Module Type Library Usage

System.SnmpScanQueryProvider

System.Snmp.Library

Performs SNMP GET actions in the context of an IP range and at a specified interval. The module returns the data as a System.SnmpData data type

Sample

The following example illustrates how you can use the System.SnmpScanProbe inside a data source module type definition that returns discovery data. The System.SnmpScanProbe module retrieves the SNMP data that is mapped to discovery data by a System.Discovery.FilteredClassSnapshotDataMapper condition detection module that returns discovery data.

<DataSourceModuleType ID="Microsoft.OperationsManager.Samples.SnmpScanProbeDS" Accessibility="Internal" Batching="false">
 <Configuration>
   <IncludeSchemaTypes>
      <SchemaType>System!System.Discovery.MapperSchema</SchemaType>
      <SchemaType>System!System.ExpressionEvaluatorSchema</SchemaType>
   </IncludeSchemaTypes>
    <xsd:element minOccurs="1" name="IPStart" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="IPEnd" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="CommunityString" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="Timeout" type="xsd:unsignedInt" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
      <xsd:element minOccurs="1" name="OIDProps" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <xsd:complexType>
          <xsd:sequence>
          <xsd:element minOccurs="1" maxOccurs="unbounded" name="OIDProp" type="xsd:string" />
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element minOccurs="1" name="ClassId" type="xsd:string" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="InstanceSettings" type="SettingsType" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element minOccurs="1" name="Expression" type="ExpressionType" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
  </Configuration>
  <ModuleImplementation Isolation="Any">
    <Composite>
        <MemberModules>
          <DataSource ID="Scheduler" TypeID="System!System.Scheduler">
           <Scheduler>
             <SimpleReccuringSchedule>
              <Interval Unit="Seconds">41600</Interval>
            </SimpleReccuringSchedule>
            <ExcludeDates />
          </Scheduler>
        </DataSource>
         <ProbeAction ID="Probe" TypeID="Snmp!System.SnmpScanProbe">
          <IPStart>$Config/IPStart$</IPStart>
          <IPEnd>$Config/IPEnd$</IPEnd>
          <CommunityString>$Config/CommunityString$</CommunityString>
          <Timeout>$Config/Timeout$</Timeout>
          <OIDProps>$Config/OIDProps$</OIDProps>
        </ProbeAction>
         <ConditionDetection ID="Mapper" TypeID="System!System.Discovery.FilteredClassSnapshotDataMapper">
          <Expression>$Config/Expression$</Expression>
          <ClassId>$Config/ClassId$</ClassId>
          <InstanceSettings>$Config/InstanceSettings$</InstanceSettings>
        </ConditionDetection>
      </MemberModules>
       <Composition>
         <Node ID="Mapper">
           <Node ID="Probe">
            <Node ID="Scheduler" />
          </Node>
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>System!System.Discovery.Data</OutputType>
</DataSourceModuleType>

Information

   

Module Type

ProbeActionModuleType

Input Type

System.BaseData

Output Type

System.SnmpData

Implementation

Native

Library

System.Snmp.Library