wodSSH Object

Main wodSSH object.

About	Displays the About box.
Connect	Connects to the remote server.
Disconnect	Disconnects from the remote server.
Execute	Executes a blocking method and waits for it to complete.
Peek	Receives incoming data without removing it from the buffer.
PeekLine	Receives an incoming line without removing it from the buffer.
Receive	Receives data from the server.
ReceiveLine	Receives a line of text, if available.
Send	Sends data to the server.
SendBreak	Sends BREAK command to the server.
SendEOF	Send an EOF packet to the server.
WaitFor	Waits and reads data until a specific pattern is found.

Properties

AllocatePty	Determines if a pseudo terminal is allocated.
Authentication	Determines which authentication type is to be used.
Blocking	Determines if methods are blocking.
ClientName	Determines client name that will be used with the server during initial exchange.
Columns	Selects the number of columns reported to the server.
Command	Specifies the command to be sent to server upon connection.
Compression	Determines the level of compression used.
DataOut	Holds total numbers of bytes waiting to leave local side.
DataReady	Holds the total numbers of bytes waiting to be received by your application.
Encoding	Character set to use for text conversion.
Encryption	Determines the encryption algorithm to be used with SSH.
EncryptionList	Determines list of encryption algorithms supported and offered by wodSSH.
ErrorText	Provides a string representation of an error.
ExitSignal	Holds exit signal from SSH connection.
ExitStatus	Holds exit status from SSH connection.
FIPS	Specifies FIPS enabled OpenSSL configuration to load.
ForwardHost	Determines the hostname that data will be forwarded to with SSH tunneling.
ForwardPort	Determines if wodSSH will only forward data to remote port.
HMacList	Determines list of digest algorithms supported and offered by wodSSH.
Hostname	Determines the Hostname of the remote server.
KeepAlives	Defines number of seconds of inactivity before KeepAlive ignore packets are sent.
KeyExchangeList	Determines list of key exchange algorithms supported and offered by wodSSH.
KeyForward	Determines if key forwarding is enabled.
KeySignatureList	Determines list of server key signature algorithms supported and offered by wodSSH.
LastError	Holds the last error returned by the method.
Login	Determines the username/login to be used with the server.
MyHostname	Holds the hostname of the local computer.
MyIP	Holds the IP address of the local computer.
Notification	Fast notification interface to use instead of events.
Password	Determines the password to be used with the server.
Port	Determines the port on the remote server.
PrivateKey	Private key used for authentication.
Prompt	Holds the command prompt string to expect from the server.
Protocol	Determines the protocol to use for connection.
ProxyHostname	Specifies the hostname of the proxy to use.
ProxyLogin	Specifies the login/username to use when connecting to a proxy server.
ProxyPassword	Specifies the password to use when connecting to a proxy server.
ProxyPort	Specifies the port to use when connecting to a proxy server.
ProxyType	Specifies the type of proxy to use.
RemoteIdentification	Holds the remote identification string.
Rows	Selects the number of rows reported to the server.
ShowStdErrorMessages	Determines if server's STDERR messages are received.
State	Holds the current state information.
StateText	Provides the string expression of a state.
StripANSI	Automatically removes ANSI codes from received data.
StripNull	Automatically removes NULL characters from received data.
Subsystem	Specifies the subsystem to be started upon connection.
TerminalSpeed	Selects the terminal speed that is reported to the server.
TerminalType	Selects the terminal type that is reported to the server.
Timeout	Timeout value, in seconds.
UseIPv6	Determines if IPv6 addresses are allowed.
Version	Holds version information.

Events

Banner	Fires when remote server provides banner text.
Connected	Fires when wodSSH connects to the remote server.
CryptoInformation	Fires when wodSSH provides information about the selected algorithm.
Disconnected	Fires when wodSSH disconnects from the server.
HostFingerprint	Fires when the remote server provides public key fingerprint information.
LoginChallenge	Fires when remote server requires keyboard-interactive authentication.
PromptReceived	Fires when the command prompt string is received.
Received	Fires when there is data to be received.
StateChange	Fires when wodSSH changes its state.

Platforms

Windows

wodSSH help - wodSSH

wodSSH Object

Platforms