SCP2(1) SSH2 SCP2(1)
NAME
scp2 - secure copy client on z/OS
SYNOPSIS
scp2 [-D debug_level_spec] [-d ] [-p ] [-u ] [--verbose ]
[-v ] [--help ] [-h ] [-c cipher ] [-S ssh2-path]
[-P ssh2-port] [-t ] [-f ] [-1 ] [-4 ] [-6 ] [-r ] [-B ]
[-b buffer_size] [-N max_requests] [-a[arg]] [-q ] [-Q ]
[--statistics [yes|no|simple]] [--interactive ] [-I ]
[--overwrite ] [--whole-file ] [-W ] [--checksum ] [--ver-
sion ] [-V ] [--force-lower-case ] [-o ssh2-options]
[-i file] [[user@]host[#port]:]file ...
[[user@]host[#port]:]file_or_dir
DESCRIPTION
scp2 (Secure Copy) is used to copy files securely over the
network. It uses ssh2 for data transfer and authentica-
tion, and provides the same level of security as ssh2.
Unlike rcp, scp2 will ask for passwords or passphrases if
they are needed for authentication. You can also use your
public key for authentication. See ssh-agent2(1) and ssh-
add2(1).
Any filename may contain a host, user, and port specifica-
tion to indicate that the file is to be copied to/from
that host. Copies between two remote hosts are permitted.
The host parameter can optionally be enclosed in square
brackets ([]) to allow the use of semicolons (for example
IPv6 addresses). file can contain globbing patterns (type
zsh_fileglob). All special characters can be escaped to
include them in file, but this means that if you want to
use escapes so that they will be used in the glob pattern
(to escape special characters), you have to escape them
with '\\'. Read more about zsh_fileglob from sshregex(1).
OPTIONS
-D debug_level_spec
Prints extensive debug information to stderr.
debug_level_spec is a number between 0 and 99,
where 99 specifies that all debug information
should be displayed.
-d Forces the destination to be a directory. If it is
not, scp2 will exit with an error message.
-p Preserves file attributes and timestamps.
-u Removes source files after copying. This makes
scp2 work more like mv than cp.
SSH2 14 August 2007 1
SCP2(1) SSH2 SCP2(1)
-v,--verbose
Verbose mode. Equivalent to the -D 2 option.
-h,--help
Displays a short help.
-c cipher
Selects the encryption algorithm that ssh2 will
use. Multiple -c options are allowed. A single -c
flag can have only one cipher.
-S ssh2-path
Specifies the path to ssh2 used in connecting.
-o ssh2-options
Specifies options to give to ssh2. Use as with
ssh2, see ssh2(1).
-i file
Specifies the identification file to give to ssh2.
-P ssh2-port
Specifies the remote port to ssh2. Ports can also
be defined on a file-to-file basis. See SYNOPSIS.
-t or -f
Compatibility mode. Invokes scp1 with the given
command line to handle the connection. scp1 must
be in the path.
-1 Invokes scp1 with the rest of the given command
line.
This argument must be the first on the command line
and separate from all other one-character argu-
ments. It must not be used when -t or -f are used.
-4 Instructs ssh2 to use IPv4.
-6 Instructs ssh2 to use IPv6.
-r Copies directories recursively. Does not follow
symbolic links.
-B Invokes ssh2 in batch mode.
-b buffer_size
Defines the maximum buffer size for one request
(default 32768 bytes).
-N max_requests
Defines the maximum number of concurrent requests
SSH2 14 August 2007 2
SCP2(1) SSH2 SCP2(1)
(default 10).
-a[arg]
Transfers files using ASCII mode, i.e. newlines
will be converted on the fly. See command ascii in
sftp2(1). If the server does not advertise the
newline convention, you can give it a hint by giv-
ing the argument -a. The default is to set the des-
tination newline convention, but you can specify
either one by prefixing the argument with src: or
dest: for source or destination convention, respec-
tively. Advanced example: scp -asrc:unix -adest:dos
src_host:src_file dest_host:dest_file.
-q Quiet mode (only fatal errors are reported).
-Q Hides the progress indicator.
-V,--version
Displays version.
-I,--interactive
Prompts whether to overwrite an existing destina-
tion file (does not work with -B (batch mode)).
--overwrite
Specifies whether to overwrite existing destination
file(s). Default is yes. Takes an optional argu-
ment, with which you can disable overwriting.
-W,--whole-file
Specifies that incremental hashing is not used.
Default is to use hashing to determine whether a
data block is identical before transferring it.
Takes an an optional argument (-Wno,--whole-
file=no), which enables incremental hashing if it
was disabled.
--checksum
If the file size of source and destination files is
identical, determines whether the files are identi-
cal with an MD5 checksum. This is the default. You
can disable this feature with an optional argument
(--checksum=no). Note that file times, permissions
etc. are still updated if needed (or asked for),
even if actual file transfer does not take place.
--statistics [yes|no|simple]
Takes a mandatory argument with which you can
choose the statistics style. The default is yes for
full-blown statistics that fit the screen width.
Other possibilities are no for disabling statistics
(analogous to the -Q option), and simple which is
the default reporting style when there is no tty
SSH2 14 August 2007 3
SCP2(1) SSH2 SCP2(1)
(e.g. in cron jobs).
--force-lower-case
Causes upper case ASCII characters in the source
filename to be converted into lower case characters
in the destination filename. Takes an optional
yes/no argument, i.e. (--force-lower-case=no). The
default is no.
EXIT VALUES
scp2 returns the following values based on the success of
the operation:
0 Operation was successful.
1 Operation resulted in an undetermined error within
sshfilecopy.
2 Destination is not a directory, but a directory was
specified by the user.
3 Maximum symlink level exceeded.
4 Connecting to the host failed.
5 Connection lost.
6 File does not exist.
7 No permission to access file.
8 Undetermined error from sshfilexfer.
9 File transfer protocol mismatch.
Note that when the command is run from JCL using BPXBATCH,
the exit values are multiplied by 256.
ENVIRONMENT
scp2 uses the following environment variables:
SSH_SFTP_OVERWRITE
If this variable is set to yes, the default behav-
ior is to overwrite existing files. If set to no,
the default behavior is not to overwrite existing
files.
SSH_SFTP_SHOW_BYTE_COUNT
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.
SSH_SFTP_SMF_TYPE
If this variable is set to TYPE119, file transfers
create SMF records of type 119.
SSH_SFTP_ADVISOR_xxx
This is a number of variables where the xxx is one
of the file transfer attributes (see the SSH Tectia
Server for IBM z/OS Administrator Manual, chapter
SSH2 14 August 2007 4
SCP2(1) SSH2 SCP2(1)
"Advice String"). The variables apply to processing
local files and they set default values that can be
overridden on an Advice String.
FILES
In addition to the files used by ssh2, scp2 uses the fol-
lowing file:
$HOME/.ssh2/ssh_ftadv_config
Contains a list of file transfer profiles, which
furnish file transfer attributes to be used when
processing local files. See the SSH Tectia Server
for IBM z/OS Administrator Manual, chapter "File
Transfer Profiles".
EXAMPLES
Copy files from your local system to a remote Unix system:
$ scp2 localfile user@remotehost:/dst/dir/
Copy files from your local system to a remote Windows sys-
tem:
$ scp2 localfile user@remotehost:/C:/dst/dir/
Copy files from a remote system to your local disk:
$ scp2 user@remotehost:/src/dir/srcfile /dst/dir/dstfile
INSTALLATION
scp2 uses ssh2 in network connections. Note that the sub-
system 'sftp-server' must be defined in the sshd2(8) con-
figuration file in the remote end for scp2 to work.
AUTHORS
SSH Communications Security Corp.
For more information, see http://www.ssh.com.
SEE ALSO
ssh2(1), sshd2(8), ssh-keygen2(1), ssh-agent2(1), ssh-
add2(1), sftp2(1) rlogin(1), rsh(1), telnet(1)
SSH2 14 August 2007 5