IBM Streams 4.2.1

Instance identifiers

An instance name or identifier is the name that you specify when you create an instance.

Requirements for instance names

When you create an IBM® Streams instance, you must specify a name for the new instance that satisfies the following requirements:

The name must be unique among the instances that are defined by you, the instance owner, within the domain.
The name must contain alphanumeric characters. You cannot use the following alphanumeric characters: ^!#$%&'*+,/;<>=?@[]`{|}~(). You also cannot use the following Unicode and hexadecimal characters: u0000; u0001-u001F; u007F-u009F; ud800-uF8FF; uFFF0-uFFFF; x{10000}-x{10FFFF}.
The name cannot be zookeeper.
The maximum length for the name is 255 bytes.

IBM Streams default instance ID

If you do not specify an instance name when you run streamtool commands, 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.

By default, the default instance ID is set when you run the streamsprofile.sh script after you install IBM Streams. Running this script sets the STREAMS_DEFAULT_IID environment variable.

To set or change the value of the default instance ID, specify -i instance-id on the source streamsprofile.sh command, for example:

  source streamsprofile.sh -i MyInstance

To reset the default instance ID to StreamsInstance, enter the following command:

  source streamsprofile.sh -r

To get the value of the current default instance ID, enter the following command:

  streamtool getiid