Rexec Component
Properties Methods Events Configuration Settings Errors
The Rexec component is used to execute commands on a remote UNIX machine using the rexec mechanism.
Syntax
nsoftware.IPWorks.Rexec
Remarks
The Rexec component allows remote execution of commands on UNIX hosts, or any other system with the rexec interface. Using the component is very simple. The destination is specified by the RemoteHost property, the login information is given by the RemoteUser and RemotePassword 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 rexec 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. |
| RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
| RemotePassword | The password of the user on the remote host. |
| RemotePort | The remote exec service port (default is 512). |
| 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. |
| Reset | Reset the component. |
| 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. |
| 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). |
| 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;. |
| 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 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. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| 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. |
| GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
| UseBackgroundThread | Whether threads created by the component are background threads. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |