IAF Management – Managing a running adapter I
The IAF Management tool is provided for performing generic component management operations on a running adapter. It can be used to shut down a running adapter, request the process ID of a running adapter, or check that an adapter process is running and acknowledging communications. Any output information is displayed on stdout.
See also
IAF Client – Managing a running adapter II for IAF-specific management information, as opposed to this generic component management tool.
The executable for interfacing with the IAF's management interface status is iaf_management.exe (on Windows) or iaf_management (on UNIX). When it is run with the –h command line option, it displays the following usage information:
Usage: iaf_management [ options ]
Where options include:
-V | --version Print program version info
-h | --help Display this message
-v | --verbose Be more verbose
-n | --hostname <host> Connect to a component on <host>
-p | --port <port> Component is listening on <port>
-w | --wait Wait forever for component to start
-W | --waitFor <num> Wait <num> seconds for component to start
-N | --getname Get the name of the component
-T | --gettype Get the type of the component
-Y | --getphysical Get the physical ID of the component
-L | --getlogical Get the logical ID of the component
-O | --getloglevel Get the log level of the component
-C | --getversion Get the version of the component
-R | --getproduct Get the product version of the component
-B | --getbuild Get the build number of the component
-F | --getplatform Get the build platform of the component
-P | --getpid Get the process ID of the component
-H | --gethostname Get the hostname of the component
-U | --getusername Get the username of the component
-D | --getdirectory Get the working (current) directory of the component
-E | --getport Get the port of the component
-c | --getconnections Get all the connections to the component
-a | --getall Get all of the above values
-xs| --disconnectsender <id> <reason> Disconnect sender with physical id <id>
-xr| --disconnectreceiver <id> <reason> Disconnect receiver with physical id <id>
-I | --getinfo <category> Get component-specific info for <category>
Use empty string to get all available categories
Multiple -I options may be specified
-d | --deepping Deep-ping the component
-l | --setloglevel <level> Set logging verbosity to <level>. Available levels
are TRACE, DEBUG, INFO, WARN, ERROR, FATAL, CRIT and OFF
-r | --dorequest <req> Send component-specific request <req>
-s | --shutdown <why> Shutdown the component with reason <why>
For historical reasons, iaf_management does the same as engine_management. The only difference in behavior is that iaf_management uses the default IAF port 16903.
For detailed descriptions of all options and exit values, see
Shutting down and managing components.