qetharp/qetharp.8

   1 .TH QETHARP 8 "Oct 2009" "s390-tools"
   2 .SH NAME
   3 qetharp \- querying and purging address data in the OSA and HiperSockets hardware.
   4
   5 .SH SYNOPSIS
   6 .TP 8
   7 .B qetharp
   8 .RB [ -hv]
   9 .br
  10 .RB [ -[c|n]q
  11 .IR interface ]
  12 .br
  13 .RB [ -p
  14 .IR interface ]
  15 .br
  16 .RB [ -a
  17 .IR interface
  18 .RB -i
  19 .IR IP_address
  20 .RB -m
  21 .IR MAC_address ]
  22 .br
  23 .RB [ -d
  24 .IR interface
  25 .RB -i
  26 .IR IP_address ]
  27
  28 .SH DESCRIPTION
  29 \fBqetharp\fR is a tool to get information like MAC and IP Addresses from
  30 OSA and HiperSockets. It also allows to flush the ARP table of the mentioned Hardware.
  31
  32 .SH OPTIONS
  33 .TP
  34 \fB-q\fR or \fB--query \fIinterface\fR
  35 shows the ARP information found in the ARP table of OSA or HiperSockets, which depends on \fBinterface\fR. If it is an OSA device, it shows the ARP entries stored in OSA's ARP table, otherwise the ones from HiperSockets' ARP table.
  36 If the \fBIP address\fR is \fBIPv4\fR, \fBqetharp\fR tries  to determine the
  37 symbolic host name, if it fails the IP address will be shown. In case of
  38 \fBIPv6\fR there is no attempt for determination of host names,so the IP address will be shown directly.
  39 .TP
  40 \fB-n\fR or \fB--numeric\fR
  41 shows numerical addresses instead of trying to determine symbolic host names. This option can only be used in conjunction with \fB-q\fR option.
  42 .TP
  43 \fB-c\fR or \fB--compact\fR
  44 shows only numerical addresses without any other information like interface name. Also omits the header.
  45 .TP
  46
  47 \fB-p\fR or \fB--purge \fIinterface\fR
  48 flushes the ARP table of OSA. This option does only work with OSA Devices. \fBqetharp\fR returns immediately.
  49 .TP
  50
  51 \fB-a\fR or \fB--add \fIinterface\fR
  52 adds a static ARP entry to the OSA card. This command needs an IP address and a
  53 MAC address (\fB-i\fR and \fB-m\fR switches).
  54 .TP
  55
  56 \fB-d\fR or \fB--delete \fIinterface\fR
  57 deletes a static ARP entry from the OSA card. This command needs an
  58 IP address (\fB-i\fR switch).
  59 .TP
  60
  61 \fB-i\fR or \fB--ip \fIIP_address\fR
  62 specifies an IP address to be added to or removed from the OSA ARP cache.
  63 .TP
  64 \fB-m\fR or \fB--mac \fIMAC_address\fR
  65 specifies a MAC address to be added to the OSA ARP cache.
  66 .TP
  67
  68 \fB-v\fR or \fB--verbose\fR
  69 shows version information.
  70
  71 .TP
  72 \fB-h\fR or \fB--help\fR
  73 shows usage information for qetharp.
  74
  75 .SH EXAMPLE
  76 .TP
  77 \fBqetharp -q eth0\fR
  78 shows all ARP entries of OSA.
  79 .TP
  80 \fBqetharp -nq eth0\fR
  81 shows all ARP entries of OSA without resolving host names.
  82 .TP
  83 \fBqetharp -p eth0\fR
  84 flushes OSA's ARP table.
  85 .TP
  86 \fBqetharp -a eth0 -i 1.2.3.4 -m aa:bb:cc:dd:ee:ff\fR
  87 adds a static ARP entry for the IP address 1.2.3.4 to OSA's ARP cache, using
  88 a MAC address of aa:bb:cc:dd:ee:ff
  89 .TP
  90 \fBqetharp -d eth0 -i 1.2.3.4\fR
  91 deletes the static ARP entry for the IP address 1.2.3.4 from OSA's ARP cache.
  92
  93 .SH AUTHOR
  94 .nf
  95 This man-page was written by Frank Pavlic <pavlic@de.ibm.com>