streamtool chdomainhostconfig

Usage

chdomainhostconfig [-d,--domain-id <did>] [--new-zkconnect <{<host>:<port>},...>] [--ipaddress <ipaddress>] [--maximumJvmSize <size-in-megabytes>] [--initialJvmSize <size-in-megabytes>] [--restartcount <number>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool chdomainhostconfig command changes properties for a domain controller service that is running as a Linux system service.

Authority

You must have root authority to run this command.

Description

This command changes the properties of the domain controller service configuration that you specify. You must run this command on each system where the system service resides.

After you run this command, you must restart the system for the changes to occur. Use the stopdomainhost command to stop the system service, and the startdomainhost command to restart it.

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.

-h,--help
Specifies to show the command syntax.
--initialJvmSize <size-in-megabytes>
Specifies the initial amount of memory, in megabytes, to allocate to the Java environment for the Domain Controller system service. By default, the service uses an initial size of 512. A valid range for this value is 512 to the value of --maximumJvmSize, or the value in the system configuration file. The system service must be restarted for this value to take effect.
--ipaddress <ipaddress>
Specifies the system service IP address.
--maximumJvmSize <size-in-megabytes>
Specifies the maximum amount of memory, in megabytes, to allocate to the Java environment for the Domain Controller system service. By default, the service uses a maximum size of 1024. The value that is specified must be greater than or equal to --initialJvmSize or the value in the system service configuration file. The system service must be restarted for this value to take effect.
--new-zkconnect <{<host>:<port>},...>
Specifies the ZooKeeper connection string for the domain that is associated with the system service. The system service must be restarted for this value to take effect.
--restartcount <number>
Specifies the maximum number of times to attempt to restart the domain controller. The system service must be restarted for this value to take effect.
--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.

Examples

The following command changes the restartcount property value in the host configuration, then restarts the system:

streamtool chdomainhostconfig --restartcount 4
streamtool stopdomainhost
streamtool startdomainhost