streamtool setdomainproperty

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

The streamtool setdomainproperty sets one or more property values for a domain.

Authority

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

Description

Property changes that occur while the domain is started become "pending". If the property can be updated dynamically, the configuration change is applied without needing to stop and restart the domain. If the property cannot be updated dynamically, the change is applied when the domain stops.

• The property value cannot be only white space characters.
• Any properties that involve path or file names can accept multibyte characters.

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

For a description of the domain properties and information about which properties can be updated dynamically, see streamtool man domainproperties.

See also

streamtool getdomainproperty

streamtool setbootproperty

streamtool setproperty

-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.

--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.

property-name=property-value

Specifies a property value.

The following command sets the domainLog.level property:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] setdomainproperty domainLog.level=error
CDISC0142I The domainLog.level property was set to "error" for the "StreamsDomain" domain.
The previous property value was "warn".