FTP client transfer completion record (subtype 3)

The FTP client transfer completion record is collected when the z/OS® FTP client completes processing of one of the following FTP file transfer operations: file appending, file storage, or file retrieval. A common format for the record is used for each FTP file transfer operations, so the record contains an indication of which operation was performed.

The first or only record contains the following sections:
  • SMF header
  • Self-defining section with 7 section triplets
  • TCP/IP identification section
  • FTP client transfer completion section
  • FTP client transfer completion associated data set name section
  • (Optional) FTP client transfer completion SOCKS section
  • FTP client transfer completion security section
  • FTP client transfer completion user name section
  • (Optional) FTP client transfer completion load module name section

Load module transfers

When a load module is involved in the transfer operation, multiple FTP client transfer completion records can be created. If the information for a record exceeds 32746 bytes, additional FTP client transfer completion records are created to provide all the information. For load module members associated with the transfer, all the member names that fit in the current record are provided in the current record. Any member names that did not fit in the current record are provided in a subsequent record.

The value in the SMF119TI_Reason field indicates whether the record is complete. If the record is incomplete, it is followed by an additional record or records. The first record includes all the sections while the intermediate and final record includes only the SMF header, Self-defining section, TCP/IP identification section and the load module name section.

The Type 119 FTP client transfer completion record is collected at the same point in file transfer processing as the equivalent Type 118 FTP client SMF record.

See Table 1 for the contents of the TCP/IP stack identification section. For the FTP client transfer completion record, the TCP/IP stack identification section indicates FTPC as the subcomponent and the SMF119TI_Reasons field contains X'48' (event record, more records follow) or X'08' (event record, last record in set) as the record reason.

Table 1 shows the FTP client transfer completion record self-defining section:
Table 1. FTP client transfer completion record self-defining section
Offset Name Length Format Description
0(X'0') Standard SMF Header 24   Standard SMF header; subtype is 3(X'3')
Self-defining section
24(X'18') SMF119SD_TRN 2 Binary Number of triplets in this record (7)
26(X'1A')   2 Binary Reserved
28(X'1C') SMF119IDOff 4 Binary Offset to TCP/IP identification section
32(X'20') SMF119IDLen 2 Binary Length of TCP/IP identification section
34(X'22') SMF119IDNum 2 Binary Number of TCP/IP identification sections
36(X'24') SMF119S1Off 4 Binary Offset to FTP client transfer completion section
40(X'28') SMF119S1Len 2 Binary Length of FTP client transfer completion section
42(X'2A') SMF119S1Num 2 Binary Number of FTP client transfer completion sections
44(X'2C') SMF119S2Off 4 Binary Offset to FTP client transfer completion associated data set name section
48(X'30') SMF119S2Len 2 Binary Length of FTP client transfer completion associated data set name section
50(X'32') SMF119S2Num 2 Binary Number of FTP client transfer completion associated data set name sections
52(X'34') SMF119S3Off 4 Binary Offset to FTP client transfer completion SOCKS section
56(X'38') SMF119S3Len 2 Binary Length of FTP client transfer completion SOCKS section
58(X'3A') SMF119S3Num 2 Binary Number of FTP client transfer completion SOCKS sections
60 (X'3C') SMF119S4Off 4 Binary Offset to FTP client transfer completion security section
64 (X'40') SMF119S4Len 2 Binary Length of FTP client transfer completion security section
66 (X'42') SMF119S4Num 2 Binary Number of FTP client transfer completion security sections
68 (X'44') SMF119S5Off 4 Binary Offset to FTP client transfer completion user name section
72 (X'48') SMF119S5Len 2 Binary Length of FTP client transfer completion user name section
74 (X'4A') SMF119S5Num 2 Binary Number of FTP client transfer completion user name sections
76(X'4C') SMF119S6Off 4 Binary Offset to FTP client load module name section
80 (X'50') SMF119S6Len 2 Binary Length of FTP client load module name section
82 (X'52') SMF119S6Num 2 Binary Number of FTP client load module name sections. There is only 1 server load module name section per record.

Table 2 shows the FTP client transfer completion specific section of this SMF record.

