8.6.8 stoptask (stopping a task)

Description

This command stops execution of a task by specifying the ID of the task.

Syntax

stoptask

     /taskid task-ID

     /user user-ID

     {/password password | /passwordfile password-file-path}

Arguments

/taskid task-ID

This option specifies the task ID of the task of which you want to stop execution.

The possible values are half-width numeric characters (in decimal number) in 16 or fewer digits.

/user user-ID

This option specifies the user ID for JP1/AO.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are half-width alphanumeric characters, !, #, $, %, &, ', (, ), *, +, -, ., =, @, \, ^, _, and |.

This option is not case sensitive.

/password password

This option specifies the password of the user indicated by the /user option.

You must specify either this option or the /passwordfile option. If both options are specified, or if neither are specified, then you will get an error.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are the same as those for the /user option.

/passwordfile password-file-path

This option specifies the absolute or relative path to the password file for the user specified in the /user option. You can create a password file by using the encryptpassword command.

You must specify either this option or the /password option. If both options are specified, or if neither are specified, then you will get an error.

Located in

JP1/AO-installation-folder\bin

Execute permission

Execute the command as a user with Administrator permissions for the OS. If a user without Administrator permissions executes the command, a message appears asking the user to elevate the permission level.

The Admin, Develop, Modify, or Submit role must be set for the resource group of the target task from the user group that the user who executes the command belongs to. The command does not stop any tasks in a resource group for which none of these roles are set.

Return code

The following table lists the return codes from the command.

Return code	Description
0	The command succeeded.
1	The argument is invalid.
2	The command execution has been interrupted.
3	The service status is invalid.
5	Communication failed.
6	Authentication failed.
7	An invalid path is specified.
9	The specified path does not exist.
14	You do not have permission to execute the command.
140	Stopping the execution of the task failed.
255	The command execution has been interrupted due to an error other than the above.

Example

The following command shows an example of how to stop execution of the task with the specified task ID:

stoptask /taskid 0001 /user user01 /password pass01

Related topic

• 8.3 Valid characters for arguments in a command