Integration Server 10.3 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.sftp.admin:getHostKey
 
pub.client.sftp.admin:getHostKey
WmPublic. Gets the host key of the SFTP server.
Note:
This service was introduced for PIE-61188 in IS_10.3_Core_Fix10.
Input Parameters
sftpClientVersion
String. Indicates the Integration Server SFTP client version, which can be version1(existing) or version2(newer). Set to version2, if you want Integration Server to use the newer SFTP client that has new configuration properties, additional Key Exchange Algorithms, Machine Access Code (MAC) algorithms, and ciphers.
serverHost
String. The IP address or the host name of the SFTP server.
serverPort
Integer. The SFTP server port number. The port number must be within the range of 0 and 65535 (inclusive).
preferredKeyExchangeAlgorithms
String. Optional. A comma-separated list of preferred key exchange algorithms. If not defined, then the default list of key exchange algorithms (in the default order) is used.
Note:
You can get the list of default key exchange algorithms, MAC algorithms, and ciphers by using the pub.client.sftp.admin:getDefaultAlgorithms service.
preferredCiphersS2C
String. Optional. A comma-separated list of preferred server-to-client ciphers. If no value is provided, then the default list of server-to-client ciphers (in the default order) is used.
preferredCiphersC2S
String. Optional. A comma-separated list of preferred client-to-server ciphers. If a value is not provided, then the default list of client-to-server ciphers (in the default order) is used.
preferredMacC2S
String. Optional. A comma-separated list of preferred client-to-server Message Authentication Code (MAC) algorithms. If a value is not provided, then the default list of client-to-server MAC algorithms (in the default order) is used.
preferredMacS2C
String. Optional. A comma-separated list of preferred server-to-client Message Authentication Code (MAC) algorithms. If a value is not provided, then the default list of server-to-client MAC algorithms (in the default order) is used.
minDHKeySize
Integer. Optional. The minimum DH key size. The default value is 1024. This field is not applicable if sftpClientVersion is version1.
maxDHKeySize
Integer. Optional. The maximum DH key size. The default value is 8192. This field is not applicable, if sftpClientVersion is version1.
proxyAlias
String. Optional. The proxy alias through which the request should be routed. The proxy alias can be HTTP, HTTPS, or SOCKS. If a proxy alias is not specified, Integration Server makes outbound requests using each enabled proxy server alias until the request is sent successfully or all proxy servers are tried.
Output Parameters
hostKeyBytes
Object. An array of bytes (byte[]). The host key in byte array format.
fingerprint
String. Fingerprint of the host key.