ProbeAction (Diagnostic)

Article
05/16/2012

Applies To: Operations Manager 2007 R2, System Center Operations Manager 2007

Represents an implementation of a probe action module type definition.

Schema Hierarchy

ManagementPack
  Monitoring
    Diagnostics
      Diagnostic
        ProbeAction (Diagnostic)

Syntax

<ProbeAction ID=”ModuleID” Comment=”Comment” TypeID=”ModuleTypeID”>
Custom Schema Defined Parameters
</ProbeAction>

Attributes and Elements

The following sections describe attributes, child elements, and the parent element of the ProbeAction element.

Attributes

Attribute	Description
ID	Required attribute. Represents the identity of the element.
Comment	Optional attribute. Represents commentary by the management pack author.
TypeID	Required attribute. Represents the ProbeAction module type definition from which this ProbeAction module inherits its configuration schema.

ID Attribute Values

Value Description

Value	Description
The format for the ID attribute should be `UniqueElementID`.	The ID string must contain the following characteristics: The length is less than 255 characters. The ID begins with a letter (a-z) or a number (0-9). The ID contains only letters, numbers, the period character (.), or the underscore (_) character. The ID is unique across all elements within the scope of the ProbeAction module’s containing workflow. The ID is case-sensitive.

The format for the ID attribute should be UniqueElementID.

The ID string must contain the following characteristics:

The length is less than 255 characters.
The ID begins with a letter (a-z) or a number (0-9).
The ID contains only letters, numbers, the period character (.), or the underscore (_) character.
The ID is unique across all elements within the scope of the ProbeAction module’s containing workflow.
The ID is case-sensitive.

Child Elements

The child element of the ProbeAction module is defined by the Configuration (ProbeActionModuleType) schema of its base type as referenced in the TypeID attribute.

Parent Elements

Element	Description
Diagnostic	Represents a diagnostic definition targeted at a specific class type and associated monitor.

Remarks

A probe action module takes a single input stream and outputs data. The data types of its input and output data are defined in its InputType (ProbeActionModuleType) and OutputType (ProbeActionModuleType) elements, respectively. Like a DataSource (DataSourceModuleType) module, the probe action module runs a process or script to gather data from a source, processes it, and finally returns the data. However, unlike a data source module, a probe action module can receive input data and therefore does not have to be the first element in the workflow.

For a diagnostic workflow, the probe action module is used to probe the system some way to determine why the health state of a monitor has gone from healthy to unhealthy.

A probe action module’s base type must always be a descendant of a ProbeActionModuleType type.

Example

The following XML sample illustrates a diagnostic that is associated with the Microsoft.SystemCenter.Ping monitor.

<Diagnostic ID="Microsoft.SystemCenter.ManagedComputer.Ping.ICMPDiagnostic" Comment="In response to Ping Monitor, pings machine" Accessibility="Internal" Enabled="true" Target="Windows!Microsoft.Windows.Computer" Monitor="Microsoft.SystemCenter.Ping" ExecuteOnState="Error" Remotable="true" Timeout="300">
  <Category>Maintenance</Category>
  <ProbeAction ID="Ping" TypeID="SCLibrary!Microsoft.SystemCenter.ICMPProbe">
    <ComputerSourcePing>.</ComputerSourcePing>
    <NetworkTargetToPing>$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$</NetworkTargetToPing>
  </ProbeAction>
</Diagnostic>