IBM InfoSphere Streams Version 4.1.1

streamtool adddomainhost

The streamtool adddomainhost command adds one or more InfoSphere® Streams resources to a domain.

Usage


adddomainhost

>>-+-----------------------+--+-------------+------------------->
   '-+- -d----------+--did-'  '-+- -h-----+-'   
     '- --domain-id-'           '- --help-'     

>--+---------------------+--+-----------------+----------------->
   +- --hfile--host-file-+  '- --trace--level-'   
   | .-+---+----.        |                        
   | | '-,-'    |        |                        
   | V          |        |                        
   '---hostname-+--------'                        

>--+---------------------+--+-----------------------+----------->
   '-+- -U-----+--userid-'  '-+- -v--------+--level-'   
     '- --User-'              '- --verbose-'            

>--| Non-interactive tool options |----------------------------><

Non-interactive tool options

    (1)                                    
|--------+-----------------------------+------------------------|
         +- --embeddedzk---------------+   
         |               .-,---------. |   
         |               V           | |   
         '- --zkconnect----host:port-+-'

Notes:

The non-interactive tool options are not supported in the interactive streamtool interface.

Authority

You must have add authority for the hosts domain object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see streamtool getdomainacl.

Description

In general, this command is used only in development and test environments, and only if they do not require the resources to be highly available. For high availability, a root user must set up the InfoSphere Streams domain controller service as a Linux system service on all resources. To accomplish that, use the streamtool registerdomainhost command instead of the streamtool adddomainhost command.

If you choose to use development or test environments that are not highly available, you must configure a Secure Shell (SSH) environment for InfoSphere Streams. Each user of the product must enable SSH. For more information, see Considerations for setting up a multiple-host environment for InfoSphere Streams.

When you use the streamtool adddomainhost command, you can specify the resources to add by using the --hfile option, or by listing the host names or IP addresses. The host name can be a simple or fully qualified domain name. If a host file contains host names or IP addresses that are already resources in the domain, the command returns a warning and that host specification is ignored. A warning is generated if any hosts in a host file include service placement control specifications and the service placement control specifications are ignored.

This command starts the domain controller service on each resource and adds the resource to the domain. For more information about starting the domain controller service, see the streamtool startdomainhost command.

If the domain is started, the appropriate InfoSphere Streams services are started on the resources. Otherwise, the services are started when you start the domain. If there are problems starting one or more services, the resource is added to the domain but cannot be used until the services are started successfully.

After you add InfoSphere Streams resources to the domain, you can use the streamtool chhost command to assign tags to the resources.

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.

-h, --help

Specifies to show the command syntax.

--hfile host-file

Specifies the path to a file, which contains host identifiers and tags. Unlike the host files that you use with streamtool addhost and mkinstance commands, this host file cannot contain --numresources specifications.
A host identifier can be a host name or IP address. Each host identifier must be on a separate line in the file.

The file can also contain comment lines (blank lines or lines where the first non-whitespace character is a '#').
For example:
host1,management
1.3.45.6,audit,authentication
Each host must have access to the InfoSphere Streams product. For more information about installation options, see Considerations for setting up a multiple-host environment for InfoSphere Streams.

hostname

Specifies one or more host identifiers. A host identifier can be a host name or IP address.

--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 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

The following command adds a host to the StreamsDomain domain:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] adddomainhost -d StreamsDomain host1.ibm.com