Purpose

Use the LOCSIte subcommand to specify information that is used by the local host to provide services specific to that host system.

Parameters

ASAtrans

Permits the FTP client to interpret characters in the first column of ASA files being transferred as print control characters.

AUTOMount

Permits automatic mounting of volumes for data sets on volumes that are not mounted. If AUTOMount is specified and an unmounted volume is needed, a message is automatically issued to the MVS™ operator console requesting that the volume be mounted. The MVS operator must then mount the volume and reply to the message before FTP can proceed.

AUTORecall

Permits automatic recall of migrated data sets.

BLKsize

Specifies the block size of a newly allocated data set. BLKsize is functionally equivalent to BLOCKSIze. The BLOCKSIze parameter is obsolete, but it is accepted to provide compatibility with previous releases of z/OS TCP⁄IP.

When specified without a size, no block size is used when allocating the new data set. When specified without a size, the equal sign (=) is optional.

Specify BLKsize with no value if you are also specifying DATAClass=data_class and you want the SMS data class to provide the BLKsize value, or if you are specifying DCbdsn=data_set_name and you want to use the block size from the DCBDSN data set. If BLKsize=size is specified with either the DATAClass or DCbdsn parameter, the value specified by the LOCSite BLKsize parameter overrides the DATAClass or DCbdsn block size.

Notes:

1. If you specify BLKsize without a size, FTP does not specify the block size when allocating new data sets.
2. Be especially careful specifying both BLKsize= and Blocks. While there are conditions where this is tolerated, if a valid BLKsize cannot be determined, the data set will not be created when the allocation is attempted.

size

Specifies the block size of a newly allocated data set. The valid range is 0–32 760.

BLKsize=0 is a special case. When BLKsize=0 is specified, the operating system attempts to determine a block size for the new data set. FTP does not create the new data set unless the system is able to establish a nonzero block size.

BLocks

Specifies that primary and secondary space allocations are in blocks.

If both PRImary and SECondary are specified as 0, and an SMS data class has been specified, the space allocation is determined by the SMS data class and the BLocks parameter is ignored.

BLOCKSIze

Specifies the block size of a newly allocated data set. BLOCKSIze is functionally equivalent to BLKsize. BLOCKSIze is obsolete but it is accepted to provide compatibility with previous releases of z/OS TCP⁄IP. See the BLKsize parameter for more information.

BUfno

Specifies the number of access method buffers that is used when data is read from or written to a data set. The valid range is 1 – 35. The default value is 5.

CHKPTFLUSH

Specifies that z/OS® flushes each checkpoint record from the buffer to the storage media after this record is written into the buffer.

CHKptint

Specifies the checkpoint interval that the FTP client uses when you issue the APPEnd, Put, and MPUt subcommands. When RESTGET is TRUE, the CHKptint parameter also specifies the checkpoint interval that the FTP client uses when you issue the Get and MGet subcommands. For details about the RESTGET value, see RESTGet or the RESTGET statement (FTP client) information in z/OS Communications Server: IP Configuration Reference.

The checkpoint interval is the number of records that are sent between restart markers when transferring files in EBCDIC block mode or EBCDIC compress mode. If the checkpoint interval is 0, no checkpointing occurs and no restart markers are transmitted. The default value is 0.

Do not set CHKptint to a value greater than 0 at the FTP client unless the server supports the RESTart command and can process checkpoint markers in the file transfer data stream.

Results: A CHKptint value greater than 0 enables checkpointing for file transfers that meet the following conditions:

• Type is EBCDIC
• Mode is Block or Compressed
• Filetype is SEQ
• The subcommand that was entered was APpend, MPut, or Put, and RESTGET is FALSE
• The subcommand that was entered was APpend, MPut, Put, Get, or MGet, and RESTGET is TRUE.

Checkpointing never occurs when the local file is a z/OS UNIX named pipe.

number

Specifies the checkpoint interval for the sending site in a file transfer request. This value is used to determine when checkpoint marker blocks are to be transmitted so that transmission can be restarted based on the information in the last marker.

A large checkpoint interval means that a large amount of data is sent between markers and few markers are sent. A smaller checkpoint interval means that less data is sent in between markers and therefore more markers are sent.

The costs involved with using a nonzero checkpoint interval are:

• The markers themselves are transmitted, which means that more bytes are being sent across the network (approximately 44 bytes per marker).
• For each marker that is sent by the client, a reply must be sent by the server on the control connection. The reply acknowledges the marker and provides the corresponding marker for the server.

To estimate the appropriate checkpoint interval, use the following formula. You need to know the record length of the file you are transferring and how much data you think can be transmitted reliably.

                       amount of data in interval
CHKPTINT = --------------------------
                       record length of the file

Do not use a CHKptint more often than once every 200 KB of data sent. For example, if the file you are transferring has 80-byte records, the checkpoint interval is 2560:

CHKPTINT = 200KB / 80 bytes
                    = 200 * 1024 bytes / 80 bytes
                    = 2560

CHKPTPrefix

Specifies a key which is used to determine the hlq of the checkpoint data set. The name will be hlq.FTP.CHKPOINT or hlq.pds_name(CHKPOINT).

home

The default.

userid

Creates the data set 'userid.FTP.CHKPOINT'.

local

Creates a file named current_path.FTP.CHKPOINT or, if the path happens to be a PDS, then the file name is current_path.pds_name(CHKPOINT).

Note the exceptions for z/OS UNIX and BATCH jobs in the following chart using 'path' for current path and 'FN' for FTP.CHKPOINT:

