SSHPlex Class

Properties   Methods   Events   Config Settings   Errors  

SSHPlex is a multiplexed class that operates over a single Secure Shell (SSH) connection and allows file transfers using Secure File Transfer Protocol (SFTP) or Secure Copy Protocol (SCP). It can remotely execute commands using SExec or SShell.

Syntax

ipworksssh.SSHPlex

Remarks

The SSHPlex class combines the functionality of the Secure Copy Protocol (SCP) class, the Secure File Transfer Protocol (SFTP) class, the SExec class, and the SShell class. All operations are performed over a single Secure Shell (SSH) connection.

The asynchronous design of the class allows multiple operations to be performed simultaneously. For example, several SFTP file transfers may be started, and while the files are still transferring, commands may be executed over SExec. This is accomplished through the use of operation Ids to track ongoing and complete operations, and ChannelType, which allows switching between SFTP, SCP, SExec, and SShell usage.

After establishing a connection, set ChannelType to the desired protocol and set any relevant properties for the operation. Calling the desired method will return an operation Id (string) that identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection.

When the operation completes, a corresponding event will fire indicating the success or failure of the operation. Examine the event parameters for further details. For instance, after calling Upload, the UploadComplete event will fire.

Ongoing operations may be canceled at any time by passing the operation Id to the CancelOperation method.

Note: The DoEvents method must be called frequently to process outstanding events. This is particularly important for SCP and SFTP operations. Call DoEvents in a loop for best results.

Authentication

Example. Logging On:

SSHPlexControl.SSHUser = "username" SSHPlexControl.SSHPassword = "password" SSHPlexControl.SSHLogon("sshHost", sshPort)

Channel Types

Note that CancelOperation and other methods not explicitly listed above are applicable to all channel types.

Listing Files and Folders

ListDirectory lists files and folders from the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList property. SSHPlexControl.RemoteFile = ""; //Clear filemask SSHPlexControl.RemotePath = "MyFolder"; string opId = SSHPlexControl.ListDirectory(); // ListDirectory operates async so we must wait for it to finish while (SSHPlexControl.Operations.Keys.Contains(opId)) { SSHPlexControl.DoEvents(); } for (int i = 0; i < SSHPlexControl.DirList.Count; i++) { Console.WriteLine(SSHPlexControl.DirList[i].FileName); Console.WriteLine(SSHPlexControl.DirList[i].FileSize); Console.WriteLine(SSHPlexControl.DirList[i].FileTime); Console.WriteLine(SSHPlexControl.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: SSHPlexControl.RemoteFile = "*.txt"; SSHPlexControl.ListDirectory();

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name of the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

The file will be downloaded to the stream specified (if any) by SetDownloadStream. If a stream is not specified and LocalFile is set the file will be saved to the specified location.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the download.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Cancel Download using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially downloaded temp file and set StartByte SSHPlexControl.StartByte = new FileInfo(localFile).Length; // Resume download string operationId = SSHPlexControl.Download();

Uploading Files

The Upload method is used to upload files. Set LocalFile to the name of the file to upload before calling this method. If SetUploadStream is used to set an upload stream the data to upload is taken from the stream instead.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Upload();

Resuming Uploads

The class also supports resuming failed uploads by using the StartByte property. If an upload is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the upload.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Cancel Upload using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially uploaded temp file and set StartByte SSHPlexControl.StartByte = SSHPlexControl.FileAttributes.Size; // Resume upload string operationId = SSHPlexControl.Upload();

Remote Execution

Executing commands on a remote host is done by using the cstSExec or cstSShell ChannelType.

To execute a command, simply call the Execute method with the command you wish to execute.

The output of the command is returned through the Stdout event. Errors during command execution (the stderr stream) are given by the Stderr event.

Property List

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

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

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

ChannelType Property (SSHPlex Class)

Specifies the Channel Type to be used by the class.

Syntax

public int getChannelType();
public void setChannelType(int channelType);

Enumerated values:
  public final static int cstSShell = 0;
  public final static int cstSExec = 1;
  public final static int cstScp = 2;
  public final static int cstSftp = 3;

Default Value

0

Remarks

The ChannelType property determines the protocol used by the component and therefore the applicable methods and properties for each channel. Valid values are:

Note that CancelOperation and other methods not explicitly listed above are applicable to all channel types.

Connected Property (SSHPlex Class)

Whether the class is connected.

Syntax

public boolean isConnected();

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

DirList Property (SSHPlex Class)

Collection of entries resulting in the last directory listing.

Syntax

public DirEntryList getDirList();

Remarks

This collection of entries is returned after a response is received from the server after a call to ListDirectory. The collection is made up of entries for each listing in the current directory, which is specified by the RemotePath property.

MaxDirEntries can be used to control the number of directory listings saved.

This collection is indexed from 0 to size -1.

This property is read-only and not available at design time.

FileAttributes Property (SSHPlex Class)

The attributes of the RemoteFile .

Syntax

public SFTPFileAttributes getFileAttributes();
public void setFileAttributes(SFTPFileAttributes fileAttributes);

Remarks

This property holds the attributes for the file specified by RemoteFile. Before querying this property first call QueryFileAttributes to retrieve the attributes from the server.

To modify the attributes of the file, you may set FileAttributes then call UpdateFileAttributes.

This property is not available at design time.

FilePermissions Property (SSHPlex Class)

The file permissions for the RemoteFile .

Syntax

public String getFilePermissions();
public void setFilePermissions(String filePermissions);

Default Value

"0600"

Remarks

This property defines the permissions that will be assigned to the RemoteFile after an upload. The value is a four-digit octal value. This is the same format that is used with the Unix chmod command. The default value of "0600" gives read/write permissions to the file's owner.

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group, and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written, and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it, and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

Note: Not all servers support setting permissions after an upload.

Firewall Property (SSHPlex Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

LocalFile Property (SSHPlex Class)

The path to a local file for upload/download.

Syntax

public String getLocalFile();
public void setLocalFile(String localFile);

Default Value

""

Remarks

The LocalFile property is used by the Upload and Download methods. The file will only be overwritten if the Overwrite property is set to True.

Example (Setting LocalFile)

SSHPlexControl.Localfile = "C:\localfile.txt" SSHPlexControl.RemoteFile = "remotefile.txt" string operationId = SSHPlexControl.Download() SSHPlexControl.Localfile = "C:\localfile2.txt" SSHPlexControl.RemoteFile = "folder/remotefile2.txt" string operationId = SSHPlexControl.Download()

LocalHost Property (SSHPlex Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SSHPlex Class)

The TCP port in the local host where the class binds.

Syntax

public int getLocalPort();
public void setLocalPort(int localPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Operations Property (SSHPlex Class)

This collection contains all running operations.

Syntax

public SSHPlexOperationMap getOperations();

Remarks

Each SSHPlexOperation in the collection contains information about the currently running operations.

This property is read-only and not available at design time.

Overwrite Property (SSHPlex Class)

Whether or not the class should overwrite files during transfer.

Syntax

public boolean isOverwrite();
public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

When ChannelType is set to cstSFTP this property is a value indicating whether or not the class should overwrite LocalFile when downloading, and RemoteFile when uploading. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

When ChannelType is set to cstSCP this property is a value indicating whether or not the class should overwrite LocalFile when downloading. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

RemoteFile Property (SSHPlex Class)

The name of the remote file for uploading, downloading, etc.

Syntax

public String getRemoteFile();
public void setRemoteFile(String remoteFile);

Default Value

""

Remarks

The RemoteFile is either an absolute file path, or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

SSHPlexControl.Localfile = "C:\localfile.txt" SSHPlexControl.RemoteFile = "remotefile.txt" string operationId = SSHPlexControl.Download() SSHPlexControl.Localfile = "C:\localfile2.txt" SSHPlexControl.RemoteFile = "folder/remotefile2.txt" string operationId = SSHPlexControl.Download()

Note: This property will also act as a file mask when performing ListDirectory.

Example (Using RemoteFile as a file mask): SSHPlexControl.RemoteFile = "*.txt" SSHPlexControl.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

SSHAcceptServerHostKey Property (SSHPlex Class)

Instructs the class to accept the server host key that matches the supplied key.

Syntax

public Certificate getSSHAcceptServerHostKey();
public void setSSHAcceptServerHostKey(Certificate SSHAcceptServerHostKey);

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise, the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.

If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.

SSHAuthMode Property (SSHPlex Class)

The authentication method to be used with the class when calling SSHLogon .

Syntax

public int getSSHAuthMode();
public void setSSHAuthMode(int SSHAuthMode);

Enumerated values:
  public final static int amNone = 0;
  public final static int amMultiFactor = 1;
  public final static int amPassword = 2;
  public final static int amPublicKey = 3;
  public final static int amKeyboardInteractive = 4;
  public final static int amGSSAPIWithMic = 5;
  public final static int amGSSAPIKeyex = 6;
  public final static int amCustom = 99;

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCert = New Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "certpassword", "*") Control.SSHLogon("server", 22)

SSHCert Property (SSHPlex Class)

A certificate to be used for authenticating the SSHUser .

Syntax

public Certificate getSSHCert();
public void setSSHCert(Certificate SSHCert);

Remarks

To use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then it will attempt to use those values to verify the signature.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCert = New Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "certpassword", "*") Control.SSHLogon("server", 22)

SSHCompressionAlgorithms Property (SSHPlex Class)

The comma-separated list containing all allowable compression algorithms.

Syntax

public String getSSHCompressionAlgorithms();
public void setSSHCompressionAlgorithms(String SSHCompressionAlgorithms);

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:

• zlib
• zlib@openssh.com
• none

SSHEncryptionAlgorithms Property (SSHPlex Class)

The comma-separated list containing all allowable encryption algorithms.

Syntax

public String getSSHEncryptionAlgorithms();
public void setSSHEncryptionAlgorithms(String SSHEncryptionAlgorithms);

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

SSHHost Property (SSHPlex Class)

The address of the Secure Shell (SSH) host.

Syntax

public String getSSHHost();
public void setSSHHost(String SSHHost);

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

SSHPassword Property (SSHPlex Class)

The password for Secure Shell (SSH) password-based authentication.

Syntax

public String getSSHPassword();
public void setSSHPassword(String SSHPassword);

Default Value

""

Remarks

SSHPassword specifies the password that is used to authenticate the client to the SSH server.

SSHPort Property (SSHPlex Class)

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Syntax

public int getSSHPort();
public void setSSHPort(int SSHPort);

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

SSHUser Property (SSHPlex Class)

The username for Secure Shell (SSH) authentication.

Syntax

public String getSSHUser();
public void setSSHUser(String SSHUser);

Default Value

""

Remarks

SSHUser specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCert = New Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "certpassword", "*") Control.SSHLogon("server", 22)

StartByte Property (SSHPlex Class)

The offset in bytes at which to begin the upload or download.

Syntax

public long getStartByte();
public void setStartByte(long startByte);

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting to download only a specific range of data from the current RemoteFile.

Timeout Property (SSHPlex Class)

This property includes the timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Append Method (SSHPlex Class)

Append data from a local file; to a remote file using SFTP.

Syntax

public String append();

Remarks

This method Appends the data from LocalFile to the RemoteFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the AppendComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the AppendComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Append(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Append();

CancelOperation Method (SSHPlex Class)

Cancels the operation specified by OperationId .

Syntax

public void cancelOperation(String operationId);

Remarks

When this method is called the Error event will fire and the associated operation's completion event will fire.

For example, if CancelOperation is called for an upload that is in progress, both the Error event and the UploadComplete event will fire.

The SSHPlexOperation associated with the OperationId will be removed from the Operations collection.

ChangeRemotePath Method (SSHPlex Class)

This method changes the current path on the FTP server.

Syntax

public void changeRemotePath(String remotePath);

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

CheckFileExists Method (SSHPlex Class)

Returns if the file specified by RemoteFile exists on the remote server.

Syntax

public boolean checkFileExists();

Remarks

This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile before calling this method.

If no session is in place, the value of this property will always be false.

Config Method (SSHPlex Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SSHPlex Class)

Connects to the SSH host without logging in.

Syntax

public void connect();

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases it is recommended to use the SSHLogon method which will both establish a connection and log in to the server.

This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.

CreateFile Method (SSHPlex Class)

Creates a file on the remote server using SFTP.

Syntax

public String createFile(String fileName);

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter. FileName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the CreateFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the CreateFileComplete event to determine the result.

To upload a file with content use Upload instead.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

DeleteFile Method (SSHPlex Class)

Deletes a file on the remote server using SFTP.

Syntax

public String deleteFile(String fileName);

Remarks

This method deletes a file on the server with the name specified by the FileName parameter. FileName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the DeleteFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the DeleteFileComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

Disconnect Method (SSHPlex Class)

This method disconnects from the server without first logging off.

Syntax

public void disconnect();

Remarks

This method immediately disconnects from the server without first logging off.

In most cases the SSHLogoff method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.

DoEvents Method (SSHPlex Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Download Method (SSHPlex Class)

Download a RemoteFile using SFTP or SCP.

Syntax

public String download();

Remarks

This method downloads the remote file specified by RemoteFile to the local file specified by LocalFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the DownloadComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the DownloadComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp or cstScp.

Set RemoteFile to the name of the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

The file will be downloaded to the stream specified (if any) by SetDownloadStream. If a stream is not specified and LocalFile is set the file will be saved to the specified location.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the download.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Download(); // Cancel Download using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially downloaded temp file and set StartByte SSHPlexControl.StartByte = new FileInfo(localFile).Length; // Resume download string operationId = SSHPlexControl.Download();

Downloading Multiple Files Using a Filemask

Note: Using a filemask for downloads is only applicable when ChannelType is set to cstScp. To download files matching a filemask set RemoteFile to a filemask. The path may be specified as part of the value in RemoteFile or may be set separately in RemotePath. LocalFile should be set to a local directory where files will be downloaded. When Download is called all matching files are downloaded. See RemoteFile for more information.

Execute Method (SSHPlex Class)

Execute a specified command on the remote host.

Syntax

public String execute(String command);

Remarks

This method executes the specified Command on the remote host.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the ExecuteComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the ExecuteComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSExec or cstSShell.

Interrupt Method (SSHPlex Class)

This method interrupts the current method.

Syntax

public void interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (SSHPlex Class)

List the current directory specified by RemotePath on an server using SFTP.

Syntax

public String listDirectory();

Remarks

This method lists the directory specified by RemotePath. RemoteFile may also be set to a filemask to list associated files. The file listing is received through the DirList event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the ListDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the ListDirectoryComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

The directory entries are provided through the DirList event and also via the DirList property. SSHPlexControl.RemoteFile = ""; //Clear filemask SSHPlexControl.RemotePath = "MyFolder"; string opId = SSHPlexControl.ListDirectory(); // ListDirectory operates async so we must wait for it to finish while (SSHPlexControl.Operations.Keys.Contains(opId)) { SSHPlexControl.DoEvents(); } for (int i = 0; i < SSHPlexControl.DirList.Count; i++) { Console.WriteLine(SSHPlexControl.DirList[i].FileName); Console.WriteLine(SSHPlexControl.DirList[i].FileSize); Console.WriteLine(SSHPlexControl.DirList[i].FileTime); Console.WriteLine(SSHPlexControl.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: SSHPlexControl.RemoteFile = "*.txt"; SSHPlexControl.ListDirectory();

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

MakeDirectory Method (SSHPlex Class)

Creates a directory on the remote server using SFTP.

Syntax

public String makeDirectory(String newDir);

Remarks

This method creates an empty directory on the server with the name specified by the NewDir parameter. NewDir is either an absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the MakeDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the MakeDirectoryComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

QueryFileAttributes Method (SSHPlex Class)

Queries the server for the attributes of RemoteFile .

Syntax

public void queryFileAttributes();

Remarks

This method queries the server for attributes of RemoteFile. After calling this method, FileAttributes will be populated with the values returned by the server.

To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes.

QueryRemotePath Method (SSHPlex Class)

This queries the server for the current path.

Syntax

public String queryRemotePath();

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

RemoveDirectory Method (SSHPlex Class)

Removes a directory on the remote server using SFTP.

Syntax

public String removeDirectory(String dirName);

Remarks

This method deletes a directory on the server with the name specified by the DirName parameter. DirName is either and absolute path on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the RemoveDirectoryComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the RemoveDirectoryComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

RenameFile Method (SSHPlex Class)

Changes the name of a file on the remote server using SFTP.

Syntax

public String renameFile(String newName);

Remarks

This method renames the file on the server specified by RemoteFile to the name specified by the NewName parameter. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the RenameFileComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the RenameFileComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

SendCommand Method (SSHPlex Class)

Sends the specified command to the remote host.

Syntax

public void sendCommand(String command);

Remarks

This method sends the Command to the SSHHost. The command is executed in the user's shell.

It is not necessary to append an end-of-line character to the command. All output from the remote execution will be returned through the Stdout event.

This method sends the Command to the SSHHost. The command is executed in the user's shell.

There is no need to append an end-of-line character to the command. All output from the remote execution will be returned through the Stdout event.

SendStdinBytes Method (SSHPlex Class)

This method sends binary data to the remote host.

Syntax

public void sendStdinBytes(byte[] data);

Remarks

This method sends the specified binary data to the remote host. The data provided are used as input for the process on the remote host. To send text, use the SendStdinText method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the class fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

This method sends the specified binary data to the remote host. The data provided are used as input for the process on the remote host. To send text, use the SendStdinText method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the class fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

SendStdinText Method (SSHPlex Class)

This method sends text to the remote host.

Syntax

public void sendStdinText(String text);

Remarks

This method sends the specified text to the remote host. The text provided is used as an input for the process on the remote host. To send binary data, use the SendStdinBytes method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the class fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

This method sends the specified text to the remote host. The text provided is used as an input for the process on the remote host. To send binary data, use the SendStdinBytes method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the class fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

SetDownloadStream Method (SSHPlex Class)

Sets the stream to which the downloaded data from the server will be written.

Syntax

public void setDownloadStream(java.io.OutputStream downloadStream);

Remarks

If a download stream is set before the Download method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetDownloadStream again before calling Download again.

The downloaded content will be written starting at the current position in the stream.

Note: SetDownloadStream and LocalFile will reset the other.

SetUploadStream Method (SSHPlex Class)

Sets the stream from which the class will read data to upload to the server.

Syntax

public void setUploadStream(java.io.InputStream uploadStream);

Remarks

If an upload stream is set before the Upload method is called, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetUploadStream again before calling Upload again. The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

Note: SetUploadStream and LocalFile will reset the other.

SSHLogoff Method (SSHPlex Class)

Logoff from the SSH server.

Syntax

public void SSHLogoff();

Remarks

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (SSHPlex Class)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

public void SSHLogon(String SSHHost, int SSHPort);

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)

SSHPlexControl.SSHUser = "username" SSHPlexControl.SSHPassword = "password" SSHPlexControl.SSHLogon("sshHost", sshPort)

UpdateFileAttributes Method (SSHPlex Class)

Instructs the class to send the FileAttributes to the server using SFTP.

Syntax

public String updateFileAttributes();

Remarks

When UpdateFileAttributes is called, the class will send the value of FileAttributes to the server.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the UpdateFileAttributesComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the UpdateFileAttributesComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp.

Upload Method (SSHPlex Class)

Upload a file specified by LocalFile using SCP or SFTP.

Syntax

public String upload();

Remarks

This method Uploads the local file specified by LocalFile to the remote file specified by RemoteFile. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. If the LocalFile property is "" (empty string) then the file data will be available through the Transfer event.

This method returns an Operation Id which identifies the operation in progress. A corresponding SSHPlexOperation will also be added to the Operations collection. The operation can be canceled by passing the Operation Id to the CancelOperation method.

When the operation completes the UploadComplete event will fire, and the SSHPlexOperation associated with the completed operation will be removed from the Operations collection. Inspect the parameters of the UploadComplete event to determine the result.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

This method is only applicable when ChannelType is set to cstSftp or cstScp.

Set LocalFile to the name of the file to upload before calling this method. If SetUploadStream is used to set an upload stream the data to upload is taken from the stream instead.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

Code Example

SSHPlexControl.Localfile = "C:\localfile.txt"; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Use Path in RemoteFile SSHPlexControl.Localfile = "C:\localfile2.txt"; SSHPlexControl.RemoteFile = "folder/remotefile2.txt"; string operationId = SSHPlexControl.Upload();

Resuming Uploads

The class also supports resuming failed uploads by using the StartByte property. If an upload is interrupted or canceled, set StartByte to the appropriate offset before calling this method to resume the upload.

string localFile = "C:\localfile.txt"; SSHPlexControl.Localfile = localFile; SSHPlexControl.RemoteFile = "remotefile.txt"; string operationId = SSHPlexControl.Upload(); // Cancel Upload using the CancelOperation method SSHPlexControl.CancelOperation(operationId); // Get the size of the partially uploaded temp file and set StartByte SSHPlexControl.StartByte = SSHPlexControl.FileAttributes.Size; // Resume upload string operationId = SSHPlexControl.Upload();

AppendComplete Event (SSHPlex Class)

Fired when an Append operation completes.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void appendComplete(SSHPlexAppendCompleteEvent e) {}
  ...
}

public class SSHPlexAppendCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String localFile;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when an Append operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

Connected Event (SSHPlex Class)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void connected(SSHPlexConnectedEvent e) {}
  ...
}

public class SSHPlexConnectedEvent {
  public int statusCode;
  public String description;
}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSHPlex Class)

Fired to indicate changes in the connection state.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void connectionStatus(SSHPlexConnectionStatusEvent e) {}
  ...
}

public class SSHPlexConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

CreateFileComplete Event (SSHPlex Class)

Fired when a CreateFile operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void createFileComplete(SSHPlexCreateFileCompleteEvent e) {}
  ...
}

public class SSHPlexCreateFileCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when a CreateFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

DeleteFileComplete Event (SSHPlex Class)

Fired when a DeleteFile operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void deleteFileComplete(SSHPlexDeleteFileCompleteEvent e) {}
  ...
}

public class SSHPlexDeleteFileCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when a DeleteFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

DirList Event (SSHPlex Class)

Fired when a directory entry is received.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void dirList(SSHPlexDirListEvent e) {}
  ...
}

public class SSHPlexDirListEvent {
  public String operationId;
  public String dirEntry;
  public String fileName;
  public boolean isDir;
  public long fileSize;
  public String fileTime;
  public boolean isSymlink;
}

Remarks

OperationId is associated with the operation that fired this event.

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm", otherwise it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link the value of IsDir will always be False since this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or folder set RemoteFile and query the IsDir field.

Disconnected Event (SSHPlex Class)

Fired when a connection is closed.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void disconnected(SSHPlexDisconnectedEvent e) {}
  ...
}

public class SSHPlexDisconnectedEvent {
  public int statusCode;
  public String description;
}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

DownloadComplete Event (SSHPlex Class)

Fired when a Download operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void downloadComplete(SSHPlexDownloadCompleteEvent e) {}
  ...
}

public class SSHPlexDownloadCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String localFile;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when a Download operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

EndTransfer Event (SSHPlex Class)

Fired when a file completes downloading/uploading.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void endTransfer(SSHPlexEndTransferEvent e) {}
  ...
}

public class SSHPlexEndTransferEvent {
  public String operationId;
  public int direction;
  public String localFile;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event is fired once per file when it finishes downloading/uploading.

OperationId is the string associated with operation fired this event.

Direction is 0 for Uploads and 1 for Downloads.

LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the method that triggered this event.

Error Event (SSHPlex Class)

Information about errors during data delivery.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void error(SSHPlexErrorEvent e) {}
  ...
}

public class SSHPlexErrorEvent {
  public String operationId;
  public int errorCode;
  public String description;
  public String localFile;
  public String remoteFile;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LocalFile identifies the local file. RemoteFile is the remote file.

ExecuteComplete Event (SSHPlex Class)

Fired when an Execute operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void executeComplete(SSHPlexExecuteCompleteEvent e) {}
  ...
}

public class SSHPlexExecuteCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public int exitStatus;
}

Remarks

This event fires when an Execute operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

ExitStatus is the exit code of the executed command. If an error message is returned it is present in ErrorDescription.

ListDirectoryComplete Event (SSHPlex Class)

Fired when a ListDirectory operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void listDirectoryComplete(SSHPlexListDirectoryCompleteEvent e) {}
  ...
}

public class SSHPlexListDirectoryCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remotePath;
}

Remarks

This event fires when a ListDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemotePath is the remote path that was specified when the operation was initiated.

Log Event (SSHPlex Class)

Fired once for each log message.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void log(SSHPlexLogEvent e) {}
  ...
}

public class SSHPlexLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

MakeDirectoryComplete Event (SSHPlex Class)

Fired when a MakeDirectory operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void makeDirectoryComplete(SSHPlexMakeDirectoryCompleteEvent e) {}
  ...
}

public class SSHPlexMakeDirectoryCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remotePath;
}

Remarks

This event fires when a MakeDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemotePath is the remote path that was specified when the operation was initiated.

RemoveDirectoryComplete Event (SSHPlex Class)

Fired when a RemoveDirectory operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void removeDirectoryComplete(SSHPlexRemoveDirectoryCompleteEvent e) {}
  ...
}

public class SSHPlexRemoveDirectoryCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String directoryName;
  public String remotePath;
}

Remarks

This event fires when a RemoveDirectory operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

DirectoryName is the name of the directory which was removed.

RemotePath is the remote path that was specified when the operation was initiated.

RenameFileComplete Event (SSHPlex Class)

Fired when a RenameFile operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void renameFileComplete(SSHPlexRenameFileCompleteEvent e) {}
  ...
}

public class SSHPlexRenameFileCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remoteFile;
  public String remotePath;
  public String newFileName;
}

Remarks

This event fires when a RenameFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

NewFileName is the name to which the file was renamed as provided when RenameFile was originally called.

SSHCustomAuth Event (SSHPlex Class)

Fired when the class is doing a custom authentication.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void SSHCustomAuth(SSHPlexSSHCustomAuthEvent e) {}
  ...
}

public class SSHPlexSSHCustomAuthEvent {
  public String packet; //read-write
}

Remarks

SSHCustomAuth is fired during the user authentication stage of the Secure Shell (SSH) logon process if SSHAuthMode is set to amCustom. Packet contains the last raw SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet, call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet, use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SSHPlex Class)

Fired when the class receives a request for user input from the server.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void SSHKeyboardInteractive(SSHPlexSSHKeyboardInteractiveEvent e) {}
  ...
}

public class SSHPlexSSHKeyboardInteractiveEvent {
  public String name;
  public String instructions;
  public String prompt;
  public String response; //read-write
  public boolean echoResponse;
}

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: The server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHPlex Class)

Fired after the server presents its public key to the client.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void SSHServerAuthentication(SSHPlexSSHServerAuthenticationEvent e) {}
  ...
}

public class SSHPlexSSHServerAuthenticationEvent {
  public byte[] hostKey;
  public String fingerprint;
  public String keyAlgorithm;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value, see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. The following values are supported:

• ssh-rsa
• ssh-dss
• rsa-sha2-256
• rsa-sha2-512
• x509v3-sign-rsa
• x509v3-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (SSHPlex Class)

Fired to track the progress of the secure connection.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void SSHStatus(SSHPlexSSHStatusEvent e) {}
  ...
}

public class SSHPlexSSHStatusEvent {
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (SSHPlex Class)

Fired when a file starts downloading/uploading.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void startTransfer(SSHPlexStartTransferEvent e) {}
  ...
}

public class SSHPlexStartTransferEvent {
  public String operationId;
  public int direction;
  public String localFile;
  public String remoteFile;
  public String remotePath;
  public String filePermissions; //read-write
}

Remarks

This event is fired once per file when it starts downloading/uploading.

OperationId is the string associated with operation fired this event.

Direction is 0 for Uploads and 1 for Downloads.

LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the method that triggered this event.

FilePermissions includes information about the file that can be modified before finishing the upload/download.

Stderr Event (SSHPlex Class)

