Defines that all connection-related DNS resolutions will be resolved as an IPv4 address.

Defines that all connection-related DNS resolutions will be resolved as an IPv6 address.

Transfers files using the ASCII mode, that is, newlines will be converted on the fly. For transfers between Tectia on z/OS and other hosts, this also enables automatic ASCII-EBCDIC conversions. See the sftpg3 ascii command in the section called “Commands”.

If the server does not advertise the newline convention, and you are not using a host profile that specifies its host type, you can give scpg3 a hint by giving an argument after -a. The default is to set the destination newline convention, but you can specify either one by prefixing the argument with src: or dest: for source or destination convention, respectively. The available conventions are dos, unix, and mac, using \r\n, \n, and \r as newlines, respectively. Note that there is no space between the -a and its argument. An example is shown below:

$ scpg3 -asrc:unix -adest:dos src_host:src_file dest_host:dest_file

To force the newline conventions, use these values: force-dos, force-unix, and force-mac. These settings force the newline mode irrespective of what the remote SSH server suggests to the SCP client.

Uses batch mode. Fails authentication if it requires user interaction on the terminal.

Using batch mode requires that you have previously saved the server host key on the client and set up a non-interactive method for user authentication (for example, host-based authentication or public-key authentication without a passphrase).

Defines the maximum buffer size for one SFTP protocol read or write request (default: 32768 bytes).

The maximum number of SFTP protocol read or write requests sent in parallel within the transfer of a single file can be specified with the -N option.

Note that when streaming (see --streaming) is used (as it is by default when transferring files larger than buffer_size_bytes to/from Tectia Server), this option is not used for defining buffer sizes.

Disables compression from the current connection.

Enables zlib compression for this particular connection.

Sets the allowed ciphers in their preferred order offered to the server. List the cipher names in a comma-separated list. For example:

--ciphers AEAD_AES_128_GCM,seed-cbc@ssh.com,aes256-cbc

Value any allows all supported algorithms. Enter help as the value to view the currently supported cipher names.

Sets the debug level. LEVEL is a number from 0 to 99, where 99 specifies that all debug information should be displayed. This should be the first argument on the command line.

	Note
	Option -D only applies on Unix. On Windows, instead of this command-line tool, use the Connection Broker debugging options -D, -l.

	Note
	The debug level can be set only when the scpg3 command starts the Connection Broker. This option has no effect in the command if the Connection Broker is already running.

Forces target to be a directory.

Prompts whether to overwrite an existing destination file (does not work with -B).

Defines that private keys defined in the identification file are used for public-key authentication.

Defines that the given key file of a private key or certificate is used in user authentication. The path to the key file is given in the command.

If the file is a private key, it will be read and compared to the keys already known by the Connection Broker key store. If the key is not known, it will be decoded and added to the key store temporarily. If the file is a certificate and Connection Broker knows a matching private key, it will be used. Both the certificate and the private key can be given using multiple -K options on command line.

This option can be used only on Windows. Sets the default file and directory permission bits for file upload to Unix servers.

Defines the maximum number of SFTP protocol read or write requests sent in parallel (default: 10).

The size of the buffer used in each read or write request can be specified with the -b option.

Note that this value applies within the transfer of a single file; it cannot be used to define the number of files sent in parallel.

When streaming (see --streaming) is used (as it is by default when transferring files larger than buffer_size_bytes specified with the -b option to/from Tectia Server), this option is not used.

Sets offset. Offset r<offset> specifies the start offset in the source file. Offset w<offset> specifies the start offset in the destination file. Length l<length> specifies the amount of data to be copied. Truncate length t<length>, if given, specifies the length to which the destination file is truncated or expanded after the file data has been copied.

Preserves the file permissions and the timestamps when both the source and the destination are on Unix file systems (including z/OS USS). Preserves the timestamps but not the file permissions, if either one, the source or the destination is on Windows. If the destination is on z/OS MVS, none will be preserved.

Connects to this Secure Shell port on the remote machine (default: 22).

Does not show progress indicator. The effect of this option is the same as using --progress-display=no.

Do not use this option together with parameter --statistics.

Uses quiet mode (only fatal errors are shown). This option overrides the quiet-mode setting made in the Connection Broker configuration file.

Recurses subdirectories.

Removes source files after copying (file move).

Uses verbose mode (equal to -D 2).

Does not try incremental checks. By default (if this option is not given), incremental checks are tried. This option can only be used together with the --checksum option.

Defines the only allowed methods that can be used in user authentication. List the methods in a comma-separated list. For example:

--allowed-authentications keyboard-interactive,password

Enter help as the value to view the currently supported authentication methods.

Allow any supported cipher, mac, kex, hostkey and publickey algorithm to be used.

Appends data to the end of the destination file.

Uses binary transfer mode. If the server is Tectia Server for IBM z/OS, the server is requested not to perform ASCII to EBCDIC conversion, and the file is transferred using the Stream format. You can use the --src-site and --dst-site options to change the values.

