sftp_codes » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
sftp_codes 2014-10-01 | sftp_codes 2023-02-16 (current) | ||
Line 1: | Line 1: | ||
====== SFTP Status/Error Codes ====== | ====== SFTP Status/Error Codes ====== | ||
- | SFTP status/error codes are numerical codes that SFTP server ((Exception are codes ''6'' and ''7'' that intended to by used by client. But WinSCP never uses these.)) uses to indicate result of client request (i.e. request sent by WinSCP to the server). | + | SFTP status/error codes are a numerical codes that an %%SFTP%% server ((Exception are codes ''6'' and ''7'' that intended to by used by client. But WinSCP never uses these.)) uses to indicate a result of a client request (i.e. a request sent by WinSCP to the server). |
- | WinSCP translates the numerical codes to textual description for you, so you do not have to know them. | + | WinSCP translates the numerical codes to a textual description for you, so you do not have to remember them. |
- | The SFTP server should also provide meaningful textual description of the error itself. WinSCP includes the server-side description in its error message, labeled "Error message from server". Such description can include more detailed information than WinSCP can possibly deduce from the numerical code. | + | The %%SFTP%% server should also provide a meaningful textual description of the error itself. WinSCP includes the server-side description in its error message, labeled "Error message from server". Such description can include more detailed information than WinSCP can possibly deduce from the numerical code. |
===== [[code_4]] Code 4 (Failure) ===== | ===== [[code_4]] Code 4 (Failure) ===== | ||
- | Note that not all servers use all codes. Most SSH/SFTP servers, including the most commonly used OpenSSH, support only SFTP version 3 that defines only codes ''0'' to ''8''. | + | Note that not all servers use all codes. Most SSH/SFTP servers, including the most commonly used OpenSSH, support only %%SFTP%% version 3 that defines only codes ''0'' to ''8''. |
- | These servers would generally use code ''4'' (Failure) for many errors for which there is specific code defined in later versions of SFTP protocol, such as: | + | These servers would generally use code ''4'' (Failure) for many errors for which there is a specific code defined in the later versions of %%SFTP%% protocol, such as: |
- | * Renaming file to name of already existing file. | + | * Renaming a file to a name of already existing file. |
- | * Creating directory that already exists. | + | * Creating a directory that already exists. |
- | * Moving remote file to different filesystem (HDD). | + | * Moving a remote file to a different filesystem (HDD). |
- | * Uploading file to full filesystem (HDD). | + | * Uploading a file to a full filesystem (%%HDD%%). |
- | * Exceeding user disk quota. | + | * Exceeding a user disk quota. |
- | In this case the server is required to provide meaningful description of the error itself (see above). Unfortunately, OpenSSH SFTP server uses always description "Failure". Is such case, there is unfortunately no way to tell a reason of the failure. | + | In this case the server is required to provide meaningful description of the error itself (see above). Unfortunately, OpenSSH SFTP server uses always description //"Failure"//. Is such case, there is unfortunately no way to tell a reason of the failure. |
- | ===== Codes List ===== | + | ===== [[list]] Codes List ===== |
^ Code ^ Name ^ Description ^ Comment ^ | ^ Code ^ Name ^ Description ^ Comment ^ | ||
| ''0'' | OK | Indicates successful completion of the operation. | | | | ''0'' | OK | Indicates successful completion of the operation. | | | ||
Line 25: | Line 25: | ||
| ''2'' | No such file | A reference was made to a file which does not exist. | | | | ''2'' | No such file | A reference was made to a file which does not exist. | | | ||
| ''3'' | Permission denied | The user does not have sufficient permissions to perform the operation. | | | | ''3'' | Permission denied | The user does not have sufficient permissions to perform the operation. | | | ||
- | | ''4'' | Failure | An error occurred, but no specific error code exists to describe the failure. This error message should always have meaningful text in the the //error message// field. | See [[#code_4|above]]. | | + | | ''4'' | Failure | An error occurred, but no specific error code exists to describe the failure. This error message should always have meaningful text in the //error message// field. | See [[#code_4|above]]. | |
| ''5'' | Bad message | A badly formatted packet or other SFTP protocol incompatibility was detected. | | | | ''5'' | Bad message | A badly formatted packet or other SFTP protocol incompatibility was detected. | | | ||
| ''6'' | No connection | There is no connection to the server. This error may be used locally, but must not be return by a server. | WinSCP does not use the code. | | | ''6'' | No connection | There is no connection to the server. This error may be used locally, but must not be return by a server. | WinSCP does not use the code. | | ||
Line 46: | Line 46: | ||
| ''23'' | Invalid parameter | One of the parameters was out of range, or the parameters specified cannot be used together. | | | | ''23'' | Invalid parameter | One of the parameters was out of range, or the parameters specified cannot be used together. | | | ||
| ''24'' | File is a directory | The specified file was a directory in a context where a directory cannot be used. | | | | ''24'' | File is a directory | The specified file was a directory in a context where a directory cannot be used. | | | ||
- | | ''25'' | Range lock conflict | An read or write operation failed because another process's mandatory byte-range lock overlaps with the request. | WinSCP does not use byte range locking. | | + | | ''25'' | Range lock conflict | A read or write operation failed because another process's mandatory byte-range lock overlaps with the request. | WinSCP does not use byte range locking. | |
| ''26'' | Range lock refused | A request for a byte range lock was refused. | WinSCP does not use byte range locking. | | | ''26'' | Range lock refused | A request for a byte range lock was refused. | WinSCP does not use byte range locking. | | ||
| ''27'' | Delete pending | An operation was attempted on a file for which a delete operation is pending. | | | | ''27'' | Delete pending | An operation was attempted on a file for which a delete operation is pending. | | | ||
Line 55: | Line 55: | ||
===== References ===== | ===== References ===== | ||
- | * //[[http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-9.1|Status response]]// section of ''draft-ietf-secsh-filexfer-13''; | + | * //[[https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-13#section-9.1|Status response]]// section of ''draft-ietf-secsh-filexfer-13''; |
* SFTP specifications list in "History and development" section of [[wp>SSH_File_Transfer_Protocol|SSH File Transfer Protocol]]. | * SFTP specifications list in "History and development" section of [[wp>SSH_File_Transfer_Protocol|SSH File Transfer Protocol]]. |