IBM InfoSphere Streams Version 4.1.0

streamtool startdomain

The streamtool startdomain command starts a domain.

Usage


startdomain

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

>--+-----------------+--+---------------------+----------------->
   '- --trace--level-'  '-+- -U-----+--userid-'   
                          '- --User-'             

>--+-----------------------+------------------------------------>
   '-+- -v--------+--level-'   
     '- --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 write authority for the domain object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see streamtool getdomainacl.

Description

When you start an InfoSphere® Streams domain, domain services start on the appropriate resources.

Note: If the domain controller service is a system service, this command does not start that service. If it is not already running, use the streamtool startdomainhost command to start the domain controller service on each resource.

You can manage which services run on specific resources by using tags. For example, you can apply the authentication tag to a resource so that it runs the authentication and authorization service. To change the tags that are associated with resources in a domain, use the streamtool chhost command.

Tip: If the domain fails to start because a port is in use, you can change the port number by using the streamtool setdomainproperty command. For example, if the domain fails to start because the management API service and web management service ports are in use, you can enter the following command. If you specify a value of 0 for the port number, InfoSphere Streams selects an available port.

setdomainproperty jmx.port=0 sws.port=0

Dynamic port allocation is not ideal, however, if you have applications that use the REST API or JMX API or use tools (such as Streams Studio or Streams Console) that access those services.

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.

--force

Specifies to force the domain to start. If the domain contains management resources that are quiesced, they might be resumed to start the domain.

-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 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 starts the StreamsDomain domain:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] startdomain
CDISA0064I Starting the authentication and auditing services for the following domain: StreamsDomain.
CDISA0021I Starting the following domain: StreamsDomain.
CDISA0034I Waiting for all services to start.
CDISA0038I The aas service started on the following resource: host1.ibm.com. 
The service has the following process id: 3155.
CDISA0039I The auditlog service started on the following resource: host1.ibm.com. 
The service has the following process id: 3156. The service uses the following port: 34861.
CDISA0039I The jmx service started on the following resource: host1.ibm.com. 
The service has the following process id: 3380. The service uses the following port: 40219.
CDISA0039I The sws service started on the following resource: host1.ibm.com. 
The service has the following process id: 3858. The service uses the following port: 57979.
CDISA0022I The following domain started successfully: StreamsDomain.