ProbeAction (Task)

Article
10/04/2013

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

Represents an implementation of a probe action module type definition.

Schema Hierarchy

ManagementPack
  Monitoring
    Tasks
      Task
        ProbeAction

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
Task	Defines an on-demand workflow designed to be initiated by the user.

Remarks

A ProbeAction 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 in some way, 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.

A probe action module type never alters system state. If you want your module to affect system state, you must use or implement a WriteAction (WriteActionModuleType) module.

With the exception of a Task workflow, a probe action module type is usually preceded by a data source scheduler module so that its action can occur at an interval at some frequency.

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

Example

The following XML sample illustrates a probe action task that queries local users on the computer.

<Task ID="Microsoft.Windows.Server.2003.Computer.LocalUsersQuery.Task" Target="Microsoft.Windows.Server.2003.Computer" Accessibility="Public">
  <Category>Maintenance</Category>
  <ProbeAction ID="PA" TypeID="System!System.CommandExecuterProbe">
    <ApplicationName>%WINDIR%\System32\NET.EXE</ApplicationName>
    <WorkingDirectory/>
    <CommandLine>USER</CommandLine>
    <TimeoutSeconds>30</TimeoutSeconds>
    <RequireOutput>true</RequireOutput>
    <Files/>
  </ProbeAction>
</Task>

Share via