FTP Server Monitoring
 | File Transfer Protocol (FTP) is a standard network protocol used to copy a file from one host to another over a TCP/IP-based network, such as the Internet. Secure File Transfer Protocol (SFTP) is a related protocol which uses a more reliable encryption method than FTP. |
FTP server monitor provides server operability testing by checking server status and reading attributes of a remote file using the FTP protocol.
SFTP Get and Put functions allow files to be uploaded to, and downloaded from, the remote server via SFTP.
Synchronization Details
FTP monitoring configuration settings are described in FTP Service Settings subsection.
The following operations are performed during synchronization:
Connection to the FTP server is established.
Authentication procedure is passed.
Server status information is obtained and saved in monitoring results.
File is located using path specified in parameters.
File timestamp (which is usually its last modification time) and size (in bytes) attributes are obtained.
Disconnection is performed.
All these operations should be successfully finished to make the service Online. Server status and file information are stored as monitoring results.
If any of the operations fails the server is deemed Offline. Error encountered during synchronization is saved in the monitoring results.
 | Note that a path specified in service configuration should refer to a regular file (i.e. not point to a directory or include wildcard characters). If monitor is unable to find the file using specified path the FTP service is deemed Offline. |
Operations
FTP Get
Get file from the remote computer.
Format of the function input parameters has the following fields:
Name | Type | Description |
Port | Integer | Port number the FTP server is running on. |
Username | String | User name to use for authentication. |
Password | String | Password to use for authentication. |
Mode | Boolean | FTP mode to use: Active or Passive (default). |
Path | String | Path of file or folder to be monitored (optional). |
File Encoding | String | Defines the encoding of the file content. |
Timeout | Long | FTP server operations timeout. |
| Network Host Device address is used as FTP server address. |
Format of the function output parameters has the following fields:
Name | Type | Description |
Successful | Boolean | True is operation was successfully executed. |
Error | String | Text of error message if some error occurred while operation executing. |
Result | Data Block | Requested file from the remote computer. |
FTP List
Lists files of the remotely connected computer.
Format of the function input parameters has the following fields:
Name | Type | Description |
Port | Integer | Port number the FTP server is running on. |
Username | String | User name to use for authentication. |
Password | String | Password to use for authentication. |
Mode | Boolean | FTP mode to use: Active or Passive (default). |
Path | String | Path of file or folder to be monitored (optional). |
File Encoding | String | Defines the encoding of the file content. |
Timeout | Long | FTP server operations timeout. |
| Network Host Device address is used as FTP server address. |
Format of the function output parameters has the following fields:
Name | Type | Description |
Successful | Boolean | True is operation was successfully executed. |
Error | String | Text of error message if some error occurred while operation executing. |
Result | Data Table | Requested list of files from the remote computer. |
SFTP Get
Get file from the remote computer.
Format of the function input parameters has the following fields:
Name | Type | Description |
Path | String | Path to file on the remote computer, including file name. |
Format of the function output parameters has the following fields:
Name | Type | Description |
Successful | Boolean | True if operation was successfully executed. |
Error | String | Text of error message if some error occurred while operation was executed. |
File | Data Block | Requested file from the remote computer. |
SFTP Put
Get file from the remote computer.
Format of the function input parameters has the following fields:
Name | Type | Description |
File Path | String | Path, including filename, to target location where file should be created on the remote computer |
File | Data Block | Requested file from the remote computer. |
Format of the function output parameters has the following fields:
Name | Type | Description |
Successful | Boolean | True if operation was successfully executed. |
Error | String | Text of error message if some error occurred while operation was executed. |
Was this page helpful?