Microsoft.Windows.Win32ServiceInformationProvider

Article
05/16/2012

Applies To: Operations Manager 2007 R2

The Microsoft.Windows.Win32ServiceInformationProvider data source module type monitors the state of the specified service for changes. The module returns the data as System.PropertyBagData data.

Usage

This module will poll the Service Control Manager for changes of the Win32 service at the specified frequency. It will return data when it makes its first state query and when the information changes or at every tenth poll interval.

Type Definition

<DataSourceModuleType ID="Microsoft.Windows.Win32ServiceInformationProvider" Accessibility="Public">
  <Configuration>
    <xsd:element name="ComputerName" type="xsd:string" />
    <xsd:element name="ServiceName" type="xsd:string" />
    <xsd:element name="Frequency" type="xsd:integer" />
    <xsd:element name="DisableCaching" minOccurs="0" maxOccurs="1" type="xsd:boolean" />
    <xsd:element name="CheckStartupType" minOccurs="0" maxOccurs="1" type="xsd:string" />
  </Configuration>
  <ModuleImplementation>
    <Native>
      <ClassID>47AA3039-7E86-4b81-B295-67187EDFF3D7</ClassID>
    </Native>
  </ModuleImplementation>
  <OutputType>System!System.PropertyBagData</OutputType>
</DataSourceModuleType>

Parameters

The Microsoft.Windows.Win32ServiceInformationProvider module supports the following configuration parameters:

Parameter	Type	Description
ComputerName	String	Optional parameter. The name of the computer to query. If not specified, the computer name defaults to the local computer.
ServiceName	String	Required parameter. The service name to query.
Frequency	Integer	Required parameter. The frequency in seconds at which the module is to poll for state changes.
DisableCaching	Boolean	Optional parameter. Defaults to false. Determines whether or not to cache the service information between polls. If true, the module will always return fresh data
CheckStartupType	String	Not currently used.

ComputerName

The ComputerName configuration parameter is most commonly passed to the module by using the $Target notation, although it can be specified as any string.

The module attempts to connect to either the local computer’s Service Control Manager or to a remote computer’s Service Control Manager, depending on the configuration that is passed.

For a workflow that is targeted at a Windows-based computer, the ComputerName parameter is specified as follows:

<ComputerName>$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/NetworkName$</ComputerName>

If the target is a class that is hosted by computer hosting, references are added as required. For example:

<ComputerName>$Target/Host/Property[Type="Windows!Microsoft.Windows.Computer"]/NetworkName$</ComputerName>

ServiceName

The service name specifies the short name of the Windows service to collect data on. For example:

<ServiceName>spooler</ServiceName>

DisableCaching

When caching is enabled, the module caches the service information data until it polls the Service Control Manager and discovers that the data has changed. If changed, the module updates the cached data and returns it as output. You can disable this caching feature, but doing so will cause the module to return data at every polling interval instead of only returning when the data has changed or when the polling interval count has reached a multiple of 10.

Composition

The Microsoft.Windows.Win32ServiceInformationProvider module is a native module.

Module Type	Usage
Microsoft.Windows.NTServiceStateProvider	Provides the state information of a specific Windows NT service.
Microsoft.Windows.Win32ServiceInformationProbe	Provides information about the specified Win32 service.

External Module References

The Microsoft.Windows.Win32ServiceInformationProvider module is a member of the following modules:

Module Type	Library	Usage

Remarks

The module outputs a property bag object that contains data about the service that was queried. To see the data item’s structure, see the Remarks section in Microsoft.Windows.Win32ServiceInformationProbe.

Sample

Information


Module Type	DataSourceModuleType
Input Type	None
Output Type	System.PropertyBagData
Implementation	Native
Library	Microsoft.Windows.Library