Parameter	z/OS UNIX	Batch	TSO
Home	path.FN	userid.FN	tso_prefix.FN
Userid	userid.FN	userid.FN	userid.FN
Local	path.FN	path.FN	path.FN
Local with path=pdse	N/A	path.pds_na (CHKPOINT)	path.pds_na (CHKPOINT)

CHMod

Changes the permission bits for a file.

ooo filename

ooo is an octal mask representing the permissions you want to assign to filename. Form the octal mask by OR'ing the constants corresponding to the permission bits you want set:

400

User read

200

User write

100

User execute (or list directory)

040

Group read

020

Group write

010

Group execute

004

Other read

002

Other write

001

Other execute

You cannot use the LOCSITE subcommand CHMod parameter to set the following permission bits:

• Set-user-ID bit
• Set-group-ID bit
• Sticky bit

See the z/OS UNIX System Services User's Guide and the z/OS UNIX System Services Command Reference for more information about file permissions.

symbolic filename

symbolic represents the permissions you want to apply to filename.

Note: symbolic is specified as follows:

{u|g|o|a}{=|+|-}{r|w|x|rw|rx|wx|rwx}

where u, g, o, a, =, +, -, r, w, and x are as defined for the z/OS UNIX chmod command.

If filename does not begin with a slash character (/), it is appended to the current working directory. If filename does begin with a slash character (/), it is interpreted as a complete directory name.

The file name specified must be a z/OS UNIX file name for a single file and cannot contain a wildcard (*) for multiple files. The setting of QUOtesoverride is ignored and all quotation marks are treated as part of the file name.

The CHMOD keyword must be the only or last keyword on a LOCSIte subcommand.

CONDdisp

Specifies the disposition of the data set if a retrieve operation for a new data set ends before all of the data is written.

Catlg

Specifies that a data set is kept and cataloged when an FTP file transfer ends prematurely.

Delete

Specifies that a data set is deleted when an FTP file transfer ends prematurely.

Delete is ignored if the file transfer failed as a result of the FTP client being terminated or if the client has received checkpoint information during data transfer.

CTRLConn

Specifies the ASCII code page to be used for control connections. The valid subcommands are:

LOCSITE CTRLConn=7BIT
LOCSITE CTRLConn=iconv_ascii
LOCSITE CTRLConn=FTP_STANDARD_TABLE
LOCSITE CTRLConn=*

See Support for SBCS languages for more information.

7BIT

Indicates 7-bit ASCII is to be used.

iconv_ascii

Is a name recognized by iconv to indicate an ASCII code page. For a list of code pages supported by iconv, see code set converters information in the z/OS XL C/C++ Programming Guide.

FTP_STANDARD_TABLE

Specifies that the FTP internal tables, which are the same as the tables that are shipped in TCPXLBIN(STANDARD), are to be used on the control connection.

*

Specifies that the ASCII used at initialization is to be used.

Note: Setting the control connection code page using LOCSIte CTRLCONN disables UTF-8 encoding of the control connection. You must start the client again to restore UTF-8 encoding.

CYlinders

Specifies that primary and secondary space allocations are in cylinders.

If both PRImary and SECondary are specified as 0, and an SMS data class has been specified, the space allocation is determined by the SMS data class and the CYlinders parameter is ignored.

DATAClass

Specifies the SMS data class, as defined by your organization, for the target host. Specifying DATAClass with no parameter value cancels the dataclass specification. The equal sign (=) is optional in this case.

See Specifying values for new data sets for more information about specifying attributes when allocating new data sets.

data_class

Specifies the SMS data class, as defined by your organization, for the target host. If values are specified for any of the following LOCSIte parameters, the values specified by the LOCSIte parameter override the value specified in the SMS dataclass:

• BLKsize
• Directory
• LRecl
• PRImary
• RECfm
• RETpd
• SECondary

If the DCbdsn parameter is specified on the LOCSIte subcommand, the LRecl, RECfm, BLOCKSIze, and RETpd (if specified) of the DCBDSN data set overrides the values specified in the data class.

If the MGmtclass parameter is specified on the LOCSIte subcommand, and the requested management class specifies a retention period, the retention period value of the management class can override the retention period value of the dataclass.

DATAKEEPALIVE

Specifies the data connection keepalive timer value for the FTP client.

seconds

The number of seconds that elapse before a keepalive packet is sent on the FTP data connection. Valid values are in the range 60 - 86400 or 0. If you specify the value 0, the DATAKEEPALIVE timer is disabled. For passive mode data connections, the keepalive timer that you configured in PROFILE.TCPIP controls how often keepalive packets flow on the data connection. For active mode data connections, FTP suppresses the PROFILE.TCPIP keepalive timer.

Result: Specifying a DATAKEEPALIVE value prevents a network device from closing the data connection during periods of inactivity on the data connection.

DATASetmode

Specifies that all the data set qualifiers located below the current directory are treated as entries in the directory (disables DIRECTORYMode).

DB2®

Specifies the name of the DB2 subsystem.

db2_name

The name of the DB2 subsystem.

DBSUB

Specifies that substitution is allowed for data bytes that cannot be translated in a double-byte character translation. The substitution character is selected by the C/C++ iconv() function; see information about Locales and Character Sets in z/OS XL C/C++ Programming Guide for more details.

DCbdsn

Specifies the name of the MVS data set that is to be used as a model for allocation of new data sets. Specifying DCbdsn with no parameter value cancels the DCbdsn specification.

data_set_name

Specifies the name of the data set. The file name must be an MVS data set name. z/OS UNIX file names are not allowed on the DCbdsn parameter. The setting of QUOtesoverride is ignored. If the file name is enclosed in single quotation marks, it overrides the current working directory; otherwise it is appended to the current working directory.

