.png)
Stop-HpcOperation
Cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running.
Syntax
Stop-HpcOperation [-Scheduler <string>] [-Operation] <HpcOperation> [-confirm] [-whatif] [<CommonParameters>]
Detailed Description
Cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running.
Parameters
-Operation <HpcOperation>
Specifies an HpcOperation object for the operation that you want to cancel. Use the Get-HpcOperation cmdlet to get the HpcOperation object for the operation.
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
no default |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Scheduler <string>
Specifies the host name or IP address of the head node for the cluster on which the operation is running. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:
Set-Content Env:CCP_SCHEDULER <head_node_name>
|
Required? |
false |
|
Position? |
named |
|
Default Value |
%CCP_SCHEDULER% |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
|
Input Type |
An HpcOperation object. |
|
Return Type |
None. |
Example 1
C:\PS>Get-HpcOperation -State Executing -Name "Performing maintenance on node CONTOSO\ComputeNode2." | Stop-HpcOperation
Gets the HpcOperation object for the operation named "Performing maintenance on node CONTOSO\ComputeNode2." and that is in the Executing state, and cancels the operation by redirecting the HpcOperation object to the Stop-HpcOperation cmdlet.
