OPTIONS keywords

The following keywords are used for the OPTIONS component routine parameters. You can enter complete keywords. You can also enter a portion of the characters to make the keyword distinguishable from other keywords. For example, for the DISCARD keyword, you can enter DISCARD, DISCAR, DISCA, DISC, DIS, or DI.

AH

Select packets with an AH extension header.

ASCII

Packet trace data dumped is shown in hexadecimal and interpreted in ASCII translation only. The default is BOTH.

BASIC ([DETAIL|SUMMARY])

For specific packet types, format each element of the packet data. This parameter applies to DNS, RIP, and SNMP packet data.

DETAIL: Format the IP header, protocol header, and protocol data in as few lines as possible. DETAIL is the default.
SUMMARY: Format the IP and protocol headers in as few lines as possible.

BOOTP[(port_number|67 port_number|68)]

Select BOOTP and DHCP protocol packets. The port_number defines the BOOTP and DHCP port numbers to select packets for formatting. Equivalent to PORT(67 68).

BOTH

Packet trace data dumped is shown in hexadecimal and interpreted with both ASCII and EBCDIC translations. The default is set to BOTH, but it is subject to change depending on protocol used. For example, when using TELNET, only the EBCDIC translation is used.

BROADCAST

Select packets with a broadcast IPv4 address. Equivalent to IPADDR(255.255.255.255/255.255.255.255).

CHECKSUM [(DETAIL|SUMMARY)]

The selected packets have their checksum values validated.

DETAIL: If there is a checksum error, then the packet is formatted and dumped.
SUMMARY: A message is issued for each packet that encounters a checksum error. SUMMARY is the default.

CID

Select data trace records that contain the specific connection ID value. The connection ID value can be determined from the Netstat COnn/-c report. For TCP connections across Shared Memory Communications, data trace records can be selected by using the local SMC link ID (LocalSMCLinkId). This SMC link ID can be determined from the Netstat ALL/-A or Netstat DEvlinks/-d report. Up to 16 values or ranges can be specified.

CLASSA

Select packets with a class A IPv4 address. Equivalent to IPADDR(0.0.0.0/128.0.0.0).

CLASSB

Select packets with a class B IPv4 address. Equivalent to IPADDR(128.0.0.0/192.0.0.0).

CLASSC

Select packets with a class C IPv4 address. Equivalent to IPADDR(192.0.0.0/224.0.0.0).

CLASSD

Select packets with a class D IPv4 address. Equivalent to IPADDR(224.0.0.0/240.0.0.0).

CLASSE

Select packets with a class E IPv4 address. Equivalent to IPADDR(240.0.0.0/248.0.0.0).

CLEANUP(nnnnn|500)

Defines a record interval where saved packet information in storage is released. The minimum value is 500 records; the maximum value is 1048576 records; the default is 500 records. If you set the record interval to 0, cleanup does not occur.

DATASIZE (data_size|0)

Selects packets that contain more protocol data than the data_size value. The minimum value is 0. The maximum value is 65535. The data size is determined from the amount of packet data available minus the size of any protocol headers. Equivalent to FLAGS(DATA).

DATTRACE

Select packets that are written from the VARY TCPIP,,DATTRACE command.

DEBUG(debug_level_list)

Provides documentation about SYSTCPDA format processing. debug_level_list is a list of numbers from 1 to 64. Use only under the direction of an IBM® Service representative.

DELAYACK(threshold|200)

The delay acknowledgment threshold in milliseconds used in the calculation of round-trip time in the TCP session report. The minimum value is 10 milliseconds. The maximum value is 1000 milliseconds. The default value is 200 milliseconds.

DEVICEID(device_id)

Selects packets that are written to or received from an OSAENTA trace with one of the specified device identifiers. One to 16 device IDs can be specified. This filter applies only to type 7 trace records. The device_id value is a hexadecimal number in the form X'csmfclua':

cs: The channel subsystem ID for this datapath device.
mf: The LPAR Multiple Image Facility ID for the LPAR that is using this datapath device.
cl: The control unit logical identifier for this datapath device.
ua: The unit address for this datapath device.

Each identifier is a two-digit hexadecimal value in the range 00 - FF.

Tip: You can obtain the device_id values for any active user of the OSA by using the Hardware Management Console (HMC). For a data device that is active on a z/OS stack, you can obtain the device_id value for that data device from message IST2190I of the output from the D NET,TRLE command.

DEVTYPE(device_type_list)

Select packets that are written to or received from an interface with one of the specified device types. This does not apply to data trace records. The following types can be specified:

ATM
CDLC
CLAW
CTC
ETHER8023
ETHERNET
ETHEROR8023
FDDI
HCH
IBMTR
IPAQENET
IPAQENET6
IPAQIDIO
IPAQIDIO6
IPAQIQC
IPAQIQC6
IPAQTR
IQDX
IQDX6
ISM
LOOPBACK
LOOPBACK6
MPCPTP
MPCPTP6
OSAFDDI
OSAENET
RNIC
SNALINK
SNALU62
VIRTUAL
VIRTUAL6
X25NPSI

DISCARD(reason_code_list)

Select packets with one of the specified discard reason codes. Up to 16 discard reason codes can be specified in the range 0 - 65535. Each entry in the list can be a range: low_number:high_number. Values can be decimal or hexadecimal.

    0   
      Packet was not discarded
    1:4087     A packet was discarded by OSA-Express
    1:1023     Select packets discarded by OSA-Express for DISCARD=EXCEPTION
reasons
    4096:8191  IP packet was discarded by TCPIP
    8192:12287 TCP packet was discarded by TCPIP

See z/OS Communications Server: IP and SNA Codes for the TCP/IP discard reason codes.

DNS[(port_number|53)]

Select Domain Namer Service protocol packets. The port_number defines the DNS port number to select packets for formatting. Equivalent to PORT(53).

DOMAIN[(port_number|53)]

Select Domain Namer Service protocol packets. The port_number defines the DNS port number to select packets for formatting. Equivalent to PORT(53).

DUMP[(nnnnn|65535)]

Dump the selected packets in hexadecimal with EBCDIC and ASCII translations. The IP and protocol headers are dumped separately from the packet data. The value nnnnn represents the maximum amount of packet data that is to be dumped from each packet. The default value is 65535 bytes. The minimum value is 0. The maximum value is 65535. The IP and protocol headers are not subject to this maximum.

The default report options are DUMP and FORMAT.

The BOTH, ASCII, EBCDIC, and HEX keywords describe how the dumped packets are translated. The default is BOTH. The display can be changed by using these keywords. The default ASCII translation table is used. This table might not match the table that is being used by the application. When you are formatting the CTRACE, it is helpful to have the correct line length. Use the IPCS PROFILE LINESIZE command to set the line length. For example,

IPCS PROFILE LINESIZE(80)

sets the maximum line length to 80 characters so that all formatted data is viewable within 80 characters.

If the STREAM report is chosen, then the dump of the packets is deferred until the stream of data is collected.

EBCDIC

Packet trace data dumped is shown in hexadecimal and interpreted with EBCDIC translation only. The default is BOTH.

EE

Select Enterprise Extender (EE) protocol packets. The port number defines the first EE port number to select packets for formatting. The EE port number and the next four port numbers are used. Equivalent to PORT(12000:12004).

ELEMENT(element_number_list)

Select SNA protocol packets with a matching origin or destination element address in the TH2 or TH4 transmission header. Valid values are in the range 0 - 65535. Up to 16 element numbers can be specified.

ESP

Select packets with a protocol number of 50. Equivalent to PROTOCOL(50).

ETHTYPE(type)

Selects packets that are written to or received from an OSAENTA trace with one of the specified frame types. From 1 to 16 types can be specified. This filter applies only to type 7 trace records. The following types can be specified:

x'0800'  for IP
x'86DD' for IPV6
x'0806' for ARP
x'80d5' for SNA

EXPORT[(DETAIL|SUMMARY)]

The selected packets are written to the EXPORT data set in .CSV (Comma Separated Value) format. In .CSV format, each character field is surrounded by double quotation marks and successive fields are separated by commas. The first line of the file defines the fields. Each subsequent line is a record that contains the values for each field.

DETAIL: Format the IP header, protocol header, and protocol data as separate lines of data.
SUMMARY: Format the IP header and protocol header in one line of data. SUMMARY is the default.

Allocate a file with DDNAME of EXPORT before you invoke the CTRACE command with EXPORT in the OPTIONS string.

ALLOC
FILE(EXPORT) DA(PACKET.CSV) SPACE(15 15) TRACK

The record format is variable block with logical record length of 512 bytes.

FINGER[(port_number|79)]

Select FINGER protocol packets. The port_number defines the FINGER port number to select packets for formatting. Equivalent to PORT(79).

FIRST|LAST

Selects which packet in a set of encapsulated packets is used for selection. An example is the ICMP error report packet that contains the IP header that is in error. FIRST indicates that the ICMP packet is used for selection. LAST indicates that the last encapsulated IP header is used for selection. FIRST is the default.

If a packet is encapsulated for IPSec with Encapsulating Security Payload (ESP), all inner packets are encrypted. In this case, FIRST is used for selection when these packets are analyzed.

FLAGS(flags list)

Select packets that have the matching characteristics. Flags that can be specified are:

