streamtool unregisterdomainhost

Usage

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

The streamtool unregisterdomainhost command removes an Streams resource from the domain. It also stops the domain controller service after it removes the resource.

Authority

You must have root authority and must run this command on the Streams resource that you want to remove.

Description

Unlike the streamtool rmdomainhost command, this command can remove a resource from the domain even when the domain controller service is stopped on that resource. It also differs in that it removes the domain controller service from the list of Linux system services on the resource.

You cannot remove a resource when:

  • It is the last resource in the domain. Instead, you must use the streamtool rmdomain command.
  • The resource is allocated to an instance in the domain and the instance is started. You must stop the instance before you remove a resource. For more information, see the streamtool stopinstance command.
  • There are Streams services other than the domain controller service that are running on the resource. You must stop or quiesce the resource before you remove it. For more information, see the streamtool quiesceresource and streamtool stopdomainhost commands.

If you have multiple versions of Streams installed, always use the most recent version to run the streamtool unregisterdomainhost command. Using the latest version ensures that all configuration settings on the host are removed.

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 a cleanup of the system service. The command tries to unregister the host from the domain only if the ZooKeeper connection is active and the domain exists. Use this option only if the request to unregister fails. This option ignores certain error conditions.
-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.
-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.