streamtool lsresources

Usage

lsresources [-d,--domain-id <did>] [-i,--instance-id <instance>] [--application] [--management] [--services <service>,...] [--tags <tag>,...] [[-l,--long] | [--fmt <format-spec>]] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool lsresources command lists the resources that are configured for use by the instance.

Authority

You must have read and search authority for the hosts instance object. By default, the DomainAdministrator, InstanceAdministrator, and InstanceUser roles have this authority. For more information about access control lists, see streamtool getacl.

Description

If the instance is running, the command lists all of the active externally managed resources and Streams resources for the instance. If the instance is stopped, the command lists all of the resources that are assigned to the instance, and any resource specifications that will be applied when the instance starts.

In the output, an asterisk (*) on the tag name indicates that the tag is restricted on the resource.

For more information about the status of the resources in the instance, run the streamtool getresourcestate command.

For more information about the available host selection process that is used by Streams, see the product documentation.

Options

--application
Specifies to report only the application hosts.
-d,--domain-id <did>
Specifies the domain identifier.

If you do not specify this option, 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, 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 host.
  • %Tf: Standard table format, which is the default. One line per host.
-h,--help
Specifies to show the command syntax.
-i,--instance-id <instance>
Specifies the instance identifier.

If you do not specify this option, 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.

-l,--long
Specifies whether additional information is returned for resources in the instance, including services, tags, resource specification, and whether the resource is scoped to a job. If instance.dynamicResourceAllocationEnabled is set to true, the following information is also returned: a value of Host, Specification, or Dynamic to indicate the relationship of the resource to the instance.
--management
Specifies to report only the management hosts.
--services <service>
Specifies to report only the hosts that are configured with the specified services. The following service names are valid:
  • app
  • sam
  • srm
  • view
--tags <tag>
Specifies to report only the hosts that are configured with the specified 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
The default value is off.
-U,--User <user>
Specifies an 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.
--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.