Stop-HpcOperation

Stop-HpcOperation

Cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running.

Syntax

Parameter Set: Default
Stop-HpcOperation [-Operation] <HpcOperation> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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.

Parameters

-ClusterConnectionString<String[]>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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.


Aliases

none

Required?

true

Position?

1

Default Value

none

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • HpcOperation

Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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 –Confirm or –Confirm:$True.

  • You must be a cluster administrator to run this cmdlet successfully.

Examples

Example 1: Get an operation and stop it

This 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.


PS C:\> Get-HpcOperation -State Executing -Name "Performing maintenance on node CONTOSO\ComputeNode02." | Stop-HpcOperation

Related topics

Community Additions

ADD
Show: