Specifying options at initialization

A default minimum Component Trace is always started during OMPROUTE initialization. A parmlib member can be used to customize the parameters used to initialize the trace. The default OMPROUTE Component Trace parmlib member is the SYS1.PARMLIB member CTIORA00. The parmlib member name can be changed by use of the OMPROUTE_CTRACE_MEMBER environment variable.

Tip: Besides specifying the trace options, you can also change the OMPROUTE trace buffer size. The buffer size can be changed only at OMPROUTE initialization.

The maximum OMPROUTE trace buffer size is 100 MB.

Guideline: Use of a large internal CTRACE buffer or an external writer is recommended when using the DEBUGTRC option.

Requirement: The OMPROUTE REGION size in the OMPROUTE catalog procedure must be large enough to accommodate a large buffer size.

If the CTIORA00 member is not found when starting OMPROUTE, the following message is issued:

IEE5381 CTIORA00 MEMBER NOT FOUND in SYS1.PARMLIB

When this occurs, the OMPROUTE component trace is started with a buffer size of 1 MB and the MINIMUM tracing option.

The following figure shows the SYS1.PARMLIB member CTIORA00.

/*********************************************************************/
/*                                                                   */
/*  IBM Communications Server for z/OS                               */
/*  SMP/E Distribution Name: CTIORA00                                */
/*                                                                   */
/*  PART Name:  CTIORA00                                             */
/*                                                                   */
/*                                                                   */
/*  Copyright:                                                       */
/*                Licensed Materials - Property of IBM               */
/*                5694-A01                                           */
/*                (C) Copyright IBM Corp. 1998,2003                  */
/*                                                                   */
/*                                                                   */
/*  Status:       CSV1R5                                             */
/*                                                                   */
/*                                                                   */
/*  DESCRIPTION = This parmlib member causes component trace for     */
/*                the TCP/IP OMPROUTE application to be initialized  */
/*                with a trace buffer size of 1M                     */
/*                                                                   */
/*                This parmlib member only lists those TRACEOPTS     */
/*                values specific to OMPROUTE.  For a complete list  */
/*                of TRACEOPTS keywords and their values see         */
/*                z/OS MVS INITIALIZATION AND TUNING REFERENCE.      */
/*                                                                   */
/*                                                                   */
/* $MAC(CTIORA00),COMP(OSPF  ),PROD(TCPIP ):  Component Trace        */
/*                                            SYS1.PARMLIB member    */
/*                                                                   */
/*********************************************************************/
 TRACEOPTS
 /* ---------------------------------------------------------------- */
 /*   Optionally start external writer in this file (use both        */
 /*   WTRSTART and WTR with same wtr_procedure)                      */
 /* ---------------------------------------------------------------- */
 /*        WTRSTART(wtr_procedure)                                   */
 /* ---------------------------------------------------------------- */
 /*   ON OR OFF: PICK 1                                              */
 /* ---------------------------------------------------------------- */
           ON
 /*        OFF                                                       */
 /* ---------------------------------------------------------------- */
 /*   BUFSIZE: A VALUE IN RANGE 128K TO 100M                         */
 /*             CTRACE buffers reside in OMPROUTE Private storage    */
 /*             which is in the regions address space.               */
 /* ---------------------------------------------------------------- */
           BUFSIZE(1M)
 /*        WTR(wtr_procedure)                                        */
 /* ---------------------------------------------------------------- */
 /*   OPTIONS: NAMES OF FUNCTIONS TO BE TRACED, OR "ALL"             */
 /* ---------------------------------------------------------------- */
 /*        OPTIONS(             */
 /*                'ALL     '   */
 /*               ,'MINIMUM '   */
 /*               ,'ROUTE   '   */
 /*               ,'PACKET  '   */
 /*               ,'OPACKET '   */
 /*               ,'RPACKET '   */
 /*               ,'IPACKET '   */
 /*               ,'SPACKET '   */
 /*               ,'DEBUGTRC'   */
 /*                )            */

Figure 1. SYS1.PARMLIB member CTIORA00

Table 1 describes the available trace options.

Table 1. OMPTRACE options
Trace event	Description
ALL	Select all types of records. Be aware that this option slows performance.
MINIMUM	Select OMPROUTE's minimum level of tracing. Specifying MINIMUM is the same as specifying ROUTE.
ROUTE	Select information exchange and routing updates between the OMPROUTE application and the z/OS® TCP/IP Services stack.
PACKET	Select all inbound and outbound packet flows. This is the same as specifying OPACKET, RPACKET, and IPACKET.
RPACKET	Select inbound and outbound packet flows for the IPv4 RIP and IPv6 RIP protocols.
OPACKET	Select inbound and outbound packet flows for the IPv4 OSPF and IPv6 OSPF protocols.
IPACKET	Select inbound packets sent from z/OS TCP/IP with information regarding route or interface changes.
SPACKET	Trace inbound and outbound packets sent between the SNMP agent and the OMPROUTE subagent.
DEBUGTRC	Redirects IPv4 trace (-t), IPv4 debug (-d), IPv6 trace (-6t) and IPv6 debug (-6d) output to the CTRACE facility.

Guideline: Use of a large internal CTRACE buffer or an external writer is recommended when using the DEBUGTRC option.