Byte interval between checkpoint updates (default: 10 MB). This option can only be used when --checksum=checkpoint.

Time interval between checkpoint updates (default: 10 seconds). This option can only be used when --checksum=checkpoint.

Uses MD5, SHA-1 or SHA-2 checksums or a separate checkpoint database to determine the point in the file where file transfer can be resumed. Files smaller than buffer_size_bytes are not checked unless forced, i.e. sha1-force. (default: yes, uses SHA-1 checksums in FIPS mode, MD5 checksums otherwise). Use checkpointing when transferring large files one by one.

Sets the allowed compression methods to be offered to the server. List the methods in a comma-separated list.

Enter help as the value to view the currently supported compression methods.

Uses the specified site parameters with the destination files. See the sftpg3 site command in the section called “Commands”.

Defines that a new connection will be opened for each connection attempt, otherwise Connection Broker can reuse recently closed connections.

Performs the checksums using the FIPS cryptographic library.

Destination filename will be converted to lowercase characters.

Sets the allowed host key algorithms to be offered to the server. List the host key algorithms in a comma-separated list. For example:

--hostkey-algorithms ssh-dss-sha224@ssh.com,ssh-dss-sha256@ssh.com

Value any allows all supported algorithms. Enter help as the value to view the currently supported host key algorithms.

Selects whether to overwrite existing destination file(s) (default: yes).

Defines that the ID of the private key is used in user authentication. The ID can be Connection Broker-internal ordinary number of the key, the key hash or the key file name.

Defines the private key used in user authentication with the corresponding public key hash.

Defines that the Connection Broker-internal ordinary number of the key is used in user authentication.

Defines how often keep-alive messages (non-operation packages) are sent to the Secure Shell server. Enter the value as seconds. The default value is 0, meaning that keep-alive messages are disabled.

Sets the allowed key exchange (KEX) methods to be offered to the server. List the KEX names in a comma-separated list. For example:

--kexs diffie-hellman-group14-sha224@ssh.com,diffie-hellman-group14-sha256@ssh.com

Value any allows all supported algorithms. Enter help as the value to view the currently supported KEX methods.

Defines keyboard-interactive and password as the allowed methods for user authentication; the same as

--allowed-authentications keyboard-interactive,password

Sets the allowed MACs in preferred order to be offered to the server. List the MAC names in comma-separated list. For example:

--macs hmac-sha2-256,hmac-sha1-96,hmac-md5

Value any allows all supported algorithms. Enter help as the value to view the currently supported MAC names.

