Microsoft.SystemCenter.WSManagement.TimedInvoker

  • Article

Applies To: Operations Manager 2007 R2

The Microsoft.SystemCenter.WSManagement.TimedInvoker data source module type calls the WS-Management Invoke operation to run a method on a WS-Management object at a scheduled frequency. This module returns the results of the invocation as Microsoft.SystemCenter.WSManagement.WSManData.

Usage

Use this module to invoke a method on a WS-Management object and return the results at a scheduled frequency from within a workflow.

Type Definition

<DataSourceModuleType ID="Microsoft.SystemCenter.WSManagement.TimedInvoker" Accessibility="Public" RunAs="Microsoft.SystemCenter.WSManagement.WSManActionAccount" Batching="false">
  <Configuration>
    <IncludeSchemaTypes>
      <SchemaType>System!System.ExpressionEvaluatorSchema</SchemaType>
      <SchemaType>Microsoft.SystemCenter.WSManagement.Schemas</SchemaType>
    </IncludeSchemaTypes>
    <xsd:element name="Scheduler" type="PublicSchedulerType" />
    <xsd:element name="Invoke" type="InvokeSchema" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="Protocol" Selector="$Config/Invoke/Protocol$" ParameterType="string" />
    <OverrideableParameter ID="TargetSystem" Selector="$Config/Invoke/TargetSystem$" ParameterType="string" />
    <OverrideableParameter ID="Port" Selector="$Config/Invoke/Port$" ParameterType="int" />
    <OverrideableParameter ID="Authentication" Selector="$Config/Invoke/Authentication$" ParameterType="string" />
    <OverrideableParameter ID="UserName" Selector="$Config/Invoke/UserName$" ParameterType="string" />
    <OverrideableParameter ID="Password" Selector="$Config/Invoke/Password$" ParameterType="string" />
    <OverrideableParameter ID="SkipCACheck" Selector="$Config/Invoke/SkipCACheck$" ParameterType="bool" />
    <OverrideableParameter ID="SkipCNCheck" Selector="$Config/Invoke/SkipCNCheck$" ParameterType="bool" />
    <OverrideableParameter ID="OutputErrorIfAny" Selector="$Config/Invoke/OutputErrorIfAny$" ParameterType="bool" />
    <OverrideableParameter ID="UTF" Selector="$Config/Invoke/UTF$" ParameterType="string" />
    <OverrideableParameter ID="Uri" Selector="$Config/Invoke/Uri$" ParameterType="string" />
    <OverrideableParameter ID="Selector" Selector="$Config/Invoke/Selector$" ParameterType="string" />
    <OverrideableParameter ID="InvokeAction" Selector="$Config/Invoke/InvokeAction$" ParameterType="string" />
    <OverrideableParameter ID="Input" Selector="$Config/Invoke/Input$" ParameterType="string" />
    <OverrideableParameter ID="TimeOutInMS" Selector="$Config/Invoke/TimeOutInMS$" ParameterType="int" />
  </OverrideableParameters>
  <ModuleImplementation Isolation="Any">
    <Composite>
      <MemberModules>
        <DataSource ID="Scheduler" TypeID="System!System.Scheduler">
          <Scheduler>$Config/Scheduler$</Scheduler>
        </DataSource>
        <ProbeAction ID="Invoker" TypeID="Microsoft.SystemCenter.WSManagement.Invoker">
          <Invoke>$Config/Invoke$</Invoke>
        </ProbeAction>
      </MemberModules>
      <Composition>
        <Node ID="Invoker">
          <Node ID="Scheduler" />
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>Microsoft.SystemCenter.WSManagement.WSManData</OutputType>
</DataSourceModuleType>

Parameters

The Microsoft.SystemCenter.WSManagement.TimedInvoker module supports the configuration parameters described in the following table.

Parameter Type Overrideable Description

Scheduler

PublicSchedulerType

False

Represents the schedule by which to trigger the Invoke operation.

Invoke

InvokeSchema

False

Contains the schema used to specify the set of properties required to perform a WS-Management Invoke operation.

All of the sub-elements in the Invoke parameter are marked as overrideable.

For more information about the Invoke parameter, see InvokeSchema.

For more information about the Scheduler parameter, see PublicSchedulerType.

Composition

