{"componentChunkName":"component---src-templates-manual-template-tsx","path":"/manuals/client-user/64/sftp-site.html","webpackCompilationHash":"d1750f6cc413894a8b5c","result":{"data":{"promoBlocks":{"edges":[{"node":{"contentful_id":"47glnSpWzXeFylv2vfQEF8","internal":{"type":"ContentfulPromotionBlock"},"title":{"internal":{"type":"ContentfulHeading"},"contentful_id":"7KIOfSfgwJnCXuvRN6CfrP","textContent":"Standing privileges are a risk with PAM","color":"black","size":"medium"},"subTitle":null,"content":{"nodeType":"document","internal":{"content":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Start your journey towards a just-in-time (JIT) model with zero standing privileges (ZSP). Read 'Remove Standing Privileges Through a Just-In-Time PAM Approach' by Gartner , courtesy of SSH.COM.\\n \\n\",\"marks\":[],\"data\":{}}],\"data\":{}}]}"}},"callToAction":{"internal":{"type":"ContentfulButton"},"contentful_id":"19EUesynV2Z7HHcuJk0BAS","content":"Download Gartner research","internalLink":null,"externalLink":"https://info.ssh.com/gartner_research_privileged_access_management","assetLink":null,"anchor":null},"picture":{"internal":{"type":"ContentfulAsset"},"contentful_id":"2ClylmBswcfDx4XdO7NTmL","title":"ICON Gartner ZSP","description":"","file":{"url":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png","contentType":"image/png"},"fluid":{"aspectRatio":1,"src":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=3000&q=50","srcSet":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=750&h=750&q=50 750w,\n//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=1500&h=1500&q=50 1500w,\n//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=1601&h=1601&q=50 1601w","sizes":"(max-width: 3000px) 100vw, 3000px"},"fixed":{"width":3000,"height":3000,"src":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=3000&q=50","srcSet":""}},"centered":true,"indentMainContent":null,"transparentBackground":null,"imageScale":70,"imagePadding":null,"name":"WIKI migration side promo block2","product":null,"funnel":null,"topic":null,"keywords":null,"type":null,"priority":null,"globalOverride":null}},{"node":{"contentful_id":"6dfNaA1UlY4bADKQk6awhs","internal":{"type":"ContentfulPromotionBlock"},"title":{"internal":{"type":"ContentfulHeading"},"contentful_id":"49Tb2wSR21P5C2cpcgMZ3","textContent":"Get Multi-cloud PAM software - for free!","color":"black","size":"medium"},"subTitle":null,"content":{"nodeType":"document","internal":{"content":"{\"data\":{},\"content\":[{\"data\":{},\"content\":[{\"data\":{},\"marks\":[],\"value\":\"PrivX® Free replaces your in-house jump hosts and combines your AWS, GCP and Azure access into one multi-cloud solution.\\n \\n\",\"nodeType\":\"text\"}],\"nodeType\":\"paragraph\"}],\"nodeType\":\"document\"}"}},"callToAction":{"internal":{"type":"ContentfulButton"},"contentful_id":"1dmQ13jyyZ46ID07eVNVFb","content":"PrivX Free","internalLink":null,"externalLink":"https://info.ssh.com/privx-free-access-management-software","assetLink":null,"anchor":null},"picture":{"internal":{"type":"ContentfulAsset"},"contentful_id":"4UUYdjING8micwZQur5o6d","title":"ICON computer (search)","description":"","file":{"url":"//images.ctfassets.net/0lvk5dbamxpi/4UUYdjING8micwZQur5o6d/1b378a0f4646075c7a4788f1afffbabe/ICON_computer__search_.svg","contentType":"image/svg+xml"},"fluid":{"aspectRatio":null,"src":null,"srcSet":null,"sizes":null},"fixed":{"width":null,"height":null,"src":null,"srcSet":null}},"centered":true,"indentMainContent":null,"transparentBackground":null,"imageScale":70,"imagePadding":null,"name":"WIKI migration side promo block1","product":null,"funnel":null,"topic":null,"keywords":null,"type":null,"priority":null,"globalOverride":null}}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"body":"
\"SSH\"
\"Home\" \"Prev\" \"Up\" \"Next\"  

Site Command

\n \n For command descriptions, see the \n site and lsite command in sftpg3(1) and the\n --dst-site and --src-site options in scpg3(1).\n

\n When giving the \n command, either the full parameter name or its abbreviation can be used. For example, the\n following two commands accomplish the same thing:

sftp> site x=bin\nsftp> site transfer_mode=bin

The available site parameters are listed\n and described in the following.

Table 5.1. site parameters

ParameterAbbreviationsPossible values
AUTOMOUNT-YES|NO|IMMED
[NO]AUTOMOUNT[NO]AUTOM-
AUTORECALL-YES|NO
[NO]AUTORECALL[NO]AUTOR-
BLKSIZEB, BLOCKSIsize
BLOCKSBL-
CONDDISPCOCATLG|UNCATLG|KEEP|DELETE
CYLINDERSCY-
DATACLASDAclass
DATASET_SEQUENCE_NUMBERSEQNUMnumber
DEFERDEYES|NO
[NO]DEFER--
DIRECTORY_SIZEM, DI, DIRSZsize
EXPIRY_DATEEXPDTyyddd|yyyyddd
FILE_STATUSSTATUSNEW|MOD|SHR|OLD
FILETYPEFILETSEQ|JES
FIXRECFMFIlength
JOB_IDJESIDID
JOB_OWNERJESOname
JOBNAMEJESJOBname
KEYLENKEYLlength
KEYOFFKEYOoffset
LABEL_TYPELABELNL|SL|NSL|SUL|BLP|LTM|AL|AUL
LIKE-like
LRECLR, LRlength
MGMTCLASMGclass
NORMDISPNORCATLG|UNCATLG|KEEP|DELETE
PRIMARY_SPACEPRIspace
PROFILEP, PROFprofile
RECFMO, RECrecfm
RECORD_TRUNCATEU, TRUNYES|NO
[NO]TRUNCATE[NO]TRU, [NO]TRUN-
RETENTION_PERIODRETdays
SECONDARY_SPACESE, SECspace
SIZELsize
SPACE_RELEASERLSEYES|NO
SPACE_UNITSUBLKS|TRKS|CYLS|AVGRECLEN
SPACE_UNIT_LENGTHSULlength
STAGINGS, STAGEYES|NO
STORCLASSTclass
SVC99_TEXT_UNITSSVC99string
TRACKSTR-
TRAILING_BLANKSTRAILYES|NO
[NO]TRAILINGBLANKS[NO]TRAI, [NO]TRAIL-
TRANSFER_CODESETC, CODESETcodeset
TRANSFER_FILE_CODESETD, FCODESETcodeset
TRANSFER_FILE_LINE_DELIMITERJ, FLDELIMUNIX|MVS|MVS-FTP|DOS|MAC|NEL
TRANSFER_FORMATF, FORMATLINE|STREAM|RECORD
TRANSFER_LINE_DELIMITERI, LDELIMUNIX|MVS|MVS-FTP|DOS|MAC|NEL
TRANSFER_MODEX, MODEBIN|TEXT
TRANSFER_TRANSLATE_DSN_TEMPLATESA, XDSNTtemplates
TRANSFER_TRANSLATE_TABLEE, XTBLtable
TYPETPS|PO|PDS|POE|PDSE|GDG|HFS|VSAM|ESDS|KSDS|RRN
UNITUNunit
UNIT_COUNTUC, UNCnumber
UNIT_PARALLELUNPYES|NO
VOLUME_COUNTVC, VOLCNTnumber
VOLUMESVO, VOLvol1+vol2+...

\n AUTOMOUNT=YES|NO|IMMED\n

If set to YES and a normal allocation fails because a data set is not\n online, Tectia will allocate it and request the system to mount it. This requires that the\n user has read permission to the SSZ.MOUNT facility.

If set to NO, offline data sets are not mounted automatically.

If set to IMMED, Tectia will not attempt the normal allocation, it will\n request the system to mount the data set immediately.

Default: NO

\n [NO]AUTOMOUNT|[NO]AUTOM\n

AUTOMOUNT|AUTOM is equal to AUTOMOUNT=YES.
\n NOAUTOMOUNT|NOAUTOM is equal to AUTOMOUNT=NO.

\n AUTORECALL=YES|NO\n

Defines whether data sets migrated by a storage manager are recalled\n automatically.

Default: YES

\n [NO]AUTORECALL|[NO]AUTOR\n

AUTORECALL|AUTOR is equal to AUTORECALL=YES.
\n NOAUTORECALL|NOAUTOR is equal to AUTORECALL=NO.

\n BLKSIZE|B|BLOCKSI=size\n

Specifies the maximum block size.

Default: none

\n BLOCKS|BL\n

Specifies that the space allocation unit is blocks. Equal to\n SPACE_UNIT=BLKS.

\n CONDDISP|CO=CATLG|UNCATLG|KEEP|DELETE\n

Specifies the disposition of the output file when a file transfer ends prematurely (the\n client or server are alive but disconnected from the other end; for example, when pressing\n CTRL+C in the client).

\"[Note]\"Note

If the client (when transferring to local or client side) or the server (when\n transferring to remote or server side) dies, they will have no control over the\n disposition.

The options have the following effects, depending on the file type (MVS or HFS):

  • CATLG: an MVS data set is retained and its name is cataloged. An\n HFS file is retained.

  • UNCATLG: the name of an MVS data set is removed from the catalog\n but the data set is retained. An HFS file is retained.

  • KEEP: an MVS data set is retained (if cataloged it will be still\n cataloged, if uncataloged it will be still uncataloged). An HFS file is retained.\n

  • DELETE: the name of an MVS data set is removed from the catalog and\n the space allocated for the data set is released. An HFS file is deleted.

Default: CATLG

\n CYLINDERS|CY\n

Specifies that the space allocation unit is cylinders. Equal to\n SPACE_UNIT=CYLS.

\n DATACLAS|DA=class\n

Specifies the data class of a data set.

Default: none

\n DATASET_SEQUENCE_NUMBER|SEQNUM=number\n

Identifies the relative position of a data set on a tape volume.

Default: System default

\n DEFER|DE=YES|NO\n

Specifies whether data set allocation is postponed from allocation phase to when the\n data set is opened.

If set to YES data set allocation is postponed until data set is\n opened.

If set to NO data set is allocated in allocation phase.

Default: NO

\n [NO]DEFER|DE\n

DEFER|DE is equal to DEFER=YES.
\n NODEFER is equal to DEFER=NO.

\n DIRECTORY_SIZE|M|DI|DIRSZ=size\n

Specifies the number of 256-byte records in the directory.

Default: 10

\n EXPIRY_DATE|EXPDT=yyddd|yyyyddd\n

Specifies the expiration date for a new data set. On and after this date, the operating\n system can delete or write over the data set.

Default: System default

\n FILE_STATUS|STATUS=NEW|MOD|SHR|OLD\n

Defines the status of a data set. If entered, the value will be used when allocating the\n data set. This attribute corresponds to the first value in the DISP\n parameter of the JCL DD statement. Possible values are:

  • NEW: Create a data set.

  • MOD: Append to an existing data set. If the data set does not\n exist, a new data set is created.

  • SHR: Create a read-only data set.

  • OLD: Designate an existing data set.

\n FILETYPE|FILET=SEQ|JES\n

Specifies whether to interface with the file system or with the z/OS Job Entry Subsystem\n (JES).

Using FILETYPE=JES enables the commands put and\n sput to submit transferred files to the internal reader job queue for\n execution, and get and sget\n commands to retrieve spool data sets. To terminate interfacing with JES and return to normal file access, set the\n file type back to sequential (SEQ), or to an empty string (that is,\n FILETYPE=). Entering an empty string as file type sets the file type to\n default.

Default: SEQ

\n FIXRECFM|FI=length\n

The data set organization is set to FB and the fixed record length is\n set to length.

Default: none

\n JOB_ID|JESID=ID\n

When in FILETYPE=JES mode, JOB_ID specifies that commands\n accessing the JES spool, such as get, apply only to jobs with a job ID\n that matches the supplied ID.

Commands get, sget, and so on, with a job ID\n can be used to retrieve the spool files for a given job.

\n JOB_OWNER|JESO=name\n

When in FILETYPE=JES mode, JOB_OWNER specifies that\n commands accessing the JES spool, such as ls, and get,\n and so on, apply only to jobs with owner matching the supplied\n name.

Default: Current user

\n JOBNAME|JESJOB=name\n

When in FILETYPE=JES mode, JOBNAME specifies that\n commands accessing the JES spool, such as ls, get, and\n so on, apply only to jobs with job name matching the supplied\n name.

\n KEYLEN|KEYL=length\n

Specifies the length in bytes of the keys used in the data set.

Default: none

\n KEYOFF|KEYO=offset\n

Specifies the key offset; the position of the first byte of the key in records of the\n specified VSAM data set.

Default: none

\n LABEL_TYPE|LABEL=NL|SL|NSL|SUL|BLP|LTM|AL|AUL\n

The type of the label for the data set. This attribute corresponds to the first value in\n the LABEL parameter of the JCL DD statement.

\"[Note]\"Note

It is recommended for sites to control the use of BLP and\n NL tape processing by restricting access to the appropriate resource,\n using RACF or an equivalent security product.

\n LIKE=like\n

Specifies the name of a model data set from which the RECFM,\n BLKSIZE, and LRECL attributes are to be copied. The name\n must be the full DSN of a cataloged data set and must be preceded with three\n underscores.

You must include the TYPE attribute when using LIKE\n unless you are creating a PS data set and the model is a PS data set.

Default: none

\n LRECL|R|LR=length\n

Maximum record length or fixed record length.

Default: 4096 for VSAM, 80 if data set organization is\n F or FB, otherwise 1024\n

\n MGMTCLAS|MG=class\n

Specifies the management class of a data set.

Default: none

\n NORMDISP|NOR=CATLG|UNCATLG|KEEP|DELETE\n

Specifies the data set disposition to be used after a file transfer that ends normally.\n This attribute corresponds to the second value in the DISP parameter of the\n JCL DD statement.

Default: CATLG

\n PRIMARY_SPACE|PRI=space\n

Primary space allocation for a data set.

Default: none

\n PROFILE|P|PROF=profile\n

The file transfer profile specifies the named profile used for the file transfer. The\n profile name is case-sensitive. With special profile name P=% no profiles\n are used. This also prevents profile matching based on file name.

Default: none

\n RECFM|O|REC=recfm\n

RECFM specifies the data set organization. The possible\n values are all valid combinations of the following letters:

    F       Fixed\n    V       Variable\n    U       Undefined\n    B       Blocked\n    S       Spanned or standard\n    M       Machine line printer codes\n    A       ASA line printer codes\n

Default: VB

\n RECORD_TRUNCATE|U|TRUN=YES|NO\n

When a record truncation occurs while writing an MVS data set, the system will continue\n writing the data set if RECORD_TRUNCATE is set to YES; and\n the system will abort the transfer if RECORD_TRUNCATE is set to\n NO or omitted.

Record truncation will occur if the length of a transferred record (after code set and\n line delimiter conversion) is larger than the maximum record length of the data set.\n Truncation can occur only when TRANSFER_FORMAT is set to\n LINE or RECORD. Note that the STREAM\n format does not have any concept of records in transferred data and it will fill out all\n records to their maximum length.

In the LINE transfer format, the length of a transferred record is the\n number of characters up to a newline character.

In the RECORD format, the length of a transferred record is given by\n the 4 byte binary length field which precedes the record.

The maximum length of a data set record depends on the data set organization:

  F and FB - LRECL\n  V and VB - LRECL-4\n  U        - BLKSIZE\n  VSAM     - MAXRECLEN\n

When Tectia Client aborts writing a data set because of record truncation, it will\n complete the write operation during which the system observed the truncation. It will write\n to disk one or more records, at least one of which is truncated. The data set is left on the\n system.

Tectia Client may write a large amount of data in one write operation, typically 32kB.\n Several records may be written in the last operation, some of them truncated. Small files\n may be written to the end of the file, and thus the resulting data set will be equivalent to\n one written with setting RECORD_TRUNCATE=YES.

Note that some file transfer client programs do not always show the error or warning\n messages from the server. Using the verbose mode (--verbose,\n -v) may show more messages from the server.

\"[Note]\"Note

When Tectia Client writes a data set with RECORD_TRUNCATE=YES, data\n loss may occur.

\n [NO]TRUNCATE|[NO]TRU|[NO]TRUN\n

TRUNCATE|TRU|TRUN is equal to RECORD_TRUNCATE=YES.
\n [NO]TRUNCATE|[NO]TRU|[NO]TRUN is equal to\n RECORD_TRUNCATE=NO.

\n RETENTION_PERIOD|RET=days\n

The retention period in days. After the retention period, the data set expires and the\n operating system can delete or overwrite the data set.

Default: System default

\n SECONDARY_SPACE|SE|SEC=space\n

Secondary space allocation for a data set.

Default: none

\n SIZE|L=size\n

Size estimate (in bytes) for data set allocation.

Default: 1000000

\n SPACE_RELEASE|RLSE=YES|NO\n

When a new data set it allocated, SPACE_RELEASE specifies whether\n unused disk space will be released. If set to YES, unused disk space of a\n new data set is released. If set to NO, allocated disk space of a new data\n set is retained.

Default: YES

\n SPACE_UNIT|SU=BLKS|TRKS|CYLS|AVGRECLEN\n

Unit of space allocation for a data set.

Possible values for the space allocation unit are:

  • BLKS: Blocks

  • CYLS: Cylinders

  • TRKS: Tracks

  • AVGRECLEN: Average record length

Default: none

\n SPACE_UNIT_LENGTH|SUL=length\n

When SPACE_UNIT=BLKS or SPACE_UNIT=AVGRECLEN,\n specifies the size of the space allocation unit.

Default: 100 with SPACE_UNIT=AVGRECLEN, none with\n SPACE_UNIT=BLKS

\n STAGING|S|STAGE=YES|NO\n

Specifies whether staging is to be used in the SFTP server when accessing a file or data\n set.

If set to NO, staging is not used.

If set to YES, staging is used, when needed.

Default: NO

\"[Note]\"Note

When staging is used, do not set the _CEE_RUNOPTS environment\n variable's TRAP option to OFF. If you do,\n sftpg3 fails to start. The TRAP option is\n ON by default.

\n STORCLAS|ST=class\n

Specifies the storage class of system managed storage.

Default: none

\n SVC99_TEXT_UNITS|SVC99=string\n

Dynamic allocation arguments that override or are added to arguments from other file\n transfer attributes. \n

Default: none

\n TRACKS|TR\n

Specifies that the space allocation unit is tracks. Equal to\n SPACE_UNIT=TRKS.

\n TRAILING_BLANKS|TRAIL=YES|NO\n

Specifies whether to preserve trailing blanks in a transferred data set.

If set to YES, trailing blanks will be transferred. This can be used,\n for example, to preserve the structure of fixed format data sets when transferring to a\n Unix-type file system.

If set to NO, trailing blanks will be stripped.

Default: NO

\"[Note]\"Note

This option only applies to line-delimited target files\n (TRANSFER_FORMAT=LINE), not to target unit-record data sets.

\n [NO]TRAILINGBLANKS|[NO]TRAI|[NO]TRAIL\n

\n TRAILINGBLANKS|TRAI|TRAIL is equal to TRAILING_BLANKS=YES.
\n NOTRAILINGBLANKS|NOTRAI|NOTRAIL is equal to\n TRAILING_BLANKS=NO.

\n TRANSFER_CODESET|C|CODESET=codeset\n

During the transfer the data has the specified code set.\n codeset is the code set name that is known to the\n iconv function of the system performing the conversion. The available\n code sets can be listed by invoking the iconv command at a USS prompt\n with the -l option:

> iconv -l

Default: none

Example: A Windows SFTP client puts a\n file to a z/OS data set and gets a data set from z/OS

sftp> site C=ISO8859-1 D=IBM-1047 \"1\"\nsftp> sput file.txt //DATASET.TXT \"2\"\nsftp> sget //DATASET.TXT file.txt \"3\"

\"1\"

The z/OS server is told that the code set during transfer is ISO8859-1 and that\n the data set is stored on the server with the IBM-1047 code set.

\"2\"

The server converts the code set from ISO8859-1 to IBM-1047 upon receiving the\n data.

\"3\"

The server converts the code set from IBM-1047 to ISO8859-1 before sending the\n data.

\"[Note]\"Note

The line delimiter information is always given to the host that is capable of\n performing the conversion, in these cases the z/OS host.

\n TRANSFER_FILE_CODESET|D|FCODESET=codeset\n

The data in the data set has the specified code set. codeset\n is the code set name that is known to the iconv function of the system\n performing the conversion. The available code sets can be listed by invoking the\n iconv command at a USS prompt with the -l\n option:

> iconv -l

Default: none

\n TRANSFER_FILE_LINE_DELIMITER|J|FLDELIM=UNIX|MVS|MVS-FTP|DOS|MAC|NEL\n

The transfer file line delimiter specifies the newline convention used in the (source or\n destination) file. Possible values are:

  • UNIX: The line delimiter used in the file is LF\n (\\n, 0x0A).

  • MVS: The line delimiter used in the file is NL\n (\\n, 0x15). When writing to a data set, also\n the CR (\\r, 0x0D) code is considered as the End\n of Line.

  • MVS-FTP: When reading MVS data sets, each record in the data set is\n treated as a line. The transfer line delimiter is appended to the record. Any control\n characters in the record data are preserved.

    When reading data sets with printer control characters, the control characters are\n preserved in the output.

    If the code set conversion is specified either by\n TRANSFER_TRANSLATE_TABLE|E, or by TRANSFER_CODESET|C\n and TRANSFER_FILE_CODESET|D, the appended delimiter is the delimiter\n specified by TRANSFER_LINE_DELIMITER|I,\n TRANSFER_CODESET|C, or TRANSFER_TRANSLATE_TABLE|E.\n If no code set conversion is requested, the delimiter is defined by the code set of the\n data set. By default it is EBCDIC.

    You can specify code sets by defining TRANSFER_FILE_CODESET without\n TRANSFER_CODESET. For example, to have a DOS delimiter in Unicode\n (x'000D000A') appended to the records, set\n \"I=DOS,J=MVS-FTP,D=UCS-2\", and to have a Unix delimiter in ISO Latin\n 1 (x'0A'), set \"I=UNIX,J=MVS-FTP,D=ISO8859-1\".

    Do not use this when writing data sets.

  • DOS: The line delimiter used in the file is CRLF\n (\\r\\n, 0x0D 0x0A).

  • MAC: The line delimiter used in the file is CR\n (\\r, 0x0D).

  • NEL: The line delimiter used in the file is Unicode New Line\n (0x85).

Default: none

\"[Note]\"Note

The line delimiter information should be given to the host that is capable of\n performing the conversion, such as a host with a Tectia.

Line delimiter conversion is implemented for single byte code sets only.

For the line delimiter conversion to happen, both\n TRANSFER_LINE_DELIMITER|I and\n TRANSFER_FILE_LINE_DELIMITER|J must be specified.

Example: a z/OS Tectia SFTP client sends a data set to a Windows host\n and copies the file back from Windows

In this example, the code set is also converted.

sftp> lsite I=dos J=mvs                \"1\"\nsftp> lsite C=IBM-437 D=IBM-1047       \"2\"\nsftp> sput //DATASET.TXT file.txt      \"3\"\nsftp> sget file.txt //DATASET.COPY.TXT \"4\"

\"1\"

Transfer line delimiter is set to DOS and transfer file line\n delimiter to MVS.

\"2\"

Transfer code set is set to IBM-437 and transfer file code set to IBM-1047.

\"3\"

The z/OS client inserts a NL (0x15) character after each record.\n The line delimiter conversion converts all NL:s to CRLF (0x0D 0x0A)\n characters, which remain unchanged in the code set conversion.

\"4\"

The CRLF line delimiters are converted to LF characters, which are converted to NL\n characters in the code set conversion. Each NL character (and CR character, if there\n are any in the data) causes the current record to be written out and a new record\n started.

\n TRANSFER_FORMAT|F|FORMAT=LINE|STREAM|RECORD\n

The byte stream consists of the bytes that are transferred as payload in the SFTP\n protocol packets. The byte stream has one of the following formats: LINE,\n STREAM or RECORD. All three formats may have data\n consisting of text, non-text data, or a mixture of these.

When writing an MVS data set, a record that is longer than the maximum or fixed record\n length will cause an error unless RECORD_TRUNCATE is set to\n YES, in which case the record will be truncated. When writing to data\n sets with fixed record lengths, short records will be filled with binary zeroes if you use\n the record transfer format and with blanks if you use the line transfer format.

  • LINE: The line transfer format is record-based. It uses delimiter\n characters to mark the end of a record. The delimiter character may be a Carriage Return\n (CR) or a Newline (NL). When writing to or reading from data sets with ASA control\n characters, a Form Feed (FF) is also treated as a delimiter. The table below shows the\n values of these characters in EBCDIC and ASCII. Data sent to Tectia Client in the line\n transfer format must be in EBCDIC or must be converted to EBCDIC during the\n transfer.

    Delimiter          EBCDIC                    ASCII\n                   Name  Dec   Oct   Hex     Name  Dec   Oct   Hex\n\\r Carriage Return CR    13    015   0x0D    CR    13    015   0x0D\n\\n Newline         NL    21    025   0x15    LF    10    012   0x0A\n\\f Form Feed       FF    12    014   0x0C    FF    12    014   0x0C

    Note that ASCII does not have a NL character, instead Line Feed (LF) is used to\n delimit lines.

    Avoid conversions that transform an ASCII Line Feed\n (LF/10/012/0x0A) into an EBCDIC Line Feed\n (LF/37/045/0x25) or an EBCDIC Newline\n (NL/21/025/0x15) into an ASCII Next Line\n (NEL/133/0205/0x85).

    Be aware that sending a double delimiter, e.g. \\r\\n or\n \\n\\r, to Tectia Client will result in two records. The\n TRANSFER_LINE_DELIMITER and\n TRANSFER_FILE_LINE_DELIMITER attributes can be used to cause the\n Tectia Client server or client program to convert between the line delimiter\n conventions.

    Tectia Client sends \\n as the Server Newline Convention in the\n server initialization SFTP protocol message.

    When transferring line format data to and from MVS files with ASA line printer\n control characters, Tectia Client will convert between the control characters and line\n delimiter characters, as described in the IBM z/OS \n XL C/C++ Programming Guide, \n Chapter \"Using ASA Text Files\".

    To transfer records without changing the ASA code, use the STREAM\n or RECORD transfer format, or define the data set using a DD card and\n specify RECFM=FB or RECFM=VB.

    Data sets transferred in the line transfer format and recreated on a mainframe will\n not necessarily be identical.

  • STREAM: The stream transfer format contains the data bytes of the\n data set but no structural information. If a data set with a fixed record length is\n transferred with the stream format and recreated with the same record length, the record\n structure will be preserved. Variable length records will not be recreated properly if\n transferred with the stream format.

  • RECORD: The record transfer format is record-based. Each record is\n preceded by a length field consisting of a 4- byte big-endian binary integer, which\n indicates the number of data bytes in the record. Note that the format is not the same\n as the record descriptor word in data sets with RECFM=V or\n RECFM=VB.

    A data set that is transferred with the record transfer format can be recreated as\n any data set type.

Default: LINE.

\n TRANSFER_LINE_DELIMITER|I|LDELIM=UNIX|MVS|MVS-FTP|DOS|MAC|NEL\n

The transfer line delimiter specifies the newline convention used in the data that is\n transferred over the connection. Possible values are:

  • UNIX: The line delimiter on the connection is LF\n (\\n, 0x0A).

  • MVS: The line delimiter on the connection is NL\n (\\n, 0x15). If the data is converted from\n EBCDIC to ASCII, the NL becomes a LF (\\n,\n 0x0A).

  • MVS-FTP: When writing to a data set, only the LF\n (\\n, 0x0A) control codes are considered as an\n End Of Line. Any CR (\\r, 0x0D) codes are\n preserved as data in the record.

    When writing data sets with ASA printer control characters, the first character on\n each line is used as the ASA character.

    Do not use this when reading data sets.

  • DOS: The line delimiter on the connection is CRLF\n (\\r\\n, 0x0D 0x0A).

  • MAC: The line delimiter on the connection is CR\n (\\r, 0x0D).

  • NEL: The line delimiter used in the file is Unicode New Line\n (0x85).

Default: none

\"[Note]\"Note

The line delimiter information should be given to the host that is capable of\n performing the conversion, such as a host with a Tectia.

\n TRANSFER_MODE|X|MODE=BIN|TEXT\n

The transfer mode specifies whether code set and line delimiter conversions are\n performed. The available values are:

  • BIN: Code set and line delimiter conversions are not\n performed.

  • TEXT: Code set and line delimiter conversions are performed.

Default: none

\"[Note]\"Note

If TRANSFER_MODE is not given but both\n TRANSFER_CODESET and TRANSFER_FILE_CODESET or\n TRANSFER_TRANSLATE_TABLE are present conversions are performed.

\n TRANSFER_TRANSLATE_DSN_TEMPLATES|A|XDSNT=templates\n

templates specifies the search templates for the translate\n table. Write '%T' to show the point where the translate table name (see above)\n is to be inserted. Delimit the templates with a plus character. The data set name templates\n must not contain slashes, instead they must be preceded by two or three underscores. \n \n

The first translate table data set that is found is used to perform the code\n conversion.

\"[Note]\"Note

The translate table must translate line delimiters into EBCDIC NL characters. \n See TRANSFER_FORMAT.

Default: none

\n TRANSFER_TRANSLATE_TABLE|E|XTBL=table\n

TABLE is the name of the table that specifies the code set\n conversion. If set, this attribute overrides the transfer code set and file code set\n attributes. The table is always applied in the normal direction, that is, the first\n character array is used for incoming (from the line to the data set) data and the second\n array for outgoing data. If the opposite translation is needed, e.g. the data set contains\n ASCII and should be transferred as EBCDIC, you (or your system programmer) can prepare a\n table data set with the character arrays in reversed order (e.g. with the system utility\n CONVXLAT or by editing an existing translate data set).

\n TYPE|T=PS|PO|PDS|POE|PDSE|GDG|HFS|VSAM|ESDS|KSDS|RRN\n

Specifies the type of a data set when the data set is created. The available values\n are:

  • PS: The type of the created data set is PS.

  • PO|PDS: The type of the created data set should be PDS. Note that\n in order to create a PDS, you need to specify the \n DIRECTORY_SIZE parameter. \n If you do not specify the directory size, a sequential data set - not a partitioned data \n set - is created.

  • POE|PDSE: The type of the created data set is PDSE.

  • GDG: The type of the created data set is GDG.

  • HFS: The type of the created data set is HFS.

  • VSAM: The type of the created data set is VSAM.

  • ESDS: The type of the created data set is VSAM ESDS.

  • KSDS: The type of the created data set is VSAM KSDS.

  • RRN: The type of the created data set is VSAM RRN.

Default: PO, if data set name includes member, otherwise\n PS

\n UNIT|UN=unit\n

The name of the device or group of devices that the data set will reside on (or does\n reside on, if it already exists). The maximum length of unit is 8\n characters. If the value exceeds the maximum length, it is truncated to 8 characters.

It is also possible to specify a device address. Precede a four digit address with an\n underscore.

Default: none

\n UNIT_COUNT|UC|UNC=number\n

Specifies the number of devices for the data set. This attribute corresponds to the\n second value in the UNIT parameter of the JCL DD statement.

Default: System default

\n UNIT_PARALLEL|UNP=YES|NO\n

Asks the system to mount all the volumes for the data set in parallel. This attribute\n corresponds to the character 'P' in the second value in the\n UNIT parameter of the JCL DD statement.

Default: System default

\n VOLUME_COUNT|VC|VOLCNT=number\n

Specifies the maximum number of volumes that an output data set requires. This attribute\n corresponds to the volume count value in the VOLUME parameter of the\n JCL DD statement.

Default: System default

\n VOLUMES|VO|VOL=vol1+vol2+...\n

A plus sign (+) separated list of volumes a data set will reside on (or does reside on,\n if it already exists).

Default: none

\"Home\" \"Prev\" \"Up\" \"Next\"  

\n Copyright 2020 SSH Communications Security Corporation
\n This software is protected by international copyright laws. All rights reserved.
Contact Information

","head":"Site Command","url":"/manuals/client-user/64/sftp-site.html"}}}