IBM Streams 4.2

streamtool setproperty

The streamtool setproperty command sets one or more property values for an instance.

Usage


setprop, setproperty

>>-+-------------------+--+-----------------------+------------->
   '- --application-ev-'  '-+- -d----------+--did-'   
                            '- --domain-id-'          

>--+---------+--+-------------------------+--------------------->
   +- -h-----+  '-+- -i------------+--iid-'   
   '- --help-'    '- --instance-id-'          

>--+-----------------+--+---------------------+----------------->
   '- --trace--level-'  '-+- -U-----+--userid-'   
                          '- --User-'             

>--+-----------------------+------------------------------------>
   '-+- -v--------+--level-'   
     '- --verbose-'            

>--| Non-interactive tool options |----------------------------->

   .-+---+------------------------.   
   | '-,-'                        |   
   V                              |   
>----property-name=property-value-+----------------------------><

Non-interactive tool options

    (1)                                    
|--------+-----------------------------+------------------------|
         +- --embeddedzk---------------+   
         |               .-,---------. |   
         |               V           | |   
         '- --zkconnect----host:port-+-'

Notes:

The non-interactive tool options are not supported in the interactive streamtool interface.

Authority

You must have read and write authority for the config instance object. By default, the DomainAdministrator and InstanceAdministrator roles have this authority. For more information about access control lists, see streamtool getacl.

Description

If you make property changes while the instance is started, they are pending. If the property can be updated dynamically, the configuration change is applied without needing to stop and restart the instance. If the property cannot be updated dynamically, the change is applied when the instance stops.

Note:

The property value cannot be only white space.
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 properties and information about which properties can be updated dynamically, see the streamtool man properties command.

Options and arguments

--application-ev

Specifies that the property is an application environment variable. If the property is an application environment variable and you do not specify this option, the command fails.

-d, --domain-id did

Specifies the domain identifier.
If you do not specify this option, IBM® 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, IBM Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. IBM 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 IBM Streams configuration cache, the command fails.

-h, --help

Specifies to show the command syntax.

-i, --instance-id iid

Specifies the instance identifier.
If you do not specify this option, IBM Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance. If you are using the interactive streamtool interface, it tries to use an instance ID that you specified in a previous command. If no such value is found, the command uses the STREAMS_INSTANCE_ID environment variable. Alternatively, you can run the streamtool instance command in the interactive interface.

property-name

Specifies the name of a property.

property-value

Specifies a property value.

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

Specifies an IBM 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, IBM Streams tries to use:
The --embeddedzk option

The value from the STREAMS_ZKCONNECT environment variable

A ZooKeeper connection string that is derived from cached information about the current domain.

Examples

The following command sets the instance.highAvailabilityCount instance property:

[streamtool <bsmith@StreamsDomain.StreamsInstance>]streamtool setproperty instance.highAvailabilityCount=5

The following command sets the value for the DB2INSTANCE application environment variable:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] setproperty --application-ev DB2INSTANCE=db2inst1
CDISC0160I The DB2INSTANCE application environment variable was set to "db2inst1" for the StreamsInstance instance.
The previous value was "".