IPWorks SSH 2022 API Changes

In most cases upgrading is seamless and requires no code changes, as efforts have been made to maintain backwards compatibility. However, the release of IPWorks SSH 2022 includes several API changes that may require code changes. The table below is a list of major changes between IPWorks SSH 2020 and IPWorks SSH 2022.

Upgrading to IPWorks SSH 2022 is designed to be a quick process and involve only minimal code changes while offering additional functionality and options for new and existing users. Please contact us at support@nsoftware.com with any questions or comments.

Components with Changes

API Changes

The table below describes API changes in IPWorksSSH 2022. Please refer to the notes for each entry for details.

SExec
PropertyCommandDeprecated: Please use the SendCommand method instead.
PropertyStdinDeprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
MethodSendStdinBytesNew
MethodSendStdinTextNew
SFTP
PropertyFileExistsDeprecated: Please use the CheckFileExists method instead.
MethodChangeRemotePathNew
MethodCheckFileExistsNew
MethodConnectNew
MethodDisconnectNew
MethodQueryFileAttributesNew
SFTPServer
MethodStartListeningNew
MethodStopListeningNew
SSHClient
MethodChangeRecordLengthNew
MethodConnectNew
MethodDisconnectNew
MethodSendBytesNew
MethodSendTextNew
SShell
PropertyCommandDeprecated: Please use the SendCommand method instead.
PropertyStdinDeprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
MethodConnectNew
MethodDisconnectNew
MethodSendCommandNew
MethodSendStdinBytesNew
MethodSendStdinTextNew
SSHPlex
PropertyCommandDeprecated: Please use the SendCommand method instead.
PropertyFileExistsDeprecated: Please use the CheckFileExists method instead.
PropertyRemotePathDeprecated: Please use the QueryRemotePath method or the ChangeRemotePath method instead.
PropertyStdinDeprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
MethodChangeRemotePathNew
MethodCheckFileExistsNew
MethodQueryFileAttributesNew
MethodQueryRemotePathNew
SSHServer (Previously SSHDaemon)
PropertyDefaultIdleTimeoutNew
MethodChangeRecordLengthNew
MethodSendBytesNew
MethodSendTextNew
MethodStartListeningNew
MethodStopListeningNew
EventSSHTunnelClosedNew
EventSSHTunnelRequestedNew
SSHTunnel
MethodConnectNew
MethodStartListeningNew
MethodStopListeningNew
EventReconnectAttemptNew

We appreciate your feedback.  If you have any questions, comments, or suggestions about this article please contact our support team at kb@nsoftware.com.