Stop-HpcJob

Reference

Module:: HPCPack2016

Cancels a job.

Syntax

Stop-HpcJob
    [-Id] <Int32[]>
    [-Message <String>]
    [-State <String>]
    [-Force]
    [-Graceful]
    [-ClusterConnectionString <String[]>]
    [-Scheduler <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-HpcJob
    -Job <HpcJob[]>
    [-Message <String>]
    [-State <String>]
    [-Force]
    [-Graceful]
    [-ClusterConnectionString <String[]>]
    [-Scheduler <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-HpcJob cmdlet cancels one or more specified jobs. You can specify the job by using its ID or by using the HpcJob object for the job. You can specify that you want to cancel the job immediately, without using the grace period for task cancelation and without running the node release task. You can also specify that the state of the job after it is canceled should be Finished instead of Canceled, and you can specify an error message to explain why you canceled the jobs.

When you cancel a job, the job scheduler removes the job from the job queue if the job is waiting to run. If the job is running, the scheduler by default stops the tasks that are running, and it frees the resources that those tasks were using so that they can be allocated to another job.

Only an administrator or the owner of the job can cancel a job.

Examples

Example 1: Stop a job by ID

PS C:\>Stop-HpcJob -Id 45 -Message "Clearing space for Job 51, which needs to run immediately."

This command cancels the job with an ID of 45 and provides the user with a cancellation message that explains that you canceled the job to make room for a different job to run.

Example 2: Stop a job immediately

PS C:\>Stop-HpcJob -Id 39 -Force

This command cancels the job with an ID of 39 immediately, without using the grace period for task cancelation and without running the node release task.

Example 3: Create a job, add a task to it, submit it, and then stop it

PS C:\>$Job = New-HpcJob -RunUntilCanceled $True -NumCores "1-3" 
PS C:\> $Job | Add-HpcTask -Command "echo Hello World!" 
PS C:\> $Job | Submit-HpcJob$Job | Stop-HpcJob -State "Finished"

This command creates a job with the RunUntilCanceled property set to $True, adds a task to the job, submits the job to the HPC cluster, and then cancels the job so that it has a state of Finished.

Example 4: Stop a job gracefully

PS C:\>Stop-HpcJob -Id 27 -Graceful -State "Finished"

This command cancels the job with an ID of 27 gracefully, by allowing running tasks to complete, and sets the job state to finished.

Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.

This parameter was introduced in HPC Pack 2016.

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

-Force

Stops the job immediately, without using the grace period for task cancelation and without running the node release task, if the job contains one.

This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Graceful

Stops the job gracefully, by letting running tasks complete.

This parameter was introduced in HPC Pack 2012 R2 Update 1. It is not supported in previous versions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies an array of IDs for the jobs that you want to cancel. Specify the Id parameter or the Job parameter, but not both.

Type:	Int32[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Job

Specifies an array of HpcJob objects that represent the jobs that you want to cancel.

Type:	HpcJob[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Message

Specifies an error message to provide to the user that explains why you canceled the job.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Scheduler

Specifies the host name or IP address of the head node for the cluster to which you submitted the job. 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

-State

Specifies the state of the job after it is canceled. The only valid value is Finished. If you do not specify the State parameter, the job has a state of Canceled after it is canceled. Use this parameter when you want to end a job that has the RunUntilCanceled property set to true, and want to set the state of the job to Finished because you have an alternate way to check that the job finished.