The Microsoft.SystemCenter.WSManagement.TimedInvoker module is a composite module that contains the member modules described in the following table.

Workflow Run Order Module Type Usage

1

System.Scheduler

Outputs System.Discovery.Data data on a scheduled, repeating interval and triggers the subsequent probe action to run the Invoke operation.

2

Microsoft.SystemCenter.WSManagement.Invoker

Returns the results of the Invoke operation.
Module Type Usage

Microsoft.SystemCenter.WSManagement.Enumerator

A probe action module type that performs a WS-Management Enumerate operation.

Microsoft.SystemCenter.WSManagement.Getter

A probe action module type that performs a WS-Management Get operation.

Microsoft.SystemCenter.WSManagement.TimedEnumerator

A data source module type that performs a scheduled WS-Management Enumerate operation from within a discovery workflow to return discovery data.

Microsoft.SystemCenter.WSManagement.TimedGetter

A data source module type that performs a scheduled WS-Management Get operation.

External Module References

None.

Remarks

For remarks, see the Microsoft.SystemCenter.WSManagement.Getter module type.

Sample

The following XML sample demonstrates a rule that runs a custom application once a day and alerts if the process fails:

<Rule ID="Microsoft.Samples.TimedInvoker" Target="Windows!Microsoft.Windows.Computer" Enabled="true" ConfirmDelivery="true">
  <Category>Custom</Category>
   <DataSources>
     <DataSource ID="SR" TypeID="WSManLibrary!Microsoft.SystemCenter.WSManagement.TimedInvoker ">
      <Scheduler>
        <SimpleReccuringSchedule>
          <Interval Unit="Hours">24</Interval>
        </SimpleReccuringSchedule>
        <ExcludeDates/>
      </Scheduler>
      <Invoke>
         <Protocol>http</Protocol>
         <TargetSystem>$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$</TargetSystem>
         <Port>80</Port>
         <Authentication>kerberos</Authentication>
         <UserName />
         <Password />
         <SkipCACheck>true</SkipCACheck>
         <SkipCNCheck>true</SkipCNCheck>
         <UTF>utf-8</UTF>
         <Uri>https://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process</Uri>
         <Selector/>
         <InvokeAction>Create</InvokeAction>
         <Input><p:Create_INPUT xmlns:p="https://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process><p:CommandLine>myprocess.exe</p:CommandLine></p:Create_INPUT> </Input>
         <TimeOutInMS>2000</TimeOutInMS>
      </Invoke>
    </DataSource>
  </DataSources>
  <ConditionDetection ID="Filter" TypeID="System!System.ExpressionFilter">
    <Expression>
      <SimpleExpression>
        <ValueExpression>
          <XPathQuery Type="String">p:ReturnValue</XPathQuery>
        </ValueExpression>
        <Operator>NotEqual</Operator>
        <ValueExpression>
          <Value Type="String">0</Value>
        </ValueExpression>
      </SimpleExpression>
    </Expression>
  </ConditionDetection>
  <WriteActions>
    <WriteAction ID="GenerateAlert" TypeID="Health!System.Health.GenerateAlert">
      <Priority>1</Priority>
      <Severity>1</Severity>
      <AlertMessageId>$MPElement[Name="Microsoft.Samples.AlertMessage"]$</AlertMessageId>
      <Suppression>
        <SuppressionValue />
      </Suppression>
    </WriteAction>
  </WriteActions>
</Rule>

The following section shows the data item output from the timed invoker in the preceding section of this sample.

<DataItem type ="Microsoft.SystemCenter.WSManagement.WSManData" time =" 2008-10-23T11:12:51.1451250-04:00 " sourceHealthServiceId =" CC9FCD47-4887-8AE7-A72F-2EACF9C2F1D9 ">
 <WsManData>
  <p:Win32_Process xsi:type ="p:Win32_Process_Type" xml:lang ="en-US">
    <p:ProcessId>5260</p:ProcessId>
    <p:ReturnValue>1</p:ReturnValue>
   </p:Win32_Process>
  </WsManData>
 </DataItem>

Information

   

Module Type

DataSourceModuleType

Input Type

None.

Output Type

Microsoft.SystemCenter.WSManagement.WSManData

Implementation

Composite

Library

Microsoft.SystemCenter.WSManagement.Library