Developing Apama Applications > Developing Adapters > Using the IAF > IAF Management – Managing a running adapter I > IAF Management options
IAF Management options
The tool iaf_management.exe (on Windows) or iaf_management (on UNIX) takes a number of command line options. These are:
IAF Management options
-V
Displays version information for the iaf_management tool.
-h
Displays usage information for running the iaf_management tool.
-v
Displays information in a more verbose manner.
-n host
Name of the host of the component that you want to connect to. The default is localhost. You cannot use non-ASCII characters in the host name.
-p port
Port on which the adapter is listening. The default is 16903.
-w
Instructs the iaf_management tool to wait for the component to start. This option is similar to the -W option, except that the -w option instructs the iaf_management tool to wait forever. The -W option lets you specify how many seconds to wait. See the information for the -W option for an example.
-W num
Instructs the iaf_management tool to wait num seconds for the component to start. If the component is not ready before the specified number of seconds has elapsed, the iaf_management tool terminates with an exit code of 1.
-N
Displays the name of the component.
-T
Displays the type of the component that the iaf_management tool connects to.
-Y
Displays the physical ID of the component. This can be useful if you are looking at log information that identifies components by their physical IDs.
-L
Displays the logical ID of the component. This can be useful if you are looking at log information that identifies components by their logical IDs.
-O
Displays the log level of the component. The returned value is one of the following: TRACE, DEBUG, INFO, WARN, ERROR, CRIT, FATAL, or OFF.
-C
Displays the version of the component.
-R
Displays the product version of the component. For example, when the tool connects to a correlator, it displays the version of the Apama software that is running.
-B
Displays the build number of the component. This information is helpful if you need technical support. It indicates the exact software contained by the component you connected to.
-F
Displays the build platform of the component. This information is helpful if you need technical support. It indicates the set of libraries required by the component you connected to.
-P
Displays the process ID of the correlator you are connecting to. This can be useful if you are looking at log information that identifies components by their process ID.
-H
Displays the host name of the component. When debugging connectivity issues, this option is helpful for obtaining the host name of a component that is running behind a proxy or on a multihomed system.
-U
Displays the user name of the component. On a multiuser machine, this is useful for determining who owns a component.
-D
Displays the working (current) directory of the component. This can be helpful if a plug-in writes a file in a component’s working directory.
-E
Displays the port of the component.
-c
This option is for use by technical support. It displays all the connections to the component.
-a
Displays all information for the component.
-xs
Disconnect sender with physical id <id>
-xr
Disconnect receiver with physical id <id>
-I category
This option is for use by technical support. It displays component-specific information for the specified category.
-d
Ping the component. This confirms that the component process is running and acknowledging communications.
-l level
Sets the amount of information that the component logs. In order of decreasing verbosity, you can specify TRACE, DEBUG, INFO, WARN, ERROR, FATAL, CRIT, or OFF.
-r req
This option is for use by technical support. It sends a component-specific request.
-s why
Instructs the component to shut down and specifies a message that indicates the reason for termination. The component inserts the string you specify in its log file with a CRIT flag, and then shuts down.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.