SSHPlex Component

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 component combines the functionality of the Secure Copy Protocol (SCP) component, the Secure File Transfer Protocol (SFTP) component, the SExec component, and the SShell component. All operations are performed over a single Secure Shell (SSH) connection.

The asynchronous design of the component 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: CancelOperation and other methods not explicitly listed here 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 through 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: Because RemoteFile is used as a filemask, ensure that you 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 specifies only a filename, it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If 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 component 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.

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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ChannelType Property (SSHPlex Component)

Specifies the channel type to be used by the class.

Syntax

func (obj *SSHPlex) ChannelType() (int32, error)
func (obj *SSHPlex) SetChannelType(value int32) error

Possible Values

0   // SShell
1   // SExec
2   // Scp
3   // Sftp

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 as follows:

NOTE: CancelOperation and other methods not explicitly listed here are applicable to all channel types.

Data Type

int32

Connected Property (SSHPlex Component)

Whether the class is connected.

Syntax

func (obj *SSHPlex) Connected() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

DirListCount Property (SSHPlex Component)

The number of records in the DirList arrays.

Syntax

func (obj *SSHPlex) DirListCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListEntry
• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir
• DirListIsSymlink

The array indices start at 0 and end at DirListCount - 1.

This property is read-only.

Data Type

int32

DirListEntry Property (SSHPlex Component)

This property contains the raw entry as received from the server.

Syntax

func (obj *SSHPlex) DirListEntry(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListFileName Property (SSHPlex Component)

This property shows the file name in the last directory listing.

Syntax

func (obj *SSHPlex) DirListFileName(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean DirListIsDir property.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListFileSize Property (SSHPlex Component)

This property shows the file size in the last directory listing.

Syntax

func (obj *SSHPlex) DirListFileSize(EntryIndex int32) (int64, error)

Default Value

0

Remarks

This property shows the file size in the last directory listing.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

int64

DirListFileTime Property (SSHPlex Component)

This property shows the file time in the last directory listing.

Syntax

func (obj *SSHPlex) DirListFileTime(EntryIndex int32) (string, error)

Default Value

""

Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

NOTE: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

string

DirListIsDir Property (SSHPlex Component)

This property specifies whether entries in the last directory listing are directories.

Syntax

func (obj *SSHPlex) DirListIsDir(EntryIndex int32) (bool, error)

Default Value

false

Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in DirListFileName is a file or a directory.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

bool

DirListIsSymlink Property (SSHPlex Component)

This property indicates whether the entry is a symbolic link.

Syntax

func (obj *SSHPlex) DirListIsSymlink(EntryIndex int32) (bool, error)

Default Value

false

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of DirListIsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.SFTPFileIsDir property.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only.

Data Type

bool

SFTPFileAccessTime Property (SSHPlex Component)

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Syntax

func (obj *SSHPlex) SFTPFileAccessTime() (int64, error)
func (obj *SSHPlex) SetSFTPFileAccessTime(value int64) error

Default Value

0

Remarks

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Data Type

int64

SFTPFileACL Property (SSHPlex Component)

Contains a string containing an access control list (ACL).

Syntax

func (obj *SSHPlex) SFTPFileACL() (string, error)
func (obj *SSHPlex) SetSFTPFileACL(value string) error

Default Value

""

Remarks

Contains a string containing an access control list (ACL).

Data Type

string

SFTPFileAllocationSize Property (SSHPlex Component)

Specifies the size, in bytes, that this file consumes on disk.

Syntax

func (obj *SSHPlex) SFTPFileAllocationSize() (int64, error)

Default Value

0

Remarks

Specifies the size, in bytes, that this file consumes on disk.

This property is read-only.

Data Type

int64

SFTPFileAttributeBits Property (SSHPlex Component)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SSHPlex) SFTPFileAttributeBits() (int32, error)

Default Value

0

Remarks

SFTPFileAttributeBits and SFTPFileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in SFTPFileAttributeBitsValid must be ignored in SFTPFileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

• 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
• 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
• 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
• 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
• 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
• 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
• 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
• 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
• 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
• 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
• 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
• 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

This property is read-only.

Data Type

int32

SFTPFileAttributeBitsValid Property (SSHPlex Component)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Syntax

func (obj *SSHPlex) SFTPFileAttributeBitsValid() (int32, error)

Default Value

0

Remarks

SFTPFileAttributeBits and SFTPFileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in SFTPFileAttributeBitsValid must be ignored in SFTPFileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

• 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
• 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
• 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
• 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
• 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
• 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
• 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
• 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
• 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
• 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
• 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
• 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

This property is read-only.

Data Type

int32

SFTPFileCreationTime Property (SSHPlex Component)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

Syntax

func (obj *SSHPlex) SFTPFileCreationTime() (int64, error)
func (obj *SSHPlex) SetSFTPFileCreationTime(value int64) error

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

Data Type

int64

SFTPFileType Property (SSHPlex Component)

The type of file.

Syntax

func (obj *SSHPlex) SFTPFileType() (int32, error)

Possible Values

1   // Regular
2   // Directory
3   // SymLink
4   // Special
5   // Unknown
6   // Socket
7   // CharDevice
8   // BlockDevice
9   // FIFO

Default Value

0

Remarks

The type of file. SFTPFileType may be one of the following values:

This property is read-only.

Data Type

int32

SFTPFileGroupId Property (SSHPlex Component)

Specifies the Id of the group that has access rights this file.

Syntax

func (obj *SSHPlex) SFTPFileGroupId() (string, error)
func (obj *SSHPlex) SetSFTPFileGroupId(value string) error

Default Value

""

Remarks

Specifies the Id of the group that has access rights this file.

Data Type

string

SFTPFileIsDir Property (SSHPlex Component)

Specifies whether or not the file represented by these attributes is a directory.

Syntax

func (obj *SSHPlex) SFTPFileIsDir() (bool, error)

Default Value

false

Remarks

Specifies whether or not the file represented by these attributes is a directory.

This property is read-only.

Data Type

bool

SFTPFileIsSymlink Property (SSHPlex Component)

Specifies whether or not the file or directory represented by these attributes is a symbolic link.

Syntax

func (obj *SSHPlex) SFTPFileIsSymlink() (bool, error)

Default Value

false

Remarks

Specifies whether or not the file or directory represented by these attributes is a symbolic link. This setting is applicable only when GetSymlinkAttrs is set to True. By default, the attributes of the actual file referred to by the link (not the symbolic link) are returned and this property will always be False.

This property is read-only.

Data Type

bool

SFTPFileModifiedTime Property (SSHPlex Component)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Syntax

func (obj *SSHPlex) SFTPFileModifiedTime() (int64, error)
func (obj *SSHPlex) SetSFTPFileModifiedTime(value int64) error

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Data Type

int64

SFTPFileOwnerId Property (SSHPlex Component)

Specifies the user Id of this file's owner.

Syntax

func (obj *SSHPlex) SFTPFileOwnerId() (string, error)
func (obj *SSHPlex) SetSFTPFileOwnerId(value string) error

Default Value

""

Remarks

Specifies the user Id of this file's owner.

Data Type

string

SFTPFilePermissions Property (SSHPlex Component)

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

Syntax

func (obj *SSHPlex) SFTPFilePermissions() (int32, error)
func (obj *SSHPlex) SetSFTPFilePermissions(value int32) error

Default Value

0

Remarks

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a decimal value of a series of octal digits. For example, an octal permission value of "100644" would be "33188" in Base10, and "40755" in octal would be "16877" in Base10.

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:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

NOTE: You will need to convert the octal permissions bitmask into its decimal representation.

Data Type

int32

SFTPFilePermissionsOctal Property (SSHPlex Component)

Includes an octal string containing the a POSIX-compatible file permission bitmask.

Syntax

func (obj *SSHPlex) SFTPFilePermissionsOctal() (string, error)
func (obj *SSHPlex) SetSFTPFilePermissionsOctal(value string) error

Default Value

""

Remarks

Includes an octal string containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a series of octal digits. For example, "100644" and "40755".

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:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

Data Type

string

SFTPFileSize Property (SSHPlex Component)

Specifies the total size, in bytes, of this file.

Syntax

func (obj *SSHPlex) SFTPFileSize() (int64, error)

Default Value

0

Remarks

Specifies the total size, in bytes, of this file.

This property is read-only.

Data Type

int64

FilePermissions Property (SSHPlex Component)

The file permissions for the RemoteFile .

Syntax

func (obj *SSHPlex) FilePermissions() (string, error)
func (obj *SSHPlex) SetFilePermissions(value string) error

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.

Data Type

string

FirewallAutoDetect Property (SSHPlex Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

func (obj *SSHPlex) FirewallAutoDetect() (bool, error)
func (obj *SSHPlex) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

FirewallType Property (SSHPlex Component)

The type of firewall to connect through.

Syntax

func (obj *SSHPlex) FirewallType() (int32, error)
func (obj *SSHPlex) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

int32

FirewallHost Property (SSHPlex Component)

The name or IP address of the firewall (optional).

Syntax

func (obj *SSHPlex) FirewallHost() (string, error)
func (obj *SSHPlex) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component fails with an error.

Data Type

string

FirewallPassword Property (SSHPlex Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

func (obj *SSHPlex) FirewallPassword() (string, error)
func (obj *SSHPlex) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component fails with an error.

Data Type

string

FirewallPort Property (SSHPlex Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

func (obj *SSHPlex) FirewallPort() (int32, error)
func (obj *SSHPlex) SetFirewallPort(value int32) error

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

NOTE: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

int32

FirewallUser Property (SSHPlex Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

func (obj *SSHPlex) FirewallUser() (string, error)
func (obj *SSHPlex) SetFirewallUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component fails with an error.

Data Type

string

LocalFile Property (SSHPlex Component)

The path to a local file for upload or download.

Syntax

func (obj *SSHPlex) LocalFile() (string, error)
func (obj *SSHPlex) SetLocalFile(value string) error

Default Value

""

Remarks

The LocalFile property is used by the Upload and Download methods. The file will be overwritten only 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()

Data Type

string

LocalHost Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) LocalHost() (string, error)
func (obj *SSHPlex) SetLocalHost(value string) error

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 component initiate connections (or accept in the case of server components) 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 component 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.

Data Type

string

LocalPort Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) LocalPort() (int32, error)
func (obj *SSHPlex) SetLocalPort(value int32) error

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the component 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.

Data Type

int32

OperationCount Property (SSHPlex Component)

The number of records in the Operation arrays.

Syntax

func (obj *SSHPlex) OperationCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• OperationId

The array indices start at 0 and end at OperationCount - 1.

This property is read-only.

Data Type

int32

OperationId Property (SSHPlex Component)

This property contains the Id of the currently running operation.

Syntax

func (obj *SSHPlex) OperationId(OperationIndex int32) (string, error)

Default Value

""

Remarks

This property contains the Id of the currently running operation.

The OperationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OperationCount property.

This property is read-only.

Data Type

string

Overwrite Property (SSHPlex Component)

The value indicating Whether or not the class should overwrite files during transfer.

Syntax

func (obj *SSHPlex) Overwrite() (bool, error)
func (obj *SSHPlex) SetOverwrite(value bool) error

Default Value

false

Remarks

When ChannelType is set to cstSFTP, this property is a value indicating whether or not the component 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 component should overwrite LocalFile when downloading. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

bool

RemoteFile Property (SSHPlex Component)

The name of the remote file for uploading, downloading, and so on.

Syntax

func (obj *SSHPlex) RemoteFile() (string, error)
func (obj *SSHPlex) SetRemoteFile(value string) error

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 1. 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 2. 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.

Data Type

string

SSHAcceptServerHostKeyEffectiveDate Property (SSHPlex Component)

The date on which this certificate becomes valid.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyExpirationDate Property (SSHPlex Component)

The date on which the certificate expires.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyExtendedKeyUsage Property (SSHPlex Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprint Property (SSHPlex Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprintSHA1 Property (SSHPlex Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyFingerprintSHA256 Property (SSHPlex Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyIssuer Property (SSHPlex Component)

The issuer of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPrivateKey Property (SSHPlex Component)

The private key of the certificate (if available).

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSHAcceptServerHostKeyPrivateKey may be available but not exportable. In this case, SSHAcceptServerHostKeyPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPrivateKeyAvailable Property (SSHPlex Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSHAcceptServerHostKeyPrivateKey is available for the selected certificate. If SSHAcceptServerHostKeyPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSHAcceptServerHostKeyPrivateKeyContainer Property (SSHPlex Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSHAcceptServerHostKeyPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKey Property (SSHPlex Component)

The public key of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKeyAlgorithm Property (SSHPlex Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyPublicKeyLength Property (SSHPlex Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSHAcceptServerHostKeySerialNumber Property (SSHPlex Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeySerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeySignatureAlgorithm Property (SSHPlex Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeySignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyStore Property (SSHPlex Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyStore() ([]byte, error)
func (obj *SSHPlex) SetSSHAcceptServerHostKeyStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSHAcceptServerHostKeyStoreType property denotes the type of the certificate store specified by SSHAcceptServerHostKeyStore. If the store is password-protected, specify the password in SSHAcceptServerHostKeyStorePassword.

SSHAcceptServerHostKeyStore is used in conjunction with the SSHAcceptServerHostKeySubject property to specify client certificates. If SSHAcceptServerHostKeyStore has a value, and SSHAcceptServerHostKeySubject or SSHAcceptServerHostKeyEncoded is set, a search for a certificate is initiated. Please see the SSHAcceptServerHostKeySubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSHAcceptServerHostKeyStorePassword Property (SSHPlex Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyStorePassword() (string, error)
func (obj *SSHPlex) SetSSHAcceptServerHostKeyStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSHAcceptServerHostKeyStoreType Property (SSHPlex Component)

The type of certificate store for this certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyStoreType() (int32, error)
func (obj *SSHPlex) SetSSHAcceptServerHostKeyStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSHAcceptServerHostKeySubjectAltNames Property (SSHPlex Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeySubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintMD5 Property (SSHPlex Component)

The MD5 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintSHA1 Property (SSHPlex Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyThumbprintSHA256 Property (SSHPlex Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyUsage Property (SSHPlex Component)

The text description of UsageFlags .

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyUsage() (string, error)

Default Value

""

Remarks

The text description of SSHAcceptServerHostKeyUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSHAcceptServerHostKeyUsageFlags Property (SSHPlex Component)

The flags that show intended use for the certificate.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHAcceptServerHostKeyUsageFlags is a combination of the following flags:

Please see the SSHAcceptServerHostKeyUsage property for a text representation of SSHAcceptServerHostKeyUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSHAcceptServerHostKeyVersion Property (SSHPlex Component)

The certificate's version number.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSHAcceptServerHostKeySubject Property (SSHPlex Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeySubject() (string, error)
func (obj *SSHPlex) SetSSHAcceptServerHostKeySubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSHAcceptServerHostKeyEncoded Property (SSHPlex Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *SSHPlex) SSHAcceptServerHostKeyEncoded() ([]byte, error)
func (obj *SSHPlex) SetSSHAcceptServerHostKeyEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.

When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.

Data Type

[]byte

SSHAuthMode Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) SSHAuthMode() (int32, error)
func (obj *SSHPlex) SetSSHAuthMode(value int32) error

Possible Values

0   // None
1   // MultiFactor
2   // Password
3   // PublicKey
4   // KeyboardInteractive
5   // GSSAPIWithMic
6   // GSSAPIKeyex
99   // Custom

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 component 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 component 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 component 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.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

int32

SSHCertEffectiveDate Property (SSHPlex Component)

The date on which this certificate becomes valid.

Syntax

func (obj *SSHPlex) SSHCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSHCertExpirationDate Property (SSHPlex Component)

The date on which the certificate expires.

Syntax

func (obj *SSHPlex) SSHCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSHCertExtendedKeyUsage Property (SSHPlex Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *SSHPlex) SSHCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSHCertFingerprint Property (SSHPlex Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSHCertFingerprintSHA1 Property (SSHPlex Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSHCertFingerprintSHA256 Property (SSHPlex Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *SSHPlex) SSHCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSHCertIssuer Property (SSHPlex Component)

The issuer of the certificate.

Syntax

func (obj *SSHPlex) SSHCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSHCertPrivateKey Property (SSHPlex Component)

The private key of the certificate (if available).

Syntax

func (obj *SSHPlex) SSHCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSHCertPrivateKeyAvailable Property (SSHPlex Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *SSHPlex) SSHCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSHCertPrivateKeyContainer Property (SSHPlex Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *SSHPlex) SSHCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSHCertPublicKey Property (SSHPlex Component)

The public key of the certificate.

Syntax

func (obj *SSHPlex) SSHCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSHCertPublicKeyAlgorithm Property (SSHPlex Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *SSHPlex) SSHCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHCertPublicKeyLength Property (SSHPlex Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *SSHPlex) SSHCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSHCertSerialNumber Property (SSHPlex Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *SSHPlex) SSHCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSHCertSignatureAlgorithm Property (SSHPlex Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *SSHPlex) SSHCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSHCertStore Property (SSHPlex Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *SSHPlex) SSHCertStore() ([]byte, error)
func (obj *SSHPlex) SetSSHCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password-protected, specify the password in SSHCertStorePassword.

SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSHCertStorePassword Property (SSHPlex Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *SSHPlex) SSHCertStorePassword() (string, error)
func (obj *SSHPlex) SetSSHCertStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSHCertStoreType Property (SSHPlex Component)

The type of certificate store for this certificate.

Syntax

func (obj *SSHPlex) SSHCertStoreType() (int32, error)
func (obj *SSHPlex) SetSSHCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSHCertSubjectAltNames Property (SSHPlex Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *SSHPlex) SSHCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSHCertThumbprintMD5 Property (SSHPlex Component)

The MD5 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertThumbprintSHA1 Property (SSHPlex Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertThumbprintSHA256 Property (SSHPlex Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *SSHPlex) SSHCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSHCertUsage Property (SSHPlex Component)

The text description of UsageFlags .

Syntax

func (obj *SSHPlex) SSHCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSHCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSHCertUsageFlags Property (SSHPlex Component)

The flags that show intended use for the certificate.

Syntax

func (obj *SSHPlex) SSHCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:

Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSHCertVersion Property (SSHPlex Component)

The certificate's version number.

Syntax

func (obj *SSHPlex) SSHCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSHCertSubject Property (SSHPlex Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *SSHPlex) SSHCertSubject() (string, error)
func (obj *SSHPlex) SetSSHCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSHCertEncoded Property (SSHPlex Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *SSHPlex) SSHCertEncoded() ([]byte, error)
func (obj *SSHPlex) SetSSHCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.

When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.

Data Type

[]byte

SSHCompressionAlgorithms Property (SSHPlex Component)

The comma-separated list containing all allowable compression algorithms.

Syntax

func (obj *SSHPlex) SSHCompressionAlgorithms() (string, error)
func (obj *SSHPlex) SetSSHCompressionAlgorithms(value string) error

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 component 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 component:

• zlib
• zlib@openssh.com
• none

Data Type

string

SSHEncryptionAlgorithms Property (SSHPlex Component)

The comma-separated list containing all allowable encryption algorithms.

Syntax

func (obj *SSHPlex) SSHEncryptionAlgorithms() (string, error)
func (obj *SSHPlex) SetSSHEncryptionAlgorithms(value string) error

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,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 component 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 component:

• aes256-ctr
• aes256-cbc
• aes192-ctr
• aes192-cbc
• aes128-ctr
• aes128-cbc
• 3des-ctr
• 3des-cbc
• cast128-cbc
• blowfish-cbc
• arcfour
• arcfour128
• arcfour256
• aes256-gcm@openssh.com
• aes128-gcm@openssh.com
• chacha20-poly1305@openssh.com

Data Type

string

SSHHost Property (SSHPlex Component)

The address of the Secure Shell (SSH) host.

Syntax

func (obj *SSHPlex) SSHHost() (string, error)
func (obj *SSHPlex) SetSSHHost(value string) error

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.

Data Type

string

SSHPassword Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) SSHPassword() (string, error)
func (obj *SSHPlex) SetSSHPassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SSHPort Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) SSHPort() (int32, error)
func (obj *SSHPlex) SetSSHPort(value int32) error

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.

Data Type

int32

SSHUser Property (SSHPlex Component)

The username for Secure Shell (SSH) authentication.

Syntax

func (obj *SSHPlex) SSHUser() (string, error)
func (obj *SSHPlex) SetSSHUser(value string) error

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.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

string

StartByte Property (SSHPlex Component)

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

Syntax

func (obj *SSHPlex) StartByte() (int64, error)
func (obj *SSHPlex) SetStartByte(value int64) error

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.

Data Type

int64

Timeout Property (SSHPlex Component)

This property includes the timeout for the class.

Syntax

func (obj *SSHPlex) Timeout() (int32, error)
func (obj *SSHPlex) SetTimeout(value int32) error

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The component 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 component fails with an error.

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.

Data Type

int32

Append Method (SSHPlex Component)

Appends the data from a local file; to a remote file using SFTP.

Syntax

func (obj *SSHPlex) Append() (string, error)

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 that 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 applicable only 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 Component)

Cancels the operation specified by OperationId .

Syntax

func (obj *SSHPlex) CancelOperation(OperationId string) error

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 Component)

This method changes the current path on the FTP server.

Syntax

func (obj *SSHPlex) ChangeRemotePath(RemotePath string) error

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the component 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 Component)

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

Syntax

func (obj *SSHPlex) CheckFileExists() (bool, error)

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 Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *SSHPlex) Config(ConfigurationString string) (string, error)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Connects to the Secure Shell (SSH) host without logging in.

Syntax

func (obj *SSHPlex) Connect() error

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 in which it is desirable to separate the connection and logon operations (e.g., confirming a host is available by first creating the connection).

CreateFile Method (SSHPlex Component)

Creates a file on the remote server using SFTP.

Syntax

func (obj *SSHPlex) CreateFile(FileName string) (string, error)

Remarks

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

This method returns an Operation Id that 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 applicable only when ChannelType is set to cstSftp.

DeleteFile Method (SSHPlex Component)

Deletes a file on the remote server using SFTP.

Syntax

func (obj *SSHPlex) DeleteFile(FileName string) (string, error)

Remarks

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

This method returns an Operation Id that 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 applicable only when ChannelType is set to cstSftp.

Disconnect Method (SSHPlex Component)

Disconnects from the server without first logging off.

Syntax

func (obj *SSHPlex) Disconnect() error

Remarks

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

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

DoEvents Method (SSHPlex Component)

This method processes events from the internal message queue.

Syntax

func (obj *SSHPlex) DoEvents() error

Remarks

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

Download Method (SSHPlex Component)

Download a RemoteFile using SFTP or SCP.

Syntax

func (obj *SSHPlex) Download() (string, error)

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 that 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 applicable only when ChannelType is set to cstSftp or cstScp.

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

If 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 component 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 applicable only 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 Component)

Executes a specified command on the remote host.

Syntax

func (obj *SSHPlex) Execute(Command string) (string, error)

Remarks

This method executes the specified Command on the remote host.

This method returns an Operation Id that 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 applicable only when ChannelType is set to cstSExec or cstSShell.

Interrupt Method (SSHPlex Component)

This method interrupts the current method.

Syntax

func (obj *SSHPlex) Interrupt() error

Remarks

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

ListDirectory Method (SSHPlex Component)

Lists the current directory specified by RemotePath on a server using secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) ListDirectory() (string, error)

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 that 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 applicable only when ChannelType is set to cstSftp.

The directory entries are provided through the DirList event and also through 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: Because RemoteFile is used as a filemask, ensure that you clear or reset this value before calling ListDirectory

MakeDirectory Method (SSHPlex Component)

Creates a directory on the remote server using secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) MakeDirectory(NewDir string) (string, error)

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 that 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 applicable only when ChannelType is set to cstSftp.

QueryFileAttributes Method (SSHPlex Component)

Queries the server for the attributes of RemoteFile .

Syntax

func (obj *SSHPlex) QueryFileAttributes() error

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 Component)

This queries the server for the current path.

Syntax

func (obj *SSHPlex) QueryRemotePath() (string, error)

Remarks

This method queries the server for the current path. When called, the component 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 Component)

Removes a directory on the remote server using secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) RemoveDirectory(DirName string) (string, error)

Remarks

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

This method returns an Operation Id that 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 applicable only when ChannelType is set to cstSftp.

RenameFile Method (SSHPlex Component)

Changes the name of a file on the remote server using secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) RenameFile(NewName string) (string, error)

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 that 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 applicable only when ChannelType is set to cstSftp.

SendCommand Method (SSHPlex Component)

Sends the specified command to the remote host.

Syntax

func (obj *SSHPlex) SendCommand(Command string) error

Remarks

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

You do not 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 Component)

Sends binary data to the remote host.

Syntax

func (obj *SSHPlex) SendStdinBytes(Data []byte) error

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 component fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

SendStdinText Method (SSHPlex Component)

Sends text to the remote host.

Syntax

func (obj *SSHPlex) SendStdinText(Text string) error

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 component fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. .

SSHLogoff Method (SSHPlex Component)

Logs off from the Secure Shell (SSH) server.

Syntax

func (obj *SSHPlex) SSHLogoff() error

Remarks

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

SSHLogon Method (SSHPlex Component)

Logs on to the SSHHost using the current SSHUser and SSHPassword .

Syntax

func (obj *SSHPlex) SSHLogon(SSHHost string, SSHPort int32) error

Remarks

Logs on to the Secure Shell (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 Component)

Instructs the class to send the FileAttributes to the server using secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) UpdateFileAttributes() (string, error)

Remarks

When UpdateFileAttributes is called, the component will send the values of the following properties to the server:

• SFTPFileAccessTime
• SFTPFileACL
• SFTPFileAllocationSize
• SFTPFileAttributeBits
• SFTPFileAttributeBitsValid
• SFTPFileCreationTime
• SFTPFileType
• SFTPFileGroupId
• SFTPFileIsDir
• SFTPFileModifiedTime
• SFTPFileOwnerId
• SFTPFilePermissions
• SFTPFileSize

This method returns an Operation Id that 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 applicable only when ChannelType is set to cstSftp.

Upload Method (SSHPlex Component)

Uploads a file specified by LocalFile using secure copy protocol (SCP) or secure file transfer protocol (SFTP).

Syntax

func (obj *SSHPlex) Upload() (string, error)

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 that 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 applicable only when ChannelType is set to cstSftp or cstScp.

Set LocalFile to the name of the file to upload before calling this method.

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 component 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 Component)

Fired when an append operation completes.

Syntax

// SSHPlexAppendCompleteEventArgs carries the SSHPlex AppendComplete event's parameters.
type SSHPlexAppendCompleteEventArgs struct {...}

func (args *SSHPlexAppendCompleteEventArgs) OperationId() string
func (args *SSHPlexAppendCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexAppendCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexAppendCompleteEventArgs) LocalFile() string
func (args *SSHPlexAppendCompleteEventArgs) RemoteFile() string
func (args *SSHPlexAppendCompleteEventArgs) RemotePath() string

// SSHPlexAppendCompleteEvent defines the signature of the SSHPlex AppendComplete event's handler function.
type SSHPlexAppendCompleteEvent func(sender *SSHPlex, args *SSHPlexAppendCompleteEventArgs)

func (obj *SSHPlex) GetOnAppendCompleteHandler() SSHPlexAppendCompleteEvent
func (obj *SSHPlex) SetOnAppendCompleteHandler(handlerFunc SSHPlexAppendCompleteEvent)

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 nonzero 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 that 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 Component)

Fired immediately after a connection completes (or fails).

Syntax

// SSHPlexConnectedEventArgs carries the SSHPlex Connected event's parameters.
type SSHPlexConnectedEventArgs struct {...}

func (args *SSHPlexConnectedEventArgs) StatusCode() int32
func (args *SSHPlexConnectedEventArgs) Description() string

// SSHPlexConnectedEvent defines the signature of the SSHPlex Connected event's handler function.
type SSHPlexConnectedEvent func(sender *SSHPlex, args *SSHPlexConnectedEventArgs)

func (obj *SSHPlex) GetOnConnectedHandler() SSHPlexConnectedEvent
func (obj *SSHPlex) SetOnConnectedHandler(handlerFunc SSHPlexConnectedEvent)

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 Component)

Fired to indicate changes in the connection state.

Syntax

// SSHPlexConnectionStatusEventArgs carries the SSHPlex ConnectionStatus event's parameters.
type SSHPlexConnectionStatusEventArgs struct {...}

func (args *SSHPlexConnectionStatusEventArgs) ConnectionEvent() string
func (args *SSHPlexConnectionStatusEventArgs) StatusCode() int32
func (args *SSHPlexConnectionStatusEventArgs) Description() string

// SSHPlexConnectionStatusEvent defines the signature of the SSHPlex ConnectionStatus event's handler function.
type SSHPlexConnectionStatusEvent func(sender *SSHPlex, args *SSHPlexConnectionStatusEventArgs)

func (obj *SSHPlex) GetOnConnectionStatusHandler() SSHPlexConnectionStatusEvent
func (obj *SSHPlex) SetOnConnectionStatusHandler(handlerFunc SSHPlexConnectionStatusEvent)

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 Component)

Fired when a CreateFile operation completes (or fails).

Syntax

// SSHPlexCreateFileCompleteEventArgs carries the SSHPlex CreateFileComplete event's parameters.
type SSHPlexCreateFileCompleteEventArgs struct {...}

func (args *SSHPlexCreateFileCompleteEventArgs) OperationId() string
func (args *SSHPlexCreateFileCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexCreateFileCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexCreateFileCompleteEventArgs) RemoteFile() string
func (args *SSHPlexCreateFileCompleteEventArgs) RemotePath() string

// SSHPlexCreateFileCompleteEvent defines the signature of the SSHPlex CreateFileComplete event's handler function.
type SSHPlexCreateFileCompleteEvent func(sender *SSHPlex, args *SSHPlexCreateFileCompleteEventArgs)

func (obj *SSHPlex) GetOnCreateFileCompleteHandler() SSHPlexCreateFileCompleteEvent
func (obj *SSHPlex) SetOnCreateFileCompleteHandler(handlerFunc SSHPlexCreateFileCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when a DeleteFile operation completes (or fails).

Syntax

// SSHPlexDeleteFileCompleteEventArgs carries the SSHPlex DeleteFileComplete event's parameters.
type SSHPlexDeleteFileCompleteEventArgs struct {...}

func (args *SSHPlexDeleteFileCompleteEventArgs) OperationId() string
func (args *SSHPlexDeleteFileCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexDeleteFileCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexDeleteFileCompleteEventArgs) RemoteFile() string
func (args *SSHPlexDeleteFileCompleteEventArgs) RemotePath() string

// SSHPlexDeleteFileCompleteEvent defines the signature of the SSHPlex DeleteFileComplete event's handler function.
type SSHPlexDeleteFileCompleteEvent func(sender *SSHPlex, args *SSHPlexDeleteFileCompleteEventArgs)

func (obj *SSHPlex) GetOnDeleteFileCompleteHandler() SSHPlexDeleteFileCompleteEvent
func (obj *SSHPlex) SetOnDeleteFileCompleteHandler(handlerFunc SSHPlexDeleteFileCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when a directory entry is received.

Syntax

// SSHPlexDirListEventArgs carries the SSHPlex DirList event's parameters.
type SSHPlexDirListEventArgs struct {...}

func (args *SSHPlexDirListEventArgs) OperationId() string
func (args *SSHPlexDirListEventArgs) DirEntry() string
func (args *SSHPlexDirListEventArgs) FileName() string
func (args *SSHPlexDirListEventArgs) IsDir() bool
func (args *SSHPlexDirListEventArgs) FileSize() int64
func (args *SSHPlexDirListEventArgs) FileTime() string
func (args *SSHPlexDirListEventArgs) IsSymlink() bool

// SSHPlexDirListEvent defines the signature of the SSHPlex DirList event's handler function.
type SSHPlexDirListEvent func(sender *SSHPlex, args *SSHPlexDirListEventArgs)

func (obj *SSHPlex) GetOnDirListHandler() SSHPlexDirListEvent
func (obj *SSHPlex) SetOnDirListHandler(handlerFunc SSHPlexDirListEvent)

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 component 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 component can be controlled through the FileTimeFormat configuration setting. If no format is specified, the component 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 because 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 SFTPFileIsDir property.

Disconnected Event (SSHPlex Component)

Fired when a connection is closed.

Syntax

// SSHPlexDisconnectedEventArgs carries the SSHPlex Disconnected event's parameters.
type SSHPlexDisconnectedEventArgs struct {...}

func (args *SSHPlexDisconnectedEventArgs) StatusCode() int32
func (args *SSHPlexDisconnectedEventArgs) Description() string

// SSHPlexDisconnectedEvent defines the signature of the SSHPlex Disconnected event's handler function.
type SSHPlexDisconnectedEvent func(sender *SSHPlex, args *SSHPlexDisconnectedEventArgs)

func (obj *SSHPlex) GetOnDisconnectedHandler() SSHPlexDisconnectedEvent
func (obj *SSHPlex) SetOnDisconnectedHandler(handlerFunc SSHPlexDisconnectedEvent)

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 Component)

Fired when a download operation completes (or fails).

Syntax

// SSHPlexDownloadCompleteEventArgs carries the SSHPlex DownloadComplete event's parameters.
type SSHPlexDownloadCompleteEventArgs struct {...}

func (args *SSHPlexDownloadCompleteEventArgs) OperationId() string
func (args *SSHPlexDownloadCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexDownloadCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexDownloadCompleteEventArgs) LocalFile() string
func (args *SSHPlexDownloadCompleteEventArgs) RemoteFile() string
func (args *SSHPlexDownloadCompleteEventArgs) RemotePath() string

// SSHPlexDownloadCompleteEvent defines the signature of the SSHPlex DownloadComplete event's handler function.
type SSHPlexDownloadCompleteEvent func(sender *SSHPlex, args *SSHPlexDownloadCompleteEventArgs)

func (obj *SSHPlex) GetOnDownloadCompleteHandler() SSHPlexDownloadCompleteEvent
func (obj *SSHPlex) SetOnDownloadCompleteHandler(handlerFunc SSHPlexDownloadCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when a file completes downloading or uploading.

Syntax

// SSHPlexEndTransferEventArgs carries the SSHPlex EndTransfer event's parameters.
type SSHPlexEndTransferEventArgs struct {...}

func (args *SSHPlexEndTransferEventArgs) OperationId() string
func (args *SSHPlexEndTransferEventArgs) Direction() int32
func (args *SSHPlexEndTransferEventArgs) LocalFile() string
func (args *SSHPlexEndTransferEventArgs) RemoteFile() string
func (args *SSHPlexEndTransferEventArgs) RemotePath() string

// SSHPlexEndTransferEvent defines the signature of the SSHPlex EndTransfer event's handler function.
type SSHPlexEndTransferEvent func(sender *SSHPlex, args *SSHPlexEndTransferEventArgs)

func (obj *SSHPlex) GetOnEndTransferHandler() SSHPlexEndTransferEvent
func (obj *SSHPlex) SetOnEndTransferHandler(handlerFunc SSHPlexEndTransferEvent)

Remarks

This event is fired once per file when it finishes downloading or 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 Component)

Fired when errors occur during data delivery.

Syntax

// SSHPlexErrorEventArgs carries the SSHPlex Error event's parameters.
type SSHPlexErrorEventArgs struct {...}

func (args *SSHPlexErrorEventArgs) operationId() string
func (args *SSHPlexErrorEventArgs) ErrorCode() int32
func (args *SSHPlexErrorEventArgs) Description() string
func (args *SSHPlexErrorEventArgs) LocalFile() string
func (args *SSHPlexErrorEventArgs) RemoteFile() string

// SSHPlexErrorEvent defines the signature of the SSHPlex Error event's handler function.
type SSHPlexErrorEvent func(sender *SSHPlex, args *SSHPlexErrorEventArgs)

func (obj *SSHPlex) GetOnErrorHandler() SSHPlexErrorEvent
func (obj *SSHPlex) SetOnErrorHandler(handlerFunc SSHPlexErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component fails with an error.

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 Component)

Fired when an execute operation completes (or fails).

Syntax

// SSHPlexExecuteCompleteEventArgs carries the SSHPlex ExecuteComplete event's parameters.
type SSHPlexExecuteCompleteEventArgs struct {...}

func (args *SSHPlexExecuteCompleteEventArgs) OperationId() string
func (args *SSHPlexExecuteCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexExecuteCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexExecuteCompleteEventArgs) ExitStatus() int32

// SSHPlexExecuteCompleteEvent defines the signature of the SSHPlex ExecuteComplete event's handler function.
type SSHPlexExecuteCompleteEvent func(sender *SSHPlex, args *SSHPlexExecuteCompleteEventArgs)

func (obj *SSHPlex) GetOnExecuteCompleteHandler() SSHPlexExecuteCompleteEvent
func (obj *SSHPlex) SetOnExecuteCompleteHandler(handlerFunc SSHPlexExecuteCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when a ListDirectory operation completes (or fails).

Syntax

// SSHPlexListDirectoryCompleteEventArgs carries the SSHPlex ListDirectoryComplete event's parameters.
type SSHPlexListDirectoryCompleteEventArgs struct {...}

func (args *SSHPlexListDirectoryCompleteEventArgs) OperationId() string
func (args *SSHPlexListDirectoryCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexListDirectoryCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexListDirectoryCompleteEventArgs) RemotePath() string

// SSHPlexListDirectoryCompleteEvent defines the signature of the SSHPlex ListDirectoryComplete event's handler function.
type SSHPlexListDirectoryCompleteEvent func(sender *SSHPlex, args *SSHPlexListDirectoryCompleteEventArgs)

func (obj *SSHPlex) GetOnListDirectoryCompleteHandler() SSHPlexListDirectoryCompleteEvent
func (obj *SSHPlex) SetOnListDirectoryCompleteHandler(handlerFunc SSHPlexListDirectoryCompleteEvent)

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 nonzero 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 that 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 Component)

Fired once for each log message.

Syntax

// SSHPlexLogEventArgs carries the SSHPlex Log event's parameters.
type SSHPlexLogEventArgs struct {...}

func (args *SSHPlexLogEventArgs) LogLevel() int32
func (args *SSHPlexLogEventArgs) Message() string
func (args *SSHPlexLogEventArgs) LogType() string

// SSHPlexLogEvent defines the signature of the SSHPlex Log event's handler function.
type SSHPlexLogEvent func(sender *SSHPlex, args *SSHPlexLogEventArgs)

func (obj *SSHPlex) GetOnLogHandler() SSHPlexLogEvent
func (obj *SSHPlex) SetOnLogHandler(handlerFunc SSHPlexLogEvent)

Remarks

Fired once for each log message generated by the component. 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 Component)

Fired when a MakeDirectory operation completes (or fails).

Syntax

// SSHPlexMakeDirectoryCompleteEventArgs carries the SSHPlex MakeDirectoryComplete event's parameters.
type SSHPlexMakeDirectoryCompleteEventArgs struct {...}

func (args *SSHPlexMakeDirectoryCompleteEventArgs) OperationId() string
func (args *SSHPlexMakeDirectoryCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexMakeDirectoryCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexMakeDirectoryCompleteEventArgs) RemotePath() string

// SSHPlexMakeDirectoryCompleteEvent defines the signature of the SSHPlex MakeDirectoryComplete event's handler function.
type SSHPlexMakeDirectoryCompleteEvent func(sender *SSHPlex, args *SSHPlexMakeDirectoryCompleteEventArgs)

func (obj *SSHPlex) GetOnMakeDirectoryCompleteHandler() SSHPlexMakeDirectoryCompleteEvent
func (obj *SSHPlex) SetOnMakeDirectoryCompleteHandler(handlerFunc SSHPlexMakeDirectoryCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when a RemoveDirectory operation completes (or fails).

Syntax

// SSHPlexRemoveDirectoryCompleteEventArgs carries the SSHPlex RemoveDirectoryComplete event's parameters.
type SSHPlexRemoveDirectoryCompleteEventArgs struct {...}

func (args *SSHPlexRemoveDirectoryCompleteEventArgs) OperationId() string
func (args *SSHPlexRemoveDirectoryCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexRemoveDirectoryCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexRemoveDirectoryCompleteEventArgs) DirectoryName() string
func (args *SSHPlexRemoveDirectoryCompleteEventArgs) RemotePath() string

// SSHPlexRemoveDirectoryCompleteEvent defines the signature of the SSHPlex RemoveDirectoryComplete event's handler function.
type SSHPlexRemoveDirectoryCompleteEvent func(sender *SSHPlex, args *SSHPlexRemoveDirectoryCompleteEventArgs)

func (obj *SSHPlex) GetOnRemoveDirectoryCompleteHandler() SSHPlexRemoveDirectoryCompleteEvent
func (obj *SSHPlex) SetOnRemoveDirectoryCompleteHandler(handlerFunc SSHPlexRemoveDirectoryCompleteEvent)

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 nonzero 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 that 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 that was removed.

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

RenameFileComplete Event (SSHPlex Component)

Fired when a RenameFile operation completes (or fails).

Syntax

// SSHPlexRenameFileCompleteEventArgs carries the SSHPlex RenameFileComplete event's parameters.
type SSHPlexRenameFileCompleteEventArgs struct {...}

func (args *SSHPlexRenameFileCompleteEventArgs) OperationId() string
func (args *SSHPlexRenameFileCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexRenameFileCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexRenameFileCompleteEventArgs) RemoteFile() string
func (args *SSHPlexRenameFileCompleteEventArgs) RemotePath() string
func (args *SSHPlexRenameFileCompleteEventArgs) NewFileName() string

// SSHPlexRenameFileCompleteEvent defines the signature of the SSHPlex RenameFileComplete event's handler function.
type SSHPlexRenameFileCompleteEvent func(sender *SSHPlex, args *SSHPlexRenameFileCompleteEventArgs)

func (obj *SSHPlex) GetOnRenameFileCompleteHandler() SSHPlexRenameFileCompleteEvent
func (obj *SSHPlex) SetOnRenameFileCompleteHandler(handlerFunc SSHPlexRenameFileCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when the class is doing a custom authentication.

Syntax

// SSHPlexSSHCustomAuthEventArgs carries the SSHPlex SSHCustomAuth event's parameters.
type SSHPlexSSHCustomAuthEventArgs struct {...}

func (args *SSHPlexSSHCustomAuthEventArgs) Packet() string
func (args *SSHPlexSSHCustomAuthEventArgs) SetPacket(value string)

// SSHPlexSSHCustomAuthEvent defines the signature of the SSHPlex SSHCustomAuth event's handler function.
type SSHPlexSSHCustomAuthEvent func(sender *SSHPlex, args *SSHPlexSSHCustomAuthEventArgs)

func (obj *SSHPlex) GetOnSSHCustomAuthHandler() SSHPlexSSHCustomAuthEvent
func (obj *SSHPlex) SetOnSSHCustomAuthHandler(handlerFunc SSHPlexSSHCustomAuthEvent)

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 Component)

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

Syntax

// SSHPlexSSHKeyboardInteractiveEventArgs carries the SSHPlex SSHKeyboardInteractive event's parameters.
type SSHPlexSSHKeyboardInteractiveEventArgs struct {...}

func (args *SSHPlexSSHKeyboardInteractiveEventArgs) Name() string
func (args *SSHPlexSSHKeyboardInteractiveEventArgs) Instructions() string
func (args *SSHPlexSSHKeyboardInteractiveEventArgs) Prompt() string
func (args *SSHPlexSSHKeyboardInteractiveEventArgs) Response() string
func (args *SSHPlexSSHKeyboardInteractiveEventArgs) SetResponse(value string)
func (args *SSHPlexSSHKeyboardInteractiveEventArgs) EchoResponse() bool

// SSHPlexSSHKeyboardInteractiveEvent defines the signature of the SSHPlex SSHKeyboardInteractive event's handler function.
type SSHPlexSSHKeyboardInteractiveEvent func(sender *SSHPlex, args *SSHPlexSSHKeyboardInteractiveEventArgs)

func (obj *SSHPlex) GetOnSSHKeyboardInteractiveHandler() SSHPlexSSHKeyboardInteractiveEvent
func (obj *SSHPlex) SetOnSSHKeyboardInteractiveHandler(handlerFunc SSHPlexSSHKeyboardInteractiveEvent)

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the component will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the component 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 component will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHPlex Component)

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

Syntax

// SSHPlexSSHServerAuthenticationEventArgs carries the SSHPlex SSHServerAuthentication event's parameters.
type SSHPlexSSHServerAuthenticationEventArgs struct {...}

func (args *SSHPlexSSHServerAuthenticationEventArgs) HostKey() []byte
func (args *SSHPlexSSHServerAuthenticationEventArgs) Fingerprint() string
func (args *SSHPlexSSHServerAuthenticationEventArgs) KeyAlgorithm() string
func (args *SSHPlexSSHServerAuthenticationEventArgs) CertSubject() string
func (args *SSHPlexSSHServerAuthenticationEventArgs) CertIssuer() string
func (args *SSHPlexSSHServerAuthenticationEventArgs) Status() string
func (args *SSHPlexSSHServerAuthenticationEventArgs) Accept() bool
func (args *SSHPlexSSHServerAuthenticationEventArgs) SetAccept(value bool)

// SSHPlexSSHServerAuthenticationEvent defines the signature of the SSHPlex SSHServerAuthentication event's handler function.
type SSHPlexSSHServerAuthenticationEvent func(sender *SSHPlex, args *SSHPlexSSHServerAuthenticationEventArgs)

func (obj *SSHPlex) GetOnSSHServerAuthenticationHandler() SSHPlexSSHServerAuthenticationEvent
func (obj *SSHPlex) SetOnSSHServerAuthenticationHandler(handlerFunc SSHPlexSSHServerAuthenticationEvent)

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. To configure the encoding format used when displaying this value, see SSHFingerprintEncoding.

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 Component)

Fired to track the progress of the secure connection.

Syntax

// SSHPlexSSHStatusEventArgs carries the SSHPlex SSHStatus event's parameters.
type SSHPlexSSHStatusEventArgs struct {...}

func (args *SSHPlexSSHStatusEventArgs) Message() string

// SSHPlexSSHStatusEvent defines the signature of the SSHPlex SSHStatus event's handler function.
type SSHPlexSSHStatusEvent func(sender *SSHPlex, args *SSHPlexSSHStatusEventArgs)

func (obj *SSHPlex) GetOnSSHStatusHandler() SSHPlexSSHStatusEvent
func (obj *SSHPlex) SetOnSSHStatusHandler(handlerFunc SSHPlexSSHStatusEvent)

Remarks

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

StartTransfer Event (SSHPlex Component)

Fired when a file starts downloading or uploading.

Syntax

// SSHPlexStartTransferEventArgs carries the SSHPlex StartTransfer event's parameters.
type SSHPlexStartTransferEventArgs struct {...}

func (args *SSHPlexStartTransferEventArgs) OperationId() string
func (args *SSHPlexStartTransferEventArgs) Direction() int32
func (args *SSHPlexStartTransferEventArgs) LocalFile() string
func (args *SSHPlexStartTransferEventArgs) RemoteFile() string
func (args *SSHPlexStartTransferEventArgs) RemotePath() string
func (args *SSHPlexStartTransferEventArgs) FilePermissions() string
func (args *SSHPlexStartTransferEventArgs) SetFilePermissions(value string)

// SSHPlexStartTransferEvent defines the signature of the SSHPlex StartTransfer event's handler function.
type SSHPlexStartTransferEvent func(sender *SSHPlex, args *SSHPlexStartTransferEventArgs)

func (obj *SSHPlex) GetOnStartTransferHandler() SSHPlexStartTransferEvent
func (obj *SSHPlex) SetOnStartTransferHandler(handlerFunc SSHPlexStartTransferEvent)

Remarks

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

OperationId is the string associated with the 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 or download.

Stderr Event (SSHPlex Component)

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

Syntax

// SSHPlexStderrEventArgs carries the SSHPlex Stderr event's parameters.
type SSHPlexStderrEventArgs struct {...}

func (args *SSHPlexStderrEventArgs) OperationId() string
func (args *SSHPlexStderrEventArgs) Text() []byte

// SSHPlexStderrEvent defines the signature of the SSHPlex Stderr event's handler function.
type SSHPlexStderrEvent func(sender *SSHPlex, args *SSHPlexStderrEventArgs)

func (obj *SSHPlex) GetOnStderrHandler() SSHPlexStderrEvent
func (obj *SSHPlex) SetOnStderrHandler(handlerFunc SSHPlexStderrEvent)

Remarks

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

Stdout Event (SSHPlex Component)

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

Syntax

// SSHPlexStdoutEventArgs carries the SSHPlex Stdout event's parameters.
type SSHPlexStdoutEventArgs struct {...}

func (args *SSHPlexStdoutEventArgs) OperationId() string
func (args *SSHPlexStdoutEventArgs) Text() []byte

// SSHPlexStdoutEvent defines the signature of the SSHPlex Stdout event's handler function.
type SSHPlexStdoutEvent func(sender *SSHPlex, args *SSHPlexStdoutEventArgs)

func (obj *SSHPlex) GetOnStdoutHandler() SSHPlexStdoutEvent
func (obj *SSHPlex) SetOnStdoutHandler(handlerFunc SSHPlexStdoutEvent)

Remarks

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

Transfer Event (SSHPlex Component)

Fired during file download or upload.

Syntax

// SSHPlexTransferEventArgs carries the SSHPlex Transfer event's parameters.
type SSHPlexTransferEventArgs struct {...}

func (args *SSHPlexTransferEventArgs) OperationId() string
func (args *SSHPlexTransferEventArgs) Direction() int32
func (args *SSHPlexTransferEventArgs) LocalFile() string
func (args *SSHPlexTransferEventArgs) RemoteFile() string
func (args *SSHPlexTransferEventArgs) RemotePath() string
func (args *SSHPlexTransferEventArgs) BytesTransferred() int64
func (args *SSHPlexTransferEventArgs) PercentDone() int32
func (args *SSHPlexTransferEventArgs) Text() []byte
func (args *SSHPlexTransferEventArgs) Cancel() bool
func (args *SSHPlexTransferEventArgs) SetCancel(value bool)

// SSHPlexTransferEvent defines the signature of the SSHPlex Transfer event's handler function.
type SSHPlexTransferEvent func(sender *SSHPlex, args *SSHPlexTransferEventArgs)

func (obj *SSHPlex) GetOnTransferHandler() SSHPlexTransferEvent
func (obj *SSHPlex) SetOnTransferHandler(handlerFunc SSHPlexTransferEvent)

Remarks

This event is fired once per file when it starts downloading or 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 Component)

Fired when a UpdateFileAttributes operation completes (or fails).

Syntax

// SSHPlexUpdateFileAttributesCompleteEventArgs carries the SSHPlex UpdateFileAttributesComplete event's parameters.
type SSHPlexUpdateFileAttributesCompleteEventArgs struct {...}

func (args *SSHPlexUpdateFileAttributesCompleteEventArgs) OperationId() string
func (args *SSHPlexUpdateFileAttributesCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexUpdateFileAttributesCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexUpdateFileAttributesCompleteEventArgs) RemoteFile() string
func (args *SSHPlexUpdateFileAttributesCompleteEventArgs) RemotePath() string

// SSHPlexUpdateFileAttributesCompleteEvent defines the signature of the SSHPlex UpdateFileAttributesComplete event's handler function.
type SSHPlexUpdateFileAttributesCompleteEvent func(sender *SSHPlex, args *SSHPlexUpdateFileAttributesCompleteEventArgs)

func (obj *SSHPlex) GetOnUpdateFileAttributesCompleteHandler() SSHPlexUpdateFileAttributesCompleteEvent
func (obj *SSHPlex) SetOnUpdateFileAttributesCompleteHandler(handlerFunc SSHPlexUpdateFileAttributesCompleteEvent)

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 nonzero 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 that 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 Component)

Fired when an upload operation completes (or fails).

Syntax

// SSHPlexUploadCompleteEventArgs carries the SSHPlex UploadComplete event's parameters.
type SSHPlexUploadCompleteEventArgs struct {...}

func (args *SSHPlexUploadCompleteEventArgs) OperationId() string
func (args *SSHPlexUploadCompleteEventArgs) ErrorCode() int32
func (args *SSHPlexUploadCompleteEventArgs) ErrorDescription() string
func (args *SSHPlexUploadCompleteEventArgs) LocalFile() string
func (args *SSHPlexUploadCompleteEventArgs) RemoteFile() string
func (args *SSHPlexUploadCompleteEventArgs) RemotePath() string

// SSHPlexUploadCompleteEvent defines the signature of the SSHPlex UploadComplete event's handler function.
type SSHPlexUploadCompleteEvent func(sender *SSHPlex, args *SSHPlexUploadCompleteEventArgs)

func (obj *SSHPlex) GetOnUploadCompleteHandler() SSHPlexUploadCompleteEvent
func (obj *SSHPlex) SetOnUploadCompleteHandler(handlerFunc SSHPlexUploadCompleteEvent)

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 nonzero 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 that 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.

Config Settings (SSHPlex Component)

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