Microsoft.SystemCenter.WSManagement.Enumerator
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
The Microsoft.SystemCenter.WSManagement.Enumerator probe action module type calls the WS-Management Enumerate operation on a WS-Management resource. This module returns the results of the enumeration as Microsoft.SystemCenter.WSManagement.WSManData.
Usage
Use this module to enumerate instances of a WS-Management resource and return the results from within a workflow.
Type Definition
<ProbeActionModuleType ID="Microsoft.SystemCenter.WSManagement.Enumerator" Accessibility="Public" RunAs="Microsoft.SystemCenter.WSManagement.WSManActionAccount" Batching="false" PassThrough="false">
<Configuration>
<IncludeSchemaTypes>
<SchemaType>Microsoft.SystemCenter.WSManagement.Schemas</SchemaType>
</IncludeSchemaTypes>
<xsd:element name="Enumerate" type="EnumerateSchema" />
</Configuration>
<OverrideableParameters>
<OverrideableParameter ID="Protocol" Selector="$Config/Enumerate/Protocol$" ParameterType="string" />
<OverrideableParameter ID="TargetSystem" Selector="$Config/Enumerate/TargetSystem$" ParameterType="string" />
<OverrideableParameter ID="Port" Selector="$Config/Enumerate/Port$" ParameterType="int" />
<OverrideableParameter ID="Authentication" Selector="$Config/Enumerate/Authentication$" ParameterType="string" />
<OverrideableParameter ID="UserName" Selector="$Config/Enumerate/UserName$" ParameterType="string" />
<OverrideableParameter ID="Password" Selector="$Config/Enumerate/Password$" ParameterType="string" />
<OverrideableParameter ID="SkipCACheck" Selector="$Config/Enumerate/SkipCACheck$" ParameterType="bool" />
<OverrideableParameter ID="SkipCNCheck" Selector="$Config/Enumerate/SkipCNCheck$" ParameterType="bool" />
<OverrideableParameter ID="OutputErrorIfAny" Selector="$Config/Enumerate/OutputErrorIfAny$" ParameterType="bool" />
<OverrideableParameter ID="UTF" Selector="$Config/Enumerate/UTF$" ParameterType="string" />
<OverrideableParameter ID="Uri" Selector="$Config/Enumerate/Uri$" ParameterType="string" />
<OverrideableParameter ID="Filter" Selector="$Config/Enumerate/Filter$" ParameterType="string" />
<OverrideableParameter ID="TimeOutInMS" Selector="$Config/Enumerate/TimeOutInMS$" ParameterType="int" />
<OverrideableParameter ID="SplitItems" Selector="$Config/Enumerate/SplitItems$" ParameterType="bool" />
</OverrideableParameters>
<ModuleImplementation Isolation="Any">
<Native>
<ClassID>91564CE8-81DE-4D52-9AC5-A6FB6B9AB0EB</ClassID>
</Native>
</ModuleImplementation>
<OutputType>Microsoft.SystemCenter.WSManagement.WSManData</OutputType>
<InputType>System!System.BaseData</InputType>
</ProbeActionModuleType>
Parameters
The Microsoft.SystemCenter.WSManagement.Enumerator module supports the configuration parameters described in the following table.
| Parameter | Type | Overrideable | Description |
|---|---|---|---|
Enumerate |
False |
Contains the schema used to specify the set of properties required to perform a WS-Management Enumerate operation |
All of the sub-elements in the Enumerate parameter are marked as overrideable.
For more information about the Enumerate parameter, see EnumerateSchema.
Composition
The Microsoft.SystemCenter.WSManagement.Enumerator module is a native module.
Related Modules
| Module Type | Usage |
|---|---|
A probe action module type that performs a WS-Management Invoke operation. |
|
A probe action module type that performs a WS-Management Get operation. |
|
A data source module type that performs a scheduled WS-Management Get operation. |
|
A data source module type that performs a scheduled WS-Management Invoke operation. |
External Module References
The Microsoft.SystemCenter.WSManagement.Enumerator module is a member of the module described in the following table.
| Module Type | Library | Usage |
|---|---|---|
Microsoft.SystemCenter.WSManagement.Library |
A data source module type that performs a scheduled WS-Management Enumerate operation from within a discovery workflow to return discovery data. |
Remarks
For remarks, see the Microsoft.SystemCenter.WSManagement.Getter module type.
Sample
The following XML sample demonstrates a task that enumerates all running instances of the Win32_Service resource on the target computer:
<Task ID="WSMan.Demo.Task.Enumerate" Accessibility="Internal" Enabled="true" Target="Windows!Microsoft.Windows.Computer" Timeout="300" Remotable="true">
<Category>Custom</Category>
<ProbeAction ID="wsmanget" TypeID="WSManLibrary!Microsoft.SystemCenter.WSManagement.Enumerator">
<Enumerate>
<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>
<Filter>SELECT * FROM Win32_Service WHERE State=’Running'</Filter>
<TimeOutInMS>2000</TimeOutInMS>
<SplitItems>false</SplitItems>
</Enumerate>
</ProbeAction>
</Task>
The following XML shows sample data item output from the task in the preceding section of this example.
<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>Running</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>
<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>Virtual Disk</p:Caption>
<p:CheckPoint>0</p:CheckPoint>
<p:CreationClassName>Win32_Service</p:CreationClassName>
<p:Description>Provides management services for disks, volumes, file systems, and storage arrays.</p:Description>
<p:DesktopInteract>false</p:DesktopInteract>
<p:DisplayName>Virtual Disk</p:DisplayName>
<p:ErrorControl>Normal</p:ErrorControl>
<p:ExitCode>0</p:ExitCode>
<p:InstallDate xsi:nil ="true" />
<p:Name>vds</p:Name>
<p:PathName>C:\WINDOWS\system32\vds.exe</p:PathName>
<p:ProcessId>1254</p:ProcessId>
<p:ServiceSpecificExitCode>0</p:ServiceSpecificExitCode>
<p:ServiceType>Own Process</p:ServiceType>
<p:Started>true</p:Started>
<p:StartMode>Manual</p:StartMode>
<p:StartName>LocalSystem</p:StartName>
<p:State>Running</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 |
|
Input Type |
|
Output Type |
|
Implementation |
Native |
Library |
Microsoft.SystemCenter.WSManagement.Library |