EnumerateSchema
Applies To: Operations Manager 2007 R2
EnumerateSchema is a complex data type that is used to specify the set of properties required to perform a WS-Management Invoke operation.
Schema Definition
<xsd:complexType name="EnumerateSchema">
<xsd:sequence>
<xsd:element name="Protocol" type="ProtocolType" />
<xsd:element name="TargetSystem" type="xsd:string" />
<xsd:element name="Port" type="PortType" />
<xsd:element name="Authentication" type="AuthenticationType" />
<xsd:element name="UserName" type="xsd:string" />
<xsd:element name="Password" type="xsd:string" />
<xsd:element name="SkipCACheck" type="xsd:boolean" />
<xsd:element name="SkipCNCheck" type="xsd:boolean" />
<xsd:element name="OutputErrorIfAny" type="xsd:boolean" minOccurs="0" maxOccurs="1" />
<xsd:element name="UTF" type="UtfType" />
<xsd:element name="Uri" type="xsd:string" />
<xsd:element name="Filter" type="xsd:string" />
<xsd:element name="SplitItems" type="xsd:boolean" minOccurs="0" maxOccurs="1" />
<xsd:element name="EventPolicy" type="EventPolicySchema" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
Remarks
The EnumerateSchema data type contains the parameters described in the following table.
| Parameter | Type | Description |
|---|---|---|
Protocol |
String |
Contains a string specifying the ProtocolType value that is used to communicate between computers. The supported values are HTTP and HTTPS. |
TargetSystem |
String |
Specifies the system against which the request is submitted. This can be a fully qualified domain name or an IP address. For more information, see notes later in this document. |
Port |
Integer |
Specifies the port number for the request. Must be a value in the range of 0 to 65535. |
Authentication |
String |
Contains the AuthenticationType value to use for communicating. Currently supported values are:
|
UserName |
String |
Contains the user name used for authentication. For use with Basic, Digest, and Negotiate authentication only. For more information, see notes later in this document. |
Password |
String |
Contains the password that is used for authentication. For use with Basic, Digest, and Negotiate authentication only. For more information, see notes later in this document. |
SkipCACheck |
Boolean |
Specifies whether to skip any validations against the certification authority (CA) on the target system. Enabling this flag causes the modules to trust the certificate on a target system, even if they are self-signed. |
SkipCNCheck |
Boolean |
Specifies that computer name and server certificate common name (CN) check should be skipped. For more information, see notes later in this document. |
OutputErrorIfAny |
Boolean |
Optional. Specifies whether to output any errors. Default value is false. |
UTF |
String |
Specifies the encoding format. Currently supported values are UTF-8 and UTF-16. |
Uri |
String |
Contains the complete URI for the object to be enumerated. |
Filter |
String |
Provides a filter that constrains the number instances returned. Supported only if the resource object supports filtering. |
TimeOutInMS |
unsigned Integer |
Specifies the amount of time to wait for the response from the computer on which the enumeration is to take place. Default value is 60,000 milliseconds (60 seconds). For more information, see notes later in this document. |
SplitItems |
Boolean |
Specifies whether or not the returned enumeration items should be returned separately from the module. |
EventPolicy |
Integer |
Not used. |
TargetSystem
This parameter is often passed by a substitution parameter based on the target or other configuration, as in the following example:
$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$
UserName and Password
For Kerberos and Negotiate authentication, the UserName parameter can still be passed, but it does not affect the outcome of the calling method.
You can also pass in the UserName value as a RunAsAccount associated with a RunAsProfile under which WsMan runs the module, as in the following example:
$RunAs[Name="WSMan!Microsoft.SystemCenter.WSManagement.WSManActionAccount"]/UserName$
The Password parameter can be passed in the same way, as follows:
$RunAs[Name="WSMan!Microsoft.SystemCenter.WSManagement.WSManActionAccount"]/Password$
This assumes the reference to the Microsoft.SystemCenter.WSManagement.Library has been set to WSMan, as in the following example:
<Reference Alias="WSMan">
<ID>Microsoft.SystemCenter.WSManagement.Library</ID>
<Version>6.0.6278.0</Version>
<PublicKeyToken>31bf3856ad364e35</PublicKeyToken>
</Reference>
SkipCNCheck
When using HTTPS, the computer name must match the server's certificate common name (CN) unless the SkipCNCheck parameter is set to true. This parameter should be set to true when communicating with a device using HTTPS and using an IP address (rather than a fully qualified domain name) or when the name under which the certificate has been issued is different from the name of the target system.
TimeOutInMS
When this parameter is overridden, WS-Management uses the overridden value or four times the NetworkDelayms value, whichever is greater. The value in NetworkDelayms can be found by running the following at the command prompt:
winrm get winrm/Config/Client
For more information about URIs, see Resource URIs.
SplitItems
This parameter determines whether or not to return each enumerated item separately. If SplitItems is set to true, each returned data item would have the following format:
<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:Win32_Service>
</WSManData>
</DataItem>
If SplitItems is set to false, the returned data items have the following format:
<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:Win32_Service>
<p:Win32_Service xsi:type ="p:Win32_Service_Type" xml:lang ="en-US"><
</p:Win32_Service>
<p:Win32_Service xsi:type ="p:Win32_Service_Type" xml:lang ="en-US"><
</p:Win32_Service>
</WSManData>
</DataItem>
For more information about URIs, see Resource URIs.
Information
Schema Type |
Microsoft.SystemCenter.WSManagement.WSManData |
Library |
Microsoft.SystemCenter.WSManagement.Library |