z/OS Communications Server: IP Programmer's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Input

z/OS Communications Server: IP Programmer's Guide and Reference
SC27-3659-02

  • RCCHeader structure

    Set the RCHRRequest field to RCCSetFilters.

  • RCCFilt structure - Provides filters and options for each trace type.
    The RCCFilt structure is a common structure that contains the following trace-type specific filter structures:
    • RCCPkt - packet trace
    • RCCDat - data trace
    To indicate that you want trace records for a trace type, provide a trace-type specific filter structure. If you do not specify any flag settings in the trace-type specific filter structure, no filter values are in effect for the trace after the RCCStart request is invoked for the trace instance.
Table 1. RCCFilt structure
Offset Field Length Format Description
0(X'0') RCFLEye 4 EBCDIC RCFL eyecatcher
4(X'4')   4 Binary Reserved
8(X'8')       Union of trace-type specific filter control blocks
8(X'8') RCFLPkt     RCCPkt filter structure for packet trace. For layout, see Table 2.
8(X'8') RCFLDat     RCCDat filter structure for data trace. For layout, see Table 3.
Table 2. RCCPkt structure
Offset Field Length Format Description
0(X'0') RCPKEye 4 EBCDIC RCPK eyecatcher
4(X'4') RCPKVer 1 Binary Version
5(X'5')   1 Binary Reserved
6(X'6') RCPKLen 2 Binary Length of the RCCPkt structure
8(X'8') RCPKIpAddr4 4 Binary IP address (source or destination)
  • IPv4 address, if the RCPKFIpAddr flag is set.
  • IPv6 address, if the RCPKFIpAddr flag is set.
RCPKIpAddr6 16 Binary
24(X'18') RCPKPortNum 2 Binary Port number (source or destination)
26(X'1A')   2 Binary Reserved
28(X'1C') RCPKPayload 4 Binary Payload length. The packet headers are always traced. The RCPKPayload value determines how many bytes of payload are traced. For example, if the packet holds a TCP segment of 260 bytes and RCPKPayload is specified as 100, the IP header, the TCP header, and the first 100 bytes of the TCP segment are traced.
The following values are supported for this field:
0
No payload, only headers.
n
Length of payload to be traced.
65535
Maximum amount of data. This is the default value if the RCPKFPayload flag is not set.
32(X'20') RCPKFiltFlags 2 Binary The following flags indicate which filters were set:
  • X'8000', RCPKFPrefix: If this flag is set, an IP address prefix was specified. The RCPKPrefix field contains the specified prefix. If this flag is set, you must also provide an IP address.
  • X'4000', RCPKFProto: If this flag is set, a TCP/IP protocol was specified. The RCPKProto field contains the specified protocol value.
  • X'2000', RCPKFPortNum: If this flag is set, a port number was specified. The RCPKPortNum field contains the specified port number. This value is compared to either the source or destination port numbers.
  • X'1000', RCPKFIntfName: If this flag is set, an interface name was specified. The RCPKIntfName field contains the specified interface name.
32(X'20') RCPKFiltFlags 2 Binary
  • X'0800', RCPKFIpv4Addr: If this flag is set, an IPv4 address was specified. The RCPKIpAddr4 field contains the specified IP address. This flag is mutually exclusive with the RCPKFIpv6Addr flag.
  • X'0400', RCPKFIpv6Addr: If this flag is set, an IPv6 IP address was specified. The RCPKIpAddr6 field contains the specified IP address. This flag is mutually exclusive with the RCPKFIpv4Addr flag.
  • X'0200', RCPKFDiscard: If this flag is set, the RCPKDiscard field contains either an indicator of whether discarded packets should be traced, or a discard reason code. If this flag is not set, trace records are not created for discarded packets.
  • X'0100', RCPKFIPSecClear: If this flag is set, requests trace records that contain IPSec cleartext data. The packets must match the other filters that are specified in this filter structure.
  • X'0080', RCPKFIPSecSecure: If this flag is set, requests trace records that contain IPSec secure data (encapsulated). The packets must match the other filters that are specified in this filter structure.
34(X'22') RCPKOptFlags 1 Binary Flags to indicate which options were set:
  • X'80', RCPKFPayload: If this flag is set, a payload length was specified. The RCPKPayload field contains the specific value. If this flag is not set, the complete payload is traced.
35(X'23')   1 Binary Reserved
36(X'24') RCPKPrefix 1 Binary Prefix length for IP address. The prefix value for an IPv4 address must be in the range 1 - 32; the prefix value for an IPv6 address must be in the range 1 - 128. This is the number of significant bits of the IP address to be considered for a match.
37(X'25') RCPKProto 1 Binary Protocol number (IPPROTO_TCP, IPPROTO_UDP, and so on.)
38(X'26') RCPKDiscard (see Note) 2 Binary Discarded packet indicator or reason code. The indicator values are:
  • 0 - No discarded packets should be traced. This is the default value if the RCPKFDiscard flag is not set.
  • 1 - Trace both discarded and non-discarded packets.
  • 2 - Trace only discarded packets.
The reason code values are in the range 4,096 - 20,479.
40(X'28')   4 Binary Reserved
44(X'2C') RCPKIntfName 16 EBCDIC Interface name over which packet is sent or received. The value must be displayable characters and the letters must be in uppercase.
60(X'3C')   12 Binary Reserved
Note: The RCPKDiscard filter does not apply to EE and SMC-R packets.
Guideline: If applications set the RCPKDiscard value to 0 or 1, applications might receive malformed packets. Applications must be designed to process these packets. The RCPKDiscard value of 0 or 1 enables the stack to trace malformed packets if the packet passes other filters. Applications that set the RCPKDiscard value to 1 can receive the same packet twice:
  • When the packet is traced at the lower-level IP layer.
  • When the packet is a discarded packet in an upper-level protocol layer.
Table 3. RCCDat structure
Offset Field Length Format Description
0(X'0') RCDAEye 4 EBCDIC RCDA eyecatcher
4(X'4') RCDAVer 1 Binary Version
5(X'5')   1 Binary Reserved
6(X'6') RCDALen 2 Binary Length of the RCCDat structure
8(X'8') RCDAIpAddr4 4 Binary IP address (source or destination)
  • IPv4 address, if the RCPKFIpAddr flag is set.
  • IPv6 address, if the RCPKFIpAddr flag is set.
RCDAIpAddr6 16 Binary
24(X'18') RCDAPortNum 2 Binary Port number (source or destination)
26(X'1A')   2 Binary Reserved
28(X'1C') RCDAPayload 4 Binary Payload length. The RCDAPayload value determines how many bytes of payload are traced. For example, if the total amount of data being read or written is 260 bytes and RCDAPayload is specified as 100, the first 100 bytes of the data are traced.
The following values are supported for this field:
  • 0 - No data.
  • n - Length of data to be traced.
  • 184320 - Maximum amount of data. This is the default value if the RCPKFPayload flag is not set.
32(X'20') RCDAFiltFlags 2 Binary The following flags indicate which filters were set:
  • X'8000', RCDAFPrefix: If this flag is set, an IP address prefix was specified. The RCDAPrefix field contains the specified prefix. If this flag is set, you must also provide an IP address.
  • X'4000', RCDAFPortNum: If this flag is set, a port number was specified. The RCDAPortNum field contains the specified port number. This value is compared to either the source or destination port numbers.
  • X'2000', RCDAFJobName: If this flag is set, a job name was specified. The RCDAJobName field contains the specified job name.
  • X'1000', RCDAFIpv4Addr: If this flag is set, an IPv4 address was specified. The RCDAIpAddr4 field contains the specified IP address. This flag is mutually exclusive with the RCDAFIpv6Addr flag.
  • X'0800', RCDAFIpv6Addr: If this flag is set, an IPv6 IP address was specified. The RCDAIpAddr6 field contains the specified IP address. This flag is mutually exclusive with the RCDAFIpv4Addr flag.
  • X'0400', RCDAFATTLSClear: If this flag is set, requests trace records that contain AT-TLS cleartext data. The data must match the other filters that are specified in this filter structure.
34(X'22') RCDAOptFlags 1 Binary Flags to indicate which options were set:
  • X'80', RCDAFPayload: If this flag is set, a payload length was specified. The RCDAPayload field contains the specific value. If this flag is not set, the complete payload is traced.
35(X'23') RCDAPrefix 1 Binary Prefix length for IP address. The prefix value for an IPv4 address must be in the range 1 - 32; the prefix value for an IPv6 address must be in the range 1 - 128. This is the number of significant bits of the IP address to be considered for a match.
36(X'24') RCDAJobName 8 EBCDIC Job name. The value must be displayable characters and the letters must be in uppercase.
44(X'2C')   12 Binary Reserved
Parent topic: RCCSetFilters - Set trace filters and options

Go to the previous page Go to the next page

Notices | Terms of use | Support | Contact z/OS | zFavorites



Copyright IBM Corporation 1990, 2014