HCL Workload Automation, Version 9.4

jobcancel command - Canceling jobs

Use the jobcancel command to cancel a submitted job.

Syntax

jobcancel ?

jobcancel [-usr user_name -pwd password] -id job_ID [-configFile configuration_file]

Description

This command cancels the running of submitted jobs using the unique ID created at job submission. To retrieve the job ID after submitting the job, you can use the jobquery command specifying the job name.

Options

?
Displays help information.
-usr user_name
Specifies the username for a user authorized to perform operations on the command line. This parameter is required when security is enabled and the username is not defined in the CLIConfig.properties configuration file (with the tdwb_user keyword).
-pwd password
Specifies the password for a user authorized to perform operations on the command line. This parameter is required when security is enabled and the password is not defined in the CLIConfig.properties configuration file (with the tdwb_pwd keyword).
-id job_ID
Specifies the unique job ID created at submission time. This parameter is required.
-configFile configuration_file
Specifies the name and path of a custom configuration file. This parameter is optional. If this parameter is not specified, the default configuration file is assumed. For more information on the configuration file, see Command-line configuration file.

Authorization

The user name and password for the command are defined in the CLIConfig.properties file. To override the settings defined in this file, you can enter the user name and password when typing the command. For more information on the CLIConfig.properties file, see Command-line configuration file.

Return Values

The jobcancel command returns one of the following values:
0
Indicates that jobcancel completed successfully.
< > 0
Indicates that jobcancel failed.

Examples

  1. To cancel the running of a job with ID 617l9jq7037529f83x1w36185e569fwl, type the following command:
    jobcancel -id 617l9jq7037529f83x1w36185e569fwl