3.1.5.3.9 Rules for the wxf:Signal Message
A wxf:Signal message can be sent either to a RunspacePool or pipeline (as specified in [MS-WSMV] section 3.1.4.12). The client uses a signal to stop an executing pipeline on the server. The following information MUST be supplied to the message.
|
Element |
Value |
|---|---|
|
ResourceURI |
The Resource URI of the RunspacePool to which this wxf:Signal message is targeted. For more details, see section 3.1.5.3.3. |
|
ShellId |
The ShellID returned in the wxf:ResourceCreated message (see section 3.1.5.3.2). |
The message requires a signal complex data type in the body of the message as defined in [MS-WSMV] section 2.2.4.38. The following information is sent in the signal complex data type.
|
Element |
Value |
|---|---|
|
Code |
The value MUST be "powershell/signal/crtl_c". |
A wxf:Signal message can be sent to a RunspacePool or pipeline. If the wxf:Signal message is targeted to a pipeline it MUST contain the following attribute in the Signal complex data type.
|
Element |
Attribute |
Value |
|---|---|---|
|
Signal |
CommandId |
The CommandId returned in the wxf:CommandResponse message (see section 3.1.5.3.4). This attribute MUST NOT be specified if the wxf:Signal message is targeted to a RunspacePool. |
If the wxf:Signal message is successfully received and processed by the server, the server MUST send either a success or a failure message. In either case a response is sent from the server. A wxf:SignalResponse message, described in [MS-WSMV] section 3.1.4.12, is sent to notify success. A wxf:Fault message, described in [MS-WSMV] section 2.2.4.43, is sent to notify failure.
Note that the PowerShell Remoting Protocol never sends a wxf:Signal message to a RunspacePool, although the underlying WSMV protocol supports it. No PSRP messages are sent using wxf:Signal.