G550-0428-04

Specifying trace parameters with the PSF operator interface

Specifying trace parameters with the PSF operator interface

You can use the MVS™ MODIFY command as a PSF operator interface only in deferred-printing mode. This interface can start and stop traces dynamically. You can start the FSI and FSA component traces through the PSF operator interface.

When to issue PSF operator interface commands

A PSF operator interface command can affect one of these trace environments:

  • An NST trace
  • An FSA external trace for an active FSA
  • FSA external traces for all FSAs that are not yet active
  • An FSI trace
  • An internal trace

To affect the NST trace environment, specify MODE=NOTIFY on the PSF operator interface command. (Do not specify a printer name when specifying MODE=NOTIFY.) To affect the FSA external traces for a single FSA, specify the name of the printer FSA on the PSF operator interface command. To affect the FSA external traces for all FSAs, do not include a printer name in the PSF operator interface command. For more information on these command parameters, see Syntax of the PSF operator interface command.

Operator interface commands can be entered at any time while PSF is running. If a command is directed to a specific FSA, however, that FSA must be up and running at the time when the command is issued, or the command will be rejected.

You can type multiple operator interface commands during PSF processing. Remember that each successive command overrides all the options of preceding commands affecting the same trace. Even if you want to change only one characteristic of a trace, you still have to specify values for any of the other options for which you do not want the default value to be used.

When operator interface commands are processed

The time at which a PSF operator interface command is processed depends on the trace environment. The concept underlying the processing of operator interface commands is FSA initialization. FSA initialization is complete when PSF has processed the PRINTDEV statement in the PSF startup procedure.

The exact time of FSA initialization is hard to determine. These guidelines can help:

  • When message APS620A is issued (as a result of the PROMPT parameter of the PARM keyword in the PSF startup procedure), no FSA has been initialized.
  • When PSF issues the setup message for a channel-attached printer, the FSA for that printer has been initialized.
  • For any printer, when the START command for that FSA is entered, FSA initialization occurs immediately after any of these types of commands:
    Commands affecting the NST trace
    Operator interface commands affecting the NST trace are typically queued internally by PSF. The commands are processed, and the options are changed as indicated, only on data set boundaries (any FSA) or on FSA initialization (any FSA), whichever occurs first.
    Commands affecting the tracing of a specific FSA
    Commands affecting the tracing of a specific FSA cannot be entered unless the FSA has been initialized. Commands are processed only when the FSA is idle or on data set boundaries. If the FSA is not idle, the command is queued and is processed on the next data set boundary.
    Commands affecting the tracing of all FSAs
    A command affecting the tracing of all FSAs is processed during the initialization of each FSA. The command affects only FSAs that have not yet been initialized—typically, only those that are not currently started. Therefore, the command does not affect an FSA that is already active, unless the FSA has to be reinitialized.

Syntax of the PSF operator interface command

Figure 28 shows the format of the MODIFY command. For examples of using the PSF operator interface to start traces, see Starting various traces.

Figure 28. PSF operator interface command format for starting traces
{MODIFY | F} fss_name,TRACEON
[,
[ fsa_name]
[,MODE={NOTIFY | FULL | SYNC | INTR | LIMIT | IPDS }]
[,FORMAT={PSF | GTF}]
[,COMP={ALL | (CCM | DEVM |
DOCP | ERRM | EXIT |  JCLM | LASI | LMC | LMM | MSGM |
PPCC | PPQM | PPWTR | SRM | STRM | TCPIP) }]

[,EID={FSI | PSF | ALL }]
]
Note:
The comma is always required if you specify keywords after TRACEON.

To start a trace, the PSF operator types the MODIFY (or F) command with the TRACEON parameter. The parameters used with the MODIFY command to start a trace are:

fss_name
Specifies the name of the FSS for which tracing should be started. This parameter is required and must match the FSS parameter for the JES2 FSS statement or the FSSNAME parameter for the JES3 FSSDEF statement.
TRACEON
Specifies that tracing should be started for one or more FSAs or for the notify subtask. This parameter is required.
fsa_name
Specifies the name of the printer for which tracing should be started. This parameter is optional and cannot be specified for NST traces (MODE=NOTIFY). For information about starting an NST trace for a specific FSA, see Starting an NST trace dynamically. If fsa_name is not specified, the command affects all the FSAs that are managed by the FSS and that are started after the command is entered. Notice that fsa_name is a positional parameter, which means that you must place it exactly as shown in Figure 28.
Note:
fsa_name is a positional parameter. If you specify the MODE parameter but do not specify an fsa_name, you must type a comma in place of the fsa_name.

Figure 29 shows how to start a trace when no fsa_name is specified.

Figure 29. Starting a trace without specifying a printer name
MODIFY fss_name,TRACEON,,MODE=INTR

The fsa_name specified must match one of these:

  • For JES2, the PRTnnnn statement
  • For JES3, the JNAME parameter of the DEVICE statement

For more information about the JES2 PRTnnnn statement and the JES3 JNAME parameter, see PSF for z/OS: Customization.

The presence or absence of a fsa_name affects the time at which the MODIFY command is processed. For more information, see When operator interface commands are processed.

The six optional parameters of the MODIFY command are:

[MODE={NOTIFY | FULL | SYNC | INTR | LIMIT | IPDS }]
The MODE parameter specifies the trace type:
NOTIFY
Specifies that an NST external trace is to be started. The NST trace data for an FSA is recorded only if an FSA internal or external trace of the page printing writer (PPWTR) component is also active for that FSA.

Figure 30 shows how to specify an NST external trace.

Figure 30. Specifying an NST external trace
MODIFY fss_name,TRACEON,,MODE=NOTIFY,FORMAT=GTF
FULL
Specifies that an FSA full external trace is to be started. An internal FSA trace is also started, along with an internal PPCC trace for SNA-attached printers. If the FORMAT parameter is specified, the default for the MODE parameter is FULL.

Figure 31 shows how to specify a full external trace.

Figure 31. Specifying a full external trace
MODIFY fss_name,TRACEON,,MODE=FULL
SYNC
Specifies that an FSA SYNC external trace is to be started. An internal FSA trace is also started, along with an internal PPCC trace for SNA-attached printers.
INTR
Specifies that only internal tracing is to be done. An internal FSA trace is to be started, along with an internal PPCC trace for SNA-attached printers. If the FORMAT parameter is not specified, the default for the MODE parameter is INTR. If MODE=INTR is specified for a particular printer FSA, any active external tracing of that FSA stops when internal tracing starts. If MODE=INTR is specified on an operator command affecting all FSAs that were not initialized at the time the command was entered, any requests for external tracing of those FSAs in the PSF startup procedure are ignored.

Figure 32 shows how to specify an internal trace.

Figure 32. Specifying an internal trace
MODIFY fss_name,TRACEON,PRI1,MODE=INTR
LIMIT
Specifies that a shortened FSA external trace is to be started. An internal FSA trace is also started, along with an internal PPCC trace for SNA-attached printers.

Figure 33 shows how to specify a limit external trace.

Figure 33. Specifying a limit external trace
MODIFY fss_name,TRACEON,,MODE=LIMIT
IPDS
Specifies that an FSA external trace of only the output printer commands is to be started. An internal FSA trace is also started, along with an internal PPCC trace for SNA-attached printers.

Figure 34 shows how to specify an IPDS external trace.

Figure 34. Specifying an IPDS external trace
MODIFY fss_name,TRACEON,,MODE=IPDS
[FORMAT={PSF | GTF}]
The FORMAT parameter specifies where external trace output is to be directed:
PSF
Specifies that the trace output is to be sent to a PSF-owned data set as defined in DD statements in the PSF startup procedure. This is the default. See DD statements for PSF external trace output.
GTF
Specifies that the trace output is to be sent to the GTF trace data set. If GTF is specified, the GTF program must be up and running before you type the PSF operator interface command. GTF must be specified for FSI traces and for NST traces that are started dynamically.

For more information on GTF, see z/OS MVS System Commands.

[COMP={ ALL | (CCM | DEVM | DOCP | ERRM | EXIT | JCLM | LASI | LMC | LMM | MSGM | PPCC | PPQM | PPWTR | SRM | STRM | TCPIP) }]
Specifies the PSF components to be traced. You should specify COMP only for an FSA full, limit, or IPDS external trace or for FSA and PPCC internal traces (MODE=FULL, MODE=LIMIT, MODE=IPDS, or MODE=INTR). You can specify multiple components, but you must delimit them with commas. You can specify them in any order.
ALL
Specifies that all the following individual subcomponents are to be traced. ALL is the default. You cannot specify ALL with any individual subcomponents.
CCM
Common conversion machine
DEVM
Device manager
DOCP
Document processor
ERRM
I/O error manager
EXIT
PSF installation exits
JCLM
JCL modules
LASI
Library access system interface
LMC
Line-mode conversion
LMM
Line-mode migration
MSGM
Message modules
PPCC
Page Printer Communication Component (for SNA-attached printers)
PPQM
Pending page queue manager
PPWTR
Page printing writer
Note:
If NST trace data is to be recorded, tracing of the PPWTR component must be active.
SRM
Resource Manager
STRM
Storage Manager
TCPIP
TCP/IP component
[EID={FSI | PSF | ALL}]
Specifies the Event IDs (EIDs) to be written to the GTF trace data set. If you do not specify FORMAT=GTF in conjunction with EID=PSF or EID=FSI, PSF uses the default value, EID=ALL. If you specify FORMAT=PSF, the value of the EID parameter is ignored. EID is valid only when FORMAT=GTF is specified. If EID is not specified, it defaults to ALL.

You can use the EID parameter in conjunction with the COMP parameter to limit the amount of data contained in the trace output. If you use EID=FSI, you should specify COMP=PPWTR or COMP=ALL.

FSI
Specifies that EIDs for events occurring on the FSI interface to PSF are to be written to the trace data set.
PSF
Specifies that all PSF EIDs are to be written to the trace data set, with the exception of EIDs for events occurring on the FSI interface to PSF.
ALL
Specifies that all supported EIDs are to be written to the trace data set.

To select PSF trace data when formatting the GTF trace data set, specify USR=(FDn) on the AMDPRDMP EDIT control card, where n is 4 for FSI trace information, and n is 0 for PSF information. If you want both FSI and PSF trace data, specify USR=(FD0, FD4) on the EDIT control card.