IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

SShell Component

Properties   Methods   Events   Configuration Settings   Errors  

The SShell component is used to open a shell connection to an SSH server.

Syntax

nsoftware.IPWorksSSH.Sshell

Remarks

The SShell component establishes a Secure Shell connection to a server and starts up the user's default shell. Using the component is very simple. The destination is specified by the SSHHost property, and the login information is given by the SSHUser and SSHPassword properties. Then call the SSHLogon method to establish a permanent, secure connection to the SSH server. For each command you wish to execute, simply call the Execute command or set the Command property with the command you wish to execute as the parameter. Further input can be supplied to the Text parameter of the Send method or via the Stdin property.

The output of the command is returned through the Stdout event. If an error happens on the protocol level, the error message can be found in the ErrorMessage property. 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.

CommandThe command to be sent to the remote host.
ConnectedTriggers a connection or disconnection.
ErrorMessageThe error message returned when any of the steps prior to command execution fail.
FirewallA set of properties related to firewall access.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where IPPort binds.
SSHAcceptServerHostKeyInstructs the component to accept the server host key that matches the supplied key.
SSHAuthModeThe authentication method to be used the component when calling SSHLogon .
SSHCertA certificate to be used for authenticating the SSHUser .
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
StdinA string of data to be sent to the remote host while connected.
TimeoutA timeout for the component.

Method List


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

ConfigSets or retrieves a configuration setting .
DecodePacketDecodes a hex-encoded SSH packet.
DoEventsProcesses events from the internal message queue.
EncodePacketHex encodes an SSH packet.
ExecuteExecute a Command on the remote host.
GetSSHParamUsed to read a field from an SSH packet's payload.
GetSSHParamBytesUsed to read a field from an SSH packet's payload.
InterruptInterrupt the current method.
SendSend standard input to the program executing on the remote host.
SetSSHParamUsed to write a field to the end of a payload.
SSHLogoffLogoff from the SSH server.
SSHLogonLogon to the SSHHost using the current SSHUser and SSHPassword .

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.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSHCustomAuthFired when the component is doing custom authentication.
SSHKeyboardInteractiveFired when the component receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusShows the progress of the secure connection.
StderrFired when data (complete lines) come in through stderr.
StdoutFired when data (complete lines) come in through stdout.

Configuration Settings


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

ShellPromptThe character sequence of the prompt on the SSH host to wait for.
StripANSIWhether to remove ANSI escape sequences.
TerminalTypeThe terminal type the component will use when connecting to a server.
UpdateTerminalSizeUsed to update the terminal size.
TerminalModesThe terminal mode to set when communicating with the SSH host.
EncodedTerminalModesThe terminal mode to set when communicating with the SSH host.
TerminalHeightThe height of the terminal display.
TerminalWidthThe width of the terminal display.
TerminalUsePixelWhether the terminal's dimensions are in columns/rows or pixels.
ClientSSHVersionStringThe SSH version string used by the component.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptAnyServerHostKeyIf set the component will accept any key presented by the server.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHKeyRenegotiateCauses the component to renegotiate the SSH keys.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
LogSSHPacketsIf true, detailed SSH packet logging is performed.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0