Notes:

1. Specify the LOCSIte parameters RECfm, LRecl, and BLKsize with no values to allow characteristics from the model DCB to be used.
2. To override the model characteristics of RECfm, LRecL, BLKsize, or RETpd, specify a value on the LOCSIte command.
3. If MGmtclass is specified, the RETpd value of the MGmtclass can override the RETpd value.

Specifying a GDG data set with a relative index produces an error message. The following examples are unsupported specifications:

LOCSITE DCBDSN=MYGDG(0)
LOCSITE DCBDSN=MYGDG(–nnn)or
LOCSITE DCBDSN=MYGDG(+nnn)

See Steps for using a DCBDSN model to create a new data set for more information about DCbdsn.

Directory

Specifies the number of directory blocks to be allocated for the directory of a PDS.

Specify Directory=0 to allocate without specifying the number of directory blocks. Specify Directory=0 when you are also specifying DATAClass=dataclass and you want the SMS dataclass to provide the Directory size.

The size you specify with the Directory parameter overrides the DATAClass directory specification.

size

Specifies the number of directory blocks to be allocated for the directory of a PDS. The valid range is 1 – 16 777 215. The size 0 indicates that the directory blocks should be taken from the SMS data class.

DIRECTORYMode

Specifies that only the data set qualifier immediately below the current directory is treated as an entry in the directory. In directory mode, this data set qualifier is the only one used by the MPut subcommand.

DIRECTORYMode has no effect on files residing in a z/OS UNIX file system.

DSNTYPE

Specifies the data set name type for new physical sequential data sets.

SYSTEM

Physical sequential data sets are allocated with the SMS data class value. If no data class is defined, or if the DSNTYPE attribute is not defined, new physical sequential data sets will be allocated with the system default value.

BASIC

Allocates physical sequential data sets as physical sequential basic format data sets.

LARGE

Allocates physical sequential data sets as physical sequential large format data sets.

DSWAITTIME

Specifies the number of minutes that FTP waits when trying to access a local MVS data set.

minutes

The number of minutes to wait for a local MVS data set to become available. Valid values are in the range 0 - 14400. The value 0 (the default) specifies that FTP does not wait to obtain a data set when the data set is being held by another job.

EATTR

Specifies whether newly allocated data sets can have extended attributes and whether new data sets can reside in the EAS of an EAV.

SYSTEM

The data set uses the SMS data class EATTR value. If no SMS data class is defined, or if the data class contains no EATTR specification, the data set is allocated with the system default.

NO

The data set cannot reside in the EAS, and its VTOC entry cannot contain extended attributes.

OPT

The data set can reside in the EAS, and its VTOC entry can have extended attributes if the volume supports them.

ENCODING

Specifies the kind of encoding that is used for conversions between codepages for data transfers. See Support for SBCS languagesand Support for MBCS languages for more information.

SBCS

Single Byte encoding. Code pages are specified using the SBDATACONN configuration option. This is the default value.

MBCS

Multibyte encoding. Code pages are specified using the MBDATACONN configuration option.

EPSV4

Specifies the client is to attempt to use the EPSV command to establish a data connection on an IPv4 session instead of referring to the FWFRIENDLY setting.

See RFC 2428 for information about the EPSV command. If the server rejects the EPSV command, the client refers to the FWFRIENDLY setting to determine how to establish the data connection. When the client is setting up proxy transfer data connections, it will try the EPSV and EPRT commands on IPv4 sessions; if a server rejects the EPSV or EPRT command, the client will try the PASV or PORT command instead.

If the server rejects either the EPSV or the EPRT command during the session, the client won't send EPSV to the server again, even when EPSV4 is specified.

FIFOIOTIME

Specifies the maximum length of time that the FTP client waits for an I/O operation to a named pipe in its z/OS UNIX file system to complete.

Rules:

• When you send a file that is a named pipe to the server, the FTP client reads from the named pipe one or more times. Each read from the named pipe must complete within the length of time that is specified by the FIFOIOTIME value.
• When you store a file that was received from the server as a UNIX named pipe, the FTP client writes to the named pipe one or more times. Each write to the named pipe must complete within the length of time that is specified by the FIFOIOTIME value.

seconds

The number of seconds that FTP waits for an I/O operation to a UNIX named pipe to complete. Valid values are in the range 1 - 86400. The default value is 20.

FIFOOPENTIME

Specifies the length of time that the FTP client waits for an open of a named pipe in its z/OS UNIX file system to complete.

seconds

The number of seconds that FTP waits for an open of a named pipe to complete. Valid values are in the range 1 - 86400. The default value is 60.

FILEtype

Specifies the file type of the data set.

type

The file type of the data set can be:

Type

Description

SEQ

Sequential or partitioned data sets

SQL

SQL query function

FWFriendly

Specifies that the FTP client is firewall-friendly. This means that data connections will be set up from the FTP client to the FTP server.

Note: When the FTP server has an IPv6 address, data connections are always set up from the FTP client to the FTP server without reference to the FWFriendly setting.

ISPFSTATS

Allows FTP to create or update ISPF Member statistics when Get or MGet subcommands are issued.

LISTSUBdir

Use the LISTSUBdir option to indicate that wildcard searches should apply to the current working directory and should also span one level of its subdirectories. For the FTP client, this setting applies when issuing an MPut * subcommand.

Restriction: The LISTSUBdir option applies to z/OS UNIX file operations only; MVS data set operations are not affected.

