IBM InfoSphere Streams Version 4.1.1

streamtool setloginconfig

The streamtool setloginconfig command changes the authentication configuration information for a domain. You must provide the information in a file.

Usage

Read syntax diagramSkip visual syntax diagram
setloginconfig

>>-+-----------------------+--+- -f-----+--file-name------------>
   '-+- -d----------+--did-'  '- --file-'              
     '- --domain-id-'                                  

>--+-------------+--+-----------------+------------------------->
   '-+- -h-----+-'  '- --trace--level-'   
     '- --help-'                          

>--+-------------------+---------------------------------------->
   '-+- -U-----+--user-'   
     '- --User-'           

>--+---------------------------------------------------------+-><
   '-+- -v--------+--level--| Non-interactive tool options |-'   
     '- --verbose-'                                              

Non-interactive tool options

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

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

Authority

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

Description

InfoSphere® Streams authenticates users by using a Java™ Authentication and Authorization Service (JAAS). You can use the login modules that are included in the product, or you can create your own to customize the security settings of your domain.

The file that you specify in this command must include authentication configuration information for each login module that is used by the domain.

Options and arguments

-d, --domain-id did
Specifies the domain identifier.

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

-f, --filename file-name
Specifies the file path where the command obtains the authentication configuration information.
-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 userid
Specifies an InfoSphere Streams user ID that has authority to run the command.
-v,--verbose level
Specifies to provide more detailed command output. The vebosity level can be from 0 to 3 where 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, InfoSphere 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.