IBM InfoSphere Streams Version 4.1.1

streamtool lsinstance

The streamtool lsinstance command lists the instances in a domain.

Usage

Read syntax diagramSkip visual syntax diagram
lsinst, lsinstance

>>-+------------+--+-----------------------+--+---------+------->
   +-+- -a----+-+  '-+- -d----------+--did-'  +- -h-----+   
   | '- --all-' |    '- --domain-id-'         '- --help-'   
   '- --started-'                                           

>--+---------------+--+-----------------+----------------------->
   '- --owner--uid-'  '- --trace--level-'   

>--+---------------------+--+-----------------------+----------->
   '-+- -U-----+--userid-'  '-+- -v--------+--level-'   
     '- --User-'              '- --verbose-'            

>--| Non-interactive tool options |--+------------------+------><
                                     '-iid-name-pattern-'   

Non-interactive tool options

    (1)                                    
|--------+-----------------------------+------------------------|
         +- --embeddedzk---------------+   
         |               .-,---------. |   
         |               V           | |   
         '- --zkconnect----host:port-+-'   
Notes:
  1. The non-interactive tool options are not supported in the interactive streamtool interface.

Authority

You must have search authority for the instance object and search authority for the instances domain object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see the streamtool getacl and streamtool getdomainacl commands.

Description

If you do not specify a tag pattern when you run the streamtool lsinstance command, it lists all of the instances that you created.

If you specify a simple tag name for the iid-name-pattern (for example, 'streams'), the command returns only exact matches.

The iid-name-pattern can include the following wildcard characters:
  • '*': Match zero or more characters.
  • '?': Match one or more characters.

Be careful to avoid letting the shell interpret and expand its special characters. For example, use quotation marks around tag patterns that use any of the wildcard characters.

If you specify a name pattern and no matching instances are found, the command returns a nonzero exit code.

Options and arguments

-a, --all
This option is deprecated and no longer has any effect.
-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.

-h, --help
Specifies to show the command syntax.
iid-name-pattern
Specifies the instance identifier. The name pattern can be a regular expression that contains wildcard characters. For example:
  • '*': Match zero or more characters.
  • '?': Match one or more characters.
--owner user
Specifies to report the instances for a particular user ID. If you do not specify a user ID, the command uses the current user ID.
--started
Specifies to report only instances that are started.
--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
The default value is off.
-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:
  1. The --embeddedzk option
  2. The value from the STREAMS_ZKCONNECT environment variable
  3. A ZooKeeper connection string that is derived from cached information about the current domain.
Parent topic: Streamtool commands