IBM InfoSphere Streams Version 4.1.1

streamtool mkhostfile

The streamtool mkhostfile command creates a host file from a collection of application files that are generated by the SPL compiler.

Usage


mkhostfile

>>-+-+- -a------------+--application-bundle-name-+-------------->
   | '- --application-'                          |   
   '-+- -f-----+--pathname-----------------------'   
     '- --file-'                                     

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

>--+-----------------------+--generated-host-file--------------><
   '-+- -v--------+--level-'                        
     '- --verbose-'

Authority

You do not need any authority to run this command.

Description

A streams processing application contains specifications about resource requirements. If the resource requirements for an application are not satisfied, the job submission fails. You can use the streamtool mkhostfile command to generate a host file that is based on the resource and host pool specifications in a streams processing application.

The list of applications, which you specify with the -f or --file pathname option, can have the same format as the file that you provide to the streamtool submitjob command. If any submission parameters are present in the file, they are ignored.

You can use the generated host file as input to the streamtool mkinstance and addhost commands.

Note: The output of this command specifies the minimum instance configuration information necessary to support the streams processing application. The output does not, however, consider the application placement constraints such as exlocate and hostisolation config placements. You might need to adjust the quantity of resources to satisfy the real-time placement constraints. When you submit the job, error messages provide advice about the adjustments that are required.

Options and arguments

-a, --application application-bundle-name

Specifies the path name for the application bundle file. If you do not specify an absolute path, the command seeks the file in the directory where you ran the command. Alternatively, you can specify the path name for the application description language (ADL) file if the application bundle file exists in the same directory.

-f, --file pathname

Specifies the name of an input file that contains a list of application bundle files. You can specify file names that have fully qualified paths or paths that are relative to the current directory. The input file must contain one file name per line.

generated-host-file

Specifies the name of the host file that is generated by the command. If you do not specify a relative or fully qualified path, the command creates the file in the current directory.

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

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

Examples

The following example shows the commands for generating a host file for the HostConstraint sample application:

$ cd $STREAMS_INSTALL/samples/spl/feature/HostConstraint
$ make
$ streamtool mkhostfile -a output/sample.HostConstraint.sab hostfile.gen
CDISC0177I InfoSphere Streams is processing the sample::HostConstraint application
from the application that is stored in the ...sample.HostConstraint.sab file path.
CDISC0104I The following host file was created: hostfile.gen.

The hostfile.gen file contains the following information:

# ----------------------------------------------------------------------
# InfoSphere Streams is processing the sample::HostConstraint application
from the application that is stored in the ...sample.HostConstraint.sab file path.
# ----------------------------------------------------------------------

# Host pool '$default':
--numresources 4[SHARED]