streamtool stopdomain

Usage

stopdomain [-d,--domain-id <did>] [--force] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool stopdomain command stops a domain.

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

Unless you specify the --force option, you must stop the instances before you can stop the domain.

When you stop a domain, all of its domain services are stopped on all of the resources in the domain. If the domain controller service is running under the root user, this command does not stop that service. You can use the streamtool stopdomainhost command to stop the domain controller service on each resource. If the domain controller service is running under a non-root user, the process is stopped.

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.

--force
Specifies to force the domain to stop. If the domain contains instances that are started, the command stops them then stops the domain. Use this option with caution because the command cancels all jobs and stops all instances in 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 <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

[streamtool <bsmith@StreamsDomain.StreamsInstance>] stopdomain
CDISA0023I Stopping the following domain: StreamsDomain.
CDISA0035I Waiting for all services to stop.
CDISA0042I The aas service stopped on the following resource: host1.teracloud.com. 
The service had the following process id: 31104.
CDISA0042I The auditlog service stopped on the following resource: host1.teracloud.com. 
The service had the following process id: 31103.
CDISA0042I The jmx service stopped on the following resource: host1.teracloud.com. 
The service had the following process id: 31287.
CDISA0042I The sws service stopped on the following resource: host1.teracloud.com.
The service had the following process id: 31675.
CDISA0042I The controller service stopped on the following resource: host1.teracloud.com. 
The service had the following process id: 30957.
CDISA0024I The following domain stopped successfully: StreamsDomain.