streamtool getbootproperty

Usage

getbootproperty {[-a,--all] | [<property-name> ...]} [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool getbootproperty command reports property values from the Streams bootstrap configuration, one per line.

Authority

You do not need any authority to run this command.

Description

The bootstrap properties are applicable only when you use the embedded copy of Apache ZooKeeper.

If the property is not present in the configuration, the value null is returned.

If the property is a write-only property, the command returns an error.

For a description of the properties, see streamtool man bootproperties.

See also

streamtool setbootproperty

streamtool getdomainproperty

streamtool getproperty

Options

-a,--all
Specifies to list the values for all of the properties. Write-only properties are not included in the list.
--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.
--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 gets the value for the streams.zookeeper.maxClientCnxns property in the instance "streams" in the domain "StreamsDomain":

[streamtool <bsmith@StreamsDomain.streams>] getbootproperty streams.zookeeper.maxClientCnxns
streams.zookeeper.maxClientCnxns=0