Microsoft.SystemCenter.WSManagement.Getter
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
The Microsoft.SystemCenter.WSManagement.Getter probe action module type calls the WS-Management Get operation to access information about a WS-Management resource or resources. This module returns data as Microsoft.SystemCenter.WSManagement.WSManData.
Usage
Use this module to provide information about a WS-Management resource or resources from within a discovery or monitoring workflow.
Type Definition
<ProbeActionModuleType ID="Microsoft.SystemCenter.WSManagement.Getter" Accessibility="Public" RunAs="Microsoft.SystemCenter.WSManagement.WSManActionAccount" Batching="false" PassThrough="false">
<Configuration>
<IncludeSchemaTypes>
<SchemaType>Microsoft.SystemCenter.WSManagement.Schemas</SchemaType>
</IncludeSchemaTypes>
<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">
<Native>
<ClassID>20073FC6-F8BA-466A-BAB8-92DEF165BF6F</ClassID>
</Native>
</ModuleImplementation>
<OutputType>Microsoft.SystemCenter.WSManagement.WSManData</OutputType>
<InputType>System!System.BaseData</InputType>
</ProbeActionModuleType>
Parameters
The Microsoft.SystemCenter.WSManagement.Getter module supports the configuration parameters described in the following table.
| Parameter | Type | Overrideable | Description |
|---|---|---|---|
Get |
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.
Composition
The Microsoft.SystemCenter.WSManagement.Getter module is a native module.
Related Modules
| Module Type | Usage |
|---|---|
A probe action module type that performs a WS-Management Enumerate operation. |
|
A probe action module type that performs a WS-Management Invoke operation. |
|
A data source module type that performs a scheduled WS-Management Enumerate operation from within a discovery workflow to return discovery data. |
|
A data source module type that performs a scheduled WS-Management Invoke operation. |
External Module References
The Microsoft.SystemCenter.WSManagement.Getter 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 scheduled WS-Management Get operations. |
Remarks
WS-Management is a standards-based Web services API described by the Distributed Management Task Force (DMTF). This probe action module type depends on the Windows implementation of this standard, called Windows Remote Management (WINRM).
To use this module, the computer that is running the workflows that call the WS-Management modules needs to have WS-Management version 1.1 installed. This also must be installed on each Operations Manager agent or management server where rules, discoveries, monitors, or tasks that use WS-Management must run.
WS-Management can be downloaded from the Microsoft Download Center.
This module is configured to use the global RunAs account Microsoft.SystemCenter.WSManagement.WSManActionAccount. The profile display name for this account is WS-Management Action account.
If this profile is not configured, the workflow uses the agent’s Action Account that was specified when the agent was installed.
For information about Windows Remote Management, see Windows Remote Management Command Line Tool and Windows Remote Management.
Sample
The following XML sample demonstrates a task that is implemented to get information about the Win32 Print Spooler service:
<Task ID="WSMan.Demo.Task.Get" Accessibility="Internal" Enabled="true" Target="Windows!Microsoft.Windows.Computer" Timeout="300" Remotable="true">
<Category>Custom</Category>
<ProbeAction ID="wsmanget" TypeID="MicrosoftSystemCenterWSManagementLibrary!Microsoft.SystemCenter.WSManagement.Getter">
<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>
</ProbeAction>
</Task>
The following section of this sample shows the data item output from the task in the preceding section.
<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>
</WsManData>
</DataItem>
Information
Module Type |
|
Input Type |
|
Output Type |
|
Implementation |
Native |
Library |
Microsoft.SystemCenter.WSManagement.Library |