IP*Works! rshell Component : rshell OCX, rshell .NET Component, rshell Class, rshell Bean, rshell Object

login

Red Carpet Subscriptions

IP*Works! Products

Internet Business

QuickBooks Integrator

E-Payment Integrator

Vital/TSYS Integrator

Paymentech Integrator

SharePoint Integrator

3-D Secure MPI

Enterprise Adapters

BizTalk Adapters

SQL Server SSIS Tasks

Windows Workflow

SharePoint Extensions

WCF Channels

Testimonials

You guys are awesome...Really..Support is amazing...Product is fantastic.

-- Paul Deraval

[more...]

Available in: IP*WORKS!

Rshell Component [IP*Works! V8]

Properties Methods Events Configuration Settings

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

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 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 component 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.
Firewall	A set of properties related to firewall access.
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 id 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 component with short descriptions. Click on the links for further details.


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

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


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.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
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 (Windows/COM only).

|

About

|

Privacy Policy

|

Terms of Use

|