ALL: When more than one flag is specified, the packet must meet all the criteria of the flags requested. ALL is the default.
ANY: When more than one flag is specified, the packet need meet only one of the criteria of the flags requested.
ABBREV: Select packets that are abbreviated.
ACK: Select packets that have a TCP header with the ACK flag set.
BAD: Select packets that might be too short to contain all the required headers
BBI: The SNA packet contains a begin bracket indicator.
BCI: The SNA packet contains a begin chain indicator.
CDI: The SNA packet contains a change direction indicator.
CEBI: The SNA packet contains a conditional end bracket indicator.
CKSUM: Select packets that have a check sum error
CLC: The SMC Connection Layer Control packets
CSI: The SNA packet contains a code selection indicator.
DATA: Selects packets that contain data.
DF: Select packets that have a non-zero discard code. These packets are discarded by TCP/IP.
DFC: The SNA packet is a data flow control packet.
DISCARD: Select packets that have a non-zero discard code. These packets are discarded by OSA-Express® or by TCP/IP.
DR1: The SNA packet is requesting a DR1 response.
DR2: The SNA packet is requesting a DR2 response.
EBI: The SNA packet contains an end bracket indicator.
ECI: The SNA packet contains an end chain indicator.
EDI: The SNA packet contains an enciphered data indicator.
ERI: The SNA packet is an error response.
FI: The SNA packet contains formatted data.
FIB: The SNA packet is the first packet of a bracket (or of a conditional begin bracket). The RH BBI flag is set and the EBI flag is not.
FIC: Select packets that are the first in chain SNA RU.
FIN: Select packets that have a TCP header with the FIN flag set.
FIS: Select packets that are in the first fragment of an IPv4 or IPv6 packet or the first segment of a SNA PDU.
FMD: The SNA packet is a function management data packet.
FMH: The SNA packet is a function management data header.
FRAME: Selects OSAENTA packets that have a frame header.
FULL: Select packets that are complete.
HOME: Select packets that have an IP destination address equal to the IP source address.
IN: Select packets that are inbound.
IPEXT: Select packets that have an extension header.
IPO: Select packets that have an IPv4 header options field.
IPV4: Select IPv4 packets. IPv4 cannot be used in combination with other data selectors that are IPv6-specific, such as LINKLOCAL.
IPV6: Select IPv6 packets. IPv6 cannot be used in combination with other data selectors that are IPv4-specific, such as BROADCAST.
IPV6EXT: Select packets that have an extension header. IPV6EXT is equivalent to IPEXT.
IQDC: Select inbound packets that have arrived over a HiperSockets Converged (IQDC) Interface on behalf of an associated IPAQENET or IPQENET6 interface. For outbound flows, this flag will never be set as the packet trace is recorded before the decision is made to send the packet over the IQDC interface.
IQDCND: Select ICMPv6 neighbor advertisement and neighbor solicitation packets on an IQDC6 interface.
IQDXND: Select ICMPv6 neighbor advertisement and neighbor solicitation packets on an IQDX6 interface.
LIB: The SNA packet is a last packet of a bracket. The RH BBI flag is not set and the EBI flag is set.
LIC: Select packets that are the last in a chain of SNA RUs.
LIS: Select packets that are the last fragment of an IPv4 or IPv6 packet or the last segment of a SNA PDU.
LPAR: Select NTA packets that are transmitted between LPARs shared by an OSA-Express device.
L2: The OSAENTA packet is from a layer 2 OSA application.
L3: The OSAENTA packet is from a layer 3 OSA application (like TCP/IP).
MIB: The SNA packet is in the middle of a bracket. The RH BBI flag is not set and the EBI flag is not set.
MIC: Select packets that are the middle fragment of an IPv4 or IPv6 packet.
MIS: Select packets that are the middle fragment of an IPv4 or IPv6 packet or the middle segment of a SNA PDU.
NC: The SNA packet is a Network Control packet.
NTA: Select OSAENTA packets.
OFFLOAD: Select outbound packets for which segmentation is offloaded.
OIB: The SNA packet is the only packet of a bracket. The RH BBI flag is set and the EBI flag is set.
OIC: Select packets that are only in a chain SNA RH request.
OIS: Select packets that are IPv4 or IPv6 packets that are not fragmented or that are the only segment of a SNA PDU.
OUT: Select packets that are outbound.
PDI: Select SNA packets with the padded data indicator.
PDU: The IP packets that are packed by TCP/IP into a single PDU buffer.
PI: The SNA packet contains a pacing indicator.
PING: Select packets that are ICMP/ICMPv6 echo request and echo reply.
PSH: Select packets that have a TCP header with the PSH flag set.
QID: Select packets that have a QID value greater than one.
QRI: The SNA packets with a queued response indicator
REQ: The SNA packet is a request.
RESP: The SNA packet is a response.
RLWS: Select SNA packets with the request large window size indicator.
RSM: Select packets that are reassembled.
RST: Select packets that have a TCP header with the RST flag set.
SC: The SNA packet is a session-control packet.
SDI: The SNA packet contains sense data.
SEG: Select packets that are segmented.
SMC: Select SMC packets.
SNA: Select SNA packets.
SYN: Select packets that have a TCP header with the SYN flag set.
TCPO: Select packets that have a TCP header options field.
TOS: Select IPv4 packets that have a nonzero value in the ip_tos field.
TUNNEL: Select packets with protocol number 47 GRE or 41 (IPv6 over IPv4). z/OS Communications Server currently does not support IPv6 over IPv4 (protocol number 41).
URG: Select packets that have a TCP header with the URG flag set.
VLAN: Select packets that have a VLAN 802.1q tag
ZWIN: Select packets that have a TCP header with a zero window value.

