Home Page The Club Computers News Links Glossary EYAWTK
Before Amiga Background ICS OCS ECS AGA ??? PPC
U-Boot SLB Linux Amiga OS Dual Boot Motherboards Peripherals Other
Initialisation Installation OS4 Updates About OS4 File Systems Networking Printing Other
Introduction File System Workbench Preferences Commands Error Msgs Miscellaneous

AmigaOS 4.0 - About OS4 - Commands

IPFSTAT Networking
Purpose: To report on packet filter statistics and filter list.
Format: IPFSTAT [ -aAfghIinosv ] -d <device>

IPFSTAT -t [ -C ] [ -D <addrport> ] [ -P <protocol> ] [ -S <addrport> ]
[ -T <refresh time> ] -d <device>

Template: (none)
Path: C:IPFSTAT
IPFSTAT reports on packet filter statistics and filter list. It examines '/dev/kmem' using the symbols _fr_flags, _frstats, _filterin, and _filterout. To run and work, it needs to be able to read both /dev/kmem and the kernel itself. The kernel name defaults to /vmunix.

The default behaviour of IPFSTAT is to retrieve and display the accumulated statistics which have been accumulated over time as the kernel has put packets through the filter.

The following options are available:

-a Displays the accounting filter list and show bytes counted against each rule.
-A Displays packet authentication statistics.
-C This option is only valid in combination with -t and displays "closed" states as well in the top. Normally, a TCP connection is not displayed when it reaches the CLOSE_WAIT protocol state. With this option enabled, all state entries are displayed.
-d <device> Uses a device other than /dev/ipl for interfacing with the kernel.
-D <addrport> This option is only valid in combination with -t and limits the state top display to show only state entries whose destination IP address and port match the <addrport> argument. The addrport specification is of the form ipaddress[,port]. The ipaddress and port should be either numerical or the string "any" (specifying any ip address resp. any port). If the -D option is not specified, it defaults to "-D any,any".
-f Shows fragment state information (statistics) and held state information (in the kernel) if any is present.
-g Shows groups currently configured (both active and inactive).
-h Shows per-rule the number of times each one scores a "hit". For use in combination with -i.
-i Displays the filter list used for the input side of the kernel IP processing.
-I Swaps between retrieving "inactive"/"active" filter list details. For use in combination with -i.
-n Shows the "rule number" for each rule as it is printed.
-o Displays the filter list used for the output side of the kernel IP processing.
-P <protocol> This option is only valid in combination with -t and limits the state top display to show only state entries that match a specific <protocol>. The argument can be a protocol name (as defined in /etc/protocols) or a protocol number. If this option is not specified, state entries for any protocol are specified.
-s Shows packet/flow state information (statistics only).
-sl Shows held state information (in the kernel) if any is present (no statistics).
-S <addrport> This option is only valid in combination with -t and limits the state top display to show only state entries whose source IP address and port match the <addrport> argument. The addrport specification is of the form ipaddress[,port]. The ipaddress and port should be either numerical or the string "any" (specifying any ip address resp. any port). If the -S option is not specified, it defaults to "-S any,any".
-t Shows the state table in a way similar to they way 'top' (Unix/Linux - not available on OS4) shows the process table. States can be sorted using a number of different ways. This option requires ncurses and needs to be compiled in. It may not be available on all operating systems. See below, for more information on the keys that can be used while IPFSTAT is in 'top' mode.
-T <refreshtime> This option is only valid in combination with -t and specifies how often the state top display should be updated. The refresh time is the number of seconds between an update. Any positive integer can be used. The default (and minimal update time) is 1.
-v Turns verbose mode on. Displays more debugging information.

The role of IPFSTAT is to display current kernel statistics gathered as a result of applying the filters in place (if any) to packets going in and out of the kernel. This is the default operation when no command line parameters are present.

When supplied with either -i or -o, it will retrieve and display the appropriate list of filter rules currently installed and in use by the kernel.

STATE TOP
Using the -t option IPFSTAT will enter the state top mode. In this mode the state table is displayed similar to the way top displays the process table. The -C, -D, -P, -S and -T commandline options can be used to restrict the state entries that will be shown and to specify the frequency of display updates.

In state top mode, the following keys can be used to influence the displayed information:

d - select information to display.

l - redraw the screen.

q - quit the program.

s - switch between different sorting criterion.

r - reverse the sorting criterion.

States can be sorted by protocol number, by number of IP packets, by number of bytes and by time-to-live of the state entry. The default is to sort by the number of bytes. States are sorted in descending order, but you can use the r key to sort them in ascending order.

STATE TOP LIMITATIONS
It is currently not possible to interactively change the source, destination and protocol filters or the refresh frequency. This must be done from the command line.

The screen must have at least 80 columns. This is however not checked.

Only the first X-5 entries that match the sort and filter criteria are displayed (where X is the number of rows on the display. There is no way to see more entries.

No support for IPv6.

Example 1:

  3.OS4:> IPFSTAT
   input packets:         blocked 0 passed 0 nomatch 0 counted 0 short 0
  output packets:         blocked 0 passed 0 nomatch 0 counted 0 short 0
   input packets logged:  blocked 0 passed 0
  output packets logged:  blocked 0 passed 0
   packets logged:        input 0 output 0
   log failures:          input 0 output 0
  fragment state(in):     kept 0  lost 0
  fragment state(out):    kept 0  lost 0
  packet state(in):       kept 0  lost 0
  packet state(out):      kept 0  lost 0
  ICMP replies:   0       TCP RSTs sent:  0
  Invalid source(in):     0
  Result cache hits(in):  0       (out):  0
  IN Pullups succeeded:   0       failed: 0
  OUT Pullups succeeded:  0       failed: 0
  Fastroute successes:    0       failures:     0
  TCP cksum fails(in):    0       (out):  0
  Packet log flags set: (0x0)
          none

default output.


Return to Commands Selection

Disclaimer: Amiga Auckland have prepared the above information for the use of its members based on our experiences and as such is subject to revision at any time. Amiga Auckland cannot guarantee any of the information and cannot be held accountable for any issues that may result from using it.


Copyright 2006 Amiga Auckland Inc. All rights reserved.
Revised: February 9, 2006.