Microsoft.SystemCenter.WSManagement.TimedGetter

Applies To: Operations Manager 2007 R2

The Microsoft.SystemCenter.WSManagement.TimedGetter data source module type calls the WS-Management Get operation to access information about a WS-Management object or objects at a specified frequency. This module returns data as Microsoft.SystemCenter.WSManagement.WSManData.

Usage

Use this module to provide information about a WS-Management object or objects from within a discovery or monitoring workflow at a scheduled frequency.

Type Definition

<DataSourceModuleType ID="Microsoft.SystemCenter.WSManagement.TimedGetter" 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="Get" type="GetSchema" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="Protocol" Selector="$Config/Get/Protocol$" ParameterType="string" />
    <OverrideableParameter ID="TargetSystem" Selector="$Config/Get/TargetSystem$" ParameterType="string" />
    <OverrideableParameter ID="Port" Selector="$Config/Get/Port$" ParameterType="int" />
    <OverrideableParameter ID="Authentication" Selector="$Config/Get/Authentication$" ParameterType="string" />
    <OverrideableParameter ID="UserName" Selector="$Config/Get/UserName$" ParameterType="string" />
    <OverrideableParameter ID="Password" Selector="$Config/Get/Password$" ParameterType="string" />
    <OverrideableParameter ID="SkipCACheck" Selector="$Config/Get/SkipCACheck$" ParameterType="bool" />
    <OverrideableParameter ID="SkipCNCheck" Selector="$Config/Get/SkipCNCheck$" ParameterType="bool" />
    <OverrideableParameter ID="OutputErrorIfAny" Selector="$Config/Get/OutputErrorIfAny$" ParameterType="bool" />
    <OverrideableParameter ID="UTF" Selector="$Config/Get/UTF$" ParameterType="string" />
    <OverrideableParameter ID="Uri" Selector="$Config/Get/Uri$" ParameterType="string" />
    <OverrideableParameter ID="Selector" Selector="$Config/Get/Selector$" ParameterType="string" />
    <OverrideableParameter ID="TimeOutInMS" Selector="$Config/Get/TimeOutInMS$" ParameterType="int" />
  </OverrideableParameters>
  <ModuleImplementation Isolation="Any">
    <Composite>
      <MemberModules>
        <DataSource ID="Scheduler" TypeID="System!System.Scheduler">
          <Scheduler>$Config/Scheduler$</Scheduler>
        </DataSource>
        <ProbeAction ID="Getter" TypeID="Microsoft.SystemCenter.WSManagement.Getter">
          <Get>$Config/Get$</Get>
        </ProbeAction>
      </MemberModules>
      <Composition>
        <Node ID="Getter">
          <Node ID="Scheduler" />
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>Microsoft.SystemCenter.WSManagement.WSManData</OutputType>
</DataSourceModuleType>

Parameters

The Microsoft.SystemCenter.WSManagement.TimedGetter 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 Get operation.

Get

GetSchema

False

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

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

For more information about the Get parameter, see GetSchema.

For more information about the Scheduler parameter, see PublicSchedulerType.

Composition

The Microsoft.SystemCenter.WSManagement.TimedGetter 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 Get operation.

2

Microsoft.SystemCenter.WSManagement.Getter

Returns the results of the Get operation.

Module Type Usage

Microsoft.SystemCenter.WSManagement.Enumerator

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

Microsoft.SystemCenter.WSManagement.Invoker

A probe action module type that performs a WS-Management Invoke 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.TimedInvoker

A data source module type that performs a scheduled WS-Management Invoke 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 once a day and checks to see whether the Windows spooler service has started. If it has not been started, the rule generates an alert.

<Rule ID="Microsoft.Samples.TimedGetter" Target="Windows!Microsoft.Windows.Computer" Enabled="true" ConfirmDelivery="true">
  <Category>Custom</Category>
   <DataSources>
     <DataSource ID="SR" TypeID="WSManLibrary!Microsoft.SystemCenter.WSManagement.TimedGetter ">
      <Scheduler>
        <SimpleReccuringSchedule>
          <Interval Unit="Hours">24</Interval>
        </SimpleReccuringSchedule>
        <ExcludeDates/>
      </Scheduler>
      <Get>
        <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_Service</Uri>
        <Selector>Name=spooler</Selector>
        <TimeOutInMS>2000</TimeOutInMS>
     </Get>
    </DataSource>
  </DataSources>
  <ConditionDetection ID="Filter" TypeID="System!System.ExpressionFilter">
    <Expression>
      <SimpleExpression>
        <ValueExpression>
          <XPathQuery Type="String">p:State</XPathQuery>
        </ValueExpression>
        <Operator>NotEqual</Operator>
        <ValueExpression>
          <Value Type="String">Running</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 getter 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_Service xsi:type ="p:Win32_Service_Type" xml:lang ="en-US">
  <p:AcceptPause>false</p:AcceptPause>
  <p:AcceptStop>true</p:AcceptStop>
  <p:Caption>Print Spooler</p:Caption>
  <p:CheckPoint>0</p:CheckPoint>
  <p:CreationClassName>Win32_Service</p:CreationClassName>
  <p:Description>Manages all local and network print queues and controls all printing jobs. If this service is stopped, printing on the local machine will be unavailable. If this service is disabled, any services that explicitly depend on it will fail to start.</p:Description>
  <p:DesktopInteract>true</p:DesktopInteract>
  <p:DisplayName>Print Spooler</p:DisplayName>
  <p:ErrorControl>Normal</p:ErrorControl>
  <p:ExitCode>0</p:ExitCode>
  <p:InstallDate xsi:nil =" true " />
  <p:Name>spooler</p:Name>
  <p:PathName>C:\WINDOWS\system32\spoolsv.exe</p:PathName>
  <p:ProcessId>1252</p:ProcessId>
  <p:ServiceSpecificExitCode>0</p:ServiceSpecificExitCode>
  <p:ServiceType>Own Process</p:ServiceType>
  <p:Started>true</p:Started>
  <p:StartMode>Auto</p:StartMode>
  <p:StartName>LocalSystem</p:StartName>
  <p:State>Stopped</p:State>
  <p:Status>OK</p:Status>
  <p:SystemCreationClassName>Win32_ComputerSystem</p:SystemCreationClassName>
  <p:SystemName>RED-DC-01</p:SystemName>
  <p:TagId>0</p:TagId>
  <p:WaitHint>0</p:WaitHint>
 </p:Win32_Service>
  </WsManData>
 </DataItem>

Information

   

Module Type

DataSourceModuleType

Input Type

None.

Output Type

Microsoft.SystemCenter.WSManagement.WSManData

Implementation

Composite

Library

Microsoft.SystemCenter.WSManagement.Library