The SSH Adapter enables your BizTalk Server to execute remote commands over SSH.
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.
|Command||The command to be sent to the remote host.|
|CommandErrorMessage||The error message, if any, returned by the server after command execution.|
|CommandExitStatus||The exit code for the executed command for the current message.|
|CommandSSHUser||The SSH user name used by the adapter when executing the command.|
|CommandStdErr||The standard error output of the executed Command .|
|CommandStdOut||The standard output of the executed Command .|
|ConnectionLifetime||Instructs the adapter whether or not to leave the connection to the server open.|
|FailOnError||Controls how the adapter treats error codes returned by command execution.|
|Firewall||A set of properties related to firewall access.|
|MaxPersistentConnections||The maximum number of simultaneous persistent connections when sending.|
|MaxThreads||The maximum number of threads that the adapter may consume.|
|MaxTransmissionBatchSize||The maximum number of messages that can be sent in a single batch.|
|Other||Defines a set of configuration settings to be used by the adapter.|
|SSHAcceptServerHostKey||Instructs the adapter to accept the server host key that matches the supplied key.|
|SSHAuthMode||The type of authentication used by the adapter.|
|SSHCert||The certificate to use for client authentication during the SSH handshake.|
|SSHCompressionAlgorithms||A comma-separated list of compression algorithms allowed for this connection.|
|SSHHost||The address of the SSH host.|
|SSHPassword||The password for SSH password-based authentication.|
|SSHPort||The port on the SSH server where the SSH service is running; by default, 22.|
|SSHUser||The username for SSH authentication.|
|SSOAffiliate||Specifies the name of the SSO Affiliate Application..|
|Timeout||A timeout for the adapter.|
|TransmitBatchMode||How the transmitter processes batches.|
|TransportLog||Tells the adapter where and how to report information about its operations.|
|URI||The Uniform Resource Identifier (URI) of the send port or receive location.|
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
|LogSSHPackets||If True, detailed SSH packet logging is performed.|
|SSHAcceptServerHostKeyFingerPrint||Instructs the adapter to accept the server's host key with this fingerprint.|
|SSHEncryptionAlgorithms||A comma-separated list containing all allowable compression algorithms.|
|SSHKeyExchangeAlgorithms||Specifies the supported key exchange algorithms.|
|SSHMacAlgorithms||Specifies the supported Mac algorithms.|
|SSHPublicKeyAlgorithms||Specifies the supported public key algorithms.|
|SSHPubKeyAuthSigAlgorithms||Specifies the signature algorithm when attempting public key authentication.|
|AbsoluteTimeout||Determines whether timeouts are inactivity timeouts or absolute timeouts.|
|LocalHost||The name of the local host or user-assigned IP interface through which connections are initiated or accepted.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|UseInternalSecurityAPI||Tells the adapter whether or not to use the system security libraries or an internal implementation.|
|PersistedConnectionTimeout||How long to leave a persisted connection alive.|