DEBug subcommand

Purpose

Use the DEBug subcommand to enable or disable general internal tracing.

Format


          .-----------------.   
          V                 |   
>>-DEBug----+-------------+-+----------------------------------><
            +- ?----------+     
            +- ACC--------+     
            +- ALL--------+     
            +- BAS--------+     
            +- CMD--------+     
            +- FLO--------+     
            +- FSC(n)-----+     
            +- INT--------+     
            +- NONE-------+     
            +- PAR--------+     
            +- SEC--------+     
            +- SOC(n)-----+     
            +- SQL--------+     
            +- TIMestamps-+     
            +- UTL--------+     
            '- Xyyy-------'

Parameters

One or more of the following options can be specified:

?: Displays the status of the traces.
ACC: The ACC trace shows the details of the login process.
ALL: This parameter is used to set all of the trace points.
Note: Both the FSC and the SOC traces will be set to level 1 when the ALL parameter is processed.
BAS: This parameter is used to set a select group of traces that offer the best overall debug data without the detailed information of some of the traces. Specifying this parameter is the same as DEBUG CMD INT FSC SOC.
CMD: The CMD trace shows each command and the parsing of the parameters for the command.
FLO: The FLO trace shows the flow of control within FTP. It is useful to show which services of FTP are used for an FTP request.
FSC(n): The FSC trace shows details of the processing of the file services subcommands APpend, PUt, Get, MGet, and MPut. This trace can generate very detailed information and therefore allows you to specify levels of detail for the trace points.
The level 1 tracing that is specified by entering FSC or FSC(1) is the level normally used unless more data is requested by TCP/IP service group. The level (n) can be a number from 1 to 8.
INT: The INT trace shows the details of the initialization and termination of the FTP session with the server.
NONE: This parameter is used to turn off all of the traces.
PAR: The PAR trace shows details of the FTP command parser. It is useful for debugging problems in the handling of the command parameters.
SEC: The SEC trace shows the processing of security functions such as TLS and GSSAPI negotiations.
SOC(n): The SOC trace shows details of the processing during the setup of the interface between the FTP application and the network as well as details of the actual amounts of data that is processed.
This trace can generate very detailed information and therefore allows you to specify levels of detail for the trace points. The level (n) can be a number from 1 to 8.
SQL: The SQL trace shows details of the processing for SQL requests, such as requests when LOCSIte FILETYPE=SQL is in effect.
TIMestamps: This is a special parameter used to request that each trace entry have a timestamp showing the time the entry was made. This is useful during long running file transfers to track the duration of the transfer and also to match client trace to the server trace, which also has a timestamp.
UTL: The UTL trace shows the processing of utility functions such as LCd and LOCSIte.
Xyyy: This syntax is used to turn off (reset) a trace that is named by yyy. For example, DEBUG XPAR XACC will turn off the PAR and the ACC traces.

Examples

The following example shows sample client traces with DEBug.

