Microsoft.Windows.RegistryProviderSingle

System Center

Updated: August 10, 2011

Applies To: Operations Manager 2007 R2

The Microsoft.Windows.RegistryProviderSingle module is a data source module type that queries the Windows registry for a single value or key at a scheduled frequency and returns the results as Microsoft.Windows.RegistryData type data.

Usage

Use this module when you want to query the Windows registry and return the data within a workflow such as a rule or monitor. If you wish to retrieve multiple values or keys, use the Microsoft.Windows.RegistryProvider module.

Type Definition


<DataSourceModuleType ID="Microsoft.Windows.RegistryProviderSingle" Accessibility="Public">
  <Configuration>
    <IncludeSchemaTypes>
      <SchemaType>Microsoft.Windows.RegistryAttributeDefinitionsSchema</SchemaType>
    </IncludeSchemaTypes>
    <xsd:element name="ComputerName" type="xsd:string" />
    <xsd:element name="AttributeName" type="xsd:ID" />
    <xsd:element name="Path" type="xsd:string" />
    <xsd:element name="PathType" type="xsd:integer" />
    <xsd:element name="AttributeType" type="xsd:integer" />
    <xsd:element name="Frequency" type="xsd:unsignedInt" />
    <xsd:element name="RegistryView" minOccurs="0" maxOccurs="1" type="RegistryViewType" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="Frequency" Selector="$Config/Frequency$" ParameterType="int" />
  </OverrideableParameters>
  <ModuleImplementation>
    <Composite>
      <MemberModules>
        <DataSource TypeID="System!System.Scheduler" ID="Scheduler">
          <Scheduler>
            <SimpleReccuringSchedule>
              <Interval Unit="Seconds">$Config/Frequency$</Interval>
            </SimpleReccuringSchedule>
            <ExcludeDates />
          </Scheduler>
        </DataSource>
        <ProbeAction TypeID="Microsoft.Windows.RegistryProbe" ID="Probe">
          <ComputerName>$Config/ComputerName$</ComputerName>
          <RegistryAttributeDefinitions>
            <RegistryAttributeDefinition>
              <AttributeName>$Config/AttributeName$</AttributeName>
              <Path>$Config/Path$</Path>
              <PathType>$Config/PathType$</PathType>
              <AttributeType>$Config/AttributeType$</AttributeType>
              <RegistryView>$Config/RegistryView$</RegistryView>
            </RegistryAttributeDefinition>
          </RegistryAttributeDefinitions>
        </ProbeAction>
      </MemberModules>
      <Composition>
        <Node ID="Probe">
          <Node ID="Scheduler" />
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>Microsoft.Windows.RegistryData</OutputType>
</DataSourceModuleType>

Parameters

The Microsoft.Windows.RegistryProviderSingle module supports the configuration parameters described in the following table.

 

Parameter Type Overrideable Description

ComputerName

String

False

Required parameter. The name of the computer from which to query the registry.

AttributeName

ID

False

Required parameter. An identifier for the value in the output data item. The identifier must consist only of letters, numbers, the underscore, hyphen, and period. Digits, the hyphen, and the period cannot be used to start the name.

Path

String

False

Required parameter. The path to collect in the registry under HKEY_LOCAL_MACHINE. This path can be a key or a value.

PathType

Integer

False

Required parameter. Specifies whether the path is a key or a value.

  • 0—Specifies that the path is to a key, for which the existence of the key should be checked.

  • 1—Specifies that the path is to a value that should be retrieved.

AttributeType

Integer

False

Required parameter. The data type of the value to return:

  • 0—Boolean

  • 1—String

  • 2—Integer

  • 3—Float

Values 1, 2, and 3 are used only when the PathType is set to 1.

Frequency

Unsigned Integer

True

Required parameter. Specifies the frequency, in seconds, at which to run the query over the Windows registry.

RegistryView

RegistryViewType

False

Optional parameter. Specifies the registry view type to access. If unspecified, defaults to a value of “default”.

For more information about the ComputerName parameter, see the Microsoft.Windows.RegistryProbe module.

For more information about the AttributeName, Path, PathType, RegistryView, and AttributeType parameters, see the RegistryViewType schema type.

For more information about the Frequency parameter, see the System.Scheduler module.

Composition

The Microsoft.Windows.RegistryProviderSingle module is a composite module that contains the member modules described in the following table.

 

Workflow Run Order Module Type Usage

1

System.Scheduler

Triggers the subsequent probe module to run at a scheduled, recurring interval.

2

Microsoft.Windows.RegistryProbe

Runs the query on the Windows registry and returns Microsoft.Windows.RegistryData data.

Related Modules

 

Module Type Usage

Microsoft.Windows.RegistryProvider

Queries Windows registry values or keys and returns Microsoft.Windows.RegistryData data.

Microsoft.Windows.Discovery.RegistryProvider

Queries Windows registry keys or values and returns Microsoft.Windows.RegistryData data. This should be used only from within a data source module type definition that returns discovery data.

Microsoft.Windows.Discovery.RegistryProviderSingle

Queries a single Windows registry key or value and returns Microsoft.Windows.RegistryData data. This type has simpler configuration, but only a single value or key can be specified. This should be used only from within a data source module type definition that returns discovery data.

Microsoft.Windows.FilteredRegistryDiscoveryProvider

Queries the Windows registry on a timed interval and returns System.Discovery.Data data. This type takes an expression to filter data on.

Microsoft.Windows.RegistryDiscoveryProvider

Queries the Windows registry and returns System.Discovery.Data data. No filtering of data is provided in this module type. This should be used only when you know that the registry keys and values will always be present.

Microsoft.Windows.RegistryDiscoverySingleProvider

Queries the Windows registry for a single key or value and returns System.Discovery.Data data. No filtering of data is provided in this module type. This should be used only when you know that the registry keys and values will always be present.

External Module References

None.

Sample

The following XML sample shows an example of a task that uses the registry provider single module to return a value from the registry and that generates an alert if the application is not installed.


<Rule ID="Microsoft.Samples.RegistryProvider.ApplicationExists"  Enabled="true" Target="Windows!Microsoft.Windows.Client.Computer"  Remotable="true">
  <Category>Custom</Category>
  <DataSources>
    <DataSource ID="RegistryData" TypeID="Windows!Microsoft.Windows.RegistryProvider">
     <ComputerName>$Target/Host/Property[Type='Windows!Microsoft.Windows.Computer']/NetworkName$</ComputerName>
      <AttributeName>ApplicationXExists</AttributeName>
      <Path>SOFTWARE\OpsMgrSamples\ApplicationX</Path>
      <PathType>0</PathType>
      <AttributeType>0</AttributeType>
    </DataSource>
  </DataSources>
  <ConditionDetection ID=”Filter” TypeID=”System!System.ExpressionFilter”>
    <Expression>
      <SimpleExpression>
        <ValueExpression>
          <XPathQuery Type="String">ApplicationXExists</XPathQuery>
        </ValueExpression>
        <Operator>Equal</Operator>
        <ValueExpression>
          <Value Type="String">false</Value>
        </ValueExpression>
      </SimpleExpression>
    </Expression>
  </ConditionDetection>
  <WriteAction ID="alert" TypeID="Health!System.Health.GenerateAlert">
    <AlertMessageId>$MPElement[Name="Microsoft.ModuleSamples.AlertMessage"]$</AlertMessageId>
    <Priority>0</Priority>
    <Severity>0</Severity>
  </WriteAction>
</Rule>

Information

 

   

Module Type

DataSourceModuleType

Input Type

None

Output Type

Microsoft.Windows.RegistryData

Implementation

Composite

Library

Microsoft.Windows.Library

 
Show: