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.

SShell
SSHPlex
SSHServer
SSHTunnel

API Changes

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

SExec
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`Stdin`	Deprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
	Method	`SendStdinBytes`	New
	Method	`SendStdinText`	New
SFTP
	Property	`FileExists`	Deprecated: Please use the CheckFileExists method instead.
	Method	`ChangeRemotePath`	New
	Method	`CheckFileExists`	New
	Method	`Connect`	New
	Method	`Disconnect`	New
	Method	`QueryFileAttributes`	New
SFTPServer
	Method	`StartListening`	New
	Method	`StopListening`	New
SSHClient
	Method	`ChangeRecordLength`	New
	Method	`Connect`	New
	Method	`Disconnect`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
SShell
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`Stdin`	Deprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
	Method	`Connect`	New
	Method	`Disconnect`	New
	Method	`SendCommand`	New
	Method	`SendStdinBytes`	New
	Method	`SendStdinText`	New
SSHPlex
	Property	`Command`	Deprecated: Please use the SendCommand method instead.
	Property	`FileExists`	Deprecated: Please use the CheckFileExists method instead.
	Property	`RemotePath`	Deprecated: Please use the QueryRemotePath method or the ChangeRemotePath method instead.
	Property	`Stdin`	Deprecated: Please use the SendStdinBytes method or the SendStdinText method instead.
	Method	`ChangeRemotePath`	New
	Method	`CheckFileExists`	New
	Method	`QueryFileAttributes`	New
	Method	`QueryRemotePath`	New
SSHServer (Previously SSHDaemon)
	Property	`DefaultIdleTimeout`	New
	Method	`ChangeRecordLength`	New
	Method	`SendBytes`	New
	Method	`SendText`	New
	Method	`StartListening`	New
	Method	`StopListening`	New
	Event	`SSHTunnelClosed`	New
	Event	`SSHTunnelRequested`	New
SSHTunnel
	Method	`Connect`	New
	Method	`StartListening`	New
	Method	`StopListening`	New
	Event	`ReconnectAttempt`	New

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