Notes:

The use of the FIC, MIC, and LIC flags require the use of the NOREASSEMBLY option.
When a packet is reassembled, then it becomes an OIC packet with the RSM flag set.
Do not intermix SNA and IP flags.

Table 1. Flags that apply to IP or SNA packets
Flag	Applies to IP	Applies to SNA	Comments
ABBREV	Y	Y
BAD	Y	Y
BBI	N	Y
BCI	N	Y
CDI	N	Y
CEBI	N	Y
CI	N	Y
CKSUM	Y	N
CLC	Y	N
CSI	N	Y
DATA	Y	Y
DF	Y	N
DFC	N	Y
DISCARD	Y	Y
DR1	N	Y
DR2	N	Y
EBI	N	Y
ECI	N	Y
EDI	N	Y
ERI	N	Y
FI	N	Y
FIB	N	Y
FIC	N	Y
FIN	Y	N	TCP only
FIS	Y	Y
FM	N	Y
FMD	N	Y
FMH	N	Y
FRAME	N	Y	OSAENTA only
FULL	Y	Y
HOME	Y	N
IN	Y	Y
IPEXT	Y	N
IPO	Y	N
IPV4	Y	N
IPV6	Y	N
IPV6EXT	Y	N
LIB	N	Y
LIC	N	Y
LIS	Y	Y
LPAR	Y	Y	OSAENTA only
L2	Y	Y	OSAENTA only
L3	Y	Y	OSAENTA only
MIB	N	Y
MIC	N	Y
MIS	Y	Y
NC	N	Y
NTA	Y	Y	OSAENTA only
OFFLOAD	Y	N	TCP only
OIB	N	Y
OIC	N	Y
OIS	Y	Y
OUT	Y	Y
PDI	N	Y
PDU	Y	N	SYSTCPDA only
PI	N	Y
PING	Y	N
PSH	Y	N	TCP only
QID	Y	Y	OSA-Express 3 or later ports with QDIO inbound workload queueing enabled.
QRI	N	Y
REQ	N	Y
RESP	N	Y
RLWS	N	Y
RSM	Y	N
RST	Y	N	TCP only
SC	N	Y
SDI	N	Y
SEG	Y	Y
SMC	Y	N
SYN	Y	N	TCP only
TCPO	Y	N	TCP only
TOS	Y	Y	SNA TPF field
TUNNEL	Y	Y
URG	Y	N	TCP only
VLAN	Y	Y	OSAENTA only
ZWIN	Y	N	TCP only

FMT

Equivalent to FORMAT.

FORMAT[(DETAIL|SUMMARY ALL|FIRST|LAST)]

The selected packets with defined packet data are to be formatted. The SHORT keyword on the CTRACE command selects this option if no other report options are specified. The default report options are DUMP and FORMAT.

DETAIL: Format the IP header, protocol header, and the protocol data.
SUMMARY: Format the IP header and protocol header. DETAIL is the default.
ALL: Format all encapsulated packets. ALL is the default.
FIRST: Format the first encapsulated packet.
LAST: Format the last encapsulated packet

An example of an encapsulated packet is an ICMP error report.

FTP[(data_port_number|20 control_port_number|21)]

Select FTP protocol packets. The port_number defines the FTP port numbers to select packets for formatting. Equivalent to PORT(20,21).

FULL

Equivalent to DUMP and FORMAT. The FULL keyword on the CTRACE command selects this option if no other report options are specified.

GAIN(rtgain|125,vargain|250)

Values of the round-trip gain (rtgain) and the variance gain (vargain), in milliseconds, used in the calculation of round-trip time in the TCP session report. Valid values are in the range 0 - 1000. The default value for rtgain is 125. The default value for vargain is 250.

GOPHER[(port_number|70)]

Select GOPHER protocol packets. The port_number defines the GOPHER port numbers to select packets for formatting. Equivalent to PORT(70).

GRE

Select packets with a protocol number of 47. Equivalent to PROTOCOL(47).

GMT

Format the time stamps in GMT time. The default is the value that is specified on the CTRACE subcommand.

HEX

Packet trace data dumped is shown in hexadecimal only with no translation. The default is BOTH.

HPRDIAG[(SUMMARY)]

Select high-performance routing (HPR) packets and group them by transport connection identifier (TCID). The report shows session information that can be helpful for HPR diagnosis.

HOST

Select packets with a host IP address. Equivalent to IPADDR(0.0.0.0/255.255.0.0)

HTTP[(port_number|80)]

Select HTTP protocol packets. The port_number defines the HTTP port numbers to select packets for formatting. Equivalent to PORT(80). See WWW[(port_number|80)].

ICMP

Select packets with a protocol number of 1. Equivalent to PROTOCOL(1).

ICMP6 or ICMPV6

Select packets with a protocol number of 58. Equivalent to PROTOCOL(58).

IGMP

Select packets with a protocol number of 2. Equivalent to PROTOCOL(2).

INTERFACE(interface_name_list) or LINKNAME(interface_name_list)

Select packet trace records with the specified interface name. Up to 16 interface names can be specified. Each interface name can be up to 16 characters. Use an asterisk (*) as a wildcard to replace characters at the end of the interface name.

IPADDR(ipaddr[/mask_or_prefixlength]|X'hhhhhhhh'[]-nnnnn[)

Select packets with a matching IP address, optional IPv4 address mask or IPv6 prefix length and optional port number. Up to 16 IP addresses can be specified. The IPADDR is specified in three parts:

An IPv4 or IPv6 address
The IPv4 address can be in dotted decimal notation, a keyword, or a hex value.
- IPv4 dotted decimal notation
```
127.0.0.1
```
- IPv4 keyword
  
  A
  
  A class A IPv4 address, 0.0.0.0/128.0.0.0
  
  B
  
  A class B IPv4 address, 128.0.0.0/192.0.0.0
  
  C
  
  A class C IPv4 address, 192.0.0.0/224.0.0.0
  
  D
  
  A class D IPv4 address, 224.0.0.0/240.0.0.0
  
  E
  
  A class E IPv4 address, 240.0.0.0/248.0.0.0
  
  H
  
  A local host address, 0.0.0.0/0.0.255.255
  
  L
  
  An IPv4 or IPv6 loopback address, 127.0.0.0/255.0.0.0 or ::1
  
  M
  
  The broadcast IPv4 address, 255.255.255.255/255.255.255.255
  
  *
  
  Any address, 0.0.0.0/0.0.0.0
  
  0
  
  An IPv4 or IPv6 address of zero, 0.0.0.0/255.255.255.255 or ::/128
- IPv4 or IPv6 address as a hexadecimal number up to 32 (IPv4) or 128 (IPv6) digits
```
X'7f000001'
```
- IPv6 address
```
1080::8:800:200C:417A
```
An IPv4 address mask or IPv6 prefix length
The IPv4 address mask (1 - 32) or IPv6 prefix length (1 - 128) is preceded by a slash(/). Specify an IPv4 address mask only when the IPv4 address is in dotted decimal notation. The IPv4 address mask can be in dotted decimal notation, for example: 9.37/255.0.0.0 or 9.37/255.255.0.0
A port number
The port number is preceded by a dash (-). It is a decimal number in the range 0 - 65535.

Notes:

There should be no spaces between the IP addresses and the subnet masks.
The BROADCAST, CLASSA, CLASSB, CLASSC, CLASSD, CLASSE, HOST, LINKLOCAL, LOOPBACK, MULTICAST, and SITELOCAL keywords add to the total of 16 IP addresses.
The port number when used adds to the total of 16 port numbers in the PORT keyword.
IPv4 addresses and IPv4 - mapped IPv6 addresses are treated as equivalent addresses.

IPID(ipid_number_list)

Select packets that match the ip_id number in the IPv4 packet header. Up to 16 ID numbers can be specified in the range 0 - 2147483647 or 0 - X'FFFFFFF'. Each entry in the list can be a range: low_number:high_number. Values can be decimal (nnnnn) or hexadecimal (X'hhhh'). If the packets are fragmented, specify NOREASSEMBLY to select each packet.

Tip: Associated encrypted text is not readable.

IPv4

Equivalent to FLAGS(IPV4).

IPv6

Equivalent to FLAGS(IPV6).

IKE

Select ISAKMP protocol packets. Equivalent to PORT(500). See the ISAKMP keyword.

ISAKMP

Select ISAKMP protocol packets. Equivalent to PORT(500). See the IKE keyword.

JOBLIST|JOBNAME(job_name_list)

Select data trace records with the specified JOBNAME. Up to 16 job names can be specified. Each job name can be up to eight characters. If the last character of a job name is an asterisk (*), then only the characters up to the asterisk are compared.

The CTRACE JOBLIST/JOBNAME parameter provides the same function, except that wildcards are not supported.

LIMIT(record_count)

record_count: The maximum number of records that are formatted. The default value 999999999 records.
Guideline: This keyword is also accepted if specified on the CTRACE subcommand.

LINKLOCAL

Select packets with an IPv6 link-local unicast prefix. Equivalent to IPADDR(FE80::/10).

LINKNAME(link_name_list)

Select packet trace records with the specified LINKNAME. Up to 16 link names can be specified. Each link name can be up to 16 characters. If the last character of a link name is an asterisk (*), then only the characters up to the asterisk are compared.

The CTRACE JOBLIST/JOBNAME parameter provides the same function, except that wildcards are not supported and only the first eight characters of the link name are compared.

LOCAL

Format the time stamps in local time. The default is the value that is specified on the CTRACE subcommand.

LOOPBACK

Select packets with either an IPv4 or IPv6 loop back address. Equivalent to IPADDR(127.0.0.0/255.0.0.0::1). If other addresses are defined as loopback, they can be selected explicitly by using IPADDR().

LOOPBACK6

Select packets with an IPv6 loop back address. Equivalent to IPADDR(::1). If other addresses are defined as loopback, they can be selected explicitly by using IPADDR().

MACADDR(macaddr)

Selects packets that are written to or received from an OSAENTA trace with one of the specified MAC addresses. From 1 to 16 addresses can be specified. This filter applies only to type 7 trace records. A MACADDR is 12 hexadecimal digits.

MULTICAST

Select packets with either an IPv4 or IPv6 multicast address. Equivalent to CLASSD IPADDR(FF00::/8).

NAT

Select NAT protocol packets. Equivalent to PORT(4500).

NOCHECKSUM

The selected packets do not have their checksum values validated. CHECKSUM is the default.

NOREASSEMBLY

Do not reassemble fragmented IP packets into a complete packet. REASSEMBLY is the default.

NOSEGMENT

Packet trace records that span multiple CTRACE records are not recombined. Only the first segment record of packet is used. The rest of the segment records are discarded. SEGMENT is the default.

NOT

If the NOT option is selected then any selection criteria is reversed. If a record matches the selection criteria, it is not processed. If a record does not match the selection criteria, it is processed.

NTP[(port_number|123)]

Select NTP protocol packets. The port number defines the NTP port number to select packets for formatting. Equivalent to PORT(123).

OPTION

The selected options with defaults are listed.

OSPFI

Select packets with a protocol number of 89. Equivalent to PROTOCOL(89).

PACKETTRACE

Select packets that are written from the VARY TCPIP,,PKTTRACE command.

IPEXT

Select packets with an extension header.

PORT(port_number_list)

Select packets with one of the specified port numbers. Up to 16 port numbers can be specified in the range 0 - 65535. Each entry in the list can be a range: low_number:high_number. Values can be decimal (nnnnn) or hexadecimal (X'hhhh'). The following keywords add to the list of 16 port numbers:

BOOTP
DHCP
DNS
DOMAIN
EE
FINGER
GOPHER
HTTP
NAT
IKE
RIP
NTP
ROUTER
RPC
SASP
SMTP
SNMP
TELNET
TFTP
TIME
WWW

PROTOCOL(protocol number list)

Select packets with one of the specified protocol numbers. Up to 16 protocol numbers can be specified in the range 0 - 255. Each entry in the list can be a range: low_number:high_number. Values can be decimal (nnn) or hexadecimal (X'hh').

Protocol filters on only the upper-layer header of an IPv6 packet. It does not filter for IPv6 extension headers (Hop-by-Hop Options, Routing, Fragment). Instead, IPv6 extension headers are included in the display of the basic IPv6 header. The following keywords add to the list of 16 protocol numbers:

AH
ESP
GRE
ICMP
ICMP6,
ICMPV6
IGMP
OSPFI
TCP
UDP

QOS(quality_of_service_list)

Select the records with the matching quality of service from the IPv4 Type of Service field. Up to 16 QoS values can be specified in the range 0 - 7. Each entry in the list can be a range: low_number:high_number. Values can be decimal (n) or hexadecimal (X'h').

QID(qid_list)

Select the records with the matching read queue identifier (QID) from the OSA-Express 3 or later ports with QDIO inbound workload queueing enabled. QID 1 selects records that are received on the primary input queue, and subsequent QIDs select records from the corresponding ancillary input queue (AIQ). Up to 16 QID values can be specified in the range 0 - 8. Each entry in the list can be a range: low_number:high_number. Values can be decimal (n) or hexadecimal (X'h').

REASSEMBLY[(packet_size|65535,DETAIL|SUMMARY)]

Reassemble IP fragments into a complete packet.

packet_size: The maximum size of a reassembled packet that is allowed. The smallest value that is allowed is 576 bytes, the largest is 65535 bytes. The default value is 65535 bytes.
DETAIL: List each of the reassembly statistics for each packet when a packet completes reassembly.
SUMMARY: Show only the reassembly statistics and information about packets that did not complete reassembly.

REASSEMBLY(65535,SUMMARY) is the default.

RECORDS(record_number_list)

Select the records with matching record numbers in the trace data. Up to 16 record numbers can be specified. Record numbers are assigned after any IPCS CTRACE selection criteria are met. Each entry in the list can be a range: low_number:high_number. Values can be decimal (nnnnnnnnnn) or hexadecimal (X'hhhhhhhh').

RIP[(port_number|520)]

Select RIP protocol packets. The port_number defines the RIP port number to select packets for formatting. Equivalent to PORT(520).

ROUTER[(port_number|520)]

Select RIP protocol packets. The port_number defines the RIP port number to select packets for formatting. Equivalent to PORT(520).

RIPNG

Select packets with a port number of PORT(521). Equivalent to PORT(521).

RPC[(port_number|111)]

Select RPC protocol packets. The port_number defines the RPC port number to select packets for formatting. Equivalent to PORT(111).

SASP (port_number|3860)

Select z/OS Load Balancing Advisor port numbers. The port_number defines the SASP port number to select packets for formatting. Equivalent to PORT(3860).

SEGMENT

Packet trace records that span multiple CTRACE records are recombined. Data from segment records is saved until all the CTRACE records are read to recreate the original packet. SEGMENT is the default.

SESSION[(DETAIL|PIPE|STATE|SUMMARY)]

Generate a report that shows TCP or UDP session traffic.

DETAIL: List each of the packets for a session, as well as the summary statistics. DETAIL is the default.
PIPE: List the amount of data left unacknowledged.
STATE: List the beginning and ending state of each session.
SUMMARY: Show only the summary statistics.

Tip: The UDP session analysis is also used for other protocols.

SITELOCAL

Select packets with an IPv6 site-local unicast address prefix. Equivalent to IPADDR(FEC0::/10).

SMC

This packet was sent across Shared Memory Communications.

SMCLLC

Select packets with a protocol number of 252 for Shared Memory Communications over Remote Direct Memory Access (SMC-R). Equivalent to PROTOCOL(252).

SMTP[(port_number|25)]

Select SMTP protocol packets. The port_number defines the SMTP port number to select packets for formatting. Equivalent to PORT(25).

SNIFFER[(nnnnn|200, ETHERNET|TCPDUMP)]

Writes the trace records in a format acceptable for downloading to other trace analysis programs, such as programs from http://www.tcpdump.org/.

nnnnn: The maximum size of trace data. Packets with more data than this value are truncated. The default is 200 bytes. The largest value is derived from the LRECL of the SNIFFER data set.
ETHERNET: If this keyword is specified, the output is formatted for the Ethernet analysis application of the analyzer. This keyword specifies the file format only and does not imply that only packets traced on an Ethernet are collected. Packets from all devices can be collected by using this option.
The default for the SNIFFER option is ETHERNET.
TCPDUMP: The format is compatible with the files with an Ethernet header.

Note: The TOKENRING keyword on the CTRACE OPTIONS(( SNIFFER(TOKENRING) )) on the IPCS CTRACE subcommand is ignored. The ETHERNET format of the sniffer data set is selected.

The trace records are written to the file with a DD name of SNIFFER. After the file is generated, it can be downloaded as a binary file to the analyzer and loaded by using the standard features of the analyzer. Use NOREASSEMBLY to prevent the formatter from reassembling packets. Then, each packet is passed as the packets are collected. The logical record length of the SNIFFER data set determines the largest amount of packet data that is written to the data set.

Allocate a file with DDNAME of SNIFFER before you invoke the CTRACE command with SNIFFER in the OPTIONS string as follows:

ALLOC FILE(SNIFFER)
DA(PACKET.TRC) SPACE(15 15) TRACK +
                       LRECL(8000) BLKSIZE(32000)

The data set has a record format of variable blocked with a logical record length of 8000 bytes. The maximum IP packet size is 7962 (8000 - 38) for SNIFFER(ETHERNET).

The minimum logical record length of the data set is 256 bytes.

Restriction: Do not use the SNIFFER option when the CTRACE subcommands are used with the IPCS MERGE subcommand. The SNIFFER data file is written over by the multiple CTRACE commands that specify the SNIFFER option.

SNMP[(port_number|161 port_number|162)]

Select SNMP protocol packets. The port_number defines the SNMP port number to select packets for formatting. Equivalent to PORT(161 162).

SPEED(local|10,remote|10)

The link speed, in megabits per second, for the local and remote link. These values are used in throughput calculations in the TCP session report. Valid values are in the range 0 - 17171. The default value is 10. Specify the slowest speed of the link in the route.

STATISTICS[(DETAIL|SUMMARY)]

After all the records are processed, generate statistical reports.

DETAIL: Reports are produced showing the number of records that are selected by record type, device type, job name, link name, protocol number, IP address and port numbers. The session summary report is a listing of the IP address and port number pairs that shows the number of records, the first and last record numbers, and the first and last record times.
SUMMARY: Only the session summary report is produced. SUMMARY is the default.

TALLY on the CTRACE command selects this option if no other report options are specified.

STATS

Equivalent to the STATISTICS option.

STREAMS[(stream_size|128 DETAIL|SUMMARY)]

Collect the packet data for dumping or formatting after the trace file is processed. The value nnn represents the maximum amount of storage that is used to capture each stream. The value stream_size represents the maximum amount of storage that is used to capture each stream. The smallest value is 16 KB. The largest value is 512 KB. The default value is 128 KB. The value is in 1024 bytes (1K) units.

SUMMARY: List about each packet in the stream. SUMMARY is the default.
DETAIL: Issue messages about the status of the stream.

Requirement: The DUMP keyword is required to dump the packet data.

SUBAREA(subarea_number_list)

Select SNA protocol packets with a matching subarea address in the TH4 transmission header. Valid values are in the range 1 - 65535. You can specify up to 16 subarea numbers.

SUMMARY

Format a single line for each trace record. SUMMARY on the CTRACE command selects this option if no other report options are specified. If no other report option specified on the CTRACE command, then SUMMARY is selected as the report.

NOTOD: Use the time that the trace data was moved to the CTRACE buffers for the reports. Normally, the time that the trace data was moved to the trace buffer is shown. The CTRACE command uses the time stamp when the trace data was moved to the buffers for START and STOP time selection. NOTOD is the default value for SYSTCPDA and SYSTCPIS traces.
TOD: Use the time that the trace data was captured for the reports. Normally, the time that the trace data was moved to the trace buffer is shown. The CTRACE command uses the time stamp when the trace data was moved to the buffers for START and STOP time selection. TOD is the default value for SYSTCPOT traces, which uses the time stamp that is generated by the OSA trace function.

TALLY

Equivalent to the STATISTICS(DETAIL) option.

TCID(transport connection_id_list)

Select SNA protocol packets with a matching transport connection identifier in the RTP transport header. Valid values include 1 - 16 hexadecimal digits. Up to 16 transport connection identifiers can be specified.

TCP

Select packets with a protocol number of 6. Equivalent to PROTOCOL(6).

TELNET[(port_number|23 [screen_width|80] [SUMMARY|DETAIL] ) ]

Select TELNET protocol packets. The port_number defines the TELNET port number to select packets for formatting. Equivalent to PORT(23).

The screen_width parameter defines the value that is used for converting buffer offsets into row and column values for the 3270 data stream formatting. If the screen_width parameter is provided, then the port_number parameter must also be used. The minimum value is 80. The maximum value is 255. The default value is 80.

SUMMARY formats the 3270 data stream into a representation of the screen.

DETAIL formats each 3270 command and order.

There is no default for DETAIL or SUMMARY.

TFTP[(port_number|69)]

Select TFTP protocol packets. The port_number defines the TFTP port number to select packets for formatting. Equivalent to PORT(69).

TH5ADDR(session_address_list)

Select SNA protocol packets with a matching session address in the TH5 transmission header. Valid values include 1 - 16 hexadecimal digits. You can specify up to 16 session addresses.

TIME[(port_number|37)]

Select TIME protocol packets. The port_number defines the TIME port number to select packets for formatting.

TRAFFICCLASS(traffic_class)

Select the records with the matching IPv6 traffic class field. Up to 16 traffic class values can be specified in the range from 0 to 255. Each entry in the list can be a range: low_number:high_number. Values can be decimal (nn) or Hexadecimal (X'hh').

UDP

Select packets with a protocol number of 17. Equivalent to PROTOCOL(17).

USEREXIT(exitname)

Names the user exit to be called for each selected record. The USEREXIT keyword on the CTRACE command names a user exit that is called before the SYSTCPDA packet trace filtering is done. If this exit routine returns a nonzero return code, then the record is skipped by the SYSTCPDA formatter.

VLANID(vlanid)

Select packets that are written to or received from an OSAENTA trace with one of the specified VLAN identifiers. From 1 to 16 identifiers can be specified. This filter applies only to type 7 trace records. A VLAN identifier has a value in the range 0 - 4094.

Tip: The DEVICEID, MACADDR, ETHTYPE, and VLANID filter keywords apply to SYSTCPOT data. If these keywords are specified with SYSTCPDA data, then these filters are ignored.

WWW[(port_number|80)]

Select HTTP protocol packets. The port_number defines the HTTP port number to select packets for formatting. Equivalent to PORT(80).

X25

Select packet trace records created by the X25 processor.

Tip: This option is obsolete, but it is still accepted.