SFTP poller handler commands
SFTP poller handler mode provides the commands to create or modify an SFTP
poller handler.
The poller polls a specific directory on an SFTP server for files with
matching names. When a file name matches the pattern, the associated DataPower® service processes the file with the configuration of the
poller.
To enter the configuration mode, use the global source-sftp-poller command. To delete a handler, use the no source-sftp-poller command. For more information, see source-sftp-poller.
While in this mode, use the commands in the following table to define the handler.
- To view the current configuration, use the show command.
- To restore default values, use the reset command.
- To exit this configuration mode without saving changes to the running configuration, use the cancel command.
- To exit this configuration mode and save changes to the running configuration, use the exit command.
| Command | Purpose |
|---|---|
| admin-state | This command sets the administrative state for the configuration. |
| delay-time | This command specifies the interval between polling sequences for the SFTP poller handler. |
| error-delete | This command specifies whether to delete a file after a processing failure. |
| error-rename-pattern | This command specifies the PCRE to rename a file when it cannot be processed. |
| match-pattern | This command specifies the PCRE to match the files in the polled directory. |
| max-transfers-per-poll | The command specifies the maximum number of allowed concurrent client connections during a polling sequence |
| processing-rename-pattern | The specifies the PCRE to rename a file that is being processed. |
| processing-seize-pattern | The command specifies the PCRE to find files that were renamed. |
| processing-seize-timeout | This command specifies the duration in seconds to wait. |
| result | The command specifies whether to create a response file after the successful processing of an input file. |
| result-name-pattern | This command specifies the PCRE to use as the match pattern to build the name of the result file. |
| ssh-client-connection | This command associates an SSH client profile with the SFTP poller handler. |
| success-delete | This command specifies whether to delete the input or processing-renamed files after successful processing. |
| success-rename-pattern | This command specifies the PCRE to rename the input file on success. |
| summary | This command specifies the brief, descriptive summary for the object instance. |
| target-dir | This command specifies the directory on the SFTP server to poll. |
| xml-manager | This command associates an XML manager with the SFTP poller handler. |