<< Click to Display Table of Contents >> Navigation: Sensor Settings > Capture Results Delivery > Manual Setup (Config File) > SFTP Profiles |
A sample setup of a delivery profile using SFTP is provided below:
<Profile name="sftp-transport_1" enabled="true" default="false">
<Option name="protocol" value="sftp" />
<Option name="sftp-server" value="10.101.100.125" />
<Option name="sftp-port" value="22" />
<Option name="file-drop-path" value="messages" />
<Option name="user-name" value="test" />
<Option name="password" value="" />
<Option name="enable-tmp" value="false" />
<Option name="save-format" value="eml" />
<Option name="save-zip" value="false" />
<Option name="zip-level" value="6" />
<Option name="save-headers" value="none" />
<Option name="profile-fail-timeout" value="10" />
<Option name="go-profile-weight" value="1" />
<Option name="go-profile-reserve" value="true" />
</Profile>
Description of SFTP profile options:
protocol
Defines the data transfer protocol. In this case, it is the sftp protocol
sftp-server
The IP address or domain name of the SFTP server and the path to the directory to which captured messages are to be stored.
sftp-port
The SFTP server port
file-drop-path
The name of the directory in which messages are to be stored
user-name
Defines the username that has necessary rights to access the SFTP server directory, for example: test
password
Defines the password of the user that has necessary rights to access the SFTP server directory, for example: "123456secret"
enable-tmp
Enables/disables moving files in 2 steps. Values: true or false May be helpful if a process is waiting for new files to appear in the SFTP server directory (renaming is an atomic operation).
save-format
Defines the format to save the message (eml, xml, json...)
save-zip
Defines saving data to the SFTP server in the ZIP archive format. Example: true or false
zip-level
Defines the ZIP archive compression ratio. Possible values for this setting are from 0 to 9, where 0 means no compression, 1 means minimum compression, but high speed, and 9 means maximum compression
save-headers
Enables/disables saving of standard message headers, as well as X-Sensor headers, in a separate message attachment named microolap_msis_headers.txt.
Possible values:
all
Saves all message headers
xsensor
Saves headers with the X-Sensor prefix
other
Saves standard headers (From, To, Cc, Bcc) and also any others to which xsensor settings don't apply
none
Disables saving of headers in a separate attachment.
profile-fail-timeout
Defines the timeout for message delivery in the event of receiver rejection. Provide a value in seconds.
go-profile-weight
Determines a ratio for distribution of messages among receivers. Possible values are from 1 to 10. The setting is valid only when used in a group profile.
go-profile-reserve
Enables/disables the use of the reserve profile. If this setting is enabled and the main (non-reserve) delivery profiles fail, this profile will be used for data delivery. The setting is valid only when used in a group profile.