SShell Component [IP*Works! SSH V8]
Properties
Methods
Events
Configuration Settings
The SShell component is used to open a shell connection to an SSH server.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
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.
| |
| Command | The command to be sent to the remote host. |
| Connected | Triggers a connection or disconnection. |
| ErrorMessage | The error message returned when any of the steps prior to command execution fail. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where IPPort binds. |
| SSHAcceptServerHostKeyEncoded | The certificate (PEM/base64 encoded). |
| SSHAuthMode | The authentication method to be used the component when performing an SSHLogon. |
| SSHCertEncoded | The certificate (PEM/base64 encoded). |
| SSHCertStore | The name of the certificate store for the client certificate. |
| SSHCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSHCertStoreType | The type of certificate store for this certificate. |
| SSHCertSubject | The subject of the certificate used for client authentication. |
| SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| Stdin | A string of data to be sent to the remote host while connected. |
| Timeout | A 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.
| |
| Config | Sets or retrieves a configuration setting. |
| DoEvents | Processes events from the internal message queue. |
| Execute | Execute a Command on the remote host. |
| Send | Send standard input to the program executing on the remote host. |
| SSHLogoff | Logoff from the SSH server. |
| SSHLogon | Logon 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.
| |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| SSHKeyboardInteractive | Fired when the component receives a request for user input from the server. |
| SSHServerAuthentication | Fired after the server presents its public key to the client. |
| SSHStatus | Shows the progress of the secure connection. |
| Stderr | Fired when data (complete lines) come in through stderr. |
| Stdout | Fired 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.
| |
| TerminalType | The terminal type the component will use when connecting to a server. |
| TerminalModes | The terminal mode to set when communicating with the SSH host. |
| EncodedTerminalModes | The terminal mode to set when communicating with the SSH host. |
| SSHAcceptAnyServerHostKey | If set the component will accept any key presented by the server. |
| SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHKeyRenegotiate | Causes the component to renegotiate the SSH keys. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
| KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
| KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