Fired when data (complete lines) come in through stderr.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void stderr(SSHPlexStderrEvent e) {}
  ...
}

public class SSHPlexStderrEvent {
  public String operationId;
  public byte[] text;
}

Remarks

The Stderr event is fired every time the process on the remote host outputs a line in its error output. The incoming data is provided through the Text parameter.

Stdout Event (SSHPlex Class)

Fired when data (complete lines) come in through stdout.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void stdout(SSHPlexStdoutEvent e) {}
  ...
}

public class SSHPlexStdoutEvent {
  public String operationId;
  public byte[] text;
}

Remarks

The Stdout event is fired every time the process on the remote host outputs a line in its standard output. The incoming data is provided through the Text parameter.

Transfer Event (SSHPlex Class)

Fired during file download/upload.

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void transfer(SSHPlexTransferEvent e) {}
  ...
}

public class SSHPlexTransferEvent {
  public String operationId;
  public int direction;
  public String localFile;
  public String remoteFile;
  public String remotePath;
  public long bytesTransferred;
  public int percentDone;
  public byte[] text;
  public boolean cancel; //read-write
}

Remarks

This event is fired once per file when it starts downloading/uploading.

OperationId is associated with the operation that fired this event. Direction is 0 for Uploads and 1 for Downloads. LocalFile, RemoteFile, and RemotePath are populated with values of LocalFile, RemoteFile, and RemotePath, respectively, that are associated with the operation that fired this event.

BytesTransferred shows the number of bytes transferred since the beginning of the transfer, and PercentDone contains the percentage (0-100) of bytes transferred based on the Direction being transferred. If PercentDone cannot be calculated the value will be -1.

Text contains the text of the file being transferred.

Setting Cancel to true will cancel the associated operation without firing a DownloadComplete or UploadComplete event. It is not equivalent to calling CancelOperation with the associated OperationId, which will fire the aforementioned events.

UpdateFileAttributesComplete Event (SSHPlex Class)

Fired when a UpdateFileAttributes operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void updateFileAttributesComplete(SSHPlexUpdateFileAttributesCompleteEvent e) {}
  ...
}

public class SSHPlexUpdateFileAttributesCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when an UpdateFileAttributes operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

UploadComplete Event (SSHPlex Class)

Fired when an Upload operation completes (or fails).

Syntax

public class DefaultSSHPlexEventListener implements SSHPlexEventListener {
  ...
  public void uploadComplete(SSHPlexUploadCompleteEvent e) {}
  ...
}

public class SSHPlexUploadCompleteEvent {
  public String operationId;
  public int errorCode;
  public String errorDescription;
  public String localFile;
  public String remoteFile;
  public String remotePath;
}

Remarks

This event fires when an Upload operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

LocalFile is the local file that was specified when the operation was initiated.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

DirEntry Type

This is a listing in a directory returned from the server.

Remarks

The DirEntry listings are filled out by the class when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call. The server returns a listing for each directory and file at the current path that exists. This listing is parsed into a directory entry.

If ListDirectoryLong is called, all of the fields listed below are supplied by the server. When the ListDirectory method is called, however, the FileSize, FileTime, and IsDir fields all are left empty by the server. In this case, the only field it returns is the FileName.

The full line for the directory entry is provided by the Entry field.

Fields

Constructors

public DirEntry();

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

public Firewall();

SFTPFileAttributes Type

Includes a set of attributes for a file existing on an secure file transfer protocol (SFTP) server.

Remarks

This type describes a file residing on an SFTP server.

Fields

SSHPlexOperation Type

This object contains information about a currently running operation.

Remarks

A SSHPlexOperation object is created and added to the Operations collection each time a relevant method is called. The object will be removed from the Operations collection when the operation completes, fails, or is canceled by the CancelOperation method.

Fields

Config Settings (SSHPlex Class)

SFTPClient Config Settings

SCP Config Settings

SShell Config Settings

SExec Config Settings

SSHClient Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHPlex Class)

SSHPlex Errors

SFTPClient Errors

SCP Errors

SExec Errors

SShell Errors

SSHClient Errors

TCPClient Errors

TCP/IP Errors