streamtool checkdomainhosts

Usage

checkdomainhosts [-d,--domain-id <did>] [--xclient] [--connectivity-only] [--fmt <format-spec>] [-v,--verbose <level>] [-U,--User <user>] [-h,--help] [--trace <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool checkdomainhosts command verifies that you meet configuration and network connectivity requirements on all of the resources in a domain.

Authority

You must have search 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

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 domain (in alphabetical order) as the reference resource.

If your environment has multiple versions of Streams, make sure that you source streamsprofile.sh to the version that the target domain is running. For example, if your domain is running Version 4.3.0, you must also run this command at Version 4.3.0 for the most complete checking.

You can perform the following checks with this command:

Connectivity-only check
Streams checks the network configuration or connectivity between resources in the domain.
Environment checks
Streams performs the following checks:
  • Application network check: This check provides a warning if there are inaccessible application or service network subnets that are associated with the instance. These settings are specified in the domain.applicationNetwork domain property.
  • Dependency check: This check verifies the RPM levels of all packages that are required by 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 Streams.
  • Compatible architecture check: This check verifies that the resources have compatible architectures.

Options

--connectivity-only
Specifies to run only the connectivity checks.
-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 processing element.
  • %Tf: Standard table format, which is the default. One line per host check result.
-h,--help
Specifies to show the command syntax.
--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. You must specify one of the following verbosity levels:
  • 0: This level disables detailed reporting.
  • 1: This level provides detailed information only for resources that have problems and for situations where checks fail.
  • 2: This level provides detailed information for each resource that is checked.
  • 3: This level provides detailed information for everything that the command checks.
--xclient
Specifies to use the first resource in the list of resources that is allocated to the domain (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, 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.

Examples

[streamtool <?@StreamsDomain.StreamsInstance>] checkdomainhosts
Date: Fri Oct 31 14:43:28 EDT 2014
Domain name: StreamsDomain
3 resources to check: [host6.teracloud.com, host5.teracloud.com, host4.teracloud.com]
Reference resource: host6.teracloud.com
=============================================================
Resource checks
=============================================================
  Resource Name Summary  Connectivity Check Environment Check
  host6.teracloud.com PASSED   PASSED             PASSED
  host4.teracloud.com PASSED   PASSED             PASSED
  host5.teracloud.com PASSED   PASSED             PASSED
=============================================================
3 OK resources
0 problem resources
=============================================================
Overall Summary
=============================================================
3 resources checked
3 OK resources
0 problem resources