streamtool checkinstancehosts
The streamtool checkinstancehosts command verifies that you meet configuration and network connectivity requirements on all of the resources in an instance.
Usage
checkinstancehosts >>-+----------------------+--+-----------------------+----------> '- --connectivity-only-' '-+- -d----------+--did-' '- --domain-id-' >--+---------------------+--+-------------+---------------------> '- --fmt--format-spec-' '-+- -h-----+-' '- --help-' >--+-------------------------+--+---------------------+---------> '-+- -i------------+--iid-' '- --trace--+-------+-' '- --instance-id-' '-level-' >--+-------------------+--+-----------------------+-------------> '-+- -U-----+--user-' '-+- -v--------+--level-' '- --User-' '- --verbose-' >--+-----------+--| Non-interactive tool options |------------->< '---xclient-' 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 search authority for the instance object and 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 started, the command checks each resource that is allocated to the instance and has the following state: running.
If the instance is stopped, the command checks only the resources that are explicitly allocated to the instance. It cannot check resources that you specified by using --numresources specifications because they are not yet allocated.
The command compares the resources to a reference resource, which is typically the resource where you run the command. If you run the command from a resource that is not allocated to the domain or if you specify the --xclient option, the command uses the first host that is allocated to the instance (in alphabetical order) as the reference resource.
- Connectivity-only check
- InfoSphere® Streams checks the network configuration or connectivity between resources in the instance.
- Environment checks
- InfoSphere
Streams performs
the following checks:
- Application network check: This check provides a warning if there are inaccessible application or service network subnets associated with the instance. These settings are specified in the domain.applicationNetwork domain property and instance.applicationNetwork instance property.
- Dependency check: This check verifies the RPM levels of all packages that are required by InfoSphere Streams.
- Compatible operating system check: This check verifies that the resources have compatible operating systems.
- LogPath check: This check verifies that the path specified in the domainLog.level domain property can be accessed with the appropriate read, write, and execute authority.
- FileStoragePath check: This check verifies that the path specified in the domain.fileStoragePath can be accessed with the appropriate read, write, and execute authority.
- Ulimit check: This check verifies that the ulimit settings on the resources are adequate to run InfoSphere Streams.
- Compatible architecture check: This check verifies that the resources have compatible architectures.
Options and arguments
- --connectivity-only
Specifies to run only the connectivity checks.
- -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 processing element.
- %Tf: Standard table format, which is the default. One line per host check result.
- -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.
- --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 user
Specifies an InfoSphere Streams user ID that has authority to run the command.
- -v,--verbose level
Specifies to provide more detailed command output. You can also optionally specify one of the following verbosity levels:
- 0: This level disables detailed reporting.
- 1: This level provides a summary for each resource that is checked.
- 2: This level provides detailed information for each resource that is checked.
- --xclient
Specifies to use the first resource in the list of resources that is allocated to the instance (in alphabetical order) as the reference for operating system and architecture checks. If you do not specify this option, the resource where you run the command is used for the comparison checks unless that resource is not allocated to the domain.
- --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>]
checkinstancehosts -d StreamsDomain -i StreamsInstance
Date: Fri Oct 31 14:44:48 EDT 2014
Domain name: StreamsDomain
Instance name: StreamsInstance
1 resources to check: [host5.ibm.com]
Reference resource: host6.ibm.com
=============================================================
Resource checks
=============================================================
Resource Name Summary Connectivity Check Environment Check
host5.ibm.com PASSED PASSED PASSED
=============================================================
1 OK resources
0 problem resources
=============================================================
Overall Summary
=============================================================
1 resources checked
1 OK resources
0 problem resources