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.

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

The -B - option enables reading from the standard input. This option is useful when you want to launch processes with sftpg3 and redirect the stdin pipes.

By defining the name of a batch_file as an attribute, you can execute SFTP commands from the given file in batch mode. The file can contain any allowed SFTP commands. For a description of the commands, see the section called “Commands”.

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).

Disables compression from the current connection.

Enables zlib compression for this particular connection.

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

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

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
	The debug level can be set only when the sftpg3 command starts the Connection Broker. This option has no effect in the command if the Connection Broker is already running.

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.

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

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

Suppresses the printing of error, warning, and informational messages. This option overrides the quiet-mode setting made in the Connection Broker configuration file.

Uses verbose mode (equal to -D 2).

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.

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.

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.

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

Enter help as the value to view the currently supported host key algorithms.

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 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

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 to be offered to the server. List the MAC names in a comma-separated list. For example:

--macs hmac-sha1-96,hmac-md5,hmac-md5-96

Enter help as the value to view the currently supported MAC names.

Sets the user password or passphrase that the client will send as a response to an authentication method requesting a password or passphrase (hereafter: password). This can be used also with password-protected certificates and public-keys.

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.

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

USERNAME will be used in the logon if the user name is not specified in the address string.

Displays program version and exits.

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

Invokes an interactive shell on the local machine. if a command is given, it is used as the command to be executed. Optional arguments can be given depending on the command.

Appends the specified local file to the remote file. No globbing can be used.

Options:

The semantics of options --statistics, --summary-display, --summary-format, --progress-display, --progress-line-format, and --progress-line-interval are the same as with get.

Command ascii sets the transfer mode to ASCII.

For transfers between Tectia on z/OS and other hosts, this also enables automatic ASCII-EBCDIC conversion. Default conversion is between code sets ISO8859-1 and IBM-1047. Files are transferred using the LINE format. The site and lsite commands can be used to change the values.

If you enter the ascii command with any options, it does not set the transfer mode to ASCII, but affects the newline conventions used in the transferred files. You can also set the server's newline convention by using a host profile that specifies the host type. For more information, see the host-type attribute in the section called “The profiles Element”.

Options:

File transfer mode will be selected automatically from the file extension.

Files will be transferred in binary mode.

Interrupts batch file execution. Batch file execution can be continued with the continue command.

Quits the application.

Changes the current remote working directory.

With Unix files, sets file permissions of the specified file or files to the bit pattern OCTAL-MODE or changes the file permissions according to the symbolic mode [ugoa][+-=][rwxs].

Options:

Closes the remote connection.

Continues interrupted batch file execution.

Disables or enables debug. With disable or no, debugging is disabled. Otherwise, sets debuglevel as debug level string, as per command-line option -D.

Tries to delete a file or directory specified in file. The options are the same as for rm.

Calculates MD5 or SHA-1 digest over file data. The digest is calculated over the data on the disk. If any code or line delimiter conversion attributes are in effect, they are ignored when calculating the digest.

Options:

Echo the text. This command can be used for example in batch mode to print text into batch logs.

Quits the application.

Transfers the specified files from the remote end to the local end. By default, directories are recursively copied with their contents, but this is configurable in the Connection Broker configuration with the SFTP compatibility mode setting (sftpg3-mode in ssh-broker-config.xml). To view the currently set SFTP compatibility mode, run command:

sftp> help get

The currently set compatibility mode is shown in the beginning of the help for command get.

The SFTP compatibility mode options are:

Options:

Displays the extensions that will be ASCII in the auto transfer mode.

The same as append, but appends the specified remote file to the local file.

Changes the current local working directory.

The same as chmod, but operates on local files.

Closes the local connection.

The same as delete, but operates on local files.

The same as digest, but operates on local files.

The same as ls, but operates on local files.

The same as lsroots, but operates on local files (when the local end has been opened to a VShell server).

The same as mkdir, but operates on local files.

The same as lopen.

Tries to connect the local end to the host hostname. If this is successful, lls and friends will operate on the file system on that host.

Options:

The same as site, but operates on local files and data sets.

Prints the name of the current local working directory.

The same as readlink, but operates on local files.

The same as rename, but operates on local files.

The same as rm, but operates on local files.

The same as rmdir, but operates on local files.

Lists the names of files on the remote server. For directories, contents are listed. If no arguments are given, the contents of the current working directory are listed.

Options:

The same as site, but operates on local files and data sets.

Dumps the virtual roots of the server. (This is a VShell extension. Without this you cannot know the file system structure of a VShell server.)

The same as symlink, but operates on local files.

Synonymous to get.

Tries to create the directory specified in directory.

Transfers the specified files from the local end to the remote end. Options and semantics are the same as for get. Synonymous to put.

Tries to connect the remote end to the host hostname.

Options:

Pauses batch file execution for seconds seconds, or if seconds is not given until ENTER is pressed.

Transfers the specified files from the local end to the remote end. Options and semantics are the same as for get.

Prints the name of the current remote working directory.

Quits the application.

Provided that path is a symbolic link, shows where the link is pointing to.

Tries to rename the oldfile to newfile. If newfile already exists, the files are left intact.

Tries to delete a file or directory specified in file.

Options:

Tries to delete the directory specified in directory. This command removes the directory only if it is empty and has no subdirectories.

Sets the default values for various parameters. The set command takes the following options:

Sets the file extensions that will be ASCII in the auto transfer mode. Normal zsh-fileglob regexps can be used in the file extensions.

Sets the default file or directory permission bits for upload. (Prefix fileperm with p to preserve permissions of existing files or directories.)

Transfers a single specified file from the remote end to the local end under the filename defined with dstfile. Directories are not copied. No wildcards can be used. Options are the same as for get.

Sets the file and data set parameters for the remote host. Parameters can be entered either one by one, or several parameters can be delimited by spaces or commas. Both long parameters and abbreviations can be used. When run without arguments, the site command outputs the list of entered parameters. Setting none resets all parameters.

The available parameters are:

For a detailed description of the parameters, see File Transfer Advice String / Site Command.

Transfers a single specified file from the local end to the remote end under the filename defined with dstfile. Directories are not copied. No wildcards can be used. Options are the same as for get.

Stores files with unique names. If no option is specified, the command toggles the state of 'sunique'.

In case more than one of the transferred data sets have the same name, this feature adds a sequential number to the end of the repeated data set name, for example: DS.version, DS.version1, and DS.version2.

Creates symbolic link linkpath, which will point to targetpath.

Sets file transfer type. If type is not specified, the current file transfer type is displayed.

Enables verbose mode (identical to the debug 2 command). You may later disable verbose mode by debug disable.

If topic is not given, lists the available topics. If topic is given, outputs available online help about the topic.

Outputs available online help about all topics.

Set mark.

Go to the beginning of the line.

Move the cursor one character to the left.

Erase the character to the right of the cursor, or exit the program if the command line is empty.

Go to the end of the line.

Move the cursor one character to the right.

Backspace.

Tab.

Enter.

Delete the rest of the line.

Redraw the line.

Enter.

Move to the next line.

Move to the previous line.

Toggle two characters.

Delete the line.

Delete a region (the region's other end is marked with Ctrl-Space).

Begin an extended command.

Yank deleted line.

Undo.

Lower case region.

Upper case region.

Exchange cursor and mark.

Mark the whole buffer.

Undo.

Backwards word delete.

Backwards word delete.

Delete extra spaces (leaves only one space).

Go to the beginning of the line.

Go to the end of the line.

Mark current word.

Go back one sentence.

Go back one word.

Capitalize current word.

Delete current word.

Go forward one sentence.

Go forward one word.

Delete current sentence.

Change current word to lower case.

Transpose words.

Change current word to upper case.

Backspace.

The get command can be used to transfer several files at the same time, but it is not possible to define target filenames. Note that if there are special characters in the filenames, you need to rename the files already on Unix so that the names are acceptable also on Windows.

The sget command is used to transfer one file at a time, and it allows you to define a new name for the destination file. Use it to make the name acceptable on Windows. The command sequence is as follows:

$ sftpg3

sftp> open user@server

sftp> sget "file*name.txt" windowsfilename.txt

If this variable is not set correctly sftpg3 fails to start.

This variable defines the permissions for newly created files, and this umask value will be used if the server configuration file does not have a umask defined for the sftpg3 subsystem.

This variable defines that ssh-broker-g3 and sftpg3 processes are run in separate address spaces.

This environment variable can be used to specify the format of the debug messages.

The default variable used is:

SSH_DEBUG_FMT="%Dd/%Dt/%Dy %Dh:%Dm:%Ds:%Df %m/%s:%n:%f %M"

It will produce an output similar to the following example:

debug: 21/08/2007 16:17:25:883 BrokerRun/broker_run.c:158: broker_start returning.

The format of the debug message is composed of flags that are percent signs (%) followed by one or more characters. If no % is used, the character will be literally printed to the debug message. The value of the flags will be shown only if the information is available.

The different flags that can be used are:

Defines the path to the sftpg3 startup batch file. The file is run and the sftpg3 commands defined in the file are executed each time sftpg3 is started.

If this variable is not defined, sftpg3 looks for a startup batch file named ssh_sftp_batch_file in the user-specific directory $HOME/.ssh2/ on Unix or %APPDATA%\SSH\ on Windows.

Note that if this variable is defined but the file is missing or cannot be accessed, sftpg3 fails to start.

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

If this variable is set to yes, the sftpg3 local directory is set to USER prefix in the MVS side. If it is set to no (default), local directory is the current directory.

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 TYPE119, file transfers create SMF records of type 119.

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.

This is the user-specific file that contains a list of file transfer profiles, which furnish file transfer attributes to be used when processing local files. For more information, see File Transfer Profiles.

This is the global (system-wide) file that contains a list of file transfer profiles, which furnish file transfer attributes to be used when processing local files. For more information, see File Transfer Profiles.