IBM InfoSphere Streams Version 4.1.0

Streamtool commands

Streamtool is the InfoSphere® Streams command-line interface.

Usage

Many streamtool commands require an InfoSphere Streams domain or instance context and a connection to Apache ZooKeeper. You can store that information in the STREAMS_DOMAIN_ID, STREAMS_INSTANCE_ID, and STREAMS_ZKCONNECT environment variables. When you use the interactive streamtool interface, common options and user information is cached so that you do not need to specify them in every command. To enter the interactive mode, run the following command: streamtool. To exit interactive mode, enter exit or quit.

To obtain a list of all the streamtool commands and their syntax, enter streamtool help.

To obtain the help information for a specific streamtool command, enter streamtool man command-name.

To get reference information for the InfoSphere Streams properties, use the following commands:
  • streamtool man properties
  • streamtool man domainproperties
  • streamtool man bootproperties
  • Streamtool command syntax help
    Command syntax help is available for all commands in IBM® InfoSphere Streams.
  • streamtool addcertificate
    The streamtool addcertificate command adds a client certificate into the web management service (SWS) truststore.
  • streamtool adddomainhost
    The streamtool adddomainhost command adds one or more InfoSphere Streams resources to a domain.
  • streamtool addgroupdomainrole
    The streamtool addgroupdomainrole command assigns a role to a group in a domain.
  • streamtool addgrouprole
    The streamtool addgrouprole command adds a group to the list of groups that have a specific role in an instance.
  • streamtool addhost
    The streamtool addhost command adds one or more resources to an instance.
  • streamtool addresourcespec
    The streamtool addresourcespec command adds a specification for a resource in an instance.
  • streamtool addtrustedorigin
    The streamtool addtrustedorigin command adds an origin to the list of origins that are trusted by the InfoSphere Streams REST API.
  • streamtool adduserdomainrole
    The streamtool adduserdomainrole command adds a user to the list of users that have a specific role in a domain.
  • streamtool adduserrole
    The streamtool adduserrole command adds a user to the list of users that have a specific role in an instance.
  • streamtool cancelcertrequest
    The streamtool cancelcertrequest command cancels a pending renew request for the web management service (SWS) keystore.
  • streamtool canceljob
    The streamtool canceljob command cancels one or more jobs.
  • streamtool capturestate
    The streamtool capturestate command captures the current state of the instance, including the state of objects in the system and the metrics available on those objects.
  • streamtool checkdomainhosts
    The streamtool checkdomainhosts command verifies that you meet configuration and network connectivity requirements on all of the resources in a domain.
  • streamtool checkhosts
    The streamtool checkhosts command verifies that you meet configuration and network connectivity requirements on one or more InfoSphere Streams hosts.
  • streamtool checkinstancehosts
    The streamtool checkinstancehosts command verifies that you meet configuration and network connectivity requirements on all of the resources in an instance.
  • streamtool chhost
    The streamtool chhost command changes the tags that are associated with hosts in a domain.
  • streamtool chhosttag
    The streamtool chhosttag command changes the description or resource definition for a tag.
  • streamtool chresourcespec
    The streamtool chresourcespec command changes the specification for a resource in an instance.
  • streamtool chtag
    The streamtool chtag command changes the description or resource definition for a tag.
  • streamtool cleanlog
    The streamtool cleanlog command removes log and trace files.
  • streamtool cpinstance
    The streamtool cpinstance command copies the instance configuration to a new instance.
  • streamtool displaype
    The streamtool displaype command displays details about a specific processing element (PE), including the configuration settings currently being used by the PE.
  • streamtool domain
    The streamtool domain command sets the active domain for the current streamtool session.
  • streamtool embeddedzk
    The streamtool embeddedzk command stops, starts, and provides status information about the embedded ZooKeeper.
  • streamtool exportkeystore
    The streamtool exportkeystore command exports the keystore file for a domain.
  • streamtool exporttruststore
    The streamtool exporttruststore command exports the truststore file for a domain.
  • streamtool gencertificate
    The streamtool gencertificate command generates a server certificate for the web management service (SWS) keystore.
  • streamtool genkey
    The streamtool genkey command generates a public and private key pair.
  • streamtool getacl
    The streamtool getacl command lists the access control lists (ACLs) associated with a specific security object in the InfoSphere Streams instance.
  • streamtool getapplicationlog
    The streamtool getapplicationlog command retrieves the trace files for streams processing applications.
  • streamtool getbootproperty
    The streamtool getbootproperty command reports property values from the InfoSphere Streams bootstrap configuration, one per line.
  • streamtool getdomainacl
    The streamtool getdomainacl command lists the access control lists (ACLs) that are associated with a specific security object in an InfoSphere Streams domain.
  • streamtool getdomainhoststatus
    The streamtool getdomainhoststatus command returns the status of the InfoSphere Streams domain controller service on the host.
  • streamtool getdomainproperty
    The streamtool getdomainproperty command reports property values for the domain, one per line.
  • streamtool getdomainstate
    The streamtool getdomainstate command returns the status of the domain and its resources.
  • streamtool getiid
    The streamtool getiid command reports the InfoSphere Streams default instance ID value.
  • streamtool getjmxconnect
    The streamtool getjmxconnect command reports the connection string for the management API service.
  • streamtool getjobtopology
    The streamtool getjobtopology command gets the job topology information for the system.
  • streamtool getlog
    The streamtool getlog command saves log and trace files for an InfoSphere Streams instance.
  • streamtool getloginconfig
    The streamtool getloginconfig command gets authentication configuration information for a domain. You can optionally output the information to a file.
  • streamtool getnsentry
    The streamtool getnsentry command finds an application entry that is stored in ZooKeeper and prints the value.
  • streamtool getproperty
    The streamtool getproperty command reports property values for an instance, one per line.
  • streamtool getresourcestate
    The streamtool getresourcestate command reports the state of specified resources or all the resources in an instance.
  • streamtool gettag
    The streamtool gettag command displays or exports the resource definition for a tag.
  • streamtool geturl
    The streamtool geturl command prints the web server URLs for the domain. By default, the command returns the URL that is associated with the Streams Console.
  • streamtool getzk
    The streamtool getzk command prints information about the ZooKeeper servers that the domain uses.
  • streamtool getzkstate
    The streamtool getzkstate command returns the status of the ZooKeeper servers.
  • streamtool grantjobpermission
    The streamtool grantjobpermission command sets specific permissions for a job group.
  • streamtool help
    The streamtool help command prints help for all commands or a specified command.
  • streamtool importcertificate
    The streamtool importcertificate command imports a server certificate from the certificate authority into the web management service (SWS) keystore.
  • streamtool importkeystore
    The streamtool importkeystore command imports a keystore.
  • streamtool importtruststore
    The streamtool importtruststore command imports a truststore.
  • streamtool instance
    The streamtool instance command sets the active instance for the current session in the interactive streamtool interface.
  • streamtool jconsole
    The streamtool jconsole command opens the Java™ Monitoring and Management Console.
  • streamtool launch
    The streamtool launch command starts an InfoSphere Streams graphical user interface.
  • streamtool login
    The streamtool login command logs in to a domain with the specified user ID and password.
  • streamtool logout
    The streamtool logout command logs out of a domain.
  • streamtool lsacl
    The streamtool lsacl command lists all of the security objects and the associated access control lists (ACL) in the InfoSphere Streams instance.
  • streamtool lsavailablehosts
    The streamtool lsavailablehosts command lists the hosts available for use in the domain.
  • streamtool lscertificate
    The streamtool lscertificate command lists the certificates for the web management service (SWS).
  • streamtool lsdomain
    The streamtool lsdomain command lists domains.
  • streamtool lsdomainacl
    The streamtool lsdomainacl command lists all of the security objects and associated access control lists (ACL) in a domain.
  • streamtool lsdomainpermission
    The streamtool lsdomainpermission command lists the permissions that a user, group, or role has for domain security objects.
  • streamtool lsdomainrole
    The streamtool lsdomainrole command lists the roles in the domain and the users and groups that have those roles.
  • streamtool lshosts
    The streamtool lshosts command lists the InfoSphere Streams resources that are configured for use by the instance.
  • streamtool lshosttag
    The streamtool lshosttag command lists the tags for a domain.
  • streamtool lsinstance
    The streamtool lsinstance command lists the instances in a domain.
  • streamtool lsjobgroup
    The streamtool lsjobgroup command lists the job groups in an instance.
  • streamtool lsjobpermission
    The streamtool lsjobpermission command lists the permissions that users, groups, and roles have for a specific job group.
  • streamtool lsjobs
    The streamtool lsjobs command lists the jobs in the instance.
  • streamtool lslogin
    The streamtool lslogin command lists the domains and authenticated user IDs of the current streamtool interactive session.
  • streamtool lsloginmodule
    The streamtool lsloginmodule command lists the login modules that are installed for a domain.
  • streamtool lspermission
    The streamtool lspermission command lists the permissions that a user, group, or role has for instance security objects.
  • streamtool lspes
    The streamtool lspes command lists the processing elements (PEs) in the instance.
  • streamtool lsresources
    The streamtool lsresources command lists the resources that are configured for use by the instance.
  • streamtool lsrole
    The streamtool lsrole command lists the roles in the instance and the users and groups that have those roles.
  • streamtool lsservices
    The streamtool lsservices command lists the domain and instance services on a specific resource in the domain.
  • streamtool man
    The streamtool man command provides reference information about commands.
  • streamtool lstag
    The streamtool lstag command lists the tags for a domain.
  • streamtool lstrustedorigins
    The streamtool lstrustedorigins command returns the list of origins that are trusted by the InfoSphere Streams REST API.
  • streamtool mkdomain
    The streamtool mkdomain command creates a domain.
  • streamtool mkdomainrole
    The streamtool mkdomainrole command creates a role in a domain.
  • streamtool mkhostfile
    The streamtool mkhostfile command creates a host file from a collection of application files that are generated by the SPL compiler.
  • streamtool mkhostpkg
    The streamtool mkhostpkg command generates a domain host installation package that you can use to add InfoSphere Streams resources to the domain.
  • streamtool mkhosttag
    The streamtool mkhosttag command creates a tag in a domain.
  • streamtool mkinstance
    The streamtool mkinstance command creates an instance in the domain.
  • streamtool mkjobgroup
    The streamtool mkjobgroup command creates a job group in an instance.
  • streamtool mkresourcepkg
    The streamtool mkresourcepkg command generates a resource installation package that you can use to add externally managed resources.
  • streamtool mkrole
    The streamtool mkrole command creates a role in an instance.
  • streamtool mktag
    The streamtool mktag command creates a tag in a domain.
  • streamtool quiescehost
    The streamtool quiescehost command quiesces one or more InfoSphere Streams resources in a domain.
  • streamtool quiesceresource
    The streamtool quiesceresource command quiesces one or more resources in a domain.
  • streamtool registerdomainhost
    The streamtool registerdomainhost command registers an InfoSphere Streams resource with a domain, and installs the domain controller service as a system service.
  • streamtool renewcertificate
    The streamtool renewcertificate command renews a server certificate for the web management service (SWS) keystore when the certificate is about to expire.
  • streamtool requestcertificate
    The streamtool requestcertificate command generates a Certificate Signing Request file that can be sent to the certificate authority to be signed. The request is generated from the self-signed certificate for the web management service (SWS) keystore.
  • streamtool resetstreamsconfigcache
    The streamtool resetstreamsconfigcache command resets the InfoSphere Streams configuration cache, which contains mappings between domains and ZooKeeper connection strings.
  • streamtool restartdomainservice
    The streamtool restartdomainservice command restarts domain services.
  • streamtool restartpe
    The streamtool restartpe command restarts one or more processing elements (PEs).
  • streamtool restartservice
    The streamtool restartservice command restarts instance services.
  • streamtool resumehost
    The streamtool resumehost command resumes one or more quiesced InfoSphere Streams resources in the domain.
  • streamtool resumeresource
    The streamtool resumeresource command resumes one or more quiesced InfoSphere Streams resources in the domain.
  • streamtool revokejobpermission
    The streamtool revokejobpermission command removes specific permissions for a job group.
  • streamtool rmbootproperty
    The streamtool rmbootproperty removes one or more property values from the InfoSphere Streams bootstrap configuration.
  • streamtool rmcertificate
    The streamtool rmcertificate command removes a client certificate from the web management service (SWS) truststore.
  • streamtool rmdomain
    The streamtool rmdomain command removes a domain.
  • streamtool rmdomainhost
    The streamtool rmdomainhost command removes one or more InfoSphere Streams resources from the domain. It also stops the domain controller service on each resource.
  • streamtool rmdomainproperty
    The streamtool rmdomainproperty removes one or more property values from a domain.
  • streamtool rmdomainrole
    The streamtool rmdomainrole command removes a role from a domain.
  • streamtool rmgroupdomainrole
    The streamtool rmgroupdomainrole command removes a group from the list of groups that have a specific role in a domain.
  • streamtool rmgrouprole
    The streamtool rmgrouprole command removes a group from the list of groups that have a specific role in an instance.
  • streamtool rmhost
    The streamtool rmhost command removes one or more resources from an instance.
  • streamtool rmhosttag
    The streamtool rmhosttag command removes tags from a domain.
  • streamtool rminstance
    The streamtool rminstance command removes an instance from a domain.
  • streamtool rmjobgroup
    The streamtool rmjobgroup command removes a job group from an instance.
  • streamtool rmkey
    The streamtool rmkey command removes the public and private key pair for a user.
  • streamtool rmproperty
    The streamtool rmproperty command removes one or more properties from an instance.
  • streamtool rmresourcespec
    The streamtool rmresourcespec command removes a resource specification from an instance.
  • streamtool rmrole
    The streamtool rmrole command removes a role from an instance.
  • streamtool rmtag
    The streamtool rmtag command removes tags from a domain.
  • streamtool rmtagproperty
    The streamtool rmtagproperty command removes properties from the resource definition that is associated with a tag.
  • streamtool rmtrustedorigin
    The streamtool rmtrustedorigin command removes an origin from the list of origins that are trusted by the InfoSphere Streams REST API.
  • streamtool rmuserdomainrole
    The streamtool rmuserdomainrole command removes a user from the list of users that have a specific role in a domain.
  • streamtool rmuserrole
    The streamtool rmuserrole command removes a user from the list of users that have a specific role in an instance.
  • streamtool setacl
    The streamtool setacl command changes the access or default permissions for an object in an InfoSphere Streams instance.
  • streamtool setbootproperty
    The streamtool setbootproperty sets one or more property values in the InfoSphere Streams bootstrap configuration.
  • streamtool setdomainacl
    The streamtool setdomainacl command changes the permissions for an object in an InfoSphere Streams domain.
  • streamtool setdomainproperty
    The streamtool setdomainproperty sets one or more property values for a domain.
  • streamtool setigcadminconfig
    The streamtool setigcadminconfig command manages the user IDs and passwords that can administer the IBM InfoSphere Information Governance Catalog.
  • streamtool setldapadminconfig
    The streamtool setldapadminconfig command changes the Lightweight Directory Access Protocol (LDAP) administrator authentication credentials for a domain.
  • streamtool setloginconfig
    The streamtool setloginconfig command changes the authentication configuration information for a domain. You must provide the information in a file.
  • streamtool setproperty
    The streamtool setproperty command sets one or more property values for an instance.
  • streamtool settagproperty
    The streamtool settagproperty command updates the resource definition that is associated with a tag.
  • streamtool startdomain
    The streamtool startdomain command starts a domain.
  • streamtool startdomainhost
    The streamtool startdomainhost command starts the domain controller service on an InfoSphere Streams resource.
  • streamtool startinstance
    The streamtool startinstance command starts an InfoSphere Streams instance.
  • streamtool stopdomain
    The streamtool stopdomain command stops a domain.
  • streamtool stopdomainhost
    The streamtool stopdomainhost command stops the domain controller service on an InfoSphere Streams resource in an enterprise domain.
  • streamtool stopinstance
    The streamtool stopinstance command stops an InfoSphere Streams instance.
  • streamtool stoppe
    The streamtool stoppe command stops one or more processing elements (PEs).
  • streamtool submitjob
    The streamtool submitjob command submits one or more jobs.
  • streamtool trace
    The streamtool trace command updates or returns information about the trace settings in InfoSphere Streams.
  • streamtool unregisterdomainhost
    The streamtool unregisterdomainhost command removes an InfoSphere Streams resource from the domain.
  • streamtool updatecertificate
    The streamtool updatecertificate command updates a client certificate in the web management service truststore.
  • streamtool updatelicense
    The streamtool updatelicense command updates the InfoSphere Streams product license.
  • streamtool updatepe
    The streamtool updatepe command updates the configuration settings for one or more processing elements (PEs).
  • streamtool updateusers
    The streamtool updateusers command retrieves user and role information from the authentication and authorization service.
  • streamtool version
    The streamtool version command reports version information for InfoSphere Streams.
  • streamtool viewlog
    The streamtool viewlog command retrieves a log or trace file and opens an editor ($VISUAL, $EDITOR, or vi) to view the contents.
Related reference:
Java cache for InfoSphere Streams streamtool command operations