Connecting Apama Applications to External Components > Developing Custom Adapters > Using the IAF > The IAF runtime > IAF command line options
IAF command line options
The complete usage information for the executable iaf (on UNIX) or iaf.exe (on Windows) is as follows. This can be displayed at any time by launching the IAF with the --help option.
Usage: iaf [ options ] [ config.xml ]
Where config.xml is the name of a configuration file using the format
described in the Integration Adapter Framework documentation.
Options include:
  -V | --version           Print program version info
  -h | --help              This message
  -p | --port <port>    Port to listen for commands on (default is 16903)
  -f | --logfile <file>    Log to named file (default is stderr)
  -l | --loglevel <level>  Set logging verbosity. Available levels
                          are TRACE, DEBUG, INFO, WARN, ERROR, FATAL, CRIT and OFF.
                           The default logging level is INFO.
  -t | --truncat           Truncate the log file
  -N | --name <name>       Set the component name
  -e | --events            Dump event definitions to stdout then exit
--logQueueSizePeriod <p> Send info to log every <p> seconds
  -Xconfig | --configFile <file> Use service configuration file <file>
 
Note that a configuration file must be provided unless the -h or -V
options are used.
Unless –e or --events are used, the above will generate and start a custom adapter, load and initialize the plug-ins defined in the configuration file, connect to Apama, and start processing incoming messages.
When the –e or --events command line switches are used, iaf generates event definitions that can be saved to a file and injected during your application’s startup sequences as specified by Apama Studio, the Enterprise Management and Monitoring console (EMM), or Apama command line tools. If either of these switches is used, the IAF will load the IAF configuration file, process it, generate the event definitions and print them out onto stdout (standard output) and promptly exit. A valid configuration file must be supplied with either of these switches. The output definitions are grouped by package, with interleaved comments between each set. If all the event types in the configuration are in the same package, the output will be valid EPL code that can be injected directly into the correlator. Otherwise, it will have to be split into separate files for each package. The IAF can be configured to automatically inject event definitions into a connected correlator, but this is not the default behavior. The event definitions generated by the -e or --events options are exactly what the IAF would inject into the correlator, if configured to do so.
The –Xconfig and --configFile are reserved for usage under guidance by Apama support. For more information about the service configuration file, see Using the Apama component extended configuration file.
If the --logfile and --loglevel command line switches are provided, any logging settings set in the IAF configuration file (<logging> and <plugin-logging>) will be ignored.
If the IAF cannot write to the log file specified either with the --logfile option or in the adapter’s configuration file, the IAF will fail to start.
Copyright © 2013-2015 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.