Table 2. FTP client transfer completion record section
Offset Name Length Format Description
0(X'0') SMF119FT_FCCmd 4 EBCDIC FTP command (according to RFC 959)
4(X'4') SMF119FT_FCFType 4 EBCDIC Local file type (SEQ, JES, or SQL)
8(X'8') SMF119FT_FCDRIP 16 Binary Remote IP address (data connection)
24(X'18') SMF119FT_FCDLIP 16 Binary Local IP address (data connection)
40(X'28') SMF119FT_FCDRPort 2 Binary Remote port number (data connection)
42(X'2A') SMF119FT_FCDLPort 2 Binary Local port number (data connection)
44(X'2C') SMF119FT_FCCRIP 16 Binary Remote IP address (control connection)
60 (X'3C') SMF119FT_FCCLIP 16 Binary Local IP address (control connection)
76(X'4C') SMF119FT_FCCRPort 2 Binary Remote port number (control connection)
78 (X'4E') SMF119FT_FCCLPort 2 Binary Local port number (control connection)
80 (X'50') SMF119FT_FCRUser 8 EBCDIC User ID (login name) on server
88(X'58') SMF119FT_FCLUser 8 EBCDIC Local User ID
96(X'60') SMF119FT_FCType 1 EBCDIC Data format:
  • A: ASCII
  • E: EBCDIC
  • I: Image
  • B: Double-byte
  • U: UCS-2
97(X'61') SMF119FT_FCMode 1 EBCDIC Transfer mode:
  • B: Block
  • C: Compressed
  • S: Stream
98(X'62') SMF119FT_FCStruct 1 EBCDIC Structure:
  • F: File
  • R: Record
99(X'63') SMF119FT_FCDSType 1 EBCDIC Data set type:
  • S: SEQ
  • P: PDS
  • H: z/OS UNIX
100(X'64') SMF119FT_FCSTime 4 Binary Transmission start time of day
104(X'68') SMF119FT_FCSDate 4 Packed Transmission start date
108(X'6C') SMF119FT_FCETime 4 Binary Transmission end time of day
112(X'70') SMF119FT_FCEDate 4 Packed Transmission end date
116(X'74') SMF119FT_FCDur 4 Binary File transmission duration in units of 1/100 seconds
120(X'78') SMF119FT_FCBytes 8 Binary Transmission byte count; 64-bit integer
128(X'80') SMF119FT_FCLReply 4 EBCDIC Last server reply (3-digit RFC 959 code, left-aligned)
132(X'84') SMF119FT_FCM1 8 EBCDIC PDS member name
140(X'8C') SMF119FT_FCHostname 8 EBCDIC Host name
148(X'94') SMF119FT_FCRS 8 EBCDIC Reserved for abnormal end info
156(X'9C') SMF119FT_FCBytesFloat 8 Floating point hex z/OS floating point format for transmission byte count
164 (X'A4') SMF119FT_FCCConnID 4 Binary TCP connection ID of FTP control connection
168 (X'A8') SMF119FT_FCDConnID 4 Binary TCP connection ID of FTP data connection, or 0 if no data connection is active
Table 3 shows the FTP client transfer completion associated data set name section. This section represents the MVS™ or z/OS UNIX data set name associated with the file transfer.
Table 3. FTP client transfer completion associated data set name section
Offset Name Length Format Description
0(X'0') SMF119FT_FCFileName n EBCDIC MVS or z/OS UNIX data set name associated with the file transfer operation. Use the Data Set Type field information in the FTP client transfer completion section to determine the type of file name represented by this value.
Table 4 shows the FTP client transfer completion SOCKS section. This section is present when the FTP operation traverses a SOCKS server on the path between the z/OS FTP client and FTP server.
Table 4. FTP client transfer completion SOCKS section
Offset Name Length Format Description
0(X'0') SMF119FT_FCCIP 16 Binary IP address of SOCKS server for control connection
16(X'10') SMF119FT_FCCPort 2 Binary SOCKS port number (control connection)
18(X'12') SMF119FT_FCCProt 1 Binary SOCKS protocol version (control connection):
  • X'01': SOCKS Version 4
  • X'02': SOCKS Version 5

Table 5 shows the FTP client transfer completion security section:

Table 5. FTP client transfer completion security section
Offset Name Length Format Description
0 (X'0') SMF119FT_FCMechanism 1 EBCDIC Protection Mechanism:
  • N: None
  • T: TLS
  • G: GSSAPI
  • A: AT_TLS
