/n software Connectors for MuleSoft

Questions / Feedback?

SCP Connector

Properties   Configuration Settings  

The SCP Connector adds SSH-secured file transfer capabilities to your MuleSoft.

Remarks

The SCP Connector adds a SCP client to your Mule Project that enables it with SSH-secured file download and upload functionality.

SCP Receive Connector

The SCP Receive Connector requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SCP server every PollingInterval and download the file(s) specified by FileMask. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual messages.

Download Example

Add an SCP Receive source connector to your flow and configure the connection settings. That is all that is required to get started.

Optionally specify a RemotePath to change the working directory on the remote machine. The connector will handle connecting to the server and downloading a group of files. One Mule event is generated for each file downloaded.

Behind the SCP Receive connector you can add a File Write connector to write each file to disk. You will need to dynamically set the Path property on the File Write connector to accomplish this. Click the Mule expression indicator on the Path property and set the value to:


'C:\\temp\\' ++ attributes.ReceivedFileName

The received filename will then be used as the same filename on disk. The content of each file will be present in the payload of the Mule Message. That is all that is required to write an incoming file to disk. Additional properties about the file and SSH user are also available in the attributes collection.

SCP Send Connector

The SCP Send Connector requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SCP server whenever it has a message to send. The connector will attempt to upload to the specified RemotePath.

Upload Files Example

To get started, add a File Read connector to your flow and configure it to read a target file. Behind the File Read connector, add an SCP Send module and configure the connection settings. There is no need to transform the output of the File Read connector before passing it to the SCP Send module.

The connector will upload the bytes in the payload to the specified RemoteFile at the location specified in RemotePath

Receiver Property List


The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.

FileMaskIndicates the type of files to download from the SSH server.
FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the connector.
PersistentConnectionInstructs the connector whether to keep the connection to the server open.
ReceivedFileNameThe name of the remote file received by the SCP connector.
ReceivedFilePathThe remote path of the received file.
ReceivedFileSizeThe size of the remote file received by the SCP connector.
ReceivedFileSSHUserThe SSH user name used by the SCP connector when downloading the remote file.
RemotePathThe current path on the SSH server.
RuntimeLicenseSpecifies the connector runtime license key.
SSHAcceptServerHostKeyInstructs the connector to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the connector.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TempPathA temporary local directory where data can be stored before the connector processes it.
TimeoutA timeout for the connector.

Sender Property List


The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.

FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the connector.
PersistentConnectionInstructs the connector whether to keep the connection to the server open.
RemoteFileThe name of the destination file on the SSH server for uploading.
RemotePathThe current path on the SSH server.
RuntimeLicenseSpecifies the connector runtime license key.
SSHAcceptServerHostKeyInstructs the connector to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the connector.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TimeoutA timeout for the connector.

Configuration Settings


The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.

FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
RecursiveModeIf set to true the connector will recursively upload or download files.
ServerResponseWindowThe time to wait for a server response in milliseconds.
SSHAcceptServerHostKeyFingerPrintInstructs the connector to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the connector whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]