streamtool lsdomain

Usage

lsdomain [--started] [--owner <owner>] [--fmt <format-spec>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk] [<did-name-pattern>]

The streamtool lsdomain command lists domains.

Authority

You do not need any authority to run this command.

Description

The command lists domains that match the pattern that you specify. If you do not specify a pattern, the command lists all domains that match the options that you select.

If a domain ends unexpectedly, it is not removed from the streamtool lsdomain command output until you try to use the domain.

Options

--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, Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. 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 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 domain.
  • %Tf: Standard table format, which is the default. One line per domain.
-h,--help
Specifies to show the command syntax.
--owner <owner>
Specifies to list the domains for the specified user.
--started
Specifies to list only the domains 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.
-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.
--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, 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.

Arguments

did-name-pattern
Specifies a domain name. The name pattern can be a regular expression that contains wildcard characters. For example:
  • '*': Match zero or more characters.
  • '?': Match one or more characters.