Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Excel Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Excel) SSH Quick/Simple Shell Session

Demonstrates the simplified way to run multiple commands in a shell session on an SSH server.

Note: This example requires Chilkat v9.5.0.65 or greater.

Download Excel Class Modules

Chilkat Excel Class Modules

'  This example assumes Chilkat SSH/SFTP to have been previously unlocked.
'  See Unlock SSH for sample code.

Dim ssh As Chilkat.Ssh
Set ssh = Chilkat.NewSsh

Dim port As Long
port = 22
Dim success As Boolean
success = ssh.Connect("the-ssh-server.com",port)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Authenticate using login/password:
success = ssh.AuthenticatePw("theSshLogin","theSshPassword")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Start a shell session.
'  (The QuickShell method was added in Chilkat v9.5.0.65)
Dim channelNum As Long
channelNum = ssh.QuickShell()
If (channelNum < 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Construct a StringBuilder with multiple commands, one per line.
'  Note: The line-endings are potentially important.  Some SSH servers may
'  require either LF or CRLF line endings.  (Unix/Linux/OSX servers typically
'  use bare-LF line endings.  Windows servers likely use CRLF line endings.)
Dim sbCommands As Chilkat.StringBuilder
Set sbCommands = Chilkat.NewStringBuilder
success = sbCommands.Append("echo hello world" & vbLf)
success = sbCommands.Append("date" & vbLf)
success = sbCommands.Append("df" & vbLf)

'  For our last command, we're going to echo a marker string that
'  we'll use in ChannelReceiveUntilMatch below.
'  The use of single quotes around 'IS' is a trick so that the output
'  of the command is "THIS IS THE END OF THE SCRIPT", but the terminal echo
'  includes the single quotes.  This allows us to read until we see the actual
'  output of the last command.
success = sbCommands.Append("echo THIS 'IS' THE END OF THE SCRIPT" & vbLf)

'  Send the commands..
success = ssh.ChannelSendString(channelNum,sbCommands.GetAsString(),"ansi")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Send an EOF to indicate no more commands will be sent.
'  For brevity, we're not checking the return values of each method call.
'  Your code should check the success/failure of each call.
success = ssh.ChannelSendEof(channelNum)

'  Receive output up to our marker.
success = ssh.ChannelReceiveUntilMatch(channelNum,"THIS IS THE END OF THE SCRIPT","ansi",True)

'  Close the channel.
'  It is important to close the channel only after receiving the desired output.
success = ssh.ChannelSendClose(channelNum)

'  Get any remaining output..
success = ssh.ChannelReceiveToClose(channelNum)

'  Get the complete output for all the commands in the session.
Debug.Print "--- output ----"
Debug.Print ssh.GetReceivedText(channelNum,"ansi")

'  Here's our actual sample output:

' 	Last login: Thu Dec 22 20:19:09 2016 from chilkat13
' 
' 	echo hello world
' 	date
' 	df
' 	echo THIS 'IS' THE END OF THE SCRIPT
' 	chilkatosx:~ chilkat$ echo hello world
' 	hello world
' 	chilkatosx:~ chilkat$ date
' 	Thu Dec 22 20:30:48 CST 2016
' 	chilkatosx:~ chilkat$ df
' 	Filesystem    512-blocks      Used  Available Capacity  iused     ifree %iused  Mounted on
' 	/dev/disk2    2176716032 265768928 1910435104    13% 33285114 238804388   12%   /
' 	devfs                383       383          0   100%      664         0  100%   /dev
' 	map -hosts             0         0          0   100%        0         0  100%   /net
' 	map auto_home          0         0          0   100%        0         0  100%   /home
' 	/dev/disk3s2      374668    374668          0   100%    93665         0  100%   /Volumes/Google Chrome
' 	chilkatosx:~ chilkat$ echo THIS 'IS' THE END OF THE SCRIPT
' 	THIS IS THE END OF THE SCRIPT
' 	chilkatosx:~ chilkat$

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.