Dovetailed Technologies

Name

cozsftp — secure file transfer program for z/OS

Synopsis

cozsftp [-1246Cpqrv] [-B buffer_size] 
        [-b batchfile] [-c cipher]
        [-D sftp_server_path] [-F ssh_config] 
        [-i identity_file] [-k my-ring:my-cert] [-l limit]
        [-o ssh_option] [-P port] 
        [-R num_requests] [-S program]
        [-s subsystem | sftp_server] host
cozsftp [user@]host][:file ...]
cozsftp [user@]host][:dir[/]]
cozsftp -b batchfile [user@]host]
    

Description

cozsftp is an interactive file transfer program, similar to ftp(1), which performs all operations over an encrypted ssh(1) transport. It may also use many features of ssh, such as public key authentication and compression. sftp connects and logs into the specified host, then enters an interactive command mode.

The second usage format will retrieve files automatically if a non- interactive authentication method is used; otherwise it will do so after successful interactive authentication.

The third usage format allows sftp to start in a remote directory.

The final usage format allows for automated sessions using the -b option. In such cases, it is necessary to configure non-interactive authentication to obviate the need to enter a password at connection time (see sshd(8) and ssh-keygen(1) for details).

Since some usage formats use colon characters to delimit host names from path names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity.

z/OS specific notes:

  • cozsftp is a z/OS specific version of the OpenSSH sftp command

  • Includes support for z/OS artifacts such as data sets and JES spool access

  • Features and options that are different from the base sftp command are noted below with [z/OS ...]

Options

-1

Specify the use of protocol version 1.

-2

Specify the use of protocol version 2.

-4

Forces cozsftp to use IPv4 addresses only.

-6

Forces cozsftp to use IPv6 addresses only.

-B buffer_size

Specify the size of the buffer that cozsftp uses when transferring files. Larger buffers require fewer round trips at the cost of higher memory consumption. The default is 32768 bytes.

-b batchfile

Batch mode reads a series of commands from an input batchfile instead of stdin. Since it lacks user interaction it should be used in conjunction with non-interactive authentication. A batchfile of `-' may be used to indicate standard input. cozsftp will abort if any of the following commands fail: get, put, reget, rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp, lpwd, df, symlink, and lmkdir. Termination on error can be suppressed on a command by command basis by prefixing the command with a `-' character (for example, -rm /tmp/blah*).

-C

Enables compression (via ssh's -C flag).

-c cipher

Selects the cipher to use for encrypting the data transfers. This option is directly passed to ssh(1).

-D sftp_server_path

Connect directly to a local sftp server (rather than via ssh(1)). This option may be useful in debugging the client and server.

-F ssh_config

Specifies an alternative per-user configuration file for ssh(1). This option is directly passed to ssh(1).

-i identity_file

Selects the file from which the identity (private key) for public key authentication is read. This option is directly passed to ssh(1).

-k my-ring:my-cert

[z/OS only] Specifies a SAF/RACF certificate for SSH authentication. if :mycert is not specified, the default certificate label for the given key ring will be used.

-l limit

Limits the used bandwidth, specified in Kbit/s.

-o ssh_option

Can be used to pass options to ssh in the format used in ssh_config(5). This is useful for specifying options for which there is no separate sftp command-line flag. For example, to limit the number of password prompts allowed to one use: cozsftp -oNumberOfPasswordPrompts=1. For full details of the options allowed, and their possible values, see ssh_config(5).

-P port

Specifies the port to connect to on the remote host.

-p

[z/OS Unix files only] Preserves modification times, access times, and modes from the original files transferred.

-q

Quiet mode: disables the progress meter as well as warning and diagnostic messages from ssh(1).

-R num_requests

Specify how many requests may be outstanding at any one time. Increasing this may slightly improve file transfer speed but will increase memory usage. The default is 64 outstanding requests.

-r

[z/OS Unix files only] Recursively copy entire directories when uploading and downloading. Note that sftp does not follow symbolic links encountered in the tree traversal.

-S program

Name of the program to use for the encrypted connection. The program must understand ssh(1) options.

-s subsystem | sftp_server

Specifies the SSH2 subsystem or the path for an sftp server on the remote host. A path is useful for using sftp over protocol version 1, or when the remote sshd(8) does not have an sftp subsystem configured.

-v

Raise logging level. This option is also passed to ssh.

Interactive Commands

Once in interactive mode, cozsftp understands a set of commands similar to those of ftp(1). Commands are case insensitive. Pathnames that contain spaces must be enclosed in quotes. Any special characters contained within pathnames that are recognized by glob(3) must be escaped with backslashes (`\').

ascii

[z/OS added] Alias for: lzopts mode=text

append [-Pp] local-path [remote-path]

[z/OS added] Upload local-path and append it to the end of a remote file on the remote machine. If the remote path name is not specified, it is given the same name it has on the local machine. local-path may contain glob(3) characters and may match multiple files. If it does and remote-path is specified, then remote-path must specify a directory. The remote file is created if it does not exist.

[z/OS Unix files only] If either the -P or -p flag is specified, then full file permissions and access times are copied to the remote file.

[z/OS Note:] The append command is implemented by opening the remote file and then obtaining its current size as the initial offset for writing data. Some SFTP server products may not support this correctly. If the remote server is Co:Z SFTP, then the append command will be rejected if the current file transfer options (e.g. linerule, translation) allow the file size to be changed.

binary

[z/OS added] Alias for: lzopts mode=binary

bye

Quit cozsftp.

cd path

Change remote directory to path.

chgrp grp path

[z/OS Unix files only] Change group of file path to grp. path may contain glob(3) characters and may match multiple files. grp must be a numeric GID.

chown own path

[z/OS Unix files only] Change owner of file path to own. path may contain glob(3) characters and may match multiple files. own must be a numeric UID.

df [-hi] [path]

[z/OS Unix files only] Display usage information for the filesystem holding the current directory (or path if specified). If the -h flag is specified, the capacity information will be displayed using "human-readable" suffixes. The -i flag requests display of inode information in addition to capacity information. This command is only supported on servers that implement the ``statvfs@openssh.com'' extension.

exit

Quit cozsftp.

get [-aPpr] remote-path [local-path]

Retrieve the remote-path and store it on the local machine. If the local path name is not specified, it is given the same name it has on the remote machine. remote-path may contain glob(3) characters and may match multiple files. If it does and local-path is specified, then local-path must specify a directory.

If the -a flag is specified, then attempt to resume partial transfers of existing files. Note that resumption assumes that any partial copy of the local file matches the remote copy. If the remote file differs from the partial local copy then the resultant file is likely to be corrupt.

If either the -P or -p flag is specified, then full file permissions and access times are copied too.

If the -r flag is specified then directories will be copied recursively. Note that sftp does not follow symbolic links when performing recursive transfers.

[z/OS Unix files only] No flags are supported if either the local or remote file is a z/OS data set. The -a is also not supported for z/OS Unix files if the current file transfer options (e.g. linerule, translation) allow the file size to be changed

help

Display help text.

lcd path

Change local directory to path.

lls [ls-options [path]]

Display local directory listing of either path or current directory if path is not specified. ls-options may contain any flags supported by the local system's ls(1) command. path may contain glob(3) characters and may match multiple files.

[z/OS] lls -h and -S are not supported because the z/OS ls command does support these options. The -n option is displayed as -l for data sets rather than displaying a numerical listing.

lmkdir path

[z/OS Unix files only] Create local directory specified by path.

ln [-s] oldpath newpath

[z/OS Unix files only] Create a link from oldpath to newpath. If the -s flag is specified the created link is a symbolic link, otherwise it is a hard link.

lpwd

Print local working directory.

ls [-1afhlnrSt] [path]

Display a remote directory listing of either path or the current directory if path is not specified. path may contain glob(3) characters and may match multiple files.

The following flags are recognized and alter the behaviour of ls accordingly:

-1

Produce single columnar output.

-a

List files beginning with a dot (`.').

-f

Do not sort the listing. The default sort order is lexicographical.

-h

When used with a long format option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce the number of digits to four or fewer using powers of 2 for sizes (K=1024, M=1048576, etc.).

If the remote server is Co:Z SFTP, the numerical long form listing is displayed data sets when -h is used with either -l or -n

-l

Display additional details including permissions and ownership information.

If the remote server is Co:Z SFTP, for data sets this returns the following (unless the Co:Z unixls option is set): Volume, Referred, Ext, Tracks, Used, Recfm, Lrecl, BlkSz, Dsorg, Dsname.

-n

Produce a long listing with user and group information presented numerically.

If the remote server is Co:Z SFTP, for data sets this displays the estimated data set size when possible.

-r

Reverse the sort order of the listing.

-S

Sort the listing by file size.

-t

Sort the listing by last modification time.

lumask umask

Set local umask to umask.

lzopts [-a] [option=value,...]

[z/OS added] Set local (client) file transfer options. These options are set prior to initiating file/dataset transfers from z/OS to a remote host.

Multiple options can be set by separating the option=value pairs with commas. An error is returned if one or more of the options was incorrectly specified, but the remaining options are set as requested.

The active options and their settings can be displayed by issuing the lzopts command without arguments. The -a option can be specified to list all available options, even those that are not active.

For the set of Co:Z SFTP Options, see the Co:Z SFTP - User's Guide.

mkdir path

Create remote directory specified by path. If the remote server is Co:Z SFTP, the path may be a //data-set-name in which case Co:Z SFTP serve will create a PDS or PDSE if no data set with this name alread exists.

progress

Toggle display of progress meter.

put [-Ppr] local-path [remote-path]

Upload local-path and store it on the remote machine. If the remote path name is not specified, it is given the same name it has on the local machine. local-path may contain glob(3) characters and may match multiple files. If it does and remote-path is specified, then remote-path must specify a directory.

If either the -P or -p flag is specified, then full file permissions and access times are copied too.

If the -r flag is specified then directories will be copied recursively. Note that sftp does not follow symbolic links when performing recursive transfers.

[z/OS Unix files only] No flags are supported if either the local or remote file is a z/OS data set. The -a is also not supported for z/OS Unix files if the current file transfer options (e.g. linerule, translation) allow the file size to be changed

pwd

Display remote working directory.

quit

Quit cozsftp.

reget [-Ppr] remote-path [local-path]

[z/OS Unix files only] Resume download of remote-path. Equivalent to get with the -a flag set. Note: reget is not supported if the current file transfer options (e.g. linerule, translation) can cause the file size to be changed.

rename oldpath newpath

Rename remote file from oldpath to newpath.

rm path

Delete remote file specified by path.

rmdir path

[z/OS Unix files only] Remove remote directory specified by path.

symlink oldpath newpath

[z/OS Unix files only] Create a symbolic link from oldpath to newpath.

version

Display the sftp protocol version.

zopts [-a] [option=value,...]

[z/OS added] Set server file transfer options, if the server is a Co:Z SFTP server. These options are set prior to initiating file/dataset transfers from z/OS to a remote host.

The zopts command is functionally equivalent to the ls /+[option=value,...] command used by existing clients to set Co:Z sftp-server file transfer options.

Multiple options can be set by separating the option=value pairs with commas. An error is returned if one or more of the options was incorrectly specified, but the remaining options are set as requested.

The active options and their settings can be displayed by issuing the zopts command without arguments. The -a option can be specified to list all available options, even those that are not active.

For the set of Co:Z SFTP Options, see the Co:Z SFTP - User's Guide.

!command

Execute command in local shell.

!

Escape to local shell.

?

Synonym for help.

See Also

ftp(1), ls(1), scp(1), sftp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3), ssh_config(5), sftp-server(8), sshd(8).

T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- filexfer-00.txt, January 2001, work in progress material.

Copyright© 2009-2017 Dovetailed Technologies, LLC. All rights reserved.
Co:Z® is a registered trademark of Dovetailed Technologies, LLC.