IPPrint Element Documentation

IPPrint -- Click element; pretty-prints IP packets

IPPrint([LABEL, KEYWORDS])

Ports: 1 input, 1 output
Processing: agnostic
Package: ip (core)

Expects IP packets as input. Should be placed downstream of a CheckIPHeader or equivalent element. Prints out IP packets in a human-readable tcpdump-like format, preceded by the LABEL text. Keyword arguments are:

CONTENTS

Determines whether the packet data is printed. It may be `NONE' (do not print packet data), `HEX' (print packet data in hexadecimal), or `ASCII' (print packet data in plaintext). Default is `NONE'.

PAYLOAD

Like CONTENTS, but prints only the packet payload, rather than the entire packet. Specify at most one of CONTENTS and PAYLOAD.

NBYTES

If CONTENTS is `hex' or `ascii', then NBYTES determines the number of bytes to dump. Default is 1500.

ID

Boolean. Determines whether to print each packet's IP ID field. Default is false.

TTL

Boolean. Determines whether to print each packet's IP TOS field. Default is false.

TOS

Boolean. Determines whether to print each packet's IP TOS field. Default is false.

LENGTH

Boolean. Determines whether to print each packet's IP length field. Default is false.

TIMESTAMP

Boolean. Determines whether to print each packet's timestamp in seconds since 1970. Default is true.

AGGREGATE

Boolean. Determines whether to print each packet's aggregate annotation. Default is false.

PAINT

Boolean. Determines whether to print each packet's paint annotation. Default is false.

SWAP

Boolean. Determines whether to swap bytes before printing the values of ICMP sequence and ID numbers. Default is false. The RFC does not require these two-byte values to be sent in any particular byte order. For example, OpenBSD/i386 writes ping (ICMP echo) sequence numbers in network byte order, while Linux/i386 writes them in host byte order (often little-endian).

OUTFILE

String. Only available at user level. Print information to the file specified by OUTFILE instead of standard error.

Print, CheckIPHeader

Generated by 'click-elem2man' from '../elements/ip/ipprint.hh' on 18/Sep/2007.