Component: SSH 
---------------

Secure Shell connection to server.

Can be used to login remotely into a Linux or macOS (or Windows) machine if there is a SSH server running and run various commands.  
  
See [CURL](component_CURL.md) functions for doing file transfers via SFTP.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [6.3](newinversion63.md "First functions introduced with version 6.3.") / [13.0](newinversion130.md "Newest functions in version 13.0.") | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

  
| Item | Details |
|:--|:--|
| [SSH.CloseChannel](SSHCloseChannel.md)   Closes the channel. | All   6.3 |
| [SSH.ConfigureKeepAlive](SSHConfigureKeepAlive.md)   Configures keep alive probes. | All   10.4 |
| [SSH.Connect](SSHConnect.md)   Connects a new socket to the given IP &amp; Port. | All   6.3 |
| [SSH.Disconnect](SSHDisconnect.md)   Disconnects the session. | All   6.3 |
| [SSH.EOF](SSHEOF.md)   Check a channel's EOF status. | All   6.3 |
| [SSH.Execute](SSHExecute.md)   Executes something on the server. | All   6.3 |
| [SSH.Flush](SSHFlush.md)   Flush streams for this channel. | All   6.3 |
| [SSH.FreeChannel](SSHFreeChannel.md)   Frees the SSH channel. | All   6.3 |
| [SSH.GetExitState](SSHGetExitState.md)   Get the remote exit code. | All   6.3 |
| [SSH.GetIP](SSHGetIP.md)   Queries IP or domain used to connect. | All   6.3 |
| [SSH.GetPort](SSHGetPort.md)   Queries port used to connect. | All   6.3 |
| [SSH.GetTag](SSHGetTag.md)   Queries tag value. | All   6.3 |
| [SSH.GetTimeout](SSHGetTimeout.md)   Queries timeout. | All   6.3 |
| [SSH.GetUserName](SSHGetUserName.md)   The user name we got authenticated for. | All   6.3 |
| [SSH.HostKey](SSHHostKey.md)   Returns the hex encoded host key. | All   6.3 |
| [SSH.HostKeyHash](SSHHostKeyHash.md)   Returns the hex encoded host key hash. | All   6.3 |
| [SSH.IsAuthenticated](SSHIsAuthenticated.md)   Queries the authentication state. | All   6.3 |
| [SSH.List](SSHList.md)   Lists all IDs of SSH connection objects. | All   13.0 |
| [SSH.New](SSHNew.md)   Creates a new SSH session. | All   6.3 |
| [SSH.OpenSession](SSHOpenSession.md)   Opens a SSH channel. | All   6.3 |
| [SSH.ReadHex](SSHReadHex.md)   Reads bytes from channel and returns them hex encoded. | All   6.3 |
| [SSH.ReadText](SSHReadText.md)   Reads bytes from channel and returns them as text. | All   6.3 |
| [SSH.Release](SSHRelease.md)   Frees the memory for the ssh session. | All   6.3 |
| [SSH.ReleaseAll](SSHReleaseAll.md)   Release all SSH sessions. | All   10.5 |
| [SSH.RequestPTY](SSHRequestPTY.md)   Request a PTY on an established channel. | All   6.3 |
| [SSH.SendEOF](SSHSendEOF.md)   Send EOF to remote server. | All   6.3 |
| [SSH.SessionHandshake](SSHSessionHandshake.md)   Perform the SSH handshake. | All   6.3 |
| [SSH.SetEnv](SSHSetEnv.md)   Set an environment variable on the channel. | All   6.3 |
| [SSH.SetTag](SSHSetTag.md)   Sets the tag value. | All   6.3 |
| [SSH.SetTimeout](SSHSetTimeout.md)   Sets timeout. | All   6.3 |
| [SSH.Shell](SSHShell.md)   Request a shell on a channel. | All   6.3 |
| [SSH.Tunnel.BytesReceived](SSHTunnelBytesReceived.md)   Queries number of bytes received. | All   8.5 |
| [SSH.Tunnel.BytesSent](SSHTunnelBytesSent.md)   Queries number of bytes sent. | All   8.5 |
| [SSH.Tunnel.Cancel](SSHTunnelCancel.md)   Cancel the tunnel. | All   8.5 |
| [SSH.Tunnel.Cancelled](SSHTunnelCancelled.md)   Queries cancel state for tunnel. | All   8.5 |
| [SSH.Tunnel.GetConnected](SSHTunnelGetConnected.md)   Queries whether tunnel is connected and transfers data. | All   10.3 |
| [SSH.Tunnel.GetKeepAlive](SSHTunnelGetKeepAlive.md)   Queries keep alive status. | All   10.2 |
| [SSH.Tunnel.Messages](SSHTunnelMessages.md)   Queries messages from tunnel. | All   8.5 |
| [SSH.Tunnel.Run](SSHTunnelRun.md)   Creates a SSH tunnel on the session. | All   8.5 |
| [SSH.Tunnel.Running](SSHTunnelRunning.md)   Queries whether tunnel is running. | All   8.5 |
| [SSH.Tunnel.SetKeepAlive](SSHTunnelSetKeepAlive.md)   Sets keep alive status. | All   10.2 |
| [SSH.UserAuthKeyboardInteractive](SSHUserAuthKeyboardInteractive.md)   Authenticate a session using keyboard-interactive authentication. | All   6.3 |
| [SSH.UserAuthList](SSHUserAuthList.md)   List supported authentication methods. | All   6.3 |
| [SSH.UserAuthPassword](SSHUserAuthPassword.md)   Authenticate a session with username and password. | All   6.3 |
| [SSH.UserAuthPublicKey](SSHUserAuthPublicKey.md)   Authenticate a session with a public key, read from memory. | All   6.3 |
| [SSH.UserAuthPublicKeyFile](SSHUserAuthPublicKeyFile.md)   Authenticate a session with a public key, read from a file. | All   6.3 |
| [SSH.WaitClosed](SSHWaitClosed.md)   Wait for the remote to close the channel. | All   6.3 |
| [SSH.WaitEOF](SSHWaitEOF.md)   Wait for the remote end to acknowledge an EOF request. | All   6.3 |
| [SSH.WaitSocket](SSHWaitSocket.md)   Waits on the socket for sending or receiving. | All   6.3 |
| [SSH.WriteHex](SSHWriteHex.md)   Writes text to the channel. | All   6.3 |
| [SSH.WriteText](SSHWriteText.md)   Writes text to the channel. | All   6.3 |

