Agents Administration - Tests
 

Configuration of SftpTest

This test emulates a user connecting to an SFTP server (on Windows/Unix) and performing an operation on the server. The operation may either be a GET or a PUT. For the specified operation, this test measures the availability of the SFTP server and its response time.

The default parameters associated with this test are as follows:

  • The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

  • Specify the hostname (or IP address) of the SFTP server in the HOST text box.

  • Specify the port number on which the SFTP server is listening in the PORT text box.

  • Provide the user name used for connecting to the SFTP server in the USER text box.

  • Provide the password corresponding to the user in the PASSWORD text box.

  • Confirm the PASSWORD by retyping it in the CONFIRM PASSWORD text box.

  • In the REMOTEFILE text box, provide the remote file that is downloaded in the case of GET operation; In the case of a PUT operation, the remote file represents the file to which data is uploaded. This value can be none in the case of a PUT operation.

  • The REMOTE FOLDER indicates the remote SFTP folder where the specified REMOTEFILE exists. For example, this can be / or /sftpRoot or /mysftpFolder, in the case of a GET operation. In the case of a PUT operation, the REMOTE FOLDER represents the remote destination folder.

  • Specify the local folder that is written to in the case of a GET operation in the LOCAL text box. In the case of a PUT operation, this string represents the name of the file that is uploaded to the SFTP server. If this value is “none”, then the test will write the downloaded data to the eG agent's logs folder.

  • Select the command that is to be executed by the test i.e., whether GET or PUT using the CMD flag.

  • Speicfy the maximum time (in seconds) that the client will wait for a response from the SFTP server in the TIMEOUT text box.

  • If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

  • Once the necessary values have been provided, clicking on the Update button will register the changes made.

When changing the configuration for specific servers, a "*" beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a "$" or contain a series of "*". A value of "none" in the parameter value indicates that the corresponding parameter value can be changed if required.