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

Rshell Bean

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Rshell

Remarks

The Rshell component allows remote execution of commands on UNIX hosts, or any other system with the rshell interface. Using the component 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 component, the remote host must be set up to allow execution of commands via rshell from the machine the component runs on.

Property List


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

BytesSentThe number of bytes actually sent after an assignment to Stdin.
CommandThe command to be sent to the remote host.
ConnectedShows whether the component is connected.
EOFIf True, the connection has closed, and there is no buffered data available.
EOLUsed to break the stdout data stream into chunks separated by its value.
ErrEOLUsed to break the stderr data stream into chunks separated by its value.
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 the component binds.
LocalUserThe identifier of the user on the local machine.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe remote shell service port (default is 514).
RemoteUserThe id of the user on the remote host.
StderrReturns the standard error output (stderr) from the remote application.
StdinA string of data to be sent to the remote host while connected.
StdoutProvides the standard output (stdout) from the remote application.
TimeoutA timeout for the component.

Method List


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

configSets or retrieves a configuration setting .
disconnectDisconnects from the RemoteHost .
doEventsProcesses events from the internal message queue.
executeExecutes a Command on the remote host.
interruptInterrupt the current method.
sendSends standard input to the program executing on the remote host.

Event List


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

EnableStderrEnables or disables secondary (stderr) stream.
StderrPortThe local port from which the remote system sends the stderr stream.
MaxStdoutMaximum storage available for the stdout buffer.
MaxStderrMaximum storage available for the stderr buffer.
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) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0