Rexec Class

Properties   Methods   Events   Configuration Settings   Errors  

The Rexec class is used to execute commands on a remote UNIX machine using the rexec mechanism.

Syntax

class ipworks.Rexec

Remarks

The Rexec class allows remote execution of commands on UNIX hosts, or any other system with the rexec interface. Using the class is very simple. The destination is specified by the remote_host property, the login information is given by the remote_user and remote_password 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 on_stdout event. If an error happens on the protocol level, the error message can be found in the error_message property. Errors during command execution (the stderr stream) are given by the on_stderr event.

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

Property List


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

bytes_sentThe number of bytes actually sent after an assignment to Stdin.
commandThe command to be sent to the remote host.
connectedShows whether the class 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.
err_eolUsed to break the stderr data stream into chunks separated by its value.
error_messageThe error message returned when any of the steps prior to command execution fail.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_portThe TCP port in the local host where the class binds.
remote_hostThe address of the remote host. Domain names are resolved to IP addresses.
remote_passwordThe password of the user on the remote host.
remote_portThe remote exec service port (default is 512).
remote_userThe 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 class.

Method List


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

configSets or retrieves a configuration setting.
disconnectDisconnect from the RemoteHost .
do_eventsProcesses events from the internal message queue.
executeExecute a Command on the remote host.
interruptInterrupt the current method.
resetReset the class.
sendSend standard input to the program executing on the remote host.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

on_connectedFired immediately after a connection completes (or fails).
on_connection_statusFired to indicate changes in connection state.
on_disconnectedFired when a connection is closed.
on_errorInformation about errors during data delivery.
on_stderrFired when data (complete lines) come in through stderr.
on_stdoutFired when data (complete lines) come in through stdout.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

EnableStderrEnables or disables secondary (stderr) stream.
MaxStderrMaximum storage available for the stderr buffer.
MaxStdoutMaximum storage available for the stdout buffer.
StderrPortThe local port from which the remote system sends the stderr stream.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class 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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 7941]