SFTP Watch Type

From WebWatchBotWiki
Jump to: navigation, search
 Share 

Summary

This watch type allows monitoring of a SFTP server to ensure that connections can be successfully established, to monitor Response Time, and to verify transactions between WebWatchBot and the SFTP server. The results are analyzed by WebWatchBot. This watch type does not delete files on the local machine or on the remote server.


Functionality

  • Reports response time for entire SFTP transaction.
  • Log-in to SFTP server.
  • Logs complete communication and SFTP commands executed.
  • Reports SFTP status codes and most importantly failures.
  • Support host key (fingerprint) validation, and capture & storage of host key.
  • Supports the ability to save entire transaction to disk or log file.
  • Supports the ability to upload a file.
  • Supports the ability to download a file.


Why Use this Watch Type?

The SFTP Watch Type is the SSH-enabled equivalent of the FTP Watch Type. The main difference are the fields that assist with SSH security. The SFTP Watch Type implements a standard SSH File Transfer client.

The SFTP Watch Type is often used to determine if a SFTP server is available for connections and available to complete a transaction. The two measurements are Response Time - the amount of time that it takes to connect and the amount of time to complete a transaction, file upload completion and file download completion. An increase in Response Time may indicate network congestion or an overall increase in customer use of the SFTP server. Failure in the content verification may indicate an error in configuration or a network problem.

WebWatchBot can upload a file to the SFTP server, and optionally download the same file or a different file to serve as a complete end to end test.


What to monitor

sftp-settings.gif

Fields and Buttons

Account Information

Username - Sets the SFTP username for login. Though the UI shows this field as required, it may be optional for some SFTP servers.

Password - Sets the SFTP password for login. This is a required field if the username field is not blank.

Fingerprint - Optional

Fingerprint - Sets the MD5 hash host key (SSH key), in the hex-encoded form: "f1:2c:3d:4e(...)". The full binary text of the key is in the same format used internally by SSH. NOTE: WebWatchBot supports RSA and DSA algorithms for the MD5 fingerprint, connects, and compares the server fingerprint with the fingerprint stored in this field. It supports a key size of 1024 to 4096 bytes. ECDSA algorithm is not supported.

Capture and save after connect - When checked, on the next connection the server's fingerprint is automatically accepted and saved in the fingerprint field. This is useful if you know and trust the SFTP server and do not want or need to enter the fingerprint manually.

File to Upload - Optional

Local Filename - a fully qualified pathname of a file to upload, e.g. c:\my documents\testfile.txt.

Remote Filename - a fully qualified pathname for the uploaded file. When the file is uploaded it will be placed in the directory specified, and named the specified filename, e.g. /uploadarea/myfiles/testfile.txt. This filename can be different than the local filename, e.g. /uploadarea/myfiles/file1.txt.

File to Download - Optional

If a file to upload is specified and a file to download is specified, the upload will occur first, then the download will occur. This allows a complete end-to-end test to be performed.

Local Filename - a fully qualified pathname for the downloaded file. When the file is downloaded it will be placed in the directory specified, and named the specified filename, e.g. c:\my documents\downloadedfile.txt. This filename can be different than the remote filename, e.g. c:\my documents\file2.txt

Remote Filename - a fully qualified pathname of a file to download, e.g. \downloads\testfile.zip

Test

The current settings will be used to run a test on the watch item but will not affect the overall success. By clicking this button, the "Test Watch Item" dialog box will appear.