streamtool rmdomain

Usage

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

The streamtool rmdomain command removes a domain.

Authority

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

Description

Before you can remove a domain, you must stop the domain and all of the instances in the domain. For more information, see streamtool stopinstance and streamtool stopdomain.

The command removes the domain and the instances in the domain. In basic domains, the embedded ZooKeeper is stopped when there are no users or domains using it. If you are using the interactive streamtool interface, the embedded ZooKeeper is stopped when you exit the interface by entering exit or quit.

In enterprise domains, the command contacts the Streams domain controller service that is running on each resource in the domain. If you do not specify the --keep-domain-hosts option, each domain controller service unregisters the resource from the domain and then stops. If the domain controller service was running as a system service, it is removed. If you specify the --keep-domain-hosts option, the command does not unregister the resources and does not remove the domain controller service from each resource. If you later create a domain with the same name, you do not have to re-register each of these resources with the domain. The command also removes the domain configuration information from ZooKeeper.

If the command fails, for example because the authentication and authorization service failed and cannot be restarted, you can run the command with the --force option.

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 command to complete.
-h,--help
Specifies to show the command syntax.
--keep-domain-hosts
Specifies to refrain from unregistering the resources from the domain. If the domain controller service is running as a system service on a resource, it is not stopped or removed. If the service is not a system service, it is stopped. To restart it, use the streamtool restartdomainservice command.
--noprompt
Specifies to suppress confirmation prompts.
--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.