Sets user password that the client will send as a response to password authentication. The PASSWORD can be given directly as an argument to this option (not recommended). Better alternatives are entering a path to a file containing the password (--password=file://PASSWORDFILE), or entering a path to a program or script that outputs the password (--password=extprog://PROGRAM).

When using the extprog:// option to refer to a shell script, make sure the script also defines the user's shell, and outputs the actual password. Otherwise the executed program fails, because it does not know what shell to use for the shell script. For example, if the password string is defined in a file named my_password.txt, and you want to use the bash shell, include these lines in the script:

#!/usr/bash
cat /full/pathname/to/my_password.txt

Caution

Supplying the password on the command line is not a secure option. For example, in a multi-user environment, the password given directly on the command line is trivial to recover from the process table. You should set up a more secure way to authenticate. For non-interactive batch jobs, it is more secure to use public-key authentication without a passphrase, or host-based authentication. At a minimum, use a file or a program to supply the password.

Sets plugin path to PATH. This is only used in the FIPS mode.

Adds a prefix to a filename during the file transfer. The prefix is removed after the file has been successfully transferred.

On z/OS, when applied to MVS data set names, the prefix is inserted after the High Level Qualifier (HLQ). In case you want the prefix to be a separate qualifier, include a dot at the end of the prefix:

--prefix=PREFIX.

Allow only selected signature algorithms to be used in public key authentication. For example:

--publickey-algorithms=x509v3-ssh-rsa,rsa-sha2-512

Value any allows all supported algorithms. Enter help as the value to view the available signature algorithms.

Uses the specified site parameters with the source files. See the site command in the section called “Commands”.

	Note
	In release 6.1.5, the behavior of the --statistics option has changed and the --statistics-format option has been removed. Instead of them, use the new --summary-display and --summary-format options.

The --statistics option chooses the style of the statistics to be shown after a file transfer operation. Note that --statistics and --summary-display must not be used together.

The --statistics option takes the following values:

no - no statistics will be created.

yes - shows a progress bar during the file transfer. This is the default. An example of the output:

scpg3 --statistics="yes" sourcefile destinationfile
sourcefile                 |  127MB |  42.9MiB/s | TOC: 00:00:03 | 100%

simple - simple one-line statistics will be displayed after the file transfer has ended. For example:

scpg3 --statistics=simple sourcefile destinationfile
sourcefile   | 127MB | 151.3MiB/s | TOC: 00:00:00 | 100%

Chooses the style of the file transfer summary data to be displayed after a file transfer operation. With the summary display, the progress bar data is also displayed by default.

Note that --summary-display and --statistics must not be used together.

The --summary-display option takes the following values:

no - no summary data will be created. This is the default.

yes - detailed summary data will be created. You can configure the contents with the summary-format option. By default, the following contents are displayed in the summary:

Default settings:                    Render for example this:
"Source: %c:%g\n"                    user@host1#22:/path/to/source/file
"Source parameters: %e\n"            X=TEXT, C=ISO8859-1,D=IBM.1047
"Destination: %C:%G\n"               user@host2#22:/path/to/destination/file
"Destination parameters: %E\n"       NONE
"File size: %s bytes\n"              123456 bytes
"Transferred: %t bytes\n"            123456 bytes
"Rate: %RB/s\n"                      345kiB/s
"Start: %xy-%xt-%xd %xh:%xm:%xs\n"   2010-01-26 13:10:56
"Stop: %Xy-%Xt-%Xd %Xh:%Xm:%Xs\n"    2010-01-26 13:23:30
"Time: %y\n"                         00:12:34

simple - simple one-line summary will be displayed. For example:

scpg3 --summary-display=simple sourcefile destinationfile
sourcefile | 127MB | 151.3MiB/s | TOC: 00:00:00 | 100%

bytes - basic statistics reporting the transferred bytes will be displayed. For example:

scpg3 --summary-display=bytes sourcefile destinationfile
Transferred 12915145984 bytes, file: 'sourcefile' -> 'destinationfile'

Chooses the format and the contents of the summary. You can use this option when --summary-display=yes. Do not use this option with --statistics.

Select the contents for the summary using the following definitions:

%c  - source connection: user@host#port or profile
%C  - destination connection: user@host#port or profile
%D* - current date
%e  - source parameters (file transfer and data set parameters)
%E  - destination parameters (file transfer and data set parameters)
%f  - source file name
%F  - destination file name
%g  - /path/to/source/file
%G  - /path/to/destination/file
%k  - compression done ("zlib" or "none")
%p  - transfer percentage
%q  - transfer rate in bit/s
%Q  - transfer rate as "XXyb/s" (b/s, kib/s, Mib/s, Gib/s)
%r  - transfer rate in bytes/s
%R  - transfer rate as "XXyB/s" (B/s, kiB/s, MiB/s, GiB/s)
%s  - file size in bytes
%S  - file size as "XXyB" (B, kiB, MiB or GiB)
%t  - transfer size in bytes
%T  - transfer size as "XXyB" (B, kiB, MiB or GiB)
%x* - start date
%X* - end date
%y  - elapsed time
%Y  - time remaining
%z  - ETA or TOC, if transfer has finished
%Z  - string "ETA" or "TOC", if transfer has finished

Where * is one of the following:

h - hours (00-23)
m - minutes (00-59)
s - seconds (00-59)
f - milliseconds (0-999)
d - day of the month (1-31)
t - month (1-12)
y - year (1970-)

Other special characters in format strings are:

\n - line feed
\r - carriage return
\t - horizontal tab
\\ - backslash

Chooses the mode of displaying the progress during a file transfer operation. The default is bar, which shows a progress bar. Option line shows the progress information according to the settings made in the --progress-line-format option.

Do not use this option with --statistics.

Chooses what information will be shown on the progress line. You can use this option when --progress-display=line.

Do not use this option with --statistics.

Select the contents for the progress line using the definitions described for command: --summary-format

Defines how often the progress information is updated in line mode. The interval is given in seconds, and the default is 60 seconds.

Do not use this option with --statistics.

Uses streaming in file transfer, if server supports it. Files smaller than buffer_size_bytes are not transferred using streaming. Use force with small files. Default: yes

Use ext with z/OS hosts to enable direct MVS data set access. Use this option only when the file transfer is mainly used for mainframe data set transfers, as it can slow down the transfer of small files in other environments.

The --streaming=ext option requires also the --checksum=no option, because if checksums are calculated, the file transfer uses staging, which excludes streaming.

Stores files with unique names. In case more than one of the transferred files have the same name, this feature adds a sequential number to the end of the repeated file name, for example: file.name, file.name1, and file.name2.

Defines a timeout period (in seconds) for establishing a TCP connection to the Secure Shell server. Enter the timeout value as a positive number. Value 0 (zero) disables this feature and the default system TCP timeout will be used instead.

Use the specified profile when connecting.

Logs in using this user name if the user name is not provided in the address string.

Displays program version and exits.

Displays a short summary of command-line options and exits.

Defines the setting for comparing checksums. For more information on the available values, see checksum .

If this variable is set to yes, the number of transferred bytes is shown after successful file transfer. Also the names of source and destination files are shown. The default is no.

If this variable is set to yes (default), normal progress bar is shown while transferring the file. If it is set to no, progress bar is not shown. If it is set to simple file transfer statistics are shown after the file has been transferred.

If this variable is set to 0, the default charset mode UTF-8 is disabled. To force UTF-8 charset mode for file names, set the variable to 1.