debug none fsc soc time                                                             
Active client traces - FSC(1) SOC(1)                                            
get a 'user33.abc111' (replace                                                  
11:21:33 CG0204 get: F=1 p=FSA ARTW=0000                                        
11:21:33 CG3356 rcvFile: entered                                                
11:21:33 MR1200 set_filename: entered with pathname 'user33.abc111'             
11:21:33 CG2078 mvs_rcvFile: entered                                            
11:21:33 CG1944 newGDGname: entered                                             
11:21:33 MV0874 seq_create_file: entered with dsn=USER33.ABC111                 
11:21:34 MV1545 seq_create_file: ddname=SYS00009                                
12345678901234567890123456789012345678901234567890123456789012345678901234567890
11:21:34 MV1605 seq create file: data set has recfm=50, lrecl=256, blksize=6233 
11:21:34 CG2470 mvs_rcvFile: FASTIO pending for store_type = N                  
11:21:34 CG2473 mvs_rcvFile: ... recfm=VB, lrecl=256, blksize=6233              
11:21:34 CG2560 mvs_rcvFile: request FASTIO with recfmU override for record form
 at VB                                                                         
11:21:34 MF2540 seq_open_file: recfm is VB                                      
11:21:34 MF2598 seq_open_file: BSAM O SYS00009 ()                               
11:21:34 MF2600 seq_open_file: ncp=29 DA=0 K0=0 DF=0                            
11:21:34 MF2658 seq_open_file: stream 46EE8 has maxreclen 256
11:21:34 SC0531 initDsConnection: entered                                  
>>> PORT 9,67,113,57,4,32                                                  
200 Port request OK.                                                       
>>> RETR a                                                                 
125 Sending data set /u/user33/a                                           
11:21:34 SC0783 accDsConnection: entered                                   
11:21:34 TI3053 WrtStreamFastIO: O=2 HGPES=00001 BCTE=1000 RLB=50/256/6233 
11:21:34 MF2441 seq_close_file: file closed                                
11:21:34 GV0150 releaseFile: release ddname - SYS00009                     
11:21:34 GV0171 releaseFile: dynfree() results- rc=0, errcode=0, infocode=0
11:21:34 SC1128 dataClose: entered                                         
250 Transfer completed successfully.                                       
820 bytes transferred in 0.005 seconds.  Transfer rate 164.00 Kbytes/sec.  
11:21:34 CU1821 write_smf_record: entered with type 16.                    
11:21:34 CU1275 write_smf_record_119: entered with type 16.                
11:21:34 CU2084 write_smf_record: length of smfrecord: 224

Usage

By default, DEBug is off. When the FTP environment is entered, you can activate DEBug by any of the following methods:

Use the TRACE or -d parameter on the FTP command.
Code one or more DEBUG statements in the client's FTP.DATA.
Code the TRACE statement in the client's FTP.DATA.

Once FTP is started, you can change the DEBug settings with the DEBug subcommand.

The trace supports the DEBug parameters 1 and 2 that are used with previous product releases. Specifying DEBug BAS provides the same tracing as parameter 1 formerly provided. The DUMP subcommand now provides the extended tracing that parameter 2 formerly provided.
The state of the traces points is displayed as a response to the DEBug subcommand. To see the states without making a change, enter DEBUG ?.

The setting of the traces is additive as shown by the following:

        DEBUG NONE CMD 
        EZA2851I Active traces: CMD
        DEBUG PAR
        EZA2851I Active traces: CMD PAR

Entering DEBug with no parameters will toggle the trace on and off. The state of the traces when the trace is toggled off is remembered so that toggling it on restores the previous trace settings. If no traces were active previously, then toggling activates the BAS trace points

       DEBUG NONE CMD                      
       EZA2851I Active traces: CMD         
       DEB                                 
       EZA2851I Active traces:  NONE       
       DEB                                 
       EZA2851I Active traces: CMD
       DEB FSC                             
       EZA2851I Active traces: CMD FSC(1)           
       DEB                                         
       EZA2851I Active traces:  NONE               
       DEB                                         
       EZA2851I Active traces: CMD FSC(1)           
       DEB NONE                                    
       EZA2851I Active traces:  NONE               
       DEB                                         
       EZA2851I Active traces: CMD INT FSC(1) SOC(1)

The timestamp option is demonstrated with the following example:

       deb fsc(1)                                    
       PC0304 parseCmd: subcommand:  deb            
       PC0307 parseCmd: parameter 1: fsc(1)          
       Active traces: CMD FSC(1)                     
       Command:                                     
       deb time                                     
       PC0304 parseCmd: subcommand:  deb            
       PC0307 parseCmd: parameter 1: time           
       Active traces: CMD FSC(1)                     
       Command:                                     
       deb soc(1)                                    
       11:39:37 PC0304 parseCmd: subcommand:  deb   
       11:39:37 PC0307 parseCmd: parameter 1: soc(1) 
       Active traces: CMD FSC(1) SOC(1)               
       Command:

For the FSC and SOC trace options only one level of tracing can be defined at any time. However, when level 2 is defined, levels 1 and 2 are active. When level 3 is defined, levels 1, 2, and 3 are active. This progression also applies to levels 4 and 5.
```
       deb fsc(2) soc(1)              
       Active traces: FSC(2) SOC(1) 
       Command:                     
       deb fsc(1) soc(2)             
       Active traces: FSC(1) SOC(2)  
       Command:                     
```

Tip: The DEBug FSC command accepts level values 6–8, but provides only level 5 trace data. Likewise, DEBug SOC accepts level values 4–8, but provides only level 3 trace data.

See Diagnosing FTP client problems with tracing in z/OS Communications Server: IP Diagnosis Guide for more information about FTP client tracing.