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
[-Operation] <HpcOperation>
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Stop-HpcOperation cmdlet cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running.
Examples
Example 1: Get an operation and stop it
PS C:\>Get-HpcOperation -State Executing -Name "Performing maintenance on node CONTOSO\ComputeNode02." | Stop-HpcOperationThis command gets the HpcOperation object for the operation named "Performing maintenance on node CONTOSO\ComputeNode02." and that is in the Executing state, and cancels the operation by redirecting the HpcOperation object to the Stop-HpcOperation cmdlet.
Parameters
-ClusterConnectionString
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Operation
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.
| Type: | HpcOperation |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scheduler
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\>
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
HpcOperation
Outputs
None
Notes
- The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify
-Confirm:$False. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify-Confirmor-Confirm:$True. - You must be a cluster administrator to run this cmdlet successfully.