IPPrint

IPPrint Element Documentation

NAME

IPPrint — Click element; pretty-prints IP packets

SYNOPSIS

IPPrint([LABEL, KEYWORDS])

Batching: Batching natively supported
Ports: 1 input, 1 output
Processing: agnostic

DESCRIPTION

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.
• MAXLENGTH — If CONTENTS or PAYLOAD printing is on, then MAXLENGTH determines the maximum number of bytes to print. -1 means print the entire packet or payload. Default is 1500.
• ETHER — Boolean. Determines whether to print each packet's Ethernet addresses. Default is false.
• 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.
• VLAN — Boolean. Determines whether to print each packet's VLAN ID. Default is false.
• PAINT — Boolean. Determines whether to print each packet's paint annotation. Default is false.
• SWAP — Boolean. Determines whether to print ICMP sequence and ID numbers in network order. Default is true. The RFC does not require these two-byte values to be sent in any particular byte order. When Click was originally designed, Linux/i386 wrote ping sequence numbers in host byte order (often little endian), but it uses network order now.
• OUTFILE — String. Only available at user level. Print information to the file specified by OUTFILE instead of standard error.
• ACTIVE — Boolean. If false, then don't print messages. Default is true.

SEE ALSO

Print, CheckIPHeader

Generated by click-elem2man from ../elements/ip/ipprint.hh:6 on 2020/05/07.