streamtool lstag
The streamtool lstag command lists the tags for a domain.
Usage
lstag .- --fmt--format-spec-. >>-+-----------------------+--+---------------------+-----------> '-+- -d----------+--did-' '-+- -s------+--------' '- --domain-id-' '- --short-' >--+-----------------+--+-------------------+-------------------> '- --trace--level-' '-+- -U-----+--user-' '- --User-' >--+-----------------------+--+-------------+-------------------> '-+- -v--------+--level-' '- --xheaders-' '- --verbose-' >--| Non-interactive tool options |--+-------------+----------->< '-tag-pattern-' 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 read authority for the config domain object. By default, the DomainAdministrator and DomainUser roles have this authority. For more information about access control lists, see streamtool getdomainacl.
Description
Tags are a mechanism for differentiating and identifying resources that have different physical characteristics or logical uses. Resources can have any number of tags. Tags are case-sensitive strings with a letter optionally followed by alphanumeric or underscore characters.
- application
- Specifies that the resource can run InfoSphere Streams applications.
- audit
- Specifies that the resource can run the logging service.
- authentication
- Specifies that the resource can run the authentication and authorization service.
- jmx
- Specifies that the resource can run the management API service.
- management
- Specifies that the resource can run any of the InfoSphere Streams domain and instance management services.
- sws
- Specifies that the resource can run the web management service.
- view
- Specifies that the resource can run the view service.
If you do not specify a tag pattern when you run the streamtool lstag command, it lists all of the tags for the domain.
If you specify a simple tag name for the tag-pattern (for example, 'mytag1'), the command returns only exact matches.
- '*': 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 tag pattern and no matching tags are found, the command exits with a nonzero exit code.
Options and arguments
- -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.
- --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 tag.
- %Tf: Standard table format, which is the default. One line per tag.
- -h, --help
Specifies to show the command syntax.
- -s, --short
Specifies to return a shortened list of information. In particular, the command returns only the tag names.
- tag-pattern
Specifies the pattern that the command uses to filter the tags.
- --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.
- --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, 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.
Examples
[streamtool <bsmith@StreamsDomain.StreamsInstance>] lstag --fmt %Mf manage*
=================================================
Domain: StreamsDomain
=================================================
Tag : management
ResourceType: streams
Description : A management resource is one that can be
used to run the InfoSphere Streams management services.
=================================================