IBM InfoSphere Streams Version 4.1.1

streamtool restartpe

The streamtool restartpe command restarts one or more processing elements (PEs). The PEs can be identified by their PE ID or be any stopped PEs that belong to one or more specified jobs.

Usage


restartpe

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

>--+-------------------------+--+-------------------------+----->
   '-+- -i------------+--iid-'  |              .-,-----.  |   
     '- --instance-id-'         |              V       |  |   
                                +-+- -j-----+----jobid-+--+   
                                | '- --jobs-'             |   
                                '- --resource--resourceID-'   

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

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

                                     .-----------.   
                                     V           |   
>--| Non-interactive tool options |----+-------+-+-------------><
                                       '-pe-id-'     

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 add and delete authority for the appropriate jobgroup_name instance object. By default, the DomainAdministrator and InstanceAdministrator roles have this authority. The user who submits the job also has this authority. For more information about access control lists, see the streamtool getacl and streamtool lsjobpermission commands.

Description

If any of the PEs are not configured as restartable, the command fails to restart those PEs and returns error messages.

If the PE is restartable and relocatable and you do not specify the --resource option, it is automatically restarted on an available resource that is chosen by the scheduler service. If you specify the --resource option, the PE is restarted on that specific resource.

Important: Exercise caution with restarting a PE on a specific resource. This action overrides the original resource constraints that are defined in the application and bypasses the scheduler service. The PE is constrained to run only on that resource. If the resource crashes, the PE is not automatically restarted on other available resources.

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.

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

-j, --jobs job-id

Specifies a list of job IDs, which are delimited by commas.

pe-id

Specifies the processing element ID.

--resource resourceID

Specifies a resource identifier, which varies depending on the resource manager. For example, it might be a host name or IP address. The command restarts the processing element on this resource.

--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:
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 restarts the processing element with an ID of 3:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] restartpe 3

The following command restarts all stopped processing elements that are associated with job IDs 5 and 20.

[streamtool <bsmith@StreamsDomain.StreamsInstance>] restartpe --jobs 5,20