/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

SSH Adapter

Properties   Configuration Settings  

The SSH Adapter enables your BizTalk Server to execute remote commands over SSH.

Remarks

The SSH Adapter uses the SSH "exec" subsystem to remotely execute commands from your BizTalk Server.

SSH Send Adapter

The SSH Send Adapter provides an ultra light-weight remote command execution client for your BizTalk Server. You must first set an SSHHost. If the SSH server requires authentication, you should set the necessary SSHUser, and either SSHPassword or SSHCert depending on the SSHAuthMode you wish to use. Once the SSH server information is set, you must enter the Command you wish to execute.

Whenever called from the BizTalk Message Engine, the adapter will execute the given command. If the outbound message has any data, that data will supplied to the executing command's standard input.

Once the command has finished executing, the adapter will write the output from the command's standard out pipe to the CommandStdOut property in the message context. It will also write the command's exit code to the CommandExitStatus property, and any data from the standard err pipe to the CommandErrorMessage property in the message context.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Sender Property List


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

CommandThe command to be sent to the remote host.
CommandErrorMessageThe error message, if any, returned by the server after command execution.
CommandExitStatusThe exit code for the executed command for the current message.
CommandSSHUserThe SSH user name used by the adapter when executing the command.
CommandStdErrThe standard error output of the executed Command .
CommandStdOutThe standard output of the executed Command .
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FailOnErrorControls how the adapter treats error codes returned by command execution.
FirewallA set of properties related to firewall access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
OtherDefines a set of configuration settings to be used by the adapter.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
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.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.

Configuration Settings


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

LogSSHPacketsIf True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrintInstructs the adapter 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.
SSHPubKeyAuthSigAlgorithmsSpecifies the signature algorithm when attempting public key authentication.
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 adapter whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6824]