Skip to main content

simple telnet module

Project description


This is an easy to use telnet module to interact with a remote system smoothly over this protocol!

Why should I use xtelnet?

  • Easy to use and stable
  • Simple Authentication mechanism
  • Compatible with almost all servers when it comes to authentication and executing the commands
  • Available Command line tool
  • Thread-safe: if the session is shared among threads to execute commands, the commands will be executed one by one
  • Supports running multiple sessions concurrently
  • Can connect simultaneously and run in parallel the same command on: single or some or all connected hosts
  • Allow reconnect after closing the connection
  • Allow escape ANSI characters
  • Grab banners
  • Available "ping" function to use if you want to keep the connection open

Install :

pip install xtelnet


pip3 install xtelnet

Usage on a script :

import xtelnet
ip=''#just an example
t.connect(ip, username='root',password='toor',p=23,timeout=5)
output1=t.execute('echo ala_is_king')
output2=t.execute('cd / && ls')
t.cwd('/')#change working directory
t.switch_terminal('tclsh')#change terminal type where the prompt will get changed as well (just and example of command to do it on some routers)
t.close()#close the connection but keep the connection string to do reconnect later
t.reconnect()#reconnect to the host with the previous parameters new line to the host to keep the connectio open
t.destroy()#close the connection and remove the connection string totally, after this you can't do "reconnect"

To start a manual interactive session after login, just do:

import xtelnet
ip=''#just an example
t.connect(ip, username='root',password='toor',p=23,timeout=5)

The multi_session helps you in controlling multiple telnet sessions in parallel:

import xtelnet
ip1=''#just an example
host1=xtelnet.dict_host(ip1, username='root',password='toor',p=23,timeout=5)
host2=xtelnet.dict_host(ip2, username='root',password='toor',p=23,timeout=5)
host3=xtelnet.dict_host(ip3, username='root',password='toor',p=23,timeout=5)
host4=xtelnet.dict_host(ip4, username='root',password='toor',p=23,timeout=5)
host5=xtelnet.dict_host(ip5, username='root',password='toor',p=23,timeout=5)
print(t.sessions)#to see the connected hosts
c=t.all_execute('echo "ala is king"')#execute this command on all hosts
print(c)#print output
c=t.some_execute([ip1,ip2],'echo "ala is king"')#execute this command on some hosts
c=t.host_execute(ip1,'echo "ala is king"')#execute this command on this host
t.disconnect_host(ip1)#to disconnect of this host
t.disconnect_some([ip2,ip3])#to disconnect of those hosts
t.disconnect_all()#to disconnect of all hosts
t.destroy()#disconnect from all hosts

Usage from command line :

xtelnet host [options...]


-username : set a username (required if username is needed to access) -password : set a password (required if password is needed to access) -port : (23 by default) set port -timeout : (5 by default) set timeout --add-command : a command to execute after login and disable shell --set-newline : ("\n" by default) set a new line indecator("\n" or "\r\n") --no-shell : (enabled by default if no commands are specified) disable shell after authentication --read-retries : times to retry reading the response if it takes too long --help : get this help message


xtelnet -username root -password root --add-command "echo ala" --add-command "dir"

xtelnet -username root -password root -port 2323 -timeout 5

xtelnet -username root -password root -port 2323 -timeout 5 --no-shell

Xtelnet can be used to grab banners:

import xtelnet
telnet_banner=xtelnet.get_banner("localhost",p=23)#suppose you have telnet server running on that port

http_banner=xtelnet.get_banner("",p=80,payload="GET / HTTP/1.1\r\nHost:\r\n\r\n")#we send a http request as a payload to get the response


Xtelnet can escape all ANSI characters :

import xtelnet
escaped_string=xtelnet.escape_ansi( unescaped_string )

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xtelnet, version 2.1.3
Filename, size File type Python version Upload date Hashes
Filename, size xtelnet-2.1.3.tar.gz (9.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page