IBM Streams 4.2

streamtool stopdomainhost

The streamtool stopdomainhost command stops the domain controller service on an IBM® Streams resource in an enterprise domain.

Usage


stopdomainhost

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

>--+-----------------+--+-----------------------+--------------->
   '- --trace--level-'  '-+- -v--------+--level-'   
                          '- --verbose-'            

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

Non-interactive tool options

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

Notes:

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

Authority

For a domain controller service that is registered as a Linux system service, you must have root authority and you must run this command on the IBM Streams resource that you are stopping. For a domain controller service that is running as an unregistered service, you must be the same user that started the process.

Description

The resource must be allocated to an enterprise domain. If you run the command in a basic domain, the command fails.

If the domain controller service is running as a registered system service, you must have root permissions. Otherwise, the command fails. To configure the domain controller service to run as a registered system service, run the streamtool registerdomainhost command.

If the domain controller service is running as an unregistered service, you must be the user who started the service to run this command. The exception to this rule is the root user. A user with root permissions can stop a process that is running as an unregistered service even if they did not start that process.

Before the command stops the domain controller service, it checks for other IBM Streams services. If IBM Streams services are running on this resource and standby services are configured on other resources in the domain, the command stops the services on this resource and a failover occurs. If there are no standby services, the command fails. The command also verifies that any processing elements that are running on the resource can be relocated to another resource. If this verification test fails, the command fails.

If necessary, you can specify the --force option to force the services to stop despite the warnings. Stopping the services in this manner can cause one or more jobs to become unhealthy or even cause the domain to stop unexpectedly.

Options and arguments

-d, --domain-id did

Specifies the domain identifier.
If you do not specify this option, IBM 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.

-h, --help

Specifies to show the command syntax.

--force

Specifies to force the domain controller service to stop. Use this option with caution because the command might cause one or more jobs to become unhealthy or cause the domain to stop. The --zkconnect option is not required when you specify this option.

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

-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, IBM Streams tries to use:
The value from the STREAMS_ZKCONNECT environment variable

A ZooKeeper connection string that is derived from cached information about the current domain.

This command cannot use the embedded ZooKeeper.