IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


FTP Server policy (FtpServer)

Use an FTP Server policy to configure FTP or SFTP file transfer for a message flow.

You use a FileInput node in a message flow to process messages that are read from files, and a FileOutput node to write messages to files. You can use an FTP Server policy to control, at run time, the connection details for the remote server that the File nodes use to read or write to files.

To attach an FTP Server policy to a File node, set the Remote server and port property of the FileInput, FileOutput, or FileRead node to the name of the policy, in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

The properties of this policy are described in the following table.
Table 1. Properties of the FTP Server policy
Property Property name in .policyxml file Value
FTP server name fileFtpServer This mandatory property specifies the IP address and, optionally, port number for the remote FTP server. The syntax for the property is identical to the syntax that is used for the FTP server and port property of the FileInput and FileOutput nodes (except that it cannot be the name of an FTP Server policy).

Value type: String

Account information fileFtpAccountInfo Some FTP servers require an account name during the FTP logon procedure. If this property is specified, its value is the account name that is supplied when it is requested during FTP logon. If this property is not specified, and the server requests an account name, the FTP transfer fails.

Value type: String

Remote FTP server directory fileFtpDirectory This property specifies the relative or absolute directory name on the remote FTP server. If it is set, this property overrides the Server directory property on the FTP tab of the FileInput or FileOutput node that uses this policy.

Value type: String

FTP security identity fileFtpUser This property specifies the name of a security identity that is used to authenticate the connection to the FTP server. If it is set, this property overrides the Security identity property on the FTP tab of the FileInput or FileOutput node that uses this policy. If the value of this property is secId, use the following command to define the security identity:
  • If you are using FTP:
    mqsisetdbparms -w workDir
    -n ftp::secId -u userName 
    -p password
  • If you are using SFTP:
    mqsisetdbparms -w workDir
    -n sftp::secId -u userName 
    -p password 
    or
    mqsisetdbparms -w workDir
    -n sftp::secId -u userName 
    -i SSHIdentityFile 
    -r Passphrase

Value type: String

Transfer mode fileFtpTransferMode This property specifies the transfer mode of the FTP connection. Valid values are BINARY (the default) or ASCII. If it is set, this property overrides the Transfer mode property on the FTP tab of the FileInput or FileOutput node that uses this policy.

This property is valid only when FTP is specified as the protocol. If SFTP is specified, this property is ignored.

Value type: String

Scan delay (seconds) fileFtpScanDelay This property specifies the time, in seconds, to wait after a scan of the directory results in no files being identified for processing. The default value is 60 seconds. If it is set, this property overrides the Scan delay property on the FTP tab of the FileInput node that uses this policy.

Value type: Integer

Connection type fileFtpConnectionType This property specifies the FTP data socket connection. Valid values are PASSIVE (the default) or ACTIVE.

This property is valid only when FTP is specified as the protocol. If SFTP is specified, this property is ignored.

Value type: String

Strict host key checking strictHostKeyChecking This property specifies how host keys are checked during the connection and authentication phase. Valid values are:
False (the default)
This value specifies that the following action is completed:
  • If the connection is to a new host, connect and accept the host key, and store it.
  • If the connection is to a host that has been connected to previously, and the host key has changed, issue an exception (in the FileOutput node).
If you select False, a default known hosts file is used.
True
This value specifies that a connection is made only to known hosts with valid keys; otherwise, an exception is issued.

If you select True, you must specify your own known hosts file by using the Location of the known hosts file property.

The host information is stored in a known_hosts file in the standard OpenSSH format.

This property is valid only when SFTP is specified as the protocol. If FTP is used, this property is ignored.

Value type: Boolean

Encryption ciphers allowedCiphers This property specifies the cipher that is used for encryption, and consists of one or more of the following values, which are separated by plus signs (+):
  • blowfish-cbc
  • 3des-cbc
  • aes128-cbc
  • aes192-cbc
  • aes256-cbc
  • aes128-ctr
  • aes192-ctr
  • aes256-ctr
  • 3des-ctr
  • arcfour
  • arcfour128
  • arcfour256
The cipher that you use for encryption depends on your SSH implementation. List the values in order of preference. If you do not specify a value for this property, the following default value is used: blowfish-cbc+3des-cbc+aes128-cbc+aes192-cbc+aes256-cbc+aes128-ctr+aes192-ctr+aes256-ctr+3des-ctr+arcfour+arcfour128+arcfour256.

This property is valid only when SFTP is specified as the protocol. If FTP is used, this property is ignored.

Value type: String

Compression level fileFtpCompression

This property specifies the level of compression that is used. Valid values are integers in the range 0 - 9, where 0 is the default value, which specifies no compression, and 9 specifies maximum compression.

This property is valid only when SFTP is specified as the protocol. If FTP is used, this property is ignored.

Value type: Integer

Remote transfer protocol remoteTransferType This property specifies the remote transfer protocol to use. Valid values are FTP (the default) or SFTP. If no protocol is specified in the policy, the value that is specified on the node is used.

Value type: String

Location of the known hosts file knownHostsFile This property specifies the location of the known hosts file. The value must be the fully qualified path to a valid known hosts file. The host information is stored in a known_hosts file in the standard OpenSSH format.

This property is mandatory if the Strict host key checking property is set to True. If the Strict host key checking property is set to False, this property is ignored.

This property is valid only when SFTP is specified as the protocol. If FTP is used, this property is ignored.

Value type: String

Message authentication code mac This property specifies the message authentication code, and consists of one or more of the following values, which are separated by plus signs (+):
  • hmac-md5
  • hmac-sha1
  • hmac-md5-96
  • hmac-sha1-96
The message authentication code that you use depends on your SSH implementation. List the values in order of preference. If you do not specify a value for this property, the following default value is used: hmac-md5+hmac-sha1+hmac-md5-96+hmac-sha1-96.

This property is valid only when SFTP is specified as the protocol. If FTP is used, this property is ignored.

Value type: String

Timeout (seconds) timeoutInterval This property specifies the timeout value, in seconds, to establish a connection to the remote FTP or SFTP server. You can set this property to any valid integer. This property has a default value of 0, which indicates that no timeout exists.

Value type: Integer

Preserve remote file date preserveRemoteFileDate This property specifies whether files that are retrieved from a remote server by the FileInput node retain the last modified date on the server.

The default value is False. If you select True, the FileInput node completes appropriate parsing to determine the remote file date during processing. The MDTM command is used where it is supported by the remote server. Where the MDTM command is not supported, the listing text is used.

When parsing from listing text, the precision is limited to the information that is available in the specific listing format that is used by the remote server. If the listing format is ambiguous, the FileInput node bases parsing on the locale settings of the integration server. If the date cannot be determined reliably from the remote server, an exception is issued and the message is not processed.

Value type: Boolean


py00114_.htm | Last updated 2018-11-02 14:46:47