InvokeSchema

Applies To: Operations Manager 2007 R2

InvokeSchema 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="InvokeSchema">
  <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="Selector" type="xsd:string" />
    <xsd:element name="InvokeAction" type="xsd:string" />
    <xsd:element name="Input" type="xsd:string" />
    <xsd:element name="TimeOutInMS" type="xsd:unsignedLong" />
    <xsd:element name="EventPolicy" type="EventPolicySchema" minOccurs="0" maxOccurs="1" />
  </xsd:sequence>
</xsd:complexType>

Remarks

The InvokeSchema data type contains the parameters described in the following table.

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 parameter value as a RunAsAccount associated with a RunAsProfile under which WsMan runs the module, as shown in the following example:

$RunAs[Name="WSMan!Microsoft.SystemCenter.WSManagement.WSManActionAccount"]/UserName$

The Password parameter can be passed in the same way, as in the following example:

$RunAs[Name="WSMan!Microsoft.SystemCenter.WSManagement.WSManActionAccount"]/Password$

This assumes the reference to 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 value of NetworkDelayms, 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.

Input

The Input parameter must be included whether or not the method requires parameters. If you are calling the StopService method, you would provide the parameter in the following way:

<Input><p:StopService_INPUT xmlns:p="https://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service"/></Input>

If you are calling a method that does require a parameter, such as the Create method on a Win32 process resource, you would provide the parameter in the following way:

<Input>
  <p:Create_INPUT xmlns:p="https://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process">
    <p:CommandLine>calc.exe</p:CommandLine>
  </p:Create_INPUT>
</Input>

Information