streamtool getdomainstate

Usage

getdomainstate [-d,--domain-id <did>] [-l,--long] [--fmt <format-spec>] [--resources <resourceId>,...] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool getdomainstate command returns the status of the domain and its resources.

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

The command lists the domain services that are running on the resources in the domain.

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

If the domain is not running, the command fails.

For more information about the domain and instance services, see the product documentation.

Options

-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.
-l,--long
Reports more detailed information, such as the Streams product version on each resource and the process identifiers for each domain service. All versions that are installed in the same base installation directory are displayed. An asterisk (*) indicates the active version. For the domain controller service, the command reports both the process ID and a "system" qualifier for that service. An asterisk (*) on the service indicates that the process is running as an unregistered service. For example, controller(9132:system) means that the process is running as a registered service, while controller(9132:system*) means that the process is running as an unregistered service.
--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
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.

Examples

The following command reports the status of the StreamsDomain domain and its resources:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] getdomainstate --long  
domain: bsmith  State: STARTED  
Resource            Status  Services                                                Tags  
host1.teracloud.com RUNNING RUNNING:aas,auditlog,controller(4689:system*),jmx,sws   authentication  
host2.teracloud.com RUNNING WAITING:controller,auditlog                        
host3.teracloud.com RUNNING WAITING:controller                                 
host6.teracloud.com RUNNING FAILED:sws RUNNING:jmx,controller,auditlog