streamtool canceljob
The streamtool canceljob command cancels one or more jobs.
Usage
canceljob >>-+---------------+--+------------------+----------------------> '---collectlogs-' '---collectprofile-' >--+-----------------------+--+-+- -f-----+--file-name--+-------> '-+- -d----------+--did-' | '- --file-' | '- --domain-id-' | .-,------. | | V | | +-+- -j-----+----job-id-+-+ | '- --jobs-' | | .-+---+--. | | | '-,-' | | | V | | '---job-id-+--------------' >--+---------+--+-------------+--+-------------------------+----> '---force-' '-+- -h-----+-' '-+- -i------------+--iid-' '- --help-' '- --instance-id-' >--+-----------------+--+-------------------+-------------------> '- --trace--level-' '-+- -U-----+--user-' '- --User-' >--+-----------------------+------------------------------------> '-+- -v--------+--level-' '- --verbose-' >--| Non-interactive tool options |---------------------------->< Non-interactive tool options (1) |--------+-----------------------------+------------------------| +- --embeddedzk---------------+ | .-,---------. | | V | | '- --zkconnect----host:port-+-'
- The non-interactive tool options are not supported in the interactive streamtool interface.
Authority
You must have delete authority for the appropriate jobgroup_name instance object or JOBCONTROL or ALL permissions for the job group. By default, the DomainAdministrator and InstanceAdministrator roles and the user who submits the job have this authority. For more information about access control lists, see the streamtool getacl or streamtool lsjobpermission commands.
Description
This command stops the processing elements (PEs) for the job and removes knowledge of the jobs and their PEs from the instance. The log files for the processing elements are scheduled for removal.
If you specify to collect the PE logs before they are removed, the operation can time out waiting for the termination of PEs. If such a timeout occurs, the operation fails and the jobs or PEs are still in the system. The canceljob command can be run again later to cancel them.
You can use the --force option to ignore a PE termination timeout and force the job to cancel.
See also streamtool getlog.
Options and arguments
- --collectlogs
Specifies to collect the log and trace files for each processing element that is associated with the job.
- --collectprofile
Collects the profile files for each processing element that is associated with the job. These profile files are created when you run the application in profiling mode. They characterize the resource usage, processor consumption, and data traffic, and you can use them for profile-driven fusion optimization when you run the application again.
The profile files are compressed and saved in the current directory as a file called StreamsProfileJobjobID.tgz.
- -d, --domain-id did
Specifies the domain identifier.
If you do not specify this option, InfoSphere® Streams uses the domain name that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain name is StreamsDomain. If you are using the interactive streamtool interface, it uses the name of the active domain for the current streamtool session or else it prompts you for the domain name.
The active domain for the current streamtool session is set every time that you successfully run a streamtool command with a -d or --domain-id option. Alternatively, you can run the streamtool domain command in the interactive interface.
- --embeddedzk
Specifies to use the embedded copy of ZooKeeper. This option is not supported within the interactive streamtool interface.
If you are not using the interactive streamtool interface and you do not specify either this option or the --zkconnect option, InfoSphere Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. InfoSphere Streams determines which connection maps to the domain by using cached information about the domains. In this scenario, if the domain identifier is not unique in the InfoSphere Streams configuration cache, the command fails.
- -f, --file file-name
Specifies the file that contains a list of job IDs, one per line.
- --force
Specifies that if a time-out occurs while the command is waiting for the termination of processing elements, the timeout is ignored. If you also specified the --collectlogs option, the log files for the processing elements are collected, then the processing elements are forced to stop.
- -h, --help
Specifies to show the command syntax.
- -i, --instance-id iid
Specifies the instance identifier.
If you do not specify this option, InfoSphere Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance. If you are using the interactive streamtool interface, it tries to use an instance ID that you specified in a previous command. If no such value is found, the command uses the STREAMS_INSTANCE_ID environment variable. Alternatively, you can run the streamtool instance command in the interactive interface.
- -j, --jobs job-id
Specifies a list of job IDs, which are delimited by commas.
- job-id
Specifies a job identifier.
- --trace level
Specifies the trace setting. The following valid levels are listed in order of increasing verbosity, which is to say that the first level in the list generates the least amount of information:
- off
- error
- warn
- info
- debug
- trace
- -U, --User userid
Specifies an InfoSphere Streams user ID that has authority to run the command.
- -v,--verbose level
Specifies to provide more detailed command output. The vebosity level can be from 0 to 3 where each increment provides more detailed output.
- --zkconnect host:port
The name of one or more host and port pairs that specify the configured ZooKeeper servers. This option is not supported within the interactive streamtool interface.
If you are not using the interactive streamtool interface and you do not specify this option, InfoSphere Streams tries to use:- The --embeddedzk option
- The value from the STREAMS_ZKCONNECT environment variable
- A ZooKeeper connection string that is derived from cached information about the current domain.