Skip to main content

A generic and platform agnostic SSH module to access and send commands to remote devices that support OpenSSH

Project description

Project description

SSH Client Package

#Simple, Fast and Secure method to:

  • Create automated tools to back-up Routers, Switches and Access-Points

  • Create automated tools for dynamic network configuration generation

  • Create automated tools for configurations roll-out

  • Create automated tools for network devices audit

  • Create automated tools for network devices inventory generation

  • Create automated tools for network devices troubleshooting

##How to use the Package.

###How to send a single command to a remote host ‘in global config mode’

#####Download the package in your computer

pip install sshFRIEND

#####Inside your script, do the following:

  • from sshFRIEND.ssh_connector import *

  • hostname = “your hostname here”

  • username = “your username here”

  • password = “your password here”

  • cmd = “show running-config”

  • channel = ssh_connector(hostname, username, password)

  • output = send_cmd(cmd, channel)

  • print(output)

###How to send a single command to a remote host ‘in config mode’

#####Inside your script, do the following:

  • from sshFRIEND.ssh_connector import *

  • hostname = “your hostname here”

  • username = “your username here”

  • password = “your password here”

  • cmd = “show running-config”

  • channel = ssh_connector(hostname, username, password)

  • output = send_config_cmd(cmd, channel)

  • print(output)

###How to send multiple commands to a remote host ‘in global config mode’

#####Inside your script, do the following:

  • from sshFRIEND.ssh_connector import *

  • hostname = “your hostname here”

  • username = “your username here”

  • password = “your password here”

  • list_of_commands = [“show running-config”, “show running-config”]

  • channel = ssh_connector(hostname, username, password)

  • output = send_cmds(list_of_commands, channel)

  • print(output)

###How to send multiple commands to a remote host ‘in config mode’

##### Inside your script, do the following:

  • from sshFRIEND.ssh_connector import *

  • hostname = “your hostname here”

  • username = “your username here”

  • password = “your password here”

  • list_of_commands = [“show running-config”, “show running-config”]

  • channel = ssh_connector(hostname, username, password)

  • output = send_config_cmds(list_of_commands, channel)

  • print(output)

Project details


Download files

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

Source Distribution

sshFRIEND-0.0.11.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

sshFRIEND-0.0.11-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page