51 functions shown.

These functions require a license (88%).

### Release notes

- **Version 13.0**
    - Added [SSH.List](https://www.mbsplugins.eu/SSHList.shtml) function.
- **Version 12.1**
    - Fixed a problem with tunnel in [SSH](https://www.mbsplugins.eu/component_SSH.shtml) functions, where [SSH.Tunnel.Cancel](https://www.mbsplugins.eu/SSHTunnelCancel.shtml) didn't end the tunnel quickly in some cases.
- **Version 10.5**
    - Added [AVExport.ReleaseAll](https://www.mbsplugins.eu/AVExportReleaseAll.shtml), [AVRecorder.ReleaseAll](https://www.mbsplugins.eu/AVRecorderReleaseAll.shtml), [CoreML.ReleaseAll](https://www.mbsplugins.eu/CoreMLReleaseAll.shtml), [DNSLookup.ReleaseAll](https://www.mbsplugins.eu/DNSLookupReleaseAll.shtml), [Dictionary.ReleaseAll](https://www.mbsplugins.eu/DictionaryReleaseAll.shtml), [FM.SQL.ReleaseAll](https://www.mbsplugins.eu/FMSQLReleaseAll.shtml), [JS.ReleaseAll](https://www.mbsplugins.eu/JSReleaseAll.shtml), [JavaScript.ReleaseAll](https://www.mbsplugins.eu/JavaScriptReleaseAll.shtml), [LDAP.ReleaseAll](https://www.mbsplugins.eu/LDAPReleaseAll.shtml), [PDFKit.ReleaseAll](https://www.mbsplugins.eu/PDFKitReleaseAll.shtml), [PKCS12.ReleaseAll](https://www.mbsplugins.eu/PKCS12ReleaseAll.shtml), [PKCS7.ReleaseAll](https://www.mbsplugins.eu/PKCS7ReleaseAll.shtml), [PKey.ReleaseAll](https://www.mbsplugins.eu/PKeyReleaseAll.shtml), [SSH.ReleaseAll](https://www.mbsplugins.eu/SSHReleaseAll.shtml), [WinSendMail.ReleaseAll](https://www.mbsplugins.eu/WinSendMailReleaseAll.shtml), [WindowsML.ReleaseAll](https://www.mbsplugins.eu/WindowsMLReleaseAll.shtml), [WordFile.ReleaseAll](https://www.mbsplugins.eu/WordFileReleaseAll.shtml), and [X509.ReleaseAll](https://www.mbsplugins.eu/X509ReleaseAll.shtml).
- **Version 10.4**
    - Added [SSH.ConfigureKeepAlive](https://www.mbsplugins.eu/SSHConfigureKeepAlive.shtml) function.
- **Version 10.3**
    - Added [SSH.Tunnel.GetConnected](https://www.mbsplugins.eu/SSHTunnelGetConnected.shtml) function.
- **Version 10.2**
    - Added [SSH.Tunnel.GetKeepAlive](https://www.mbsplugins.eu/SSHTunnelGetKeepAlive.shtml) and [SSH.Tunnel.SetKeepAlive](https://www.mbsplugins.eu/SSHTunnelSetKeepAlive.shtml) functions.
- **Version 8.5**
    - Added [SSH](http://www.mbsplugins.eu/component_SSH.shtml) functions to create SSH tunnel, see [SSH.Tunnel.Run](http://www.mbsplugins.eu/SSHTunnelRun.shtml).
- **Version 8.3**
    - Updated code for [Socket.Connect](http://www.mbsplugins.eu/SocketConnect.shtml), [ServerSocket.SendQuery](http://www.mbsplugins.eu/ServerSocketSendQuery.shtml), [SSH.Connect](http://www.mbsplugins.eu/SSHConnect.shtml) and SendCommand to use new unified socket connection code, which uses IPv4 and IPv6, queries DNS if needed and tries several IPs if needed.
- **Version 7.2**
    - Added ProtocolPreference parameter to [SSH.Connect](http://www.mbsplugins.eu/SSHConnect.shtml) and [Socket.Connect](http://www.mbsplugins.eu/SocketConnect.shtml) to request IPv4 or IPv6.

### Blog Entries

- [MBS FileMaker Plugin, version 12.1pr6](https://www.mbsplugins.de/archive/2022-03-08/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)
- [Combine MBS functions to automate processes in FileMaker](https://www.mbsplugins.de/archive/2019-04-11/Combine_MBS_functions_to_autom/monkeybreadsoftware_blog_filemaker)
- [Neues MBS FileMaker Plugin 8.5 - Über 5500 Funktionen in einem Plugin](https://www.mbsplugins.de/archive/2018-11-27/Neues_MBS_FileMaker_Plugin_85_/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 8.5 - More than 5500 Functions In One Plugin](https://www.mbsplugins.de/archive/2018-11-27/MBS_FileMaker_Plugin_85_-_More/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 8.5pr3](https://www.mbsplugins.de/archive/2018-10-24/MBS_FileMaker_Plugin_version_8/monkeybreadsoftware_blog_filemaker)
- [FileMaker Cloud Tipps &amp; Tricks](https://www.mbsplugins.de/archive/2017-12-10/FileMaker_Cloud_Tipps__Tricks/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 6.3 for OS X/Windows](https://www.mbsplugins.de/archive/2016-07-12/MBS_FileMaker_Plugin_63_for_OS/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 6/2020, Seite 25](https://filemaker-magazin.de/neuigkeit/4118-Appetithappen-FMM_202006)

### Example Databases

- [Network/SSH Tunnel](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Network/SSH%20Tunnel.shtml#1ScriptAnchor_)
- [Network/SSH](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Network/SSH.shtml#1ScriptAnchor_)

[HTML Version](component_SSH.shtml)