1 (X'1') SMF119FT_FCCProtect 1 EBCDIC Control connection Protection Level:
  • N: None
  • C: Clear
  • S: Safe
  • P: Private
2 (X'2') SMF119FT_FCDProtect 1 EBCDIC Data connection Protection Level:
  • N: None
  • C: Clear
  • S: Safe
  • P: Private
3 (X'3') SMF119FT_FCLoginMech 1 EBCDIC Login Method:
  • U: Login method is not defined for the FTP client
4 (X'4') SMF119FT_FCProtoLevel 8 EBCDIC Protocol level (present only if protocol mechanism is TLS or AT-TLS).
Possible values are:
  • SSLV2
  • SSLV3
  • TLSV1
  • TLSV1.1
  • TLSV1.2
12 (X'C') SMF119FT_FCCipherSpec 20 EBCDIC Cipher specification (present only if protocol mechanism is TLS or AT-TLS).
Possible values when protocol level is SSLV2:
  • RC4: US
  • RC4: Export
  • RC2: US
  • RC2: Export
  • DES: 56-Bit
  • Triple: DES US
Possible values when protocol level is SSLV3, TLSV1, TLSV1.1, or TLSV1.2:
  • SSL_NULL_MD5
  • SSL_NULL_SHA
  • SSL_RC4_MD5_EX
  • SSL_RC4_MD5
  • SSL_RC4_SHA
  • SSL_RC2_MD5_EX
  • SSL_DES_SHA
  • SSL_3DES_SHA
  • SSL_AES_128_SHA
  • SSL_AES_256_SHA
32 (X'20') SMF119FT_FCProtBuffSize 4 Binary Negotiated protection buffer size
36(X'24') SMF119FT_FCCipher 2 EBCDIC Hexadecimal value of cipher specification (present only if protocol mechanism is TLS or AT-TLS). If the value is 4X, the Cipher Specification must be obtained from the SMF119FT_FCCipher4 field.
38(X'26') SMF119FT_FCFips140 1 Binary FIPS 140 status
  • X'00': FIPS 140 off
  • X'01': FIPS 140 on
  • X'02': FIPS 140 level 1
  • X'03': FIPS 140 level 2
  • X'04': FIPS 140 level 3
39(X'27') SMF119FT_FCCipher4 4 EBCDIC Four byte hexadecimal value of Cipher Specification (present only if Protocol Mechanism is TLS or AT-TLS).
43(X'2B') SMF119FT_FCSessReuse 1 EBCDIC SSL session reuse:
  • N: None
  • A: Allowed
  • R: Required
44(X'2C') SMF119FT_FCCSSLSessIDLen 2 Binary Length of the SSL session ID of FTP control connection.
46(X'2E') SMF119FT_FCCSSLSessID 32 Binary SSL session ID of FTP control connection.
78(X'4E') SMF119FT_FCDSSLSessIDLen 2 Binary Length of the SSL session ID of FTP data connection.
80(X'50') SMF119FT_FCDSSLSessID 32 Binary SSL session ID of FTP data connection.
Table 6 shows the FTP client transfer completion user name section.
Table 6. FTP client transfer completion user name section
Offset Name Length Format Description
0(X'0') SMF119FT_FCIUserID n EBCDIC User name or user ID used to log into the FTP server.
Table 7 shows the FTP client load module name section, physically located after the FTP client transfer completion user name section. This section represents the load module or program object library name and member name associated with this transfer. It's optional and is present only for load module transfer.
Table 7. FTP client transfer completion load module name section
Offset Name Length Format Description
0(X'0') SMF119FT_FCMemNum 4 Binary Number of members associated with the file transfer operation. The member names begin in field SMF119FT_FCMemName.
4(X'4') SMF119FT_FCLibNameLen 1 Binary Length of the name of the Load module or program object library associated with the file transfer operation
5(X'5') SMF119FT_FCLibName 44 EBCDIC Name of the load module or program object library associated with the file transfer operation, padded with trailing blanks.
49(X'31') SMF119FT_FCMemName n EBCDIC Names of members associated with the file transfer operation. There is no delimiter between the names of members. Each member name occupies 8 bytes. Name values that are less than 8 bytes in length are padded with trailing blanks.