DEBUG (FTP client and server) statement

Use the DEBUG statement to activate a specific trace type.

Restriction: Only one trace type can be activated for a DEBUG statement.

Server
Traces are recorded on server's system for server processing.
Client
Traces are recorded on client's system for client processing.

Syntax

Read syntax diagramSkip visual syntax diagram DEBUG parameter

Parameters

FLO
The FLO trace shows the flow of control within FTP. It is used to show which services of FTP are used for an FTP request.
CMD
The CMD trace shows each command and the parsing of the parameters for the command.
PAR
The PAR trace shows details of the FTP command parser. It is useful when debugging problems with the processing of command parameters.
INT
The INT trace shows the details of the initialization and termination of the FTP session.
ACC
The ACC trace shows the details of the login process.
UTL
The UTL trace shows the processing of utility functions such as CD and SITE.
FSC(n)
The FSC trace shows details of processing the file services server commands APPE, STOR, STOU, RETR, DELE, RNFR, and RNTO. For the client, it shows the details for subcommands, such as GET, PUT, APPEND, DELETE, and RENAME. This trace allows you to specify levels of detail for the trace points. The level one tracing specified by entering FSC or FSC(1) is the level typically used unless more data is requested by the TCP/IP service group. n can be an integer between 1 and 8.
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 are processed. This trace allows you to specify levels of detail for the trace points. The level one tracing that is specified by entering SOC or SOC(1) is the level typically used unless more data is requested by the TCP/IP service group. n can be an integer between 1 and 8.
JES
The JES trace shows details of the processing for JES requests (that is, requests when SITE FILETYPE=JES is in effect).

Restriction: This parameter applies to the server only.

SQL
The SQL trace shows details of the processing for SQL requests (that is, requests when SITE or LOCSITE FILETYPE=SQL is in effect).
ALL
This value is used to set all of the trace points. Both the FSC and the SOC trace are set to level one when the ALL parameter is processed.
BAS
This value is used to set a select group of traces that offer the best overall details without the more excessive tracing some of the other traces provide. Specifying this value is the same as the following values:
  • DEBUG CMD
  • DEBUG INT
  • DEBUG FSC
  • DEBUG SOC
USERID (filter_name)
This parameter is used to filter the trace for user IDs matching the filter_name pattern. If the user ID matches the filter at the time the client logs in, tracing options are set to the current value of the options. Otherwise, no tracing options are set. The client can use the SITE command to set options after login if the initial ones are not appropriate. An example for the USERID filter is:
DEBUG USERID(USER33)
which activates the trace for a user if the user ID is USER33.

Restriction: This parameter applies to the server only.

IPADDR (filter)
This parameter is used to filter the trace for IP addresses matching the filter pattern. If the IP address matches the filter at the time the client connects, tracing options are set to the current value of the options. Otherwise, no tracing options are set. The client might use the SITE command to set options after connect if the initial ones are not appropriate. Examples of the IPADDR(filter) are:
DEBUG IPADDR(9.67.113.57) 
DEBUG IPADDR(FEDC:BA98:7654:3210:FEDC:BA98:7654:3210)
The first example activates the trace for a client whose IP address is 9.67.113.57; the second activates the trace for a client whose IP address is FEDC:BA98:7654:3210:FEDC:BA98:7654:3210. If the filter is an IPv4 address, submasking can be indicated by using a slash followed by a dotted decimal submask. For example, 192.48.32.0/255.255.255.0 allows addresses from 192.48.32.00 to 192.48.32.255.

If the filter is an IPv6 address, network prefixing can be indicated by using a slash followed by a network prefix. For example, use FEDC:BA98::0/32 to indicate the prefix: FEDCBA98.

Restriction: This parameter applies to the server only.