IBM InfoSphere Streams Version 4.1.0

streamtool setigcadminconfig

The streamtool setigcadminconfig command manages the user IDs and passwords that can administer the IBM® InfoSphere® Information Governance Catalog.

Usage

Read syntax diagramSkip visual syntax diagram
setigcadminconfig

>>-+-----------------------+--+-------------+------------------->
   '-+- -d----------+--did-'  '-+- -h-----+-'   
     '- --domain-id-'           '- --help-'     

>--+--------------------------------------------------------------+-->
   +- --igc-admin-user--user--+---------------------------------+-+   
   |                          '- --igc-admin-password--password-' |   
   '- --remove----------------------------------------------------'   

>--+------------------------+--+-----------------+-------------->
   '-+- -i-----------+--iid-'  '- --trace--level-'   
     '- -instance-id-'                               

>--+-------------------+--+-----------------------+------------->
   '-+- -U-----+--user-'  '-+- -v--------+--level-'   
     '- --User-'            '- --verbose-'            

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

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

To affect the domain settings, you must have write authority for the config domain object. To affect the instance settings, you must have write authority for the config domain object and the config instance object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see streamtool getacl and getdomainacl.

Description

The InfoSphere Information Governance Catalog is an interactive, web-based tool that you can use to create, manage, and share an enterprise vocabulary and classification system in a central catalog. The InfoSphere Information Governance Catalog helps you understand the business meaning of your assets and provides search, browse, and query capabilities. In addition, you can establish asset collections and run lineage reports to examine data flow between assets. For more information, see its product documentation.

When you configure InfoSphere Streams instances for data governance, they generate data flows and data lineage for the streams processing applications. Set the domain.governanceEnabled and domain.governanceUrl domain properties or the instance.governanceEnabled and instance.governanceUrl instance properties. These properties specify whether data governance is enabled and the URL of the InfoSphere Information Governance Catalog server. Use this command to set the user ID and password that InfoSphere Streams uses to connect to the server.

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.

-h, --help
Specifies to show the command syntax.
--igc-admin-password password
Specifies the password for the user ID that was specified in the --igc-admin-user parameter.
--igc-admin-user user
Specifies a user ID that is valid and has appropriate authority on the IBM InfoSphere Information Governance Catalog server. At a minimum, the user must be an IBM InfoSphere Information Governance Catalog Information Asset Administrator.
-i, --instance-id iid
Specifies the instance identifier.

If you do not specify this option, InfoSphere 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.

--remove
Specifies to remove the information about the user ID and password of the IBM InfoSphere Information Governance Catalog administrator from the domain or instance.
--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.