System.ICMPProbe

System Center

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.ICMPProbe probe action module type is used to ping a remote computer. It takes System.TriggerData data as input and returns System.ICMPResponse data as output.

Usage

This module is commonly used to ping a remote device to check its availability. It is commonly used with an expression filter to evaluate the output.

This module serves the same function as the module Microsoft.SystemCenter.ICMPProbe, but that module is no longer recommended for use, because System.ICMPProbe is faster and more reliable. Use Microsoft.SystemCenter.ICMPProbe for backward compatibility with management packs that use the Operations Manager 2007 schema.

Type Definition

<ProbeActionModuleType ID="System.ICMPProbe" Accessibility="Public" Batching="false" PassThrough="false">
  <Configuration>
    <xsd:element name="Destination" type="xsd:string" minOccurs="1" maxOccurs="1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="TimeoutMilliseconds" type="xsd:nonNegativeInteger" minOccurs="0" maxOccurs="1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="Retries" type="xsd:nonNegativeInteger" minOccurs="0" maxOccurs="1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
    <xsd:element name="PacketSizeBytes" type="xsd:nonNegativeInteger" minOccurs="0" maxOccurs="1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
  </Configuration>
  <ModuleImplementation Isolation="Any">
    <Native>
      <ClassID>8F446429-71AC-49e0-B833-671696193552</ClassID>
    </Native>
  </ModuleImplementation>
  <OutputType>System.ICMPResponse</OutputType>
  <InputType>System.TriggerData</InputType>
</ProbeActionModuleType>


Parameters

The Microsoft.SystemCenter.ICMPProbe module supports the following configuration parameters.

 

Parameter Type Description

Destination

String

Required element. The target of the ping. This can be a computer or device name or an IP address.

TimeoutMilliseconds

Integer

Optional element. The amount of time, in milliseconds, that the ping should wait for a response before timing out.

Retries

Integer

Optional element. The number of retries the ping should make before quitting.

PacketSizeBytes

Integer

Optional element. The size of the ping packet, in bytes.

Composition

The System.ICMPProbe module is a native module.

External Module References

 

Module Type Usage

System.NetworkManagement.ICMPPingTime

Internal module for Microsoft use only.

Sample

The following example demonstrates the use of System.ICMPProbe in a rule. The rule pings a designated network target, and generates an alert if any result other than status code 0 (success) is returned.

<TypeDefinitions>
  <ModuleTypes>
    <DataSourceModuleType ID="MPAuthor.NetworkTest.ScheduledICMPPing" Accessibility="Internal" Batching="false">
      <Configuration>
        <xsd:element minOccurs="1" name="IntervalSeconds" type="xsd:integer" />
        <xsd:element minOccurs="1" name="SyncTime" type="xsd:string" />
        <xsd:element minOccurs="1" name="NetworkTargetToPing" type="xsd:string" />
        <xsd:element minOccurs="1" name="ComputerSourcePing" type="xsd:string" />
      </Configuration>
      <OverrideableParameters>
        <OverrideableParameter ID="IntervalSeconds" Selector="$Config/IntervalSeconds$" ParameterType="int" />
        <OverrideableParameter ID="SyncTime" Selector="$Config/SyncTime$" ParameterType="string" />
        <OverrideableParameter ID="NetworkTargetToPing" Selector="$Config/NetworkTargetToPing$" ParameterType="string" />
        <OverrideableParameter ID="ComputerSourcePing" Selector="$Config/ComputerSourcePing$" ParameterType="string" />
      </OverrideableParameters>
      <ModuleImplementation Isolation="Any">
        <Composite>
          <MemberModules>
            <DataSource ID="Scheduler" TypeID="System!System.SimpleScheduler">
              <IntervalSeconds>$Config/IntervalSeconds$</IntervalSeconds>
              <SyncTime>$Config/SyncTime$</SyncTime>
            </DataSource>
            <ProbeAction ID="ICMPPing" TypeID="SC!Microsoft.SystemCenter.ICMPProbe">
              <ComputerSourcePing>$Config/ComputerSourcePing$</ComputerSourcePing>
              <NetworkTargetToPing>$Config/NetworkTargetToPing$</NetworkTargetToPing>
            </ProbeAction>
          </MemberModules>
          <Composition>
            <Node ID="ICMPPing">
              <Node ID="Scheduler" />
            </Node>
          </Composition>
        </Composite>
      </ModuleImplementation>
      <OutputType>System!System.PropertyBagData</OutputType>
    </DataSourceModuleType>
  </ModuleTypes>
</TypeDefinitions>
<Monitoring>
  <Rules>
    <Rule ID="MPAuthor.NetworkTest.ICMPPingRule" Enabled="true" Target="Windows!Microsoft.Windows.Computer" ConfirmDelivery="true" Remotable="true" Priority="Normal" DiscardLevel="100">
      <Category>Custom</Category>
      <DataSources>
        <DataSource ID="DS" TypeID="MPAuthor.NetworkTest.ScheduledICMPPing">
          <IntervalSeconds>120</IntervalSeconds>
          <SyncTime />
          <NetworkTargetToPing>www.bing.com</NetworkTargetToPing>
          <ComputerSourcePing>$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$</ComputerSourcePing>
        </DataSource>
      </DataSources>
      <ConditionDetection ID="CD" TypeID="System!System.ExpressionFilter">
        <Expression>
          <SimpleExpression>
            <ValueExpression>
              <XPathQuery>Property=[@Name="StatusCode"]</XPathQuery>
            </ValueExpression>
            <Operator>NotEqual</Operator>
            <ValueExpression>
              <XPathQuery>0</XPathQuery>
            </ValueExpression>
          </SimpleExpression>
        </Expression>
      </ConditionDetection>
      <WriteActions>
        <WriteAction ID="Alert" TypeID="Health!System.Health.GenerateAlert">
          <Priority>1</Priority>
          <Severity>2</Severity>
          <AlertMessageId>$MPElement[Name="AlertMessageIDf1b5617adb0449d594c4c6d76f997fe0"]$</AlertMessageId>
        </WriteAction>
      </WriteActions>
    </Rule>
  </Rules>
</Monitoring>

Information

 

   

Module Type

ProbeActionModuleType

Input Type

System.TriggerData

Output Type

System.ICMPResponse

Implementation

Native

Library

Microsoft.SystemCenter.Library

 
Show: