Rshell Control

Properties Methods Events Configuration Settings Errors

The Rshell component is used to execute commands on a remote Unix machine using the rshell mechanism.

Syntax

Rshell

Remarks

The Rshell control allows remote execution of commands on UNIX hosts, or any other system with the rshell interface. Using the control is very simple. The destination is specified by the RemoteHost property, the login information is given by the LocalUser and RemoteUser properties. Then call the Execute method with the Command to execute as a parameter. You can also set the Command property to the command that you would like to execute for identical results. Further input can be supplied to the command by assigning data 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.

To be able to successfully use the control, the remote host must be set up to allow execution of commands via rshell from the machine the control runs on.

Property List

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


BytesSent	The number of bytes actually sent after an assignment to Stdin.
Command	The command to be sent to the remote host.
Connected	Shows whether the component is connected.
EoF	If True, the connection has closed, and there is no buffered data available.
EOL	Used to break the stdout data stream into chunks separated by its value.
ErrEOL	Used to break the stderr data stream into chunks separated by its value.
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 the component binds.
LocalUser	The identifier of the user on the local machine.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The remote shell service port (default is 514).
RemoteUser	The id of the user on the remote host.
Stderr	Returns the standard error output (stderr) from the remote application.
Stdin	A string of data to be sent to the remote host while connected.
Stdout	Provides the standard output (stdout) from the remote application.
Timeout	A timeout for the component.

Method List

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


Config	Sets or retrieves a configuration setting .
Disconnect	Disconnects from the RemoteHost .
DoEvents	Processes events from the internal message queue.
Execute	Executes a Command on the remote host.
Interrupt	Interrupt the current method.
Send	Sends standard input to the program executing on the remote host.

Event List

The following is the full list of the events fired by the control 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.
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 control with short descriptions. Click on the links for further details.


EnableStderr	Enables or disables secondary (stderr) stream.
StderrPort	The local port from which the remote system sends the stderr stream.
MaxStdout	Maximum storage available for the stdout buffer.
MaxStderr	Maximum storage available for the stderr buffer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
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).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
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.