task finish
Finishes a specified running or queued task or subtask.
For examples of how to use this command, see Examples.
Note
This subcommand was introduced in HPC Pack 2012 R2 Update 1 and is not supported in previous versions.
Syntax
task finish <jobID>.<taskID>[.<subtaskID>] [/message:<message>]
[/scheduler:<name>]
task finish {/? | /help}
Parameters
| Parameter | Description |
|---|---|
| <jobID>.<taskID>[.<subtaskID>] | Specifies the task or subtask that you want to finish. Only parametric tasks have subtasks. For a parametric task, you can finish a subtask or the entire task. |
| /message:<message> | Specifies a message to add to the log for the task to explain why you finish the task. If the message contains spaces, enclose the message in double quotes (" "). |
| /scheduler:<name> | Specifies the host name or IP address of the head node for the cluster to which you submitted the task or subtask. The value must be a valid computer name or IP address. If you do not specify the /scheduler parameter, this command uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. |
| /? | Displays Help at the command prompt. |
| /help | Displays Help at the command prompt. |
Remarks
Only an administrator or the owner of a task can finish the task.
When you finish a task or subtask, the job scheduler removes the task or subtask from the queue if the task or subtask is waiting to run. If the task or subtask is running, the job scheduler immediately stops the task or subtask and sets the state of the task to Finished.
Examples
To finish the first task in the job with a job identifier of 3, and add a message to the task log, use the following command:
task finish 3.1 /message:"Finishing the task"