Result: If the LISTSUBdir option is not specified on the LOCSITE subcommand and the LISTSUBDIR statement is not specified in the client FTP.DATA file, the default is as if the LISTSUBdir option was specified on the LOCSITE subcommand.

LRecl

Used to specify the logical record length (LRecl) of a newly allocated data set.

Specify LRecl with no value when you are also specifying DATAClass=data_class and you want the SMS dataclass to provide the LRecl value, or when you are specifying DCbdsn=data_set_name and you want to use the LRecl from the DCBDSN data set. If LRecl=length is specified with either DATAClass or DCbdsn, the length specified by the LOCSIte LRecl parameter overrides the DATAClass or DCbdsn LRecl.

length

Specifies the logical record length of a newly allocated data set. The valid range is 0 - 32760. A special value of x (LRecl=x) is also supported to indicate that a logical record length can be 32768 for variable-length spanned records.

Specifying LRecl=0 has the same effect as specifying LRecl with no parameters.

MBDATACONN=(file_system_codepage,network_transfer_codepage)

Specifies the codepages for the file system and for the network transfer used when the client does data conversion during a data transfer. This parameter affects the conversion of multibyte character set (MBCS) data (including support for DBCS code pages) and is used when the ENCODING=MBCS is also specified.

See Support for MBCS languages for more information.

file_system_codepage

Specifies the name of the file system codepage.

network_transfer_codepage

Specifies the name of the network transfer codepage.

MBREQUIRELASTEOL

Specifies that the FTP client will report an error when a multibyte file or data set is received from the server with no EOL sequence in the last record received. FTP will abort the file transfer.

MBSENDEOL

Specifies which end-of-line sequence to use when ENCODING is MBCS, the data transfer type is ASCII, MODE is Stream, and data is being sent to the server. The following are possible values:

CRLF

Append both carriage return (X'0D') and line feed (X'0A') end-of-line sequences to each line of translated text. This is the default and the standard sequence defined by RFC 959. The z/OS server can receive ASCII data in this format only.

CR

Append only a carriage return (X'0D') end-of-line sequence to each line of translated text.

LF

Append only a line feed (X'0A') end-of-line sequence to each line of translated text.

NONE

Do not append an end-of-line sequence to the line of translated text.

Rules:

• Most servers support only the CRLF value for incoming ASCII data. Do not specify another value for MBSENDEOL unless you have verified that the server is expecting the end-of-line sequence that you specify.
• Do not use an end-of-line sequence other than CRLF if the server is a z/OS FTP server. The z/OS FTP server supports only the CRLF value for incoming ASCII data.
• If you send a file to a server when MBSENDEOL has a value other than CRLF, a subsequent SIZE command to that server targeting the file you sent could yield unpredictable results. Any size indicated in the server reply for such a file might not be reliable.

MGmtclass

Used to specify the SMS management class as defined by your organization for the target host. Specifying MGmtclass with no mgmtclass cancels the mgmtclass specification. The equal sign (=) is optional in this case.

mgmtclass

Specifies the SMS management class as defined by your organization for the target host. If the mgmtclass specified has a setting for RETpd, the value specified by the mgmtclass can override the setting of the LOCSIte RETpd parameter, the RETpd value of a model data set if the DCbdsn parameter is specified, and the RETpd value defined in an SMS data class if DATAClass is specified. See Specifying values for new data sets for more information about specifying attributes when allocating new data sets.

MIGratevol

Specifies the volume ID for migrated data sets if they do not use IBM® storage management systems. If you do not specify MIGratevol, the default volume_serial is MIGRAT.

volume_ID

The volume ID for migrated data.

NOASAtrans

Treats ASA file transfers as regular file transfers; that is, the ASA characters are treated as part of the data and are not converted to print control characters.

NOAUTOMount

Prevents automatic mounting of volumes for data sets on volumes that are not mounted.

NOAUTORecall

Prevents automatic recall of migrated data sets.

Note: A migrated data set can be deleted even though NOAUTORecall is specified, because migrated data sets are not recalled for deletion.

NOCHKPTFLUSH

Specifies that z/OS can save the checkpoint records in the buffer and determine when to flush these records to the storage media.

NODBSUB

Specifies that substitution is not allowed for data bytes that cannot be translated in a double-byte character translation. This causes a data transfer failure if a character cannot be translated during the transfer. This is the default.

NOEPSV4

Prevents the client from using the EPSV command to establish a data connection on an IPv4 session. See RFC 2428 for information about the EPSV command. When NOEPSV4 is set, the client refers to the FWFRIENDLY setting to determine how to establish the data connection. When the client is setting up proxy transfer data connections, the client will use only PASV and PORT commands with IPv4 servers.

NOFWFriendly

Specifies that the FTP client is not firewall friendly. This means that data connections will be set up from the FTP server to the FTP client. This is the default behavior for FTP data connections.

Note: When the FTP server has an IPv6 address, data connections are always set up from the FTP client to the FTP server without reference to the FWFriendly setting.

NOISPFSTATS

Does not allow FTP to create or update ISPF Member statistics when Get or MGet subcommands are issued.

NOLISTSUBdir

Use the NOLISTSUBdir option to indicate that wildcard searches should apply only to the current working directory and should not span its subdirectories. For the FTP client, this setting applies when issuing an MPut * subcommand.

Restriction: The NOLISTSUBdir option applies to z/OS UNIX file operations only; MVS data set operations are not affected.

Result: If the NOLISTSUBdir option is not specified on the LOCSITE subcommand and the LISTSUBDIR statement is not specified in the client FTP.DATA file, the default is as if the LISTSUBdir option was specified on the LOCSITE subcommand.

NOMBREQUIRELASTEOL

Specifies that the FTP client does not report an error when a multibyte file or data set is received from the network with no EOL sequence in the last record received. FTP will report the file transfer as completed.

NOPASSIVEIGNOREADDR

For passive mode FTP, specifies that the FTP client uses the IP address and port number from the PASV command reply that is returned by the FTP server for the data connection.

NOQUOtesoverride

A single quote at the beginning of the file name, as well as all other single quotation marks contained in the file name, is treated as part of the actual file name. The entire file name, including the leading single quotation mark, is appended to the current working directory.

NORDW

Specifies that variable record descriptor words (RDWs) are discarded during FTP transmission of variable format data sets. This applies to transfers in stream mode only.

NOREMOVEINBEOF

Specifies that the UNIX end-of-file (EOF) byte (X'1A') is not removed on inbound ASCII transfers before the data is stored. See z/OS Communications Server: IP Configuration Reference for more information.

NORESTGet

Prevents opening the checkpoint data set for a Get request. Thus, checkpoint will not be active or recognized. Using this parameter when opening the checkpoint data set might cause a problem.

NOSBSUB

Specifies that substitution is not allowed for data bytes that cannot be translated in a single-byte character translation. This causes a data transfer failure if a character cannot be translated during the transfer.

NOSECUREIMPlicitzos

When the client connects to the server's TLSPORT, the security handshake and negotiation are done immediately after the connect and before the 220 reply is received.

NOSPRead

Specifies that the output is in report format rather than spreadsheet format when the file type is SQL.

NOTRAILingblanks

Specifies that the FTP client does not preserve the trailing blanks that are in a fixed format data set when the data is sent to a foreign host.

NOTRUNcate

Specifies that truncation is not permitted. The FTP client will set an error and fail file transfer if a record that is longer than LRECL of the new file is detected.

Note: If WRAPRECORD is set then the data is wrapped, not truncated, no error will be set, and the file transfer will continue.

NOUCSSUB

In UCS-2-to-EBCDIC conversion, the data transfer is terminated if any UCS-2 character cannot be converted into the EBCDIC code set.

NOUCSTRUNC

In UCS-2-to-EBCDIC conversion, truncation of EBCDIC data is not allowed. The data transfer is aborted if the logical record length of the receiving data set is too small to contain the data after conversion to EBCDIC.

Note: The setting of the CONDdisp parameter determines what happens to the target data set if the transfer is aborted.

NOWRAPrecord

Indicates that data is truncated if no new line character is encountered before the logical record length of the receiving file is reached.

Note: If NOTRUNcate is also set, an error will be set and the file transfer will fail.

NOWRTAPEFastio

Specifies that ASCII stream data that is being written to tape must be written using the Language Environment® run time library.

PASSIVEIGNOREADDR

For passive mode FTP, specifies that the FTP client uses the port number from the PASV command reply and the IP address that was used to log in to the FTP server, for the data connection.

Requirement: See the PASSIVEIGNOREADDR (FTP client) information in z/OS Communications Server: IP Configuration Reference for more details about the requirements.

PDSTYPE

Specifies whether the FTP client creates local MVS directories as partitioned data sets or as partitioned data sets extended.

When specified without a value, FTP will not specify to z/OS whether to allocate a new MVS directory as a PDS or a PDSE. When specified without a value, the equal sign (=) is optional.

PDS

Allocate directories as partitioned data sets.

PDSE

Allocate directories as partitioned data sets extended.

PROGRESS

Specifies the interval between progress report messages generated by the FTP client during a file transfer (inbound or outbound).

number

Specifies the interval (in seconds) between progress report messages that are generated in the FTP client during an inbound or outbound file transfer. Valid values are in the range 10 - 86400, or 0. The value 0 turns off progress reporting in the FTP client. The default value is 10 seconds.

The messages that are generated as part of progress reporting are EZA2509I and EZA1485I. These messages are generated automatically at 10-second intervals by the FTP client in releases prior to version V1R6. Beginning in version V1R6, the default behavior is the same as in prior releases, but the length of the interval and whether to generate the messages can be configured by using the PROGRESS parameter setting on the LOCSITE subcommand or by specifying the PROGRESS statement in the FTP.DATA file.

PRImary

Used to specify the number of tracks, blocks, or cylinders for primary allocation. When specified with a value of 0, no primary value is used when allocating the data set.

Specify a PRImary allocation of 0 when you are also specifying DATAClass=data_class and when you want the SMS dataclass to provide the PRImary amount.

To enable the SMS data class to determine the space allocation, both PRImary and SECondary allocations must be specified as 0. The tracks, blocks, cylinders setting is ignored in this case. If PRImary with amount not equal to 0 is specified with DATAClass, the value specified by the LOCSIte PRImary parameter overrides the DATAClass space allocation.

amount

Specifies the number of tracks, blocks, or cylinders for primary allocation. For allocating partitioned data sets, this is the amount of space that is allocated for the primary extent.

For allocating sequential data sets this is the maximum amount of space that is allocated for the primary extent. If a lesser amount of space is needed to hold the data being transferred, only the amount of space actually needed to hold the data is allocated. The valid range is 1 – 16 777 215.

Qdisk

Used to display statistics about the amount of space available on a volume. If Qdisk is entered without a specific volume_serial, statistics about available space are displayed for each volume that is defined with “Use Attribute=storage”.

volume_serial

Displays statistics about available space on a specific volume.

QUOtesoverride

Specifies that a single quotation mark at the beginning and end of a file name should override the current working directory instead of being appended to the current working directory. This is the way single quotation marks are used in all previous MVS FTP servers, and this is the default. Any single quotation mark inside the beginning and ending quotation marks are treated as part of the file name.

QUOtesoverride indicates the usage of single quotation marks appearing at the beginning of, or surrounding, a file name. The setting of this keyword affects all FTP subcommands that have a path name as a parameter except keywords on the LOCSIte subcommand.

RDW

Specifies that variable record descriptor words (RDWs) are treated as if they were part of the record and are not discarded during FTP transmission of variable format data sets. This applies to transfers in stream mode only.

Note: RDW information is stored in binary format. Transfer files in binary mode to avoid the translation problems that can occur if you transfer this binary field in EBCDIC or ASCII mode.

READTAPEFormat

Used to provide information about an input data set on tape. If specified without the tape_format (which is the default), processing of input tapes does not take advantage of the record format information prior to open. The equal sign (=) is optional in this case.

The READTAPEFormat parameter has no effect on, and is not affected by DATAClass, DCbdsn, LRecl, RECfm, or any other parameters associated with creating a data set.

tape_format

Specifies the format of the records on the input tape data set. Valid formats are:

F

Fixed record length

V

Variable record length

S

Spanned records

X

Logical record length is undefined (Lrecl X)

blank

Unspecified (displayed as U in messages and reply)

These formats are mutually exclusive. Spanned implies variable, and Lrecl X implies spanned. If specified, the tape_format value must be the most inclusive identifier in the list that matches the tape. If it is not the most inclusive identifier, an error message is issued. For example, if the tape_format value is S (spanned) and the tape contains records with undefined length (Lrecl X), the request will fail. An unspecified format avoids this type of error. However, the following should be considered:

• Specify a value for the READTAPEFormat parameter in all the following cases. Failure to specify a format will likely cause errors in processing the tape.
  • The record length is undefined (Lrecl X).
  • The records are spanned (Recfm is VBS, VS).
  • The records are variable (Recfm is V, VB, VBA) and RDW is specified.
• Specify a value for the READTAPEFormat parameter for all input tapes that have one of the listed formats to ensure best results.

RECfm

Used to specify the record format of a data set. When specified without the format, no record format is used when allocating the data set. The equal sign (=) is optional in this case.

Specify the RECfm parameter with no value when you are also specifying DATAClass=data_class and you want the SMS dataclass to provide the RECfm format, or when you are specifying DCbdsn=data_set_name and you want to use the record format from the DCBDSN data set.

If RECfm=format is specified with either DATAClass or DCbdsn, the value specified by the LOCSIte RECfm parameter overrides the DATAClass or DCbdsn record format.

format

Specifies the record format of a data set. Valid record formats are: F, FA, FB, FBA, FBM, FBS, FBSA, FBSM, FM, FS, FSA, FSM, U, UA, UM, V, VA, VB, VBA, VBM, VBS, VBSA, VBSM, VM, VS, VSA, and VSM. The characters used to specify these record formats have the following meanings:

Code	Description
F	Fixed record length
V	Variable record length
U	Undefined record length
B	Blocked records
S	Spanned records (if variable) / standard records (if fixed)
A	Records contain ISO/ANSI control characters
M	Records contain machine code control characters

REMOVEINBEOF

Specifies that the UNIX end-of-file (EOF) byte (X'1A') is removed on inbound ASCII transfers before the data is stored. See z/OS Communications Server: IP Configuration Reference for more information.

RESTGet

Allows opening the checkpoint data set for the Get request. This is the default when the RESTGet statement has not been added to the FTP.DATA file.

RETpd

Used to specify the number of days that a newly allocated data set should be retained.

Specify RETpd with no value when you are also specifying DATAClass=data_class or MGmtclass=mgmtclass and you want SMS to provide the RETpd value, or when you are specifying DCbdsn=data_set_name and you want to use the RETpd from the DCBDSN data set. If more than one of the LOCSIte parameters (RETpd, MGmtclass, DATAClass, or DCbdsn) are specified, the order of precedence (highest to lowest) is:

1. MGmtclass
2. RETpd
3. DCbdsn
4. DATAClass

If a retention period is associated with an SMS management or data class, or with a model DCBDSN data set, the value of the retention period can be overridden to another nonzero value, but it cannot be overridden to have no retention period specified for the newly created data sets.

days

Specifies the number of days that a newly allocated data set should be retained. The valid range is 0–9999. A value of 0 indicates a retention period of 0 days so that the data set expires the same day as it was created.

SBDataconn

Specifies the conversions between file system and network code pages to be used for data transfers.

LOCSITE SBDataconn=dsname
LOCSITE SBDataconn=(file_system_cp,network_transfer_cp)
LOCSITE SBDataconn=FTP_STANDARD_TABLE
LOCSITE SBDataconn=*
LOCSITE SBDataconn=
LOCSITE SBDataconn

See Support for SBCS languages for more information.

The following forms of specifying SBDataconn are equivalent to specifying SBDataconn=*:

• SBDataconn
• SBDataconn=

dsname

Specifies the fully qualified name of an MVS data set or z/OS UNIX file that contains the EBCDIC-to-ASCII and ASCII-to-EBCDIC translate tables generated by the CONVXLAT utility.

Notes:

1. The name must not be enclosed in quotation marks. If quotation marks appear, they are treated as part of the name. (QUOtesoverride is ignored.)
2. The z/OS UNIX file system name is case sensitive. The MVS name is not case sensitive.
3. The name cannot begin with a left parenthesis [(].
4. The SBDataconn keyword must be the only keyword or the last keyword on a LOCSIte subcommand.

file_system_cp

Specifies the name of the file system code page recognized by iconv. For a list of code pages supported by iconv, see code set converters information in the z/OS XL C/C++ Programming Guide.

network_transfer_cp

Specifies the network transfer code page recognized by iconv. For a list of code pages supported by iconv, see code set converters information in the z/OS XL C/C++ Programming Guide.

FTP_STANDARD_TABLE

Specifies that the FTP internal tables, which are the same as the tables that are shipped in TCPXLBIN(STANDARD), are to be used on the data connection.

*

Specifies the translate tables set up at initialization for the data connection must be used.

SBSENDEOL

Specifies which end-of-line sequence to use when ENCODING is SBCS, the data transfer type is ASCII, and data is being sent to the server. The following are possible values:

CRLF

Append both carriage return (X'0D') and line feed (X'0A') end-of-line sequences to each line of translated text. This is the default and the standard sequence defined by RFC 959. The z/OS server can receive ASCII data in this format only.

CR

Append only a carriage return (X'0D') end-of-line sequence to each line of translated text.

LF

Append only a line feed (X'0A') end-of-line sequence to each line of translated text.

NONE

Do not append an end-of-line sequence to the line of translated text.

Tip: The srestart subcommand is disabled if you configure an SBSENDEOL value other than CRLF.

Rules:

• Most servers support only the CRLF value for incoming ASCII data. Do not specify another value for SBSENDEOL unless you have verified that the server is expecting the end-of-line sequence that you specify.
• Do not use an end-of-line sequence other than CRLF if the server is a z/OS FTP server. The z/OS FTP server supports only the CRLF value for incoming data.
• If you send a file to a server while SBSENDEOL has a value other than CRLF, a subsequent SIZE command to that server targeting the file you sent could yield unpredictable results. Any size indicated in the server reply for such a file might not be reliable.

SBSUB

Specifies that substitution is allowed for data bytes that cannot be translated in a single byte character translation. The substitution character is specified by the SBSUBCHAR parameter.

SBSUBCHAR nn

Specifies the value that is used for substitution when SBSUB is also specified. The value is one of the following:

SPACE

When the target code set is ASCII, replace untranslatable characters with X'20' during SBCS data transfers. When the target code set is EBCDIC, replace untranslatable characters with X'40' during SBCS data transfers.

nn

Replace untranslatable characters with nn during SBCS data transfers, where nn is a hexadecimal value in the range 00 - FF.

SECondary

Specifies the amount of tracks, blocks, or cylinders for secondary allocation.

Specify SECondary=0 when you are also specifying DATAClass=dataclass and you want the SMS dataclass to provide the SECondary value. To enable the SMS data class to determine the space allocation, both PRImary and SECondary must be specified as 0. The tracks, blocks, cylinders setting is ignored in this case. If SECondary is specified as other than 0 with DATAClass, the value specified by the SIte SECondary parameter overrides the DATAClass space allocation.

amount

Specifies the number of tracks, blocks, or cylinders for secondary allocation. The valid range is 0 – 16 777 215. If you specify the amount value 0, FTP allocates without specifying secondary space.

SECUREIMPlicitzos

When the client connects using the TLSPORT implicit connection, the client waits for the 220 good morning reply before initiating the security handshake and negotiation. This is the default.

SPRead

Specifies that the output is in spreadsheet format when the file type is SQL.

SQLCol

Specifies the column headings of the SQL output file.

any

The label of the DB2 SQL table column heading is the first choice for column heading, but if there is no label, the name becomes the column heading.

labels

Labels are the DB2 SQL table column headings. If any of the columns do not have labels, FTP supplies a column heading in the form of COLnnn.

names

Uses the names of the DB2 SQL table column headings. The labels are ignored.

STOrclass

Specifies the SMS storage class as defined by your organization for the target host. Cancels the storage class specification when specified without a storage_class parameter value. The equal sign (=) is optional in this case.

See Specifying values for new data sets for more information about specifying attributes when allocating new data sets.

storage_class

Specifies the SMS storage class as defined by your organization for the target host.

When an SMS storage class is in use, any of the attributes specified there can be overridden by a different specification by the user. To avoid overriding the setting in the SMS storage class, specify BLKSize, LRecl, PDSTYPE, PRImary, RECfm, SECondary, UCOUNT, Unit, VCOUNT, or VOLume with no associated value. This removes any value specified on a prior LOCSITE command or in FTP.DATA, and the affected attributes are not included on the allocation. To override a setting in the SMS storage class, specify the wanted value with the appropriate keyword.

TLSRFCLEVEL

Specifies the level of RFC 4217 that the client supports for TLS-protected sessions. See Using security mechanisms for more information.

DRAFT

The Internet draft revision level of RFC 4217 is supported. This is the level of RFC 4217 support the z/OS FTP client has offered since CSV1R2. This is the default value.

RFC4217

The FTP client complies with RFC 4217.

CCCNONOTIFY

The FTP client does not issue the TLSshutdown command after sending the CCC command. RFC 4217 did not mandate this flow until Internet revision 14.

Result: The SECUREIMPLICITZOS configuration option is not affected by this setting.

Note: FTP supports the TLSPORT statement regardless of the TLSRFCLEVEL setting. FTP connections to the TLSPORT port are implicitly secured with TLS as described in the Internet draft.

Restrictions:

• You cannot set the TLSRFCLEVEL setting to DRAFT during a TLS-secured session when the control connection is not secured.
• When you set the TLSRFCLEVEL option to RFC4217 or CCCNONOTIFY, the FTP server must use the same setting. If the server setting does not match, the connection might be reset or the session might hang and eventually time out.
• The CCCNONOTIFY option is not valid with the TLSMECHANISM ATTLS option. If both options are specified, using the CCC command causes the FTP session to fail. If CCCNONOTIFY is required for the partner system, configure TLSMECHANISM FTP with associated statements and exemption in the TTLSRules.

TRacks

Specifies that primary and secondary space allocations are in tracks.

If both PRImary and SECondary are specified as 0 and an SMS data class has been specified, the space allocation is determined by the SMS data class and the TRacks parameter is ignored.

TRAILingblanks

Specifies that the FTP client preserves the trailing blanks in a fixed format data set when the data is sent to a foreign host.

TRUNcate

Specifies that truncation is permitted. The FTP client does not set an error when a truncated record is detected and the file transfer continues.

UCOUNT

Specifies how many devices to allocate concurrently to support the allocation request.

unit_count

Specifies number of devices to allocate. Valid value is 1–59. When specified without a value, the FTP server does not specify a unit count when allocating data sets.

P

Parallel mount request.

Guideline: The UCOUNT statement is not meant to be used with an SMS storage class. Any UCOUNT value you specify overrides whatever is specified for the SMS managed dataclass being used.

UCSHOSTCS

Specifies the EBCDIC code set to be used when converting to and from UCS-2. If you do not specify a code_set value, the current code set is used.

code_set

Name of the EBCDIC code set to be used when converting to and from UCS-2.

UCSSUB

In UCS-2-to-EBCDIC conversion, the EBCDIC substitution character is used to replace any UCS-2 character that cannot successfully be converted. Data transfer continues.

UCSTRUNC

In UCS-2-to-EBCDIC conversion, truncation of EBCDIC data is allowed. The data transfer continues even if EBCDIC data is truncated.

UMask

Defines the file mode creation mask. The file mode creation mask defines which permission bits are not to be set on when a file is created. When a file is created, the permission bits requested by the file creation are compared to the file mode creation mask, and any bits requested by the file creation which are not allowed by the file mode creation mask are turned off.

The format of the UMask keyword is UMask ooo.

When a file is created, the specified permission bits for the file are 666 (-rw-rw-rw-). If the file mode creation mask is 027, the requested permissions and the file mode creation mask are compared:

110110110   - 666
000010111   - 027
---------
11010000    - 640
 

The actual permission bits set for the file when it is created is 640 (-rw-r-----).

Notes:

1. The default value for UMask is 027.
2. You cannot use FTP to create z/OS UNIX files with execute permissions. If you require execute permissions, use the LOCSIte CHMod command to change permissions after the file has been created.

UNICODEFILESYSTEMBOM

Specifies whether the FTP client stores incoming Unicode files with a byte order mark (BOM).

Restriction: The only Unicode encoding formats supported for file storage by z/OS FTP are UTF-8 and UTF-16. Files are always stored in big endian format.

Result: The byte order mark (BOM) stored with the file is determined by the encoding used to store the file rather than by the format of the BOM sent with the file.

ASIS

Store incoming Unicode files with a byte order mark only if the file was sent with a byte order mark

ALWAYS

Store incoming Unicode files with a byte order mark regardless of whether the file was sent with a byte order mark.

NEVER

Store incoming Unicode files without a byte order mark regardless of whether the file was sent with a byte order mark.

Results:

• The Unicode byte order mark, U+FEFF, can also be interpreted as a zero-width nonbreaking space character. z/OS FTP considers only the first character of the data received from the server as a possible byte order mark (BOM). No other instance of the BOM sequence in the inbound data is affected by this setting.
• When the local file is a z/OS UNIX named pipe, incoming data is always appended to any existing data that is in the named pipe. If you code UNICODEFILESYSTEMBOM = ASIS or ALWAYS and the named pipe contains data, the client appends a BOM byte sequence to existing data in cases in which it would add a BOM at the beginning of a regular file. The BOM byte sequence is interpreted as a zero-width nonbreaking space character when it does not start the file or data stream. You must take this into consideration when you configure the UNICODEFILESYSTEMBOM parameter.

Unit

Specifies the unit type for allocation of new data sets.

unit_type

The unit type (for example, 3380) for the allocation of new data sets on direct access devices. If unit_type is not specified, the unit type used for allocation is set back to the system default.

UNIXFILETYPE

Specifies whether to treat files in the z/OS UNIX file system as regular files or as UNIX named pipes.

FILE

Treat files in the z/OS UNIX file system as regular files. This is the default.

FIFO

Treat files in the z/OS UNIX file system as UNIX named pipes.

For information about transferring data into and from z/OS UNIX named pipes, see Using z/OS UNIX System Services named pipes.

VCOUNT

Specifies the number of tape data set volumes that an allocated data set can span. When this parameter is specified without a volume_count value, the FTP server uses the volume count 50 when it allocates tape data sets.

volume_count

Valid values are in the range 1 - 255.

VOLume

Specifies the volume serial number for allocation of new data sets.

volume_serial

The serial number of the volume to use for allocation.

volume_serial_list

A list of one or more volume serial numbers for allocation. Delimit each volume serial number from the previous one with a comma.

If VOLume is specified without a volume_serial_list or volume_serial parameter, no volumes are specified by the FTP client during the allocation of a new data set, and the installation default is used.

WRAPrecord

Specifies that data is wrapped to the next record if no new line character is encountered before the logical record length of the receiving file is reached.

WRTAPEFastio

Specifies that ASCII Stream data that is being written to tape is allowed to be written using BSAM I/O.