SFTP Polling Listener Properties

When creating or viewing details about an SFTP Polling Listener, the SFTP Polling Listener Properties appear. This dialog lets you retrieve messages from an external SFTP server for processing on the .
gateway94
When creating or viewing details about an SFTP Polling Listener, the SFTP Polling Listener Properties appear. This dialog lets you retrieve messages from an external SFTP server for processing on the
Layer7 API Gateway
.
You can add a list of fingerprints and validate the server's host key against multiple fingerprints.
To access the properties for an SFTP polling listener
:
  1. Run the Manage SFTP Polling Listeners task.
  2. Select an SFTP polling listener from the list and then click [Properties]. You can also click [
    Create
    ] to enter the properties for a new listener.
    The SFTP Polling Listener Properties appear. This dialog organizes the service properties across these tabs: Connection, Message Processing, and Advanced.
The various configuration tabs are as follows:
Configuring the [Connection] Tab
Configure the [
Connection
] tab as follows:
Setting
Description
Name
Enter the name of the SFTP polling listener. If you are creating several listeners, make sure the name is descriptive.
Enabled
Select this check box to enable the listener. Clear this check box to deactivate or disable the listener.  Deactivating a listener is an alternative to removing it.
Hostname
Enter the hostname of the remote SFTP server.
Port
Enter the port number to monitor. The default is 22.
Validate Server's Host Key
Select this check box to validate the server's SSH public key against a list of fingerprints that you will specify using the [
Manage Host Key
] button. At least one match must be available, else it throws a connection error.
This checkbox is selected by default.
Clear this check box to not validate the server's host key.
Manage Host Key
This button is available only when you are validating the server's host key. It is used to enter the fingerprints against which the host key is validated. You can enter multiple fingerprints, each fingerprint in a new line as shown below:
b9:ac:0c:3d:bb:07:a8:a3:cc:eb:d7:f8:c4:89:b1:27
b7:ac:0c:3d:bz:07:a8:a5:cc:eb:d7:f2:c4:89:b1:22
Complete the following:
  • SSH Public Key Fingerprint
    : Paste the SSH public key fingerprint(s) as retrieved from the remote server's public key location.
  • [
    Load from File
    ]: Click this to load the fingerprint from a text file.
Username
Enter the account name to access the SFTP server.
Specify a user with limited access rights (for example, create a new listener called "ssgpoll"). Do not use the root user. The polling listener appends the suffix ".processed" to each file that is processed. Using the root user could cause system files to be renamed, rendering the
Layer7 API Gateway
and the host machine inoperable.
Password
If authenticating via password, choose the password from the drop-down list.
If the password you require is not listed, click [
Manage Stored Passwords
] to add it to the
Layer7 API Gateway
password storage. For more information, see Manage Stored Passwords.
You cannot type the password directly here; it must be defined in the
Layer7 API Gateway
secure password storage.
Private Key
If authenticating via private key, choose the key to use.
If the key you require is not listed, click [
Manage Stored Passwords
] to add it to the
Layer7 API Gateway
password storage. For more information, see Manage Stored Passwords.
Security Zone
Optionally choose a security zone. To remove this entity from a security zone (security role permitting), choose "No security zone".
For more information about security zones, see Understanding Security Zones.
This control is hidden if either: (a) no security zones have been defined, or (b) you do not have Read access to any security zone (regardless of whether you have Read access to entities inside the zones).
Configuring the [Message Processing] Tab
Configure the [
Message Processing
] tab as follows:
Setting
Description
Message Input
Directory to Scan
Specify the directory to poll. It is recommended that a directory be created specifically for polling purposes. This directory must already exist.
(1) The user specified in the [
Connection
] tab must have read and write access for this directory. (2) Specifying the root directory ("/") is not recommended and a warning will be displayed when you save the SFTP polling listener.
Filter File by Name
Select this check box to filter files to be processed by name. Clear this check box to process all files.
Enter the file name in the adjacent text box. You may use regular expressions such as "test\d+\.xml".
Message Content-Type
Choose the Content-Type to use from the drop-down list. If the Content-Type you need isn't listed, type it directly into the drop-down list.
Polling Interval (in seconds)
Indicate the polling interval, in seconds. The listener will check for messages after the specified number of seconds.
Options
Delete Processed Messages
Select this check box to delete the request file from the SFTP server once the message is processed.
Clear this check box to leave the processed messages on the SFTP server. These messages will have the suffix ".processed".
Enable Responses
Select this check box to configure the listener to return
Layer7 API Gateway
responses. A response message will be saved to the SFTP server with the same name as the file that was processed with a suffix of ".response".
Clear this check box to not create response files.
If there is a file of the same name already, the
Layer7 API Gateway
will try to overwrite the contents of that files. If the
Layer7 API Gateway
is unable to write the response message, it will log an audit message.
Configuring the [Advanced] Tab
Configure the [
Advanced
] tab as follows:
Setting
Description
Override maximum message size
Select this check box to override the permitted maximum size of the message. Clear this check box to use the value set in the io.xmlPartMaxBytes cluster property.
  • Restrict messages to: Enter the maximum permitted size of the message, in bytes.
  • Allow unlimited message size (not recommended): Select this option to allow response messages of unlimited size. This is not recommended and should be used only under the direction of Support.
Process messages with published service
Select this check box to resolve messages to a specified published service that you indicate in the Service Name field below. This bypasses the
Layer7 API Gateway
normal service resolution process.
Clear this check box to process messages using the
Layer7 API Gateway
service resolution logic. For more information, see Understanding the Service Resolution Process.
Service name
If associating an SFTP polling listener with a specific service, choose the service from the drop-down list. If the service you want is not in the list, you must publish it first.
Advanced Properties
This section is used to add, edit, or remove any additional settings required to configure the SFTP Polling Listener Properties. This section is intended for advanced users and should be configured only as directed by Support.