Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

CkPython Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
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
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(CkPython) SSH Remote Shell

Demonstrates how to start a shell on a remote SSH server, run a command, and retrieve the output.

Chilkat Python Downloads

Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

ssh = chilkat.CkSsh()

# Hostname may be an IP address or hostname:
hostname = "www.some-ssh-server.com"
port = 22

# Connect to an SSH server:
success = ssh.Connect(hostname,port)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Wait a max of 5 seconds when reading responses..
ssh.put_IdleTimeoutMs(5000)

# Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Open a session channel.  (It is possible to have multiple
# session channels open simultaneously.)

channelNum = ssh.OpenSessionChannel()
if (channelNum < 0):
    print(ssh.lastErrorText())
    sys.exit()

# Some SSH servers require a pseudo-terminal
# If so, include the call to SendReqPty.  If not, then 
# comment out the call to SendReqPty.
# Note: The 2nd argument of SendReqPty is the terminal type,
# which should be something like "xterm", "vt100", "dumb", etc.
# A "dumb" terminal is one that cannot process escape sequences.
# Smart terminals, such as "xterm", "vt100", etc. process
# escape sequences.  If you select a type of smart terminal,
# your application will receive these escape sequences
# included in the command's output.  Use "dumb" if you do not
# want to receive escape sequences.  (Assuming your SSH
# server recognizes "dumb" as a standard dumb terminal.)
termType = "dumb"
widthInChars = 120
heightInChars = 40
# Use 0 for pixWidth and pixHeight when the dimensions
# are set in number-of-chars.
pixWidth = 0
pixHeight = 0
success = ssh.SendReqPty(channelNum,termType,widthInChars,heightInChars,pixWidth,pixHeight)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Start a shell on the channel:
success = ssh.SendReqShell(channelNum)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Start a command in the remote shell.  This example
# will send a "ls" command to retrieve the directory listing.
success = ssh.ChannelSendString(channelNum,"ls\r\n","ansi")
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Send an EOF.  This tells the server that no more data will 
# be sent on this channel.  The channel remains open, and
# the SSH client may still receive output on this channel.
success = ssh.ChannelSendEof(channelNum)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Read whatever output may already be available on the
# SSH connection.  ChannelReadAndPoll returns the number of bytes
# that are available in the channel's internal buffer that
# are ready to be "picked up" by calling GetReceivedText
# or GetReceivedData.
# A return value of -1 indicates failure.
# A return value of -2 indicates a failure via timeout.

# The ChannelReadAndPoll method waits
# for data to arrive on the connection usingi the IdleTimeoutMs
# property setting.  Once the first data arrives, it continues
# reading but instead uses the pollTimeoutMs passed in the 2nd argument:
# A return value of -2 indicates a timeout where no data is received.

pollTimeoutMs = 2000
n = ssh.ChannelReadAndPoll(channelNum,pollTimeoutMs)
if (n < 0):
    print(ssh.lastErrorText())
    sys.exit()

# Close the channel:
success = ssh.ChannelSendClose(channelNum)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Perhaps we did not receive all of the commands output.
# To make sure,  call ChannelReceiveToClose to accumulate any remaining
# output until the server's corresponding "channel close" is received.
success = ssh.ChannelReceiveToClose(channelNum)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Let's pickup the accumulated output of the command:
cmdOutput = ssh.getReceivedText(channelNum,"ansi")
if (ssh.get_LastMethodSuccess() != True):
    print(ssh.lastErrorText())
    sys.exit()

# Display the remote shell's command output:
print(cmdOutput)

# Disconnect
ssh.Disconnect()

 

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