streamtool getresourcestate
The streamtool getresourcestate command reports the state of specified resources or all the resources in an instance.
Usage
getresourcestate >>-+-----------------------+--+---------------------+-----------> '-+- -d----------+--did-' '- --fmt--format-spec-' '- --domain-id-' >--+-------------+--+-------------------------+--+---------+----> '-+- -h-----+-' '-+- -i------------+--iid-' +- -l-----+ '- --help-' '- --instance-id-' '- --long-' >--+------------------------------+--+-----------------+--------> | .-,----------. | '- --trace--level-' | V | | '- --resources----resourceID-+-' >--+-------------------+--+-----------------------+-------------> '-+- -U-----+--user-' '-+- -v--------+--level-' '- --User-' '- --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 read authority for the hosts domain object. By default, the DomainAdministrator and DomainUser roles have this authority. For more information about access control lists, see streamtool getdomainacl.
Description
- Resources: 1 (1/1 Management, 1/1 Application)
- The n/m Management information means n out of m management resources are running in the instance. Similar information is returned for application resources. A resource can be both a management resource and an application resource.
- Schedulable: yes
- The information about a resource includes its status and whether it is schedulable, which is an indication of whether processing elements (PEs) can be scheduled to run on the resource. To be schedulable, the resource must be configured as an application resource and the host controller service must be running.
- ResourceSpecId[count,tags,...]: 1[1(none)[shared]]
- If resources were allocated to the instance by using the --numresources option in either the streamtool mkinstance or streamtool addhost commands, this command output includes the resource specification identifier. The command also reports the number of resources, the tags, and the sharing mode that were requested in the resource specification.
The command also reports any error messages that are related to service health states.
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 host.
- %Tf: Standard table format, which is the default. One line per host.
- -h, --help
Specifies to show the command syntax.
- -i, --instance-id iid
Specifies the instance identifier.
If you do not specify this option, InfoSphere 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
Reports full host names and more detailed information.
- --resources resourceID
Specifies a list of resource identifiers, which vary depending on the resource manager. For example, they might be host names or IP addresses. The resource identifiers are delimited by commas.
- --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.
- --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>] getresourcestate --fmt '%Mf'
=================================================
Instance : StreamsInstance
Started : yes
State : RUNNING
Resources : 1 (1/1 Management, 1/1 Application)
Version : 4.0.0.0
=================================================
=================================================
Resource : host1.ibm.com
Status : RUNNING
Schedulable : yes
Services : RUNNING:app,hc,sam,sch,srm,view
Tags :
ResourceSpecId[count,tags,..] : 1[1(none)[shared]]
=================================================