SFTPPlus Client 1.2 User Manual - proatria.com Client 1.2 User... · 21.2 FTP PROTOCOL ERROR CODES...

Copyright: © Pro:Atria Limited 2005-2007. Neither the whole nor any part of this Document may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photo-

copying or otherwise, without the prior written permission of Pro:Atria Limited

Client v1.2

User Manual

The Old Exchange

South Cadbury Yeovil

Somerset

BA22 7ET UK

© Pro:Atria Limited 2005-2007 Page 2 of 101 SFTPPlus Client 1.2

User Manual, Doc. Ver. 22/02/07-94

Contents

1 LEGAL NOTICES .........................................................................................................................5

1.1 COPYRIGHT...............................................................................................................................5 1.2 TRADEMARKS............................................................................................................................5 1.3 LICENSE....................................................................................................................................5 1.4 STATUTORY REGULATION COMPLIANCE....................................................................................6

2 PREFACE .......................................................................................................................................7

3 INTRODUCTION ..........................................................................................................................9

4 DOCUMENT CONVENTIONS..................................................................................................10

5 INSTALLING SFTPPLUS CLIENT..........................................................................................11

6 CONFIGURING SFTPPLUS CLIENT......................................................................................12

6.1 GLOBAL CONFIGURATION........................................................................................................12

7 PROTOCOLS...............................................................................................................................14

7.1 TRANSFER PROTOCOLS............................................................................................................14 7.1.1 SFTP...............................................................................................................................14 7.1.2 FTP.................................................................................................................................14 7.1.3 FTPS...............................................................................................................................15 7.1.4 SCP.................................................................................................................................15 7.1.5 HTTP ..............................................................................................................................15 7.1.6 HTTPS ............................................................................................................................16

7.2 PROTOCOL PORTS....................................................................................................................16

8 PUTTY - CREATING CONNECTION FILES.........................................................................17

8.1 PUTTY INTRODUCTION (WINDOWS ONLY) .............................................................................17 8.2 STARTING A SESSION...............................................................................................................17 8.3 VERIFYING THE HOST KEY (SSH ONLY)...................................................................................18 8.4 LOGGING IN.............................................................................................................................19 8.5 AFTER LOGGING IN..................................................................................................................19 8.6 LOGGING OUT..........................................................................................................................20

9 SETTING UP TRANSFER CONFIGURATION FILES..........................................................21

9.1 EXAMPLE ‘PUT’ TRANSFER......................................................................................................21 9.1.1 Connection definition ‘targetysys’ using PuTTY ............................................................21 9.1.2 Example targetsys.conf setup..........................................................................................21 9.1.3 Restart services - Windows.............................................................................................23 9.1.4 Restart services – Linux/Unix .........................................................................................24

9.2 EXAMPLE ‘GET’ TRANSFER......................................................................................................24 9.2.1 Connection definition ‘targetysys’ using PuTTY ............................................................25 9.2.2 Example gettargetsys.conf setup.....................................................................................25 9.2.3 Initiate transfer ...............................................................................................................27

10 NOTIFICATIONS AND ALERTS .........................................................................................28

10.1 EVENT ALERTS FOR WINDOWS................................................................................................28 10.2 EVENT ALERTS FOR LINUX AND UNIX .....................................................................................32 10.3 EMAIL ALERTS .........................................................................................................................32

11 PRE AND POST PROCESSING ............................................................................................33

11.1 TITLE .......................................................................................................................................33 11.1.1 Title.................................................................................................................................33



11.1.2 Title.................................................................................................................................33 11.1.3 Title.................................................................................................................................33

11.2 TITLE .......................................................................................................................................33 11.2.1 Title.................................................................................................................................33 11.2.2 Title.................................................................................................................................33 11.2.3 Title.................................................................................................................................33



12 REMOTE SYSTEM COMMAND PROCESSING ...............................................................34

13 RESPONSE FILES...................................................................................................................35


14 AUDIT .......................................................................................................................................36

14.1 MESSAGE DETAILS..................................................................................................................36 14.1.1 Severity ...........................................................................................................................37 14.1.2 Routes .............................................................................................................................37

14.2 LOG FILE .................................................................................................................................38 14.2.1 Format ............................................................................................................................38 14.2.2 Log control .....................................................................................................................38

14.3 ARCHIVE .................................................................................................................................38

15 MANUAL TRANSFERS..........................................................................................................40

15.1 SFTP.......................................................................................................................................40 15.1.1 Usage..............................................................................................................................40 15.1.2 Examples.........................................................................................................................40 15.1.3 SFTP Parameters ...........................................................................................................40 15.1.4 Notes ...............................................................................................................................41

15.2 FTP/FTPS & HTTP/HTTPS ...................................................................................................41 15.2.1 Usage..............................................................................................................................41 15.2.2 Examples.........................................................................................................................41 15.2.3 FTP/FTPS & HTTP/HTTPS Parameters........................................................................42 15.2.4 Notes ...............................................................................................................................47

15.3 SCP.........................................................................................................................................47 15.3.1 Usage..............................................................................................................................47 15.3.2 Examples.........................................................................................................................48 15.3.3 SCP Parameters .............................................................................................................48 15.3.4 Notes ...............................................................................................................................49

16 TROUBLESHOOTING...........................................................................................................50

16.1 HELP .......................................................................................................................................50 16.1.1 Debug mode....................................................................................................................50 16.1.2 Message interpretation ...................................................................................................50 16.1.3 As a Service or Manually?..............................................................................................50

16.2 TECHNICAL SUPPORT..............................................................................................................50 16.2.1 Trial support ...................................................................................................................50 16.2.2 Annual Maintenance support..........................................................................................50 16.2.3 General support information ..........................................................................................50



17 SFTPPPLUS CLIENT ERROR MESSAGES........................................................................52

17.1 SFTPPLUS CLIENT MESSAGE CONVENTION............................................................................52 17.2 SFTPPLUS CLIENT MESSAGE LIST..........................................................................................53

18 REX INTERPRETER ERROR MESSAGES........................................................................67

18.1 REXX MESSAGE CONVENTION................................................................................................67 18.2 REXX ERROR CODES...............................................................................................................67

19 GLOBAL.CONF FILE PARAMETERS................................................................................69

20 TRANSFER CONF FILE PARAMETERS ...........................................................................70

21 PROTOCOL ERROR MESSAGES .......................................................................................73

21.1 SFTP PROTOCOL ERROR CODES..............................................................................................73 21.2 FTP PROTOCOL ERROR CODES.................................................................................................76 21.3 FTPS PROTOCOL ERROR CODES...............................................................................................79 21.4 SCP PROTOCOL ERROR CODES.................................................................................................82 21.5 HTTP 1.1 PROTOCOL ERROR CODES........................................................................................84

22 REFERENCES .......................................................................................................................100

23 CONTACT INFORMATION................................................................................................101



1 LEGAL NOTICES

1.1 Copyright

This product is copyright © Pro:Atria Limited 2005-2007. ALL RIGHTS RESERVED.

Portions of this product are copyright as follows;

Regina is Copyright © 1992-1994 Anders Christensen

PuTTY is Copyright © 1997-2005 Simon Tatham

Regutils is Copyright © 1998, 2001 Patrick TJ McPhee

md5sum is Copyright © 2002 Free Foundation, Inc

openssl is Copyright 1998-2001,The OpenSSL Project

openssh is Copyright © 1995,Tatu Ylonen

cygwin dll and utilities © Copyright © 2000-2006,Red Hat, Inc

curl is Copyright © 1996-2006, Daniel Stenberg

apache is Copyright The Apache Software Foundation 1999-2006

MySQL is Copyright © MySQL AB and is provided under

the General Public License (GPL) license agreement

1.2 Trademarks

All products, company names and logos mentioned herein are the marks of their respective owners, including but not limited to, PuTTY, Regina, HP, IBM, Intel, Linux, Microsoft, Solaris, Tivoli, NetView, Unix and Windows.

SFTPPlus is a trademark of Pro:Atria Ltd

Linux is a trademark of Linus Torvalds

Unix is a trademark of the Open Group

1.3 License

SFTPPlus is not free software and may not be copied, distributed, sub-licensed, decompiled or used in any way except with express permission of the Licensor by License. 30 day free trials will normally be permitted by trial license on request. All license terms and conditions are available on request. SFTPPlus is licensed for use according to this documentation, in conjunction with the SFTPPlus license agreement.



1.4 Statutory regulation compliance

This document was produced by;

Pro:Atria Ltd, The Old Exchange, South Cadbury, Yeovil, Somerset BA22 7ET, UK

Registered in England – Company No: 4213930



2 PREFACE

The information in this manual is intended for personnel who install and configure the SFTPPlus Client software.

This manual describes how to install, configure and troubleshoot the SFTPPlus Client software product.

The manual is organised as follows;

Chapter 1 “Legal Notices” provides copyright, trademark and license information.

Chapter 2 “Preface” (this chapter) describes intended audience and a document layout overview.

Chapter 3 “Introduction” is a brief description of the SFTPPlus Client product.

Chapter 4 “Document conventions” provides information on conventions used in this document.

Chapter 5 “Installing SFTPPlus Client” refers to the installation guides for installing the SFTPPlus Client software on various platforms.

Chapter 6 “Configuring SFTPPlus Client” describes the basic configuration procedure for SFTPPlus Server/Client.

Chapter 7 “Protocols” describes the various transfer protocols that can used in SFTPPlus Client with some background information.

Chapter 8 “PuTTY - Creating connection profiles” describes a testing procedure for verification of the SFTPPlus Server software and will comprise of two tests.

Chapter 9 “Setting up transfer definitions” providing troubleshooting hints and tips.

Chapter 10 “Notifications and Alerts” provides details on how to manipulate and route the SFTPPlus message system.

Chapter 11 “Pre and Post Processing” details of pre and post transfer facilities.

(Continued over page)



Chapter 12 “Remote System Command Processing” shows how you can manipulate system command on a remote computer after file transfer has completed.

Chapter 13 “Response Files” describes what response files are and how useful they are in validating transfer operation.

Chapter 14 “Audit” describes the message system and how SFTPPlus provides a full audit trail.

Chapter 15 “Manual Transfers” provides details what programs are used for specific protocols and to manipulate various functions during transfer.

Chapter 16 “Troubleshooting” details information regarding self-help when things go wrong and when to call upon technical support for assistance.

Chapter 17 “SFTPPlus Client error messages” lists and describes the error messages from the SFTPPlus Client software.

Chapter 18 “Rexx Interpreter Error Messages” lists and describes the error messages from the rexx Interpreter engine.

Chapter 19 “Global Conf File Parameters” describes the parameters that govern global variables within the SFTPPlus Client environment.

Chapter 20 “Transfer Conf File Parameters” describes parameters that can be used within a conf file for either a put or get transfer operation.

Chapter 22 “References” provides list of additional documents that the reader may wish to obtain for further information on SFTPPlus Client, other technical information or information regarding the SFTPPlus range of software products. Please see our website www.proatria.com for details.

Chapter 23 “Contact information” provides information for contacting Pro:Atria Limited through various media for sales, help and support services.



3 INTRODUCTION

SFTPPlus

SFTPPlus Client – a tool for secure file transfers

SFTPPlus Client utilises open standards to implement secure file transfer with controls and audit suitable for the enterprise.

SFTPPlus Client provides a facility to allow any files placed into a directory to be transferred to a configured destination using sftp, ftp, ftps, http or https. All actions are audited, and alerts can be raised for certain conditions. Optionally, a response file can be retrieved after successful upload. All files can have a date and time stamp added to avoid duplicate names. All files are also archived after processing.

Pre and post processing is available for transfers.

Also;

SFTPPlus Client (and SFTPPlus Server) is available for many platforms including;

Unix – (Intel) AIX, Solaris (Sparc & x86), HP-UX (Intel & Itanium), Tru64,

Linux – (Intel, PPC, Alpha, Sparc, Alpha) Red Hat, SUSE, Debian, etc

Windows – NT4-SP6a, 2000 Professional, 2000 Server, Server 2003 & XP

Netware

We have several platforms under development in 2007 so please check for availability. Under development; Vista,

Tandem/Non-Stop,

OS/390

OpenVMS

Mac

Please see PDF document “SFTPPlus v1.2 - Features & Benefits” for further details.



4 DOCUMENT CONVENTIONS

The following conventions are used in this document:

Convention Usage Example

Bold Menu’s, GUI elements, strong emphasis or action

Click Apply or OK

-> Series of menu selections Select File -> Save

Monospace Filenames, commands, directories, URLs,

Refer to Readme.txt

Italics Information that the user must supply or type

dir /s

Double Quote Reference to other documents or products, emphasis

See “SFTPPlus User Manual”

Between bracket Optional items [ -s ] [ -f ] [ filename]

Please Note:

Indicates neutral or positive information that emphasizes or supplements important points of the main text. Supplies information that may apply only in special cases.

Caution:

Advises users that failure to take or avoid a specific action could result in loss of data or system corruption.

Windows Only:

Linux Only:

Advises users of information that is platform specific. Other platform graphic logos can be shown.



5 INSTALLING SFTPPLUS CLIENT

For installation requirements and the installation procedure please refer to the appropriate installation guide for your platform and are available on request;

“SFTPPlus Client 1.2 Installation Guide for Windows”

“SFTPPlus Client 1.2 Installation Guide for Linux + Unix”

“SFTPPlus Client 1.2 Installation Guide for AS400”



6 CONFIGURING SFTPPLUS CLIENT

This document, and chapters hereafter, assumes that you are familiar with the directory structure of SFTPPlus Client and understand the use of it’s sub-directories as explained in the “Installation structure” sub section of the “Installing SFTPPlus Client” chapter in the relevant platform document.

There are a number of items that need to be configured in order for SFTPPlus Client to function. The main system configuration is performed by editing global.conf. This is a plain text file and can be changed with any editor, for example Vi or Kate in Linux, Notepad or WordPad in Windows. If you plan to use email notifications, then this file must be updated with your relevant SMTP information, otherwise it may be used as supplied but of course will not function until valid email details are entered.

The messages issued by SFTPPlus can be routed to a number of destinations, this can be based on message severity or controlled for individual messages. This file as supplied is suitable for most cases.

Transfers are defined with individual configuration files stored in the conf directory. Each transfer requires its own configuration file and matching inbox sub-directory. Two sample configurations (sample.conf and sampleget.conf) are provided, both of which are disabled when SFTPPlus is first installed. It is recommended to make the configuration file name match the inbox sub-directory name, for example, place sample.conf in the .conf directory, use;

\SFTPPlus\client\inbox\sample for Windows

/opt/SFTPPlus/inbox/sample for Linux/Unix

as the location for the transfer files, but this method is optional.

The SFTPPlus Client service or daemon must be restarted to pick up any configuration change, see section 9.1.3 (Microsoft Windows) or 9.1.4 (Linux/Unix) for information on restarting the SFTPPlus Client system service. Changes include modification of an existing .conf file or placement of a new .conf file in the conf directory.

6.1 Global configuration

The global.conf file contains all the main global configuration options. Most can be left at default, except the following parameters;

• global.smptaddress – the target address for email messages



• global.msghost – the host name of the SMPT server

• global.msgport – the port number of the SMTP port (the default is 25)

• global.msgfrom – the from address used for messages sent

Although the above parameters can be left to the default settings, email messaging will not function until your SMTP and email details are entered.

The parameters in the global.conf provide the foundation for the SFTPPlus system and its messaging system. This messaging system will become even more powerful with enhanced sophistication in future releases.



7 PROTOCOLS

A protocol is a convention or standard that controls or enables the connection, communication, and data transfer between two computing endpoints. In its simplest form, a protocol can be defined as the rules governing the syntax, semantics, and synchronisation of communication. Protocols may be implemented by hardware, software, or a combination of the two. At the lowest level, a protocol defines the behaviour of a hardware connection.

It is difficult to generalise about protocols because they vary so greatly in purpose and sophistication. Most protocols specify one or more of the following properties:

• Detection of the underlying physical connection (wired or wireless), or the existence of the other endpoint or node

• Handshaking

• Negotiation of various connection characteristics

• How to start and end a message

• How to format a message

• What to do with corrupted or improperly formatted messages (error correction)

• How to detect unexpected loss of the connection, and what to do next

• Termination of the session or connection.

This communication layer has been stacked with more specific transport protocols which we use to move data from one computer to another.

7.1 Transfer Protocols

SFTPPlus Client can use a wide variety of transport protocols to ensure expedient and secure delivery of your valuable data.

7.1.1 SFTP

SSH File Transfer Protocol, a network protocol designed by the IETF to provide secure file transfer and manipulation facilities over the secure shell (SSH) protocol.

7.1.2 FTP

FTP or File Transfer Protocol is used to connect two computers over the Internet so that the user of one computer can transfer files and perform file commands on the other computer.

Specifically, FTP is a commonly used protocol for exchanging files over any network that supports the TCP/IP protocol (such as the Internet, extranet or an intranet).



7.1.3 FTPS

FTPS (commonly referred to as FTP/SSL) is a name used to encompass a number of ways in which FTP software can perform secure file transfers. Each way involves the use of a SSL/TLS layer below the standard FTP protocol to encrypt the control and/or data channels. It should not be confused with the SSH file transfer protocol.

The most common uses of FTP and SSL are:

• AUTH TLS or Explicit FTPS, named for the command issued to indicate that TLS security should be used. This is the preferred method according to the RFC defining FTP over TLS. The client connects to the server port 21 and starts an unencrypted FTP session as normal, but requests that TLS security be used and performs the appropriate handshake before sending any sensitive data.

• Implicit FTPS is an older, but still widely implemented style in which the client connects to a different port (usually 990), and an SSL handshake is performed before any FTP commands are sent.

7.1.4 SCP

Secure Copy or SCP is a means of securely transferring computer files between a local and a remote host or between two remote hosts, using the Secure Shell (more commonly known as SSH) protocol.

The term SCP can refer to one of two related things, the SCP protocol or the SCP program.

The SCP protocol is basically identical to the BSD RCP protocol. Unlike RCP, data is encrypted during transfer, to avoid potential packet sniffers extracting usable information from the data packets. However the protocol itself does not provide authentication and security; it expects the underlying protocol, SSH, to provide this function.

7.1.5 HTTP

Hypertext Transfer Protocol (HTTP ) is a method used to transfer or convey information on the World Wide Web. Its original purpose was to provide a way to publish and retrieve HTML pages but is also used to transfer file data as well

Development of HTTP was coordinated by the World Wide Web Consortium and the Internet Engineering Task Force, culminating in the publication of a series of RFCs, most notably RFC 2616 (1999), which defines HTTP/1.1, the version of HTTP in common use today.



HTTP is a request/response protocol between clients and servers. The originating client, such as a web browser, spider, or other end-user tool, is referred to as the user agent. The destination server, which stores or creates resources such as HTML files and images, is called the origin server. In between the user agent and origin server may be several intermediaries, such as proxies, gateways, and tunnels.

7.1.6 HTTPS

HTTPS is a URI scheme which is syntactically identical to the http:// scheme normally used for accessing resources using HTTP. Using an https: URL indicates that HTTP is to be used, but with a different default port (443) and an additional encryption/authentication layer between HTTP and TCP. This system was designed by Netscape Communications Corporation to provide authentication and encrypted communication and is widely used on the World Wide Web for security-sensitive communication such as payment transactions and corporate logons.

7.2 Protocol ports

As with most protocols, standards have evolved to ensure that connectivity utilises standard TCP port numbers. The protocols that SFTPPlus Client can use, with their relevant default port numbers, are as follows;

Protocol Port

SFTP 22

FTP 21

FTPS 21 (explicit mode)

FTPS 990 (implicit mode)

SCP 22

HTTP 80

HTTPS 443



8 PuTTY - CREATING CONNECTION FILES

Windows Only:

8.1 PuTTY Introduction (Windows only)

PuTTY allows you to create connection definition files which SFTPPlus Client can use to connect to a remote computer for SSH connections (normally sftp on port 22). This section describes how to make such a connection definition file to use with a SFTPPlus transfer definition file (a .conf file found in the \SFTPPlus\Client\conf directory).

The PuTTY program is installed with the SFTPPlus Client installation and can be found in the SFTPPlus\Client directory.

8.2 Starting a session

When you start PuTTY, you will see a dialog box as shown below.



This dialog box allows you to control everything PuTTY can do. See chapter 4 of the PuTTY User Manual 0.58 for details of all the things you can control. You don't usually need to change most of the configuration options. To start the simplest kind of session, all you need to do is to enter a few basic parameters.

In the `Host Name' field, enter the Internet host name of the server you want to connect to. You should have been told this by the provider of your login account. Now select a login protocol to use, from the `Protocol' buttons. For a login session, you should select Telnet, Rlogin or SSH (normally SSH). The fourth protocol, _Raw_, is not used for interactive login sessions; you would usually use this for debugging other Internet services. When you change the selected protocol, the number in the `Port' box will change. This is normal: it happens because the various login services are usually provided on different network ports by the server machine. Most servers will use the standard port numbers, so you will not need to change the port setting. If your server provides login services on a non-standard port, your system administrator should have told you which one.) Once you have filled in the `Host Name', `Protocol', and possibly `Port' settings, you are ready to connect. Give the profile a name in the ‘Saved Session’ field and press the ‘Save’ button. This will save the login profile details that you have entered for SFTPPlus to use by the conf file ‘savedprofile’ parameter. Press the `Open' button at the bottom of the dialog box, and PuTTY will begin trying to connect you to the server. If you enter any incorrect details, your connect session will fail. You can alter the settings, resave and ‘open’ a session to verify that any changes have worked.

8.3 Verifying the host key (SSH only)

If you are not using the SSH protocol, you can skip this section and indeed this chapter. If you are using SSH to connect to a server for the first time, you will probably see a message looking something like this:

The server's host key is not cached in the registry. You

have no guarantee that the server is the computer you

think it is.

The server's rsa2 key fingerprint is:

ssh-rsa 1024 7b:e5:6f:a7:f4:f9:81:62:5c:e3:1f:bf:8b:57:6c:5a

If you trust this host, hit Yes to add the key to PuTTY's cache and carry on connecting. If you want to carry on connecting just once, without adding the key to the cache, hit No. If you do not trust this host, hit Cancel to abandon the connection. This is a feature of the SSH protocol. It is designed to protect you against a network attack known as ‘spoofing’. This is secretly redirecting your connection to a different computer, so that you send your password to the wrong machine. Using this technique, an attacker would be able to learn the password that guards your login account, and could then log in as if they were you and use the account for their own purposes. To prevent this attack, each server has a unique identifying code, called a



‘host key’. These keys are created in a way that prevents one server from forging another server's key. So if you connect to a server and it sends you a different host key from the one you were expecting, PuTTY can warn you that the server may have been switched and that a spoofing attack might be in progress. PuTTY records the host key for each server you connect to, in the Windows Registry. Every time you connect to a server, it checks that the host key presented by the server is the same host key as it was the last time you connected. If it is not, you will see a warning, and you will have the chance to abandon your connection before you type any private information (such as a password) into it.

However, when you connect to a server you have not connected to before, PuTTY has no way of telling whether the host key is the right one or not. So it gives the warning shown above, and asks you whether you want to trust this host key or not. Whether or not to trust the host key is your choice. If you are connecting within a company network, you might feel that all the network users are on the same side and spoofing attacks are unlikely, so you might choose to trust the key without checking it. If you are connecting across a potentially hostile network (such as the Internet), you should check with your system administrator, perhaps by telephone or in person. (Some modern servers have more than one host key. If the system administrator sends you more than one fingerprint, you should make sure the one PuTTY shows you is on the list, but it doesn't matter which one you select.)

8.4 Logging in

After you have connected, and perhaps verified the server's host key, you will be asked to log in, usually using a username and a password. Your system administrator should have provided you with these. Enter the username and the password, and the server should grant you access and begin your session. If you have mistyped your password, most servers will give you several chances to get it right.

If you are using SSH, be careful not to type your username wrongly, because you will not have a chance to correct it after you press Return; many SSH servers do not permit you to make two login attempts using different usernames. If you type your username wrongly, you must close PuTTY and start again. If your password is refused but you are sure you have typed it correctly, check that Caps Lock is not enabled. Many login servers, particularly Linux/Unix computers, treat upper case and lower case as different when checking your password; so if Caps Lock is on, your password will probably be refused.

8.5 After logging in

After you log in to the server, what happens next is up to the server! Most servers will print some sort of login message and then present a prompt, at which you can type commands which the server will carry out. Some servers will offer you on-line help, others might not. If you are in doubt about what to do next, consult your system administrator.



8.6 Logging out

When you have finished your session, you should log out by typing the server's own logout command. This might vary between servers; if in doubt, try `logout' or `exit', or consult a manual or your system administrator. When the server processes your logout command, the PuTTY window should close itself automatically.

You can close a PuTTY session using the Close button in the window border, but this might confuse the server - a bit like hanging up a telephone unexpectedly in the middle of a conversation. We recommend you do not do this unless the server has stopped responding to you and you cannot close the window any other way.

There are many other things that can be done with PuTTY, more than the scope of this document. If you require more in-depth information regarding the use of PuTTY or its companion programs, read the PuTTY User Manual version 0.58 from our web site at www.proatria.com or visit the original developers website at;

http://www.chiark.greenend.org.uk/~sgtatham/putty/



9 SETTING UP TRANSFER CONFIGURATION FILES

Create a sub-directory of inbox (in this example, ‘targetsys’) if it does not already exist. Also create a sub-directory called ‘targetsys’ under the response directory if expecting a response file.

9.1 Example ‘put’ transfer

Please Note: If you are not using sftp on port 22 you can skip section 9.1.1 regarding “Connection definition ‘targetsys’ using PuTTY” and continue with “Example targetsys.conf setup” as a connection profile is only used for sftp transfers.

9.1.1 Connection definition ‘targetysys’ using PuTTY

You need to preconfigure SFTP sessions using putty . (a) Start putty.exe (Windows) or ./putty (Linux/Unix) putty (b) Create new session by typing a name in the saved sessions box and

pressing save, or load an existing session. (c) Set host name or IP address of the target system (d) Ensure ssh is selected (e) Set port to the correct ssh port (default 22) (f) Set proxy information as required (g) Save session with targetsys (used for savedprofile later). (h) Open session, accept key permanently when prompted and login (if

allowed). It is important that the remote host’s key is saved, as the SFTPPlus service has no way of asking the user to accept the key. There is no specific requirement for the logon to proceed, and it is possible that the remote system is configured to prevent such access. At this stage it is a good idea to create any required remote directories. If a full login is not permitted, then using psftp interactively is an option.

(i) Exit the remote system

9.1.2 Example targetsys.conf setup

Make a copy of sample.conf in the conf directory. Rename the new conf file targetsys.conf and edit (e.g. with Notepad)



Please Note:

In a transfer definition file, a line that begins with /* and ends with */ is a comment line. If these are not in the above order or either of these is missing, the SFTPPlus service will not start.

You will have to set server, port, user, password etc. Each line should be in the format parameter = ’value’.

(a) Remove or comment out the disabled = ’y’ disabled line - this stops the definition being activated.

(b) subdir - the subdirectory of inbox that files will be placed in for transfer. All files placed here will be transferred. This directory has to exist.

(c) type of transfer, currently only SFTP is supported. (d) direction - get or put (put is default) (e) server - the server name or address of the target system port - port to

connect to, usually 22 for SFTP (f) user - the userid on the remote system (g) password- the password on the remote system (h) savedprofile- the profile NAME saved by putty earlier (i) targetdir- the target directory on the remote system for transferred files

(for put only). This is a relative path. (j) forcelowercase - use lower case names for the transfer, ignores the

original case of the file (k) targettimestamp - include a timestamp at the target for uniqueness ’y’ or

’n’ (default ’y’). Must be set to ’n’ for systems that do not support long filenames.

(l) createmd5sum - will an md5sum file be created ’y’ or ’n’ (default ’y’) (m) sendmd5sum - the md5sum of the file can also be transferred if required. (o) preprocess - Allow customised processing before transfer if required. As

an example, you may wish to copy the incoming file to another inbox directory to copy this file to multiple destinations.

(p) postprocesssuccess - Allow customised processing after a successful transfer if required.

(q) postprocessfail - Allow customised processing after a failed transfer if required.

(r) response- set to y if a response file is to be returned. This would typically be created by the remote system after processing the transferred file. The file will be placed in the SFTPPlus\Client\response\<subdir> directory (Windows) or /opt/SFTPPlus/respose/<subdir> directory (Linux/Unix), which must exist. <subdir> relates to the name of your transfer definition file if you are using our default method as outlined previously.

(s) responsein- the filename that should be collected. This can be a plain file name or use %fname% and %ftype% for name and type matching.



%ftype% does not include the ’.’ separator, e.g. if the file format is FNAME_rpt.FTYPE use : responsein = ’%fname%_rpt.%ftype%’

i. responsedir- the directory where the response file will be collected from on the remote system

ii. responsetimestamp - include a timestamp in the response file for uniqueness ’y’ or ’n’ (default ’y’).

iii. postprocessresponsesuccess - Allow customised processing after a successful transfer if required.

iv. postprocessresponsefail - Allow customised processing after a failed transfer if required.

(t) maxtry- maximum number of attempts for a transfer. If this is exceeded the transfer will be considered to have failed.

(u) waittime - the time to wait between attempts if a transfer fails (y) initialwait- the time to wait before looking for a response file. (v) smtpaddress- the smtp email address for email alerts.

9.1.3 Restart services - Windows

In release version 1.2 of SFTPPlus Client, if you copy a new conf file into the SFTPPlus\Client\Conf directory or make changes to an existing one, you will need to stop and restart the SFTPPlus service.

Restart the SFTPPlus service by typing ‘Start -> Run” and entering services.msc in the field box marked ‘Open:’ as shown below;

Scroll down the list of system services. Single left click on the ‘SFTPPlus’ Service, then right click and select ‘Stop’ from the dropdown menu.



Then right click and select ‘Start’ from the dropdown menu.

The SFTPPlus service will now pick up your transfer definition file and perform the file transfer. You can monitor this transfer by reading the message.log file with a text editor such as Notepad or WordPad.

9.1.4 Restart services – Linux/Unix

In release version 1.2 of SFTPPlus Client, if you copy a new conf file into the /opt/SFTPPlus/Client/Conf directory or make changes to an existing one, you will need to stop and restart the SFTPPlus service.

To restart the SFTPPlus daemon in Linux, enter the following command;

/etc/init.d/rc.SFTPPlus restart

9.2 Example ‘get’ transfer

Please Note: If you are not using sftp on port 22 you can skip the next section regarding “Connection definition ‘targetsys’ using PuTTY” and continue with “Example targetsys.conf setup”



9.2.1 Connection definition ‘targetysys’ using PuTTY

If you have already carried out this in section 81.1. you can skip this section as connection profiles are re-usable for both put and get remote connections.

You need to pre-configure an SFTP sessions using putty . (a) Start putty.exe (Windows) or ./putty (Linux/Unix) putty (b) Create new session by typing a name in the saved sessions box and

pressing save, or load an existing session. (c) Set host name or IP address of the target system (d) Ensure ssh is selected (e) Set port to the correct ssh port (default 22) (f) Set proxy information as required (g) Save session with targetsys (used for savedprofile later). (h) Open session, accept key permanently when prompted and login (if

allowed). It is important that the remote host’s key is saved, as the SFTPPlus service has no way of asking the user to accept the key. There is no specific requirement for the logon to proceed, and it is possible that the remote system is configured to prevent such access. At this stage it is a good idea to create any required remote directories. If a full login is not permitted, then using psftp interactively is an option.

(i) Exit the remote system

9.2.2 Example gettargetsys.conf setup

Make a copy of getsample.conf in the conf directory. Rename the new conf file gettargetsys.conf and edit (e.g. with Notepad)

Please Note:

In this file, a line that begins with /* and ends with */ is a comment.

You will have to set server, port, user, password etc. Each line should be in the format parameter = ’value’

(a) Remove or comment out the disabled = ’y’ disabled line - this stops the definition being activated.

(b) subdir - the subdirectory of inbox that files will be placed in for transfer. All files placed here will be transferred. This directory has to exist.

(c) type of transfer, currently only SFTP is supported.



(d) direction - get or put (put is default) (e) server - the server name or address of the target system port - port to

connect to, usually 22 for SFTP (f) user - the userid on the remote system (g) password- the password on the remote system (h) savedprofile- the profile NAME saved by putty earlier (i) timestamp - include a timestamp on the received file for uniqueness ’y’

or ’n’ (default ’y’) (j) remotedir - the directory the file is to be pulled from on the remote

system (k) remotefile - the file name to be pulled from the remote system (l) starttime - Time for transfer to be started, format is hh:mm This will be

repeated daily at the same time (m) createmd5sum - will an md5sum file be created ’y’ or ’n’ (default ’y’) (n) sendmd5sum - the md5sum of the file can also be transferred if required. (o) preprocess - Allow customised processing before transfer if required. As

an example, you may wish to copy the incoming file to another inbox directory to copy this file to multiple destinations.

(p) postprocesssuccess - Allow customised processing after a successful transfer if required. (q) postprocessfail - Allow customised processing after a failed transfer if

required. (r) response- (put only) set to y if a response file is to be returned. This

would typically be created by the remote system after processing the transferred file. The file will be placed in the response\subdir directory, which must exist.

(s) responsein- the filename that should be collected. This can be a plain file name or use %fname% and %ftype% for name and type matching. %ftype% does not include the ’.’ separator, e.g. if the file format is FNAME_rpt.FTYPE use : responsein = ’%fname%_rpt.%ftype%’

i. responsedir- the directory where the response file will be collected from on the remote system

ii. responsetimestamp - (put only) include a timestamp in the response file for uniqueness ’y’ or ’n’ (default ’y’).

iii. postprocessresponsesuccess - Allow customised processing after a successful transfer if required.

iv. postprocessresponsefail - Allow customised processing after a failed transfer if required.

(t) maxtry- maximum number of attempts for a transfer. If this is exceeded the transfer will be considered to have failed.

(u) waittime - the time to wait between attempts if a transfer fails (v) initialwait- the time to wait before looking for a response file. (w) smtpaddress- the smtp email address for email alerts.



9.2.3 Initiate transfer

In release version 1.2 of SFTPPlus Client, if you copy a new conf file into the SFTPPlus\Client\Conf directory or make changes to an existing one, you will need to stop and restart the SFTPPlus service.

To restart the SFTPPlus service, open the Windows Services Control Panel by typing ‘Start -> Run” and entering services.msc in the field box marked ‘Open:’ as shown below;

Scroll down the list of system services. Single left click on the ‘SFTPPlus’ Service, then right click and select ‘Stop’ from the dropdown menu.

Then right click and select ‘Start’ from the dropdown menu.



10 NOTIFICATIONS AND ALERTS

The messages issued by SFTPPlus are controlled by message.conf. This provides the message text, severity, help and routing information. Please refer to the Audit chapter for further details.

Messages are routed based on severity. As supplied, all messages are written to the message.log file and important messages are also written to the system and application event log. The message route of ‘console’ will write to event log when running as a service.

The message route destinations available are;

• Log

• Eventlog

• Email

• console

10.1 Event alerts for Windows

You need to have suitable tools installed to use this facility. This section includes brief details for using the tools supplied with Windows under ‘Management and Monitoring Tools’. To set up alerts, find the required message number in message.conf and ensure that this is routed to the event log, either specifically or by severity.

For example, to make message 51 (‘Response file | for | transfer id available’) route to the log and event log, add a line;

message.route.51 = ‘log,eventlog’

If using Microsoft tools, use the evntwin program to add a new trap for the required message number. The event source name is SFTPPlus.

To use eventwin, do the following;

a). start the Event to Trap Translator (evntwin)

Select Start -> Run



Then enter evntwin.exe in the ‘Open’ field

b). select Custom configuration

c). click on the Edit button to see the list of sources



d). Click on the ‘+’ sign to expand the Application event source

e). scroll down and select SFTPPlus, then select message 51 and the click Add button



f). click OK to confirm

g). click OK or Apply to activate these settings

You will now receive an alert when SFTPPlus retrieves a response file.



10.2 Event alerts for Linux and Unix

10.3 Email alerts

Email alerts are sent using an SMTP server. The server settings are defined in the global.conf file.

By default no messages are routed to email. To setup email routing of messages;

a). update the global.conf for your site SMTP server

b). set the route in message.conf for the desired severity or individual message(s) to include email, e.g. to make message 51 (‘Response file | for | transfer id available’) route to the log and email, add a line;

message.route.51 = ‘log,email’

c). optionally, set the smtpaddress parameter (in your transfer conf file) for email destinations for specific transfers.

d). restart the service.

If the SFTPPlus service has any more errors talking to the SMTP server, it will not retry and will disable its email routing. This is to prevent recursive errors when reporting on such a problem. Instead, a message 74 will be issued, which is a severity “S”.



11 PRE AND POST PROCESSING

11.1 Title

11.1.1 Title

11.1.2 Title

11.1.3 Title

11.2 Title

11.2.1 Title

11.2.2 Title

11.2.3 Title

11.3 Title

11.3.1 Title

11.3.2 Title

11.3.3 Title

11.4 Title

11.4.1 Title

11.4.2 Title

11.4.3 Title



12 REMOTE SYSTEM COMMAND PROCESSING When a transfer has been completed, you can run a native command on the destination or remote system. To do this, you must use the transfer definition file parameter; runaftertransfer For example;

Your destination system is Linux Using the ‘put’ command. You want to move a file from the directory “download1” and move to another folder within the remote system. If your destination system is linux you would enter the following in your transfer conf file;

runaftertransfer = 'mv /home/kevin/download1/*.* /h ome/kevin/kdtest/'

and doing the same on Windows;

Your destination system is Windows Using the ‘put’ command. You want to move a file from the directory “download1” and move to another folder within the remote system. If your destination system is windows you would enter the following in your transfer conf file;

runaftertransfer = 'mv c: \ home\ kevin \ download2 \ *.* c: \ home\ fred \ '

Caution:

In the destination, do not specify a file name. This will cause the command to fail.

Use runaftertransfer parameter in 1.2!!!! – add into conf parameters! The ‘runaftertransfer’ parameter will only run commands that are available within an ftp shell



13 RESPONSE FILES

13.1 Title

13.1.1 Title

13.1.2 Title

13.1.3 Title



14 AUDIT

SFTPPlus provides a full audit trail through its message system. All messages are written to the message log (unless specifically disabled, not recommended) and can optionally be routed to the Windows event log, emails and are easily extended for other systems.

The file message.conf provides the messages and the main controls. This allows messages to be routed according to requirements. The messages from this file are included in a later chapter.

14.1 Message details

To aid with explaining the message format I will use message 7 as an example:

message.text.7 = ’Definition | disabled - ignoring’

message.severity.7 = ’E’

message.help.7 = ’The definition is specifically di sabled in the configuration file. The definition should be removed if not needed. It can be left as disabled i f it may be required in future.’

These messages are defined in the message.conf file located in SFTPPlus\Client (Windows) or /opt/SFTPPlus (Linux/Unix).

The message numbers are used as an index, message text can be translated.

Caution:

Caution must be exercised when editing the message.conf file. Erroneous modification of this file can cause serious problems with SFTPPlus Client issuing accurate error messages. Do not edit the error messages listed after the message routing section.

The message.log file parameter message.log file can be changed to accommodate either a different location and/or a different log file name. The default value for message.log file is;

message.logfile = 'message.log'

You could, for example, change this to be;



message.logfile = 'e:\transferlogs\message.log'

or;

message.logfile = 'f:\transferlogs\ftp-transfer-messages.log'

This provides the user with a flexible method of directing the message output to a suitable location and filename if the default is not suitable.

14.1.1 Severity

Message severity has four classifications;

• I - information - no action needed • W - warning - usually retriable error, e.g. file not ready yet • E - Error - something has failed, but can continue • S - Severe error - cannot continue

Message text - the | symbol will be replaced with parameter information. Parameters will be appended to the string if there are no | characters.

14.1.2 Routes

Message routes are set using the following variables:

• message.route.I - the message route for severity I • message.route.W - the message route for severity W • message.route.E - the message route for severity E • message.route.S - the message route for severity S

An individual message can have its route overridden using it’s number, e.g.

message.route.7 = ’log,email’

Available message routes are:

• ’console’ - display if interactive, or piped output • ’log’ - write to the log file (see message.log file) • ’eventlog’ - (Windows only) - event log entries are used for snmp • ’email’ - send email (see global.conf parameter details)



Please Note:

Multiple routes must be separated with a comma (’,’)

By default, messages always go to the message.log file (as predefined in the message.conf file at software installation) which can be manipulated to suit your requirements. However, the default message route to the message.log file can be removed or overridden, it is highly recommended that this is not done. The message.log file is the main log file for the SFTPPlus system. Disabling message output to the main message.log file could result in an inability to provide accurate audit trail information of transfers and would also remove the existence of essential information to diagnose any issues arising from failed transfers or system errors.

It is recommended that users add their own preferred message routes in addition to the message.log file output as this provides the most flexible messaging system.

14.2 Log file

The message log file will normally always be in the program root directory. This allows the issue of messages before reading config files. If you change the log file here the initial messages will still be written to the file defined in SFTPPlus.rexx

14.2.1 Format

Messages are issued in the following format:

yyyymmdd hh:mm:ss product nnnns text

20050719 10:47:57 SFTPPlus 0007E Definition sample disabled - ignoring

This was message 7 issued with parameter ’sample’ at 10:47:57 on 19 July 2005.

14.2.2 Log control

The message log file will be saved at the end of each day with the date appended to the end of the file name, e.g. message.log.20050720 for July 20 2005. The message logs may then be archived and deleted.

14.3 Archive

All files processed and the commands used are archived for audit purposes. The files are saved in the Archive sub directory (C:\SFTPPlus\client\archive in Windows and



/opt/SFTPPlus/archive in Linux/Unix). The files all have a date and time stamp in their names. Examples for a typical transfer: myfile.20050720.094817.489000.xml

myfile.20050720.094817.489000.md5sum

myfile.20050720.094817.489000.sftp

myfile.20050720.094817.489000.result

myfile.20050720.094817.489000.response.sftp

myfile.20050720.094817.489000.response.result

myfile.20050720.094817.489000_rpt.xml

The original file was myfile.xml. The file was sent at 09:48:17 on July 20 2005. The suffixes indicate the data:

• xml - the original or response file suffix- the response file in this case has extra characters _rpt inserted. This will match the original filetype

• md5sum - contains the ms5sum of the original file • SFTP - contains the SFTP commands for the transfer (or response) • result - contains the output of the transfer (or response)

The archive files can be deleted at any time.



15 MANUAL TRANSFERS

In addition to the automated data transfer that SFTPPlus Client provides, you can also perform manual data transfers or transfer testing. This chapter outlines the programs used to perform these operations, their parameters and a brief example.

15.1 SFTP

To perform a SFTP transfer, you would use the program psftp.exe. This program is located in the \SFTPPlus\Client directory for Windows and /opt/SFTPPlus/bin/ for Linux/Unix.

15.1.1 Usage

Command line usage is as follows;

psftp [options] [user@]host

Where;

[options] are the parameters list in the table below.

[user] is the username to be used for remote computer.

host is the IP address or name of the remote computer.

15.1.2 Examples

Scenario 1

Scenario 2

15.1.3 SFTP Parameters

Parameter Parameter Description

-V Print version information and exit

-pgpfp print PGP key fingerprints and exit

-b <file> Use specified batch-file

-bc Output batchfile commands

-be Don't stop batchfile processing if errors

-v Show verbose messages




-load <sessname> Load settings from saved session

-l Connect with specified username

-P Connect to specified port, normally port 22 but can be a custom port number

-pw <passwd> Login with specified password

-1 Force use of SSH protocol version 1


-4 Force use of IPv4

-6 Force use of IPv6

-C Enable compression

-i <key> Private key file for authentication

-batch Disable all interactive prompts

15.1.4 Notes

Please note that there are parameters which are in upper and lower case, you must enter the correct case or your transfer will fail on a parameter error.

15.2 FTP/FTPS & HTTP/HTTPS

To perform an FTP or FTPS transfer, you would use the program curl.exe. This program is located in the \SFTPPlus\Client directory for Windows and /opt/SFTPPlus/bin/ for Linux/Unix.

15.2.1 Usage

Command line usage is as follows; curl [options...] <url>

Where;


<url> is the username to be used for remote computer.

15.2.2 Examples

Scenario 1

Scenario 2



15.2.3 FTP/FTPS & HTTP/HTTPS Parameters

Parameter Protocol Use

Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with

HTTP Parameter Description

-a --append √ Append to target file when uploading (F)

-A --user-agent <string> √ User-Agent to send to server (H)

--anyauth √ Pick "any" authentication method (H)

-b --cookie <name=string/file> √ Cookie string or file to read cookies from (H

--basic √ Use HTTP Basic Authentication (H)

-B --use-ascii Use ASCII/text transfer

-c --cookie-jar <file> √ Write cookies to this file after operation (H)

-C --continue-at <offset> Resumed transfer offset

-d --data <data> √ HTTP POST data (H)

--data-ascii <data> √ HTTP POST ASCII data (H)

--data-binary <data> √ HTTP POST binary data (H)

--negotiate √ Use HTTP Negotiate Authentication (H)

--digest √ Use HTTP Digest Authentication (H)

--disable-eprt √ Inhibit using EPRT or LPRT (F)

--disable-epsv √ Inhibit using EPSV (F)

-D --dump-header <file> Write the headers to this file

--egd-file <file> √ EGD socket path for random data (SSL)

--tcp-nodelay Use the TCP_NODELAY option

-e --referer √ Referer URL (H)

-E --cert <cert[:passwd]> √ Client certificate file and password (SSL)




Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with


--cert-type <type> √ Certificate file type (DER/PEM/ENG) (SSL)

--key <key> √ Private key file name (SSL)

--key-type <type> √ Private key file type (DER/PEM/ENG) (SSL)

--pass <pass> √ Pass phrase for the private key (SSL)

--engine <eng> Crypto engine to use (SSL). "--engine list" for list

--cacert <file> √ CA certificate to verify peer against (SSL)

--capath <directory> √ CA directory (made using c_rehash) to verify peer against (SSL)

--ciphers <list> √ SSL ciphers to use (SSL)

--compressed Request compressed response (using deflate or gzip)

--connect-timeout <seconds> Maximum time allowed for connection

--create-dirs Create necessary local directory hierarchy

--crlf Convert LF to CRLF in upload

-f --fail √ Fail silently (no output at all) on HTTP errors (H)

--ftp-create-dirs √ Create the remote dirs if not present (F)

--ftp-pasv √ Use PASV/EPSV instead of PORT (F)

--ftp-skip-pasv-ip √ Skip the IP address for PASV (F)

--ftp-ssl √ Enable SSL/TLS for the ftp transfer (F)

-F --form <name=content> √ Specify HTTP multipart POST data (H)

-- form-string <name=string> √ Specify HTTP multipart POST data (H)

-g --globoff Disable URL sequences and ranges using {} and []




Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with


-G --get √ Send the -d data with a HTTP GET (H)

-h --help Will display this help text

-H --header <line> √ Custom header to pass to server (H)

--ignore-content-length Ignore the HTTP Content-Length header

-i --include √ √ Include protocol headers in the output (H/F)

-I --head Show document info only

-j --junk-session-cookies √ Ignore session cookies read from file (H)

--interface <interface> Specify network interface to use

--krb4 <level> √ Enable krb4 with specified security level (F)

-k --insecure √ Allow connections to SSL sites without certs (H)

-K /--config Specify which config file to read

-l --list-only √ List only names of an FTP directory (F)

--limit-rate <rate> Limit transfer speed to this rate

-L --location √ Follow Location: hints (H)

--location-trusted √ Follow Location: and send authentication even to other hostnames (H)

-m --max-time <seconds> Maximum time allowed for the transfer

--max-redirs <num> √ Maximum number of redirects allowed (H)

--max-filesize <bytes> √ √ Maximum file size to download (H/F)

-M --manual Display the full manual

-n --netrc Must read .netrc for user name and password

--netrc-optional Use either .netrc or URL; overrides -n

--ntlm √ Use HTTP NTLM authentication (H)




Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with


-N --no-buffer Disable buffering of the output stream

-o --output <file> Write output to <file> instead of stdout

-O --remote-name Write output to a file named as the remote file

-p --proxytunnel Operate through a HTTP proxy tunnel (using CONNECT)

--proxy-anyauth √ Pick "any" proxy authentication method (H)

--proxy-basic √ Use Basic authentication on the proxy (H)

--proxy-digest √ Use Digest authentication on the proxy (H)

--proxy-ntlm √ Use NTLM authentication on the proxy (H)

-P --ftp-port <address> √ Use PORT with address instead of PASV (F)

-q If used as the first parameter disables .curlrc

-Q --quote <cmd> √ Send command(s) to server before file transfer (F)

-r --range <range> Retrieve a byte range from a HTTP/1.1 or FTP server

--random-file <file> √ File for reading random data from (SSL)

-R --remote-time Set the remote file's time on the local output

--retry <num> Retry request <num> times if transient problems occur

--retry-delay <seconds> When retrying, wait this many seconds between each

--retry-max-time <seconds> Retry only within this period




Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with


-s --silent Silent mode. Don't output anything

-S --show-error Show error. With -s, make curl show errors when they occur

--socks <host[:port]> Use SOCKS5 proxy on given host + port

--stderr <file> Where to redirect stderr. - means stdout

-t --telnet-option <OPT=val> Set telnet option

--trace <file> Write a debug trace to the given file

--trace-ascii <file> Like --trace but without the hex output

--trace-time Add time stamps to trace/verbose output

-T --upload-file <file> Transfer <file> to remote site

--url <URL> Set URL to work with

-u --user <user[:password]> Set server user and password

-U --proxy-user <user[:password]>

Set proxy user and password

-v --verbose Make the operation more talkative

-V --version Show version number and quit

-w --write-out [format] What to output after completion

-x --proxy <host[:port]> Use HTTP proxy on given port

-X --request <command> Specify request command to use

-y --speed-time Time needed to trig speed-limit abort. Defaults to 30

-Y --speed-limit Stop transfer if below speed-limit for 'speed-time' secs

-z --time-cond <time> Transfer based on a time condition

-0 --http1.0 √ Use HTTP 1.0 (H)

-1 --tlsv1 √ Use TLSv1 (SSL)

-2 --sslv2 √ Use SSLv2 (SSL)




Short Long

Use only with FTP

Use only with

SSL

(FTPS

or

HTTPS)

Use only with


-3 --sslv3 √ Use SSLv3 (SSL)

--3p-quote √ Like -Q for the source URL for 3rd party transfer (F)

--3p-url √ source URL to activate 3rd party transfer (F)

--3p-user √ user and password for source 3rd party transfer (F)

-4 --ipv4 Resolve name to IPv4 address

-6 --ipv6 Resolve name to IPv6 address

-# --progress-bar Display transfer progress as a progress bar

15.2.4 Notes


15.3 SCP

To perform an SCP transfer, you would use the program pscp.exe. This program is located in the \SFTPPlus\Client directory for Windows and /opt/SFTPPlus/bin/ for Linux/Unix

15.3.1 Usage

Command line usage is as follows;

pscp [options] [user@]host:source target

pscp [options] source [source...] [user@]host:target

Where;


[user] is the username to be used.

host is the IP address or name of the remote computer.



source is the source directory (if required) and file(s)

target is the directory and or file name on the remote computer.

15.3.2 Examples

Scenario 1

Scenario 2

15.3.3 SCP Parameters


-V Print version information and exit

-pgpfp Print PGP key fingerprints and exit

-p Preserve file attributes

-q Quiet, don't show statistics

-r Copy directories recursively

-v Show verbose messages

-load <sessname> Load settings from saved session

-P port Connect to specified port

-l <user> Connect with specified username

-pw <passw> Login with specified password



-4 Force use of IPv4 or IPv6

-6 Force use of IPv4 or IPv6

-C Enable compression

-i key Private key file for authentication

-batch Disable all interactive prompts

-unsafe Allow server-side wildcards (DANGEROUS)

-sftp Force use of SFTP protocol

-scp Force use of SCP protocol



15.3.4 Notes




16 TROUBLESHOOTING

16.1 Help

16.1.1 Debug mode

16.1.2 Message interpretation

16.1.3 As a Service or Manually?

16.2 Technical Support

First and foremost, we would like to thank you for using SFTPPlus products.

Technical support is a vital part of the total Pro:Atria customer experience. We want you to get the most from our products long after the initial sale and installation. We are dedicated to ensure that every issue is resolved expediently and to your satisfaction. To enable you to maximise the return on your investment, we offer a suite of support offerings designed to meet your business needs.

This chapter provides an overview of the SFTPPlus support offerings and how to use them.

16.2.1 Trial support

Whilst you are trialling SFTPPlus Client, you are entitled to full technical support to enable you to install, configure and perform test transfers on your platform(s). We will endeavour to help you at every step to ensure you can complete your trial successfully. Our normal terms for trials are 30 days but this can be extended on agreement. We will always make reasonable efforts to assist you to integrate and setup SFTPPlus in your business during the trial period.

16.2.2 Annual Maintenance support

Payment of the annual maintenance fee entitles you to full technical support via email, telephone support and software updates.

16.2.3 General support information We would normally conduct technical support via various media but we have preferred routing in the order of;



• Email

• Telephone

and where practical/possible

• Site visit

To help us asses any issues that may arise, it will be helpful to us, and speed up diagnostics, if you would send relevant information pertaining to the issue. This should include;

• Your platform that SFTPPlus Client is running on

• The target platform you are connecting to

• Version of SFTPPlus Client you are running

• Rexx version – using vi or kate (linux) or Wordpad (Windows), look at the first line of SFTPPlus.rexx, please supply the details after the $Id, for example

/* $Id: SFTPPlus.rexx, v x.xx yyyy/mm/dd

• Copy of Message.log

• Any screen output that you may have

• Trace output from debug mode (this can be switched on manually but please speak to us first regarding this)

In the first instance, sending us this information should help us diagnose the problem and identify a solution for you as quickly as possible.

Upon receipt of the above information, we will respond by confirming that we have received your enquiry and it is receiving attention. We will then look through the information supplied and diagnose the problem. When a solution is found we will email or telephone you with a detailed solution.



17 SFTPPPLUS CLIENT ERROR MESSAGES

The messages issued by SFTPPlus and the other various systems are listed here for your convenience.

17.1 SFTPPlus Client Message convention

SFTPPlus Client provides a comprehensive messaging system to inform users of tasks being executed. The message.conf file contains message routing and description information for SFTPPlus Client to use. Message routing can be defined against the severity level and provides a flexible method of application information to users.

Please Note:

The SFTPPlus message file (message.conf) can be found in the SFTPPlus\client directory in Windows and the /opt/SFTPPlus/ directory in Linux /Unix and may contain a more up-to-date set of messages than this document.

SFTPPlus messages can be directed to several reporting destinations;

Destination Description

console Display if interactive, or piped output.

log Write to the message.log file.

eventlog (Windows only) Write to the Eventlog and (if configured) MS Tools.

email Send email as defined in global.conf file.

snmp Send SNMP alert – This feature is not available in version 1.2 and planned for future release.

A SFTPPlus message is classified as one of four severities. These are described in the following table;

Severity Classification

Description

I Information – Information message only, no action required.

W Warning – Warning message, some user action may be required.

E Error – This is a non fatal error and is either a system error or SFTPPlus task error but will not terminate the current process.

S Severe - This is normally a fatal error and is either a system failure or a SFTPPlus task error and will terminate the current process.



17.2 SFTPPlus Client Message list

Below is an expanded list of SFTPPlus Client system error message codes.

Message ID 0

Severity I

Text

Help Messages issued before processing the global.conf file

Message ID 1

Severity I

Text Configuration read, startup continues

Help The global.conf file has been processed and startup continues

Message ID 2

Severity S

Text Unable to find conf files

Help SFTPPlus has failed to find the required configuration files. Consult message.log and check the runtime path. This may also indicate a problem with semaphore locking.

Message ID 3

Severity E

Text STDERR

Help Error output from a command issued.

Message ID 4

Severity I

Text STDOUT

Help Output from a command issued.

Message ID 5

Severity I

Text Config file

Help Configuration file is being read



Message ID 6

Severity I

Text Setting:

Help Setting from a configuration file

Message ID 7

Severity E

Text Definition | disabled - ignoring

Help The definition is specifically disabled in the configuration file. The definition should be removed if not needed. It can be left as disabled if it may be required in future.

Message ID 8

Severity E

Text Unable to scan | - ignoring

Help A defined directory was not able to be scanned. Check the directory exists and is accessible to the SFTPPlus service.

Message ID 9

Severity E

Text Command was

Help Command used to test a directory

Message ID 10

Severity I

Text Adding | to monitoring list

Help The definition listed has been added to the list of active definitions

Message ID 11

Severity E

Text Missing subdir parameter in |, ignoring

Help A definition has no subdir parameter. Add the correct subdir parameter to the definition. This must point to a sub-directory of inbox.



Message ID 12

Severity I

Text Using server | for

Help The server specified for a transfer

Message ID 13

Severity E

Text Missing server parameter |, ignoring

Help No server was specified for a transfer - the target server must be specified.

Message ID 14

Severity I

Text Using port | for

Help The port specified for a transfer.

Message ID 15

Severity I

Text Using port 22 for

Help Using the default port (22) for sftp

Message ID 16

Severity I

Text Using user | for

Help The user specified for the remote system for a transfer

Message ID 17

Severity E

Text Missing user parameter

Help A userid must be specified for the target system

Message ID 18

Severity I

Text Using password provided for

Help The password provided will be used.



Message ID 19

Severity E

Text Missing password parameter

Help No password has been provided for the remote system. This must be the password for the specified user on the remote system.

Message ID 20

Severity I

Text Using saved profile | for

Help The specified PuTTY profile will be used.

Message ID 21

Severity E

Text Missing savedprofile parameter

Help No PuTTY profile has been specified. The profile will be created by using the putty.exe gui, and saving a connection definition.

Message ID 22

Severity I

Text Using target directory | for

Help The remote directory where transferred files will be placed.

Message ID 23

Severity E

Text Missing targetdir parameter

Help A remote directory must be specified for storing transferred files.

Message ID 24

Severity I

Text Using response file | for

Help A response file as specified will be retrieved after a transfer

Message ID 25

Severity E

Text Missing responsein parameter

Help A response file name must be specified. This can include %FNAME% and %FTYPE% for filename and type



Message ID 26

Severity I

Text Using response directory | for

Help The response file will be retrieved from the specified remote directory.

Message ID 27

Severity E

Text Missing responsedir parameter

Help A remote directory where the response file will be found must be specified

Message ID 28

Severity I

Text Using maxtry | for

Help The maximum times a transfer will be attempted before considering as a Permanent failure.

Message ID 29

Severity I

Text Using global maxtry | for

Help Using the global maxtry value for this transfer.

Message ID 30

Severity I

Text Using waittime | for

Help The time between transfer attempts in seconds.

Message ID 31

Severity I

Text Using global waittime | for

Help Using the global waittime for this transfer.



Message ID 32

Severity I

Text Using initialwait | for

Help The initial wait time before attempting to retrieve a response file. This is intended to allow for processing time between sending a file and the output being created remotely.

Message ID 33

Severity I

Text Using global initialwait | for

Help The global initial waittime will be used for this transfer.

Message ID 34

Severity I

Text Looking for files

Help SFTPPlus is starting a directory scan.

Message ID 35

Severity I

Text Checking

Help SFTPPlus is checking for files for the specified transfer.

Message ID 36

Severity E

Text Unable to scan directory

Help SFTPPlus has failed to scan a directory - please check following messages for details.

Message ID 37

Severity I

Text pausing

Help SFTPPlus is waiting for further files.

Message ID 38

Severity S

Text sleep interrupted

Help SFTPPlus has received a signal and will shut down



Message ID 39

Severity S

Text unreachable code

Help Debugging information. If this message appears, please contact Technical Support.

Message ID 40

Severity I

Text Checking file size

Help Checking the size of a file before transfer, to ensure that it is not still being written to.

Message ID 41

Severity I

Text filesize | bytes

Help Report on the size of a file to be transferred

Message ID 42

Severity I

Text creating checksum

Help The md5sum hash of the file is being created

Message ID 43

Severity I

Text Sending file

Help The file is being sent

Message ID 44

Severity I

Text psftp returned

Help Return code from psftp

Message ID 45

Severity E

Text Secure ftp error - please see

Help An error has occurred in a transfer, and the indicated file will include more information.



Message ID 46

Severity I

Text File sent OK.

Help A transfer has completed

Message ID 47

Severity I

Text Adding response to queue

Help A response file will be retrieved at the appropriate time

Message ID 48

Severity I

Text Checking for response file for

Help An attempt to retrieve a response file is in progress

Message ID 49

Severity W

Text Failed to obtain response for

Help A response file has not been retrieved. This may indicate insufficient waittime.

Message ID 50

Severity I

Text Waiting | for response file for |, | attempts left

Help Information about the number of retries

Message ID 51

Severity I

Text Response file | for | transfer is available

Help A response file has been retrieved successfully

Message ID 52

Severity W

Text File Transfer message:

Help Report from a file transfer session.



Message ID 53

Severity I

Text Processing file | as

Help The original filename has had a timestamp added for uniqueness

Message ID 54

Severity I

Text Response received ok

Help A response file has been received

Message ID 55

Severity I

Text Preparing to send for

Help A file is being prepared for transfer

Message ID 56

Severity I

Text Waiting | to send file for |, | attempts left

Help Report on the number of retries for sending a file

Message ID 57

Severity I

Text Adding response to queue for

Help A response file transfer will be queued for later retrieval

Message ID 58

Severity E

Text Failed to send file for

Help transfer has failed - see following messages

Message ID 59

Severity E

Text Type | not supported, ignoring

Help An invalid transfer type has been specified, the transfer definition will not be used



Message ID 60

Severity E

Text Missing type parameter |, ignoring

Help No transfer type has been specified - the transfer definition will not be used

Message ID 61

Severity I

Text Transfer type | for

Help The specified transfer type will be used

Message ID 62

Severity I

Text md5sum will be sent for

Help The transfer will also include the md5sum file

Message ID 63

Severity I

Text md5sum will not be sent for

Help The transfer will not include the md5sum file

Message ID 64

Severity I

Text preprocess command for | is

Help The specified command will run before a transfer

Message ID 65

Severity I

Text no preprocess command for

Help There is no preprocess for a transfer

Message ID 66

Severity I

Text postprocess | command for | is:

Help The specified command will run after a transfer



Message ID 67

Severity I

Text no postprocess | command for

Help There is no postprocess for a transfer

Message ID 68

Severity I

Text Running | command for | ,

Help The specified command is being run

Message ID 69

Severity I

Text Command for | rc 0

Help The command had a return code of 0 (usually good)

Message ID 70

Severity W

Text Command for | rc

Help - The command had a return code other than 0 (usually bad)

Message ID 71

Severity I

Text Command for | stdout

Help The output for a command

Message ID 72

Severity W

Text Command for | stderr

Help The error messages for a command

Message ID 73

Severity S

Text Program interrupted, shutting down

Help An interrupt signal was received



Message ID 74

Severity S

Text SMTP Socket problem

Help A problem has occurred with a socket command for SMTP messaging. SMTP will be disabled

Message ID 75

Severity W

Text File still changing, postponing

Help A file in an inbox directory is still being updated, it will be retried later

Message ID 76

Severity I

Text Email messages for | will be sent to

Help The specified email address will receive messages related to this transfer

Message ID 77

Severity I

Text Email messages for | will be sent to default

Help The default global email address will receive messages related to this transfer

Message ID 78

Severity I

Text Failure writing file

Help A problem has occurred writing to a file. SFTPPlus will terminate

Message ID 79

Severity S

Text Failure reading file

Help A Problem has occurred reading from a file. SFTPPlus will terminate



Message ID 80

Severity I

Text md5sum will not be created for

Help No md5sum will be created for the transfer. This will reduce CPU load, but prevents use of the md5sum in the audit

Message ID 81

Severity I

Text Timestamp will not be used in the target filename

Help The target file name will not include the timestamp. This means that SFTPPlus will not be able to guarantee that files will not be overwritten

Message ID 82

Severity I

Text Timestamp will not be used in the local response filename

Help The local response file name will not include the timestamp. This means that SFTPPlus will not be able to guarantee that files will not be overwritten

Message ID 83

Severity I

Text Using remote directory | for

Help The remote directory where transfer files will be pulled from.

Message ID 84

Severity E

Text Missing remotedir parameter

Help A remote directory must be specified for pulling transfer files.

Message ID 85

Severity I

Text Using filename | for

Help The remote filename that will be pulled.



Message ID 86

Severity E

Text - Missing filename parameter (Needs to be changed to ‘remotefile’)

Help A remote filename must be specified for pulling.

Message ID 87

Severity I

Text Using starttime | for

Help The starttime for pulling the file



18 REX INTERPRETER ERROR MESSAGES

The processing engine of SFTPPlus Client is the Regina REXX interpreter. This section describes error codes that can be generated from the REXX interpreter. However, if you do receive these errors, please get in touch with Pro:Atria technical support (see chapter 18 for details). These error codes are listed here for your convenience and to allow us to help troubleshoot if you have problems.

18.1 REXX message convention

The error codes comprise of two values;

1. Error code number

2. Error description

18.2 REXX error codes

Error Code Number

Error description

1

2

3

4 Program Interrupt

5 Machine resources exhausted

6 Unmatched “/*” or quote

7 WHEN or OTHERWISE expected

8 Unexpected THEN or ELSE

9 Unexpected WHEN or OTHERWISE

10 Unexpected or unmatched END

11 Control stack full

12 Clause too long

13 Invalid character in program

14 Incomplete DO/SELECT/IF

15 Invalid hexadecimal or binary string

16 Label not found

17 Unexpected procedure

18 THEN expected

19 String or symbol expected

20 Symbol expected



Error Code Number

Error description

21 Invalid data on end of clause

22 Invalid character string

23 Invalid data string

24 Invalid TRACE request

25 Invalid sub-keyword found

26 Invalid whole number

27 Invalid DO syntax

28 Invalid LEAVE or ITERATE

29 Environment name too long, or not found

30 Name or string too long

31 Name starts with number or “.”

32

33 Invalid expression result

34 Logical value not 0 or 1

35 Invalid expression

36 Unmatched “(“ in expression

37 Unexpected “.” or “)”

38 Invalid template or pattern

39 Evaluation stack overflow (too many arguments)

40 Incorrect call to routine

41 Bad arithmetic conversion

42 Arithmetic overflow/underflow

43 Routine not found

44 Function did not return data

45 No data specified on function RETURN

46 Invalid variable reference

47

48 Failure in system service

49 Interpretation error

50



19 GLOBAL.CONF FILE PARAMETERS

This chapter provides a comprehensive list of parameters used in the global.conf file with additional information. These parameters control the behaviour of SFTPPlus Client whilst performing a transfer operation.

Section

Parameter

Default setting

Description/Notes

Message settings

global.message

Path statement to location of message.conf file. This parameter should not be changed unless your message.conf file is located than specified in the default path installation.

global.smtpaddress Your SMTP email address.

global.msghost

Your SMTP mail host. This can be either the IP address or the long format name e.g. mail.domain.co.uk

global.smtptimeout

‘60’ Response time in seconds for SFTPPLus to stop communications with SMTP server if no response is received.

global.msgport

‘25’ TCP/IP port number for communicating with SMTP server. This is normally TCP port 25.

global.msgfrom

The email address that will appear in the email “From” field.

Wait times global.maxtry

‘20’ Maximum number of attempts for SFTPPLus to try a file transfer.

global.waittime

‘10’ The maximum time in seconds to wait between file transfer retries.

global.initialwait

‘20’ The initial wait time in seconds before attempting to retrieve a response file. This is intended to allow for processing time between sending a file and the output being created remotely.

global.directoryscantime

‘10’ Time in seconds to allow directory scanning on the local machine.



20 TRANSFER CONF FILE PARAMETERS

This chapter provides a comprehensive list of parameters used in a conf file with additional information. These parameters control the behaviour of SFTPPlus Client whilst performing a transfer operation.

Rather than in alphabetical order, these parameters are in the order that you will encounter them in a conf file.

Parameter

Works with Put?

Works with Get?

Default setting

Description/Notes

subdir √ √ The name of the sub-directory under Inbox.

disabled √ √ ‘y’ Disable the transfer conf file. (All other values after this parameter in the conf file will be ignored).

filemask √ Restrict files by mask, e.g. ‘*.pdf’ for all PDF file.

deleteaftertransfer √ After transfer the original file is deleted (get or get of response file only).

runaftertransfer √(*) ‘’

Run a command after transfer. For example, to move a file from the upload directory to the directory ‘final’ use the format

runaftertransfer = ‘rename’ %file$ final/%file%

* Can only be used when direction = ‘put’ and type = ‘sftp’

type √ √

Determines the protocol for the transfer. Options are

- type = ‘sftp’ (ssh2 file transfer)

- type = ‘ftp’ (ftp plain )

- type = ‘ftps’ (ftp secure) – For implicit support contract Pro:Atria.

- type = ‘http’ (http plain)

- type = ‘https’ (http plain)

- type = ‘command’ (run a local command)

ftpsmode √ √ Specify ftpsmode = ‘implicit’. Only to be used when type = ‘ftps’ is specified and port = ‘990‘.

direction √ √ ‘put’

Direction of transfer, options are

- put (upload)

- get (download)



Parameter

Works with Put?

Works with Get?

Default setting

Description/Notes

server √ √ The name or IP address of the target server

port √ √ ‘22’

The TCP/IP port number. Default options are;

- 22 (sftp ssh2)

- 21 (plain ftp)

- 80 (http)

- 443 (https)

user √ √ Remote user ID.

password √ √ Remote password associated with the remote user ID.

cacert √ √

When this parameter is set, SFTPPlus will accept a security certificate non-interactively. The parameter value must be the location and name of either a public or private certificate.

savedprofile √ √

The profile saved with PuTTY (Only required when type = ‘sftp’). When not using a saved PuTTY profile (for sftp), this parameter must be set to;

savedprofile = ‘**NOT USED**’

remotedir √ Remote directory to get file from.

remotefile √ File to get.

targetdir √ Remote target directory.

forcelowercase √ √ Forces use of lowercase filenames on case-insensitive platforms such as Windows.

createmd5sum √ ‘y’ Create the local md5sum file.

sendmd5sum √ ‘n’ Send an md5sum file with the main file.

getmd5sum √ ‘n’ Get an md5sum from the remote system

targettimestamp √ √ ‘y’ Add timestamp to file name to ensure unique file name.

preprocess √ √ Specify a command to run before starting transfer.

response √ ‘n’ Enable a response file to be collected.

responsein √ Filename of the response file to be retrieved.

responsedir √

Directory name file will be retrieved from. Directory must have forward slash at the end e.g.

Responsedir = ‘results_download/’



Parameter

Works with Put?

Works with Get?

Default setting

Description/Notes

responsetimestamp √ ‘y’ Enable timestamp in response file name

postprocessresponsesuccess √ √ Command to run if a response ‘get’ succeeds

postprocessresponsefail √ √ Command to run if a response ‘get’ fails

postprocesssuccess √ √ Command to run after transfer succeeds.

postprocessfail √ √ Command to run after transfer fails. Use in conjunction with maxtry parameter.

runaftertransfer √ √ Run a local command from the FTP command set for after transfer processing.

maxtry √ √ Number of times a transfer will be attempted before failing.

waittime √ √ Number of seconds between attempted transfers. Use in conjunction with maxtry parameter.

initialwait √ √

The initial wait time in seconds before attempting to retrieve a response file. This is intended to allow for processing time between sending a file and the output being created remotely.

smtpaddress √ √ SMTP address for emails to be sent to.

starttime √

Time to start transfer, options are;

- hh:mm (at specified time)

- +hh:mm (at specified interval, e.g. +00:15 for fifteen minute intervals)

The value for this parameter must use the 24 hour clock format in the above specified mask layout.



21 PROTOCOL ERROR MESSAGES

These error codes are listed and described here for reference and your convenience. It may also help technical support at Pro:Atria to help diagnose issues that may arise.

21.1 SFTP Protocol error codes

Error Code

Error name Description

-1 SSH_ERROR_WRONG_MODE Attempt to call synchronous method in asynchronous mode and vice versa.

0 SSH_ERROR_OK Indicates successful completion of the operation

1 SSH_ERROR_EOF indicates end-of-file condition;

� Read: no more data is available in the file;

� ReadDirectory: no more files are contained in the directory.

2 SSH_ERROR_NO_SUCH_FILE A reference is made to a file which does not exist.

3 SSH_ERROR_PERMISSION_DENIED the authenticated user does not have sufficient permissions to perform the operation.

4 SSH_ERROR_FAILURE An error occurred for which there is no more specific error code defined.

5 SSH_ERROR_BAD_MESSAGE A badly formatted packet or protocol incompatibility is detected.

6 SSH_ERROR_NO_CONNECTION A pseudo-error which indicates that the client has no connection to the



Error Code


server.

7 SSH_ERROR_CONNECTION_LOST A pseudo-error which indicates that the connection to the server has been lost.

8 SSH_ERROR_OP_UNSUPPORTED An attempt was made to perform an operation which is not supported for the server.

9 SSH_ERROR_INVALID_HANDLE The handle value was invalid.

10 SSH_ERROR_NO_SUCH_PATH The file path does not exist or is invalid.

11 SSH_ERROR_FILE_ALREADY_EXISTS The file already exists.

12 SSH_ERROR_WRITE_PROTECT The file is on read only media, or the media is write protected.

13 SSH_ERROR_NO_MEDIA The requested operation can not be completed because there is no media available in the drive.

14 SSH_ERROR_NO_SPACE_ON_FILESYSTEM The requested operation cannot be completed because there is no free space on the filesystem.

15 SSH_ERROR_QUOTA_EXCEEDED The operation cannot be completed because it would exceed the user's storage quota.

16 SSH_ERROR_UNKNOWN_PRINCIPAL A principal referenced by the request (either the 'owner', 'group', or 'who' field of an ACL), was unknown.

17 SSH_ERROR_LOCK_CONFLICT The file could not be opened because it is locked by another process.



Error Code


18 SSH_ERROR_DIR_NOT_EMPTY The directory is not empty.

19 SSH_ERROR_NOT_A_DIRECTORY The specified file is not a directory.

20 SSH_ERROR_INVALID_FILENAME The filename is not valid.

21 SSH_ERROR_LINK_LOOP Too many symbolic links encountered.

22 SSH_ERROR_CANNOT_DELETE The file cannot be deleted. One possible reason is that the advisory READONLY attribute-bit is set.

23 SSH_ERROR_INVALID_PARAMETER On of the parameters was out of range, or the parameters specified cannot be used together.

24 SSH_ERROR_FILE_IS_A_DIRECTORY The specified file was a directory in a context where a directory cannot be used.

25 SSH_ERROR_BYTE_RANGE_LOCK_CONFLICT A read or write operation failed because another process's mandatory byte-range lock overlaps with the request.

26 SSH_ERROR_BYTE_RANGE_LOCK_REFUSED A request for a byte range lock was refused.

27 SSH_ERROR_DELETE_PENDING An operation was attempted on a file for which a delete operation is pending.

28 SSH_ERROR_FILE_CORRUPT The file is corrupt; an filesystem integrity check should be run.

29 SSH_ERROR_OWNER_INVALID The principal specified can not be



Error Code


assigned as an owner of a file.

30 SSH_ERROR_GROUP_INVALID The principal specified can not be assigned as the primary group of a file.

100 SSH_ERROR_UNSUPPORTED_VERSION Sets of supported by client and server versions has no intersection.

102 SSH_ERROR_INVALID_PACKET Invalid packet was received.

103 SSH_ERROR_CONNECTION_CLOSED Connection is closed.

21.2 FTP protocol error codes

Error Code Error name Description

100 Series - Positive Preliminary Reply (The user-process sending another command before the completion reply would be in violation of protocol; but server-FTP processes should queue any commands that arrive while a preceding command is in progress.) This type of reply can be used to indicate that the command was accepted and the user-process may now pay attention to the data connections, for implementations where simultaneous monitoring is difficult. The server-FTP process may send at most, one 1yz reply per command.

110 Restart marker reply. In this case, the text is exact and not left to the particular implementation; it must read: MARK yyyy = mmmm Where yyyy is User-process data stream marker, and mmmm server's equivalent marker (note the spaces between markers and "=").

120 Service ready in nnn minutes.

125 Data Connection already open, transfer starting.

150 File status okay, about to open data connection.

200 Series - Positive Completion reply The requested action has been successfully completed. A new request may be




initiated.

200 Command okay.

202 Command not implemented, superfluous at this site.

211 System status, or system help reply.

212 Directory status.

213 File status.

214 Help message. Help message on how to use the server or the meaning of a particular non-standard command. This reply is useful only to the human user.

215 NAME system type. NAME is an official system name from the list in the Assigned Numbers document.

220 Service ready for new user.

221 Service closing control connection. Logged out if appropriate.

225 Data connection open; no transfer in progress.

226 Closing data connection. Requested file action successful

For example; file transfer or file abort

227 Entering Passive Mode.

230 User logged in, proceed.

250 Requested file action okay, completed.

257 "PATHNAME" created.

300 Series - Positive Intermediate reply The command has been accepted, but the requested action is being held in abeyance, pending receipt of further information. The user should send another command specifying this information. This reply is used in command sequence groups

331 User name okay, need password.

332 Need account for login.

350 Requested file action pending further information.




400 Series - Transient Negative Completion reply The command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. The user should return to the beginning of the command sequence, if any. It is difficult to assign a meaning to "transient", particularly when two distinct sites (Server- and User-processes) have to agree on the interpretation. Each reply in the 4yz category might have a slightly different time value, but the intent is that the user-process is encouraged to try again. A rule of thumb in determining if a reply fits into the 4yz or the 5yz (Permanent Negative) category is that replies are 4yz if the commands can be repeated without any change in command form or in properties of the User or Server (e.g., the command is spelled the same with the same arguments used; the user does not change his file access or user name; the server does not put up a new implementation.)

421 Service not available, closing control connection.

This may be a reply to any command if the service knows it must shut down. This error may be due to service not available, closing control connection, user limit reached, or you are not authorized to make the connection, or the maximum number of connections have been exceeded.

425 Can't open data connection.

426 Connection closed; transfer aborted.

The command opens a data connection to perform an action, but that action is canceled, and the data connection is closed.

450 Requested file action not taken. File unavailable (e.g., file busy).

451 Requested action aborted: local error in processing.

452 Requested action not taken. Insufficient storage space in system.

500 Series - Permanent Negative Completion reply The command was not accepted and the requested action did not take place. The User-process is discouraged from repeating the exact request (in the same sequence). Even some "permanent" error conditions can be corrected, so the human user may want to direct his user-process to reinitiate the command sequence by direct action at some point in the future (e.g., after the spelling has been changed, or the user has altered his directory status.)

501 Syntax error in parameters or arguments.

This may include errors such as command line too long.




502 Command not implemented. The server does not support this command.

503 Bad sequence of commands.

504 Command not implemented for that parameter.

530 Not logged in.

532 Need account for storing files.

550 Requested action not taken. File unavailable

For example, file not found, no access.

552 Requested file action aborted. Exceeded storage allocation (for current directory or dataset).

553 Requested action not taken. File name not allowed.

21.3 FTPS protocol error codes


100 Series - Positive Preliminary Reply (The user-process sending another command before the completion reply would be in violation of protocol; but server-FTP processes should queue any commands that arrive while a preceding command is in progress.) This type of reply can be used to indicate that the command was accepted and the user-process may now pay attention to the data connections, for implementations where simultaneous monitoring is difficult. The server-FTP process may send at most, one 1yz reply per command.

110 Restart marker reply. In this case, the text is exact and not left to the particular implementation; it must read: MARK yyyy = mmmm Where yyyy is User-process data stream marker, and mmmm server's equivalent marker (note the spaces between markers and "=").

120 Service ready in nnn minutes.

125 Data Connection already open, transfer starting.

150 File status okay, about to open data connection.




200 Series - Positive Completion reply The requested action has been successfully completed. A new request may be initiated.

200 Command okay.

202 Command not implemented, superfluous at this site.

211 System status, or system help reply.

212 Directory status.

213 File status.

214 Help message. Help message on how to use the server or the meaning of a particular non-standard command. This reply is useful only to the human user.

215 NAME system type. NAME is an official system name from the list in the Assigned Numbers document.

220 Service ready for new user.

221 Service closing control connection. Logged out if appropriate.

225 Data connection open; no transfer in progress.

226 Closing data connection. Requested file action successful

For example; file transfer or file abort

227 Entering Passive Mode.

230 User logged in, proceed.

235 Security data exchange has completed successfully

The security data exchange has completed successfully and does not require additional data.

250 Requested file action okay, completed.

257 "PATHNAME" created.

300 Series - Positive Intermediate reply The command has been accepted, but the requested action is being held in abeyance, pending receipt of further information. The user should send another command specifying this information. This reply is used in command sequence groups

331 User name okay, need




password.

332 Need account for login.

335 Server requires additional security data

The server has accepted the security data, and requires additional data.

350 Requested file action pending further information.

400 Series - Transient Negative Completion reply The command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. The user should return to the beginning of the command sequence, if any. It is difficult to assign a meaning to "transient", particularly when two distinct sites (Server- and User-processes) have to agree on the interpretation. Each reply in the 4yz category might have a slightly different time value, but the intent is that the user-process is encouraged to try again. A rule of thumb in determining if a reply fits into the 4yz or the 5yz (Permanent Negative) category is that replies are 4yz if the commands can be repeated without any change in command form or in properties of the User or Server (e.g., the command is spelled the same with the same arguments used; the user does not change his file access or user name; the server does not put up a new implementation.)

421 Service not available, closing control connection.

This may be a reply to any command if the service knows it must shut down. This error may be due to service not available, closing control connection, user limit reached, or you are not authorized to make the connection, or the maximum number of connections have been exceeded.

425 Can't open data connection.

426 Connection closed; transfer aborted.

The command opens a data connection to perform an action, but that action is canceled, and the data connection is closed.

450 Requested file action not taken. File unavailable (e.g., file busy).

451 Requested action aborted: local error in processing.

452 Requested action not taken. Insufficient storage space in system.

500 Series - Permanent Negative Completion reply




The command was not accepted and the requested action did not take place. The User-process is discouraged from repeating the exact request (in the same sequence). Even some "permanent" error conditions can be corrected, so the human user may want to direct his user-process to reinitiate the command sequence by direct action at some point in the future (e.g., after the spelling has been changed, or the user has altered his directory status.)

501 Syntax error in parameters or arguments.

This may include errors such as command line too long.

502 Command not implemented. The server does not support this command.

503 Bad sequence of commands.

504 Command not implemented for that parameter.

530 Not logged in.

532 Need account for storing files.

535 Security data rejected Security data rejected, for example failed checksum.

550 Requested action not taken. File unavailable

For example, file not found, no access.

552 Requested file action aborted. Exceeded storage allocation (for current directory or dataset).

553 Requested action not taken. File name not allowed.

21.4 SCP protocol error codes


Host does not exist You may get this message when connecting to a server for following reasons:

• You may have typed a wrong hostname on login dialog (if using WinSCP) or defined an incorrect host in a transfer definition file.

• Your domain name is new and




is not fully distributed to DNS servers yet.

• Connection was blocked by firewall. For local firewalls, particularly the one included in Windows XP SP2, note that the firewalls may not only block the port, but also a particular program (in our case, WinSCP).

Connection has been unexpectedly closed. Server sent command exit status 11

Status 11 is reported by OpenSSH SFTP server, when it encounters corrupted SFTP packet or packet larger than 256 kB. Some versions of WinSCP can eventually send such a large packet. Version 3.7.6 solves the issue.

Received too large (???B) SFTPpacket. .Max supported packet size is 102400B

If ??? (from the subject) is a very large number then the problem is typically caused by a message printed from some profile/logon script. It violates the SFTP protocol. Some of these scripts are executed even for non-interactive (no TTY) sessions, so they cannot print anything (nor ask user to type something).

The number ??? represents the first four bytes read from the server. If your login scripts are printing words, this will be the first four characters cast into a number, and not an SFTP message at all.

To fix the problem find out what command in your login script prints text. Once you find it move the command to the proper interactive script, or remove it entirely. The scripts are usually hidden (their name starts with dot) and are located in your home directory on the server.

There are other possible sources of the message in addition to the profile script - some SSH servers print messages if they are unable to start the SFTP




server, or encounter a fatal error. You should contact your server administrator.

Another possibility is that the server is configured to only allow the SCP protocol and not the SFTP protocol, in such a way that SCP fallback mechanism of WinSCP does not work. The solution is to choose SCP protocol on the login dialog.

Invalid access to memory This error message is not very useful to you as an end-user. It generally means that there is a bug in the SCP software.

21.5 HTTP 1.1 protocol error codes


1xx – Informational

This class of status code indicates a provisional response, consisting only of the Status-Line and optional headers, and is terminated by an empty line. There are no required headers for this class of status code. Since HTTP/1.0 did not define any 1xx status codes, servers MUST NOT send a 1xx response to an HTTP/1.0 client except under experimental conditions.

A client MUST be prepared to accept one or more 1xx status responses prior to a regular response, even if the client does not expect a 100 (Continue) status message. Unexpected 1xx status responses MAY be ignored by a user agent.

Proxies MUST forward 1xx responses, unless the connection between the proxy and its client has been closed, or unless the proxy itself requested the generation of the 1xx response.

100 Continue The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response.

101 Switching protocols The server understands and is willing to comply with the client's request, via the Upgrade message header field, for




a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response.

2xx – Successful

This class of status code indicates that the client's request was successfully received, understood, and accepted.

200 OK The request has succeeded. The information returned with the response is dependent on the method used in the request, for example:

GET an entity corresponding to the requested resource is sent in the response;

HEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body;

POST an entity describing or containing the result of the action;

TRACE an entity containing the request message as received by the end server.

201 Created The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media




type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code.

202 Accepted The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this.

The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled.

203 Non-authoritative information The returned meta information in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. The set presented MAY be a subset or superset of the original version. For example, including local annotation information about the resource might result in a superset of the meta information known by the origin server. Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK).

204 No content The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta information. The response MAY




include new or updated meta information in the form of entity-headers, which if present SHOULD be associated with the requested variant.

If the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated meta information SHOULD be applied to the document currently in the user agent's active view.

The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields.

205 Reset content The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent. This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action.

206 Partial content The server has fulfilled the partial GET request for the resource. The request MUST have included a Range header field indicating the desired range, and MAY have included an If-Range header field to make the request conditional.

The response MUST include the following header fields:

- Either a Content-Range header field (section 14.16) indicating the range included with this response, or a multipart/byteranges Content-Type including Content-Range fields for each part. If a Content-Length header




field is present in the response, its

value MUST match the actual number of OCTETs transmitted in the message-body.

- Date

- ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request

- Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant

If the 206 response is the result of an If-Range request that used a strong cache validator, the response SHOULD NOT include other entity-headers. If the response is the result of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST include all of the entity-headers that would have been returned with a 200 (OK) response to the same request.

3xx – Redirectional

This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request. The action required MAY be carried out by the user agent without interaction with the user if and only if the method used in the second request is GET or HEAD. A client SHOULD detect infinite redirection loops, since such loops generate network traffic for each redirection.

300 Multiple choices The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location.

Unless it was a HEAD request, the response SHOULD include an entity




containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content- Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

If the server has a preferred choice of representation, it SHOULD include the specific URI for that representation in the Location field; user agents MAY use the Location field value for automatic redirection. This response is cacheable unless indicated otherwise.

301 Moved permanently The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise.

The new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.




Note: When automatically redirecting a POST request after receiving a 301 status code, some existing HTTP/1.0 user agents will erroneously change it into a GET request.

302 Found The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).


Note: RFC 1945 and RFC 2068 specify that the client is not allowed to change the method on the redirected request. However, most existing user agent implementations treat 302 as if it were a 303 response, performing a GET on the Location field-value regardless

of the original request method. The status codes 303 and 307 have been added for servers that wish to make unambiguously clear which kind of reaction is expected of the client.

303 See other The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference




for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable.

The different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

Note: Many pre-HTTP/1.1 user agents do not understand the 303 status. When interoperability with such clients is a concern, the 302 status code may be used instead, since most user agents react to a 302 response as described here for 303.

304 Not modified If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.

The response MUST include the following header fields:

- Date, unless its omission is required

If a clock-less origin server obeys these rules, and proxies and clients add their own Date to any response received without one (as specified by RFC 2068), caches will operate correctly.

- ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request

- Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant

If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other




entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers.

If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response and repeat the request without the conditional.

If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response.

305 Use proxy The requested resource MUST be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy. 305 responses MUST only be generated by origin servers.

306 (Unused) The 306 status code was used in a previous version of the specification, is no longer used, and the code is reserved.

307 Temporary redirect The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore,




the note SHOULD contain the information necessary for a user to repeat the original request on the new URI.


4xx – Client error

The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. These status codes are applicable to any request method. User agents SHOULD display any included entity to the user.

If the client is sending data, a server implementation using TCP SHOULD be careful to ensure that the client acknowledges receipt of the packet(s) containing the response, before the server closes the input connection. If the client continues sending data to the server after the close, the server's TCP stack will send a reset packet to the client, which may erase the client's unacknowledged input buffers before they can be read and interpreted by the HTTP application.

400 Bad request The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Unauthorized The request requires user authentication. The response MUST include a WWW-Authenticate header field containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity




that was given in the response, since that entity might include relevant diagnostic information.

402 Payment required Reserved for future use

403 Forbidden The server understood the request, but is refusing to fulfil it. Authorisation will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.

404 Not found The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

405 Method not allowed The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource.

406 Not acceptable The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from




which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable.

If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions.

407 Proxy authentication required This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy MUST return a Proxy-Authenticate header field containing a challenge applicable to the proxy for the requested resource. The client MAY repeat the request with a suitable Proxy-Authorization header field.

408 Request timeout The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.

409 Conflict The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD




include enough information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.

Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type.

410 Gone The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise.

The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the




discretion of the server owner.

411 Length required The server refuses to accept the request without a defined Content- Length. The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message-body in the request message.

412 Precondition failed The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. This response code allows the client to place preconditions on the current resource meta information (header field data) and thus prevent the requested method from being applied to a resource other than the one intended.

413 Request entity too large The server is refusing to process a request because the request entity is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request.

If the condition is temporary, the server SHOULD include a Retry- After header field to indicate that it is temporary and after what time the client MAY try again.

414 Request-URI too long The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a URI "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself), or when the server is under attack by a client attempting to exploit security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI.

415 Unsupported Media Type The server is refusing to service the request because the entity of the




request is in a format not supported by the requested resource for the requested method.

416 Requested range not satisfiable

A server SHOULD return a response with this status code if a request included a Range request-header field, and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first- byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.)

When this status code is returned for a byte-range request, the response SHOULD include a Content-Range entity-header field specifying the current length of the selected resource

417 Expectation failed The expectation given in an Expect request-header field could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server.

5xx – Server error

Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. User agents SHOULD display any included entity to the user. These response codes are applicable to any request method.

500 Internal Server error The server encountered an unexpected condition which prevented it from fulfilling the request.

501 Not implemented The server does not support the functionality required to fulfil the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.




502 Bad gateway The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfil the request.

503 Service unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.

Note: The existence of the 503 status code does not imply that a server must use it when becoming overloaded. Some servers may simply refuse the connection.

504 Gateway timeout The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.

Note: Some deployed proxies are known to return 400 or 500 when DNS lookups time out.

505 HTTP version not supported The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, other than with this error message. The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server.



22 REFERENCES

There are other documents available to help you with the trial or usage of the SFTPPlus Client product. These documents may also be referenced within this document for further information.

SFTPPlus Client 1.2 Installation Guide for AS/400

SFTPPlus Client 1.2 Installation Guide for OS/390

SFTPPlus Client 1.2 Installation Guide for Linux+Unix

SFTPPlus Client 1.2 Installation Guide for Windows

PuTTY User Manual version 0.58

Also available;

SFTPPlus v1.2 – Features and Benefits

For the most up-to-date list of documents, please see our website www.proatria.com



23 CONTACT INFORMATION

Address

Pro:Atria Limited

The Old Exchange

South Cadbury

Yeovil

Somerset

BA22 7ET UK

Telephone/Fax

Tel: +44 (0)1963 441311

Fax: +44 (0)1963 441312

Email

Sales:

Technical Support:

[email protected]

[email protected]

Website

http://www.proatria.com

Documentation

If you have any comments or suggestions regarding this or any other Pro:Atria document, please send an email to the following address ;

[email protected]

Date post:	19-May-2018
Category:	Documents
Upload:	phungquynh
View:	230 times
Download:	2 times

SFTPPlus Client 1.2 User Manual - proatria.com Client 1.2 User... · 21.2 FTP PROTOCOL ERROR CODES...

Documents