streamtool lsjobs
The streamtool lsjobs command lists the jobs in the instance.
Usage
lsjobs >>-+-----------------------+--+---------------------+-----------> '-+- -d----------+--did-' '- --fmt--format-spec-' '- --domain-id-' >--+---------+--+-------------------------+---------------------> +- -h-----+ '-+- -i------------+--iid-' '- --help-' '- --instance-id-' >--+-------------------------+--+---------------------------+---> | .-,------. | | .-,--------. | | V | | | V | | '-+- -j-----+----job-id-+-' '- --jobnames----job-name-+-' '- --jobs-' >--+------------------+--+-----------------+--------------------> '- --showtimestamp-' '- --trace--level-' >--+---------------------+--+--------------------------+--------> '-+- -U-----+--userid-' | .-,------. | '- --User-' | V | | '-+- -u------+----userid-+-' '- --users-' >--+-----------------------+--+-------------+-------------------> '-+- -v--------+--level-' '- --xheaders-' '- --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 search authority for the jobs instance object and read authority for the appropriate jobgroup_name instance object. By default, the DomainAdministrator and InstanceAdministrator roles have this authority. If the user who submits the job has the InstanceUser role, they also have this authority. For more information about access control lists, see streamtool getacl.
Description
The streamtool lsjobs command provides a health summary for each job. The health summary is an aggregation of the PE health summaries for the job. If all of the PEs for a job are reported as healthy, the job is reported as healthy. Otherwise, the job is reported as not healthy. Use the streamtool lspes command to determine the health of PEs.
The command also reports the status of each job.
The date and time that the job was submitted are presented in local time with the iso8601 format: yyyy-mm-ddThh:mm:ss+/-hhmm, where the final hhmm values are the local offset from UTC. For example: 2010-03-16T13:41:53-0500.
When job selection options are specified, selected jobs must meet all of the selection criteria.
Options and arguments
- -d, --domain-id did
Specifies the domain identifier.
If you do not specify this option, IBM® 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, IBM Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. IBM 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 IBM Streams configuration cache, the command fails.
- --fmt format-spec
Specifies the presentation format. The command supports the following values:
- %Mf: Multiline record format. One line per field.
- %Nf: Name prefixed field table format. One line per job.
- %Tf: Standard table format, which is the default. One line per job.
- -h, --help
Specifies to show the command syntax.
- -i, --instance-id iid
Specifies the instance identifier.
If you do not specify this option, IBM 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.
- --jobnames job-name
Specifies a list of job names, which are delimited by commas.
- --showtimestamp
Specifies to show a timestamp in the output to indicate when the command was run.
- --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, --users userid
Specifies to select from this list of user IDs, which are delimited by commas.
- -U, --User userid
Specifies an IBM Streams user ID that has authority to run the command.
- -v,--verbose level
Specifies to provide more detailed command output. The verbosity level can be 0-3, where 0 disables detailed reporting and each increment provides more detailed output.
- --xheaders
Specifies to exclude headings from the report.
- --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, IBM 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.
Examples
The following example uses the streamtool lsjobs command with the multiline record format:[streamtool <bsmith@StreamsDomain.StreamsInstance>] lsjobs --fmt %Mf
=================================================
Instance: StreamsInstance
=================================================
Id : 0
State : Running
Healthy : yes
User : bsmith
Date : 2015-03-03T18:07:16-0500
Name : sample.CommodityPurchasing::AutomatedBuyer_0
Group : default
=================================================
...