Dears, I am a beginner on Python programing. I want to code script files ( on Microsoft windows) to perform some command line on a cisco network device. I installed Python 2.7.12 on window 7. I perform as your guidle line: https://pynet.twb-tech.com/blog/automation/netmiko.html. But when i use the "from netmiko import ConnectHandler", it is not correct, it appear : "IndentationError: unexpected indent". Please help me to fix it? Thank you very much.

The system information is as follows:

1. netmiko version: 4.0
2. python 3.10
3. window 11

error_print:

Traceback (most recent call last):
  File "E:\web_API\test.py", line 11, in <module>
    app.net_ssh_proxy(switch_json = switch_json, commands=commands)
  File "E:\web_API\app.py", line 25, in net_ssh_proxy
    with ConnectHandler(**device_info, sock=sock) as net_connect:
  File "E:\venv_02\lib\site-packages\netmiko\ssh_dispatcher.py", line 344, in ConnectHandler
    return ConnectionClass(*args, **kwargs)
  File "E:\venv_02\lib\site-packages\netmiko\base_connection.py", line 434, in __init__
    self._open()
  File "E:\venv_02\lib\site-packages\netmiko\base_connection.py", line 439, in _open
    self.establish_connection()
  File "E:\venv_02\lib\site-packages\netmiko\base_connection.py", line 1092, in establish_connection
    self.special_login_handler()
  File "E:\venv_02\lib\site-packages\netmiko\huawei\huawei.py", line 105, in special_login_handler
    output = self.read_until_pattern(password_change_prompt)
  File "E:\venv_02\lib\site-packages\netmiko\base_connection.py", line 631, in read_until_pattern
    raise ReadException(msg)
netmiko.exceptions.ReadException: Unable to successfully split output based on pattern:
pattern=((Change now|Please choose))|([\]>]\s*$)
output='\nInfo: The max number of VTY users is 21, the number of current VTY users online is 2, and total number of terminal users online is 2.\n      The current login time is 2022-03-28 15:55:30+08:00.\n<xxxx_hostname>'
results=['\nInfo: The max number of VTY users is 21, the number of current VTY users online is 2, and total number of terminal users online is 2.\n      The current login time is 2022-03-28 15:55:30+08:00.\n<xxxx_hostname', None, None, '>', '']

test instanse 2. python 3.10 3. window 11 Netmiko 3.4.0 Release

out_print

no problem

I'm testing netmiko with my Enterasys SecureStack switches/routers and, at first it didn't work:

ValueError: Failed to enter enable mode.

So I looked at the code and it seems that it was only testes and I'm supposing that it was only testes on enterasys routers. I commented out the self.enable() and self.disable_paging() and it worked correctly with my devices.

So I thought: should we create another class, say EnterasysSecurestackSSH or something like that so that we don't break backward compatibility and add support to other devices?

If this should be the solution, I can make a pull request.

Thanks for the time.

Hello,

I got connection closed exception when I send many interface commands to cisco nexus device. On CLI, device can handle this many commands, but on script, it gives exception.

If I give keep_alive, why connection still be closed by remote?

Socket exception: An existing connection was forcibly closed by the remote host (10054) Traceback (most recent call last): File "d:.......\Python\Python37\lib\site-packages\netmiko\base_connection.py", line 1739, in send_config_set output += self.exit_config_mode() File "d:.......\Python\Python37\lib\site-packages\netmiko\cisco_base_connection.py", line 44, in exit_config_mode return super().exit_config_mode(exit_config=exit_config, pattern=pattern) File "d:.......\Python\Python37\lib\site-packages\netmiko\base_connection.py", line 1615, in exit_config_mode if self.check_config_mode(): File "d:.......\Python\Python37\lib\site-packages\netmiko\cisco\cisco_nxos_ssh.py", line 27, in check_config_mode return super().check_config_mode(check_string=check_string, pattern=pattern) File "d:.......\Python\Python37\lib\site-packages\netmiko\cisco_base_connection.py", line 30, in check_config_mode return super().check_config_mode(check_string=check_string, pattern=pattern) File "d:.......\Python\Python37\lib\site-packages\netmiko\base_connection.py", line 1582, in check_config_mode output = self.read_until_pattern(pattern=pattern) File "d:.......\Python\Python37\lib\site-packages\netmiko\base_connection.py", line 618, in read_until_pattern return self._read_channel_expect(*args, **kwargs) File "d:.......\Python\Python37\lib\site-packages\netmiko\base_connection.py", line 543, in _read_channel_expect raise EOFError("Channel stream closed by remote device.") EOFError: Channel stream closed by remote device.

['interface Ethernet1/1', 'no switchport', 'no description', 'no speed auto', ... omit ... 'interface Ethernet1/60', 'no switchport', 'no description', 'no speed auto']

net = ConnectHandler(device_type=self.deviceType, ip=self.host, username=self.username, password=self.password, global_delay_factor=3, keepalive=10) output = net.send_config_set(commands, cmd_verify=False)

SSH Proxy support is not working. I have it working linux > to linux > to linux (using netmiko), but when I try to do linux > to linux > to cisco it fails with the below.

paramiko.ssh_exception.SSHException: Error reading SSH protocol banner

I can get linux > to linux > to cisco working from command line.

On the Cisco side, it looks like it sends the banner:

Feb 2 13:15:17.572 PST: SSH0: starting SSH control process Feb 2 13:15:17.572 PST: SSH0: sent protocol version id SSH-2.0-Cisco-1.25 Feb 2 13:15:24.508 PST: SSH0: protocol version id is - SSH-2.0-paramiko_1.15.2 Feb 2 13:15:24.508 PST: SSH2 0: send:packet of length 416 (length also includes padlen of 11) Feb 2 13:15:24.508 PST: SSH2 0: send:packet of length 72 (length also includes padlen of 7) Feb 2 13:15:24.608 PST: SSH0: Session disconnected - error 0x00

On the Paramiko side, it looks like it thinks there is no banner to be read.

~/.ssh/config looks as follows:

host 50.76.53.27:22 user pyclass hostname 50.76.53.27 Port 22 ProxyCommand ssh [email protected] nc %h %p

There were some other errors that I had to fix to get the ssh_config parsing working. Fixes for these are committed in https://github.com/ktbyers/netmiko/commit/649dbcd4e10eb497e285662e4410ae45038fd15a

Hello @ktbyers,

I was wondering what is the right way of getting show tech-support command output from multiple Cisco devices. This output takes from 20-30 minutes depending on many factors (Number of switches in a stack, IOS version, etc.). There is no room for tries as you cannot stop the output. CTRL+C/CTRL+Z/CTRL+SHIFT+6 has no effect on stopping the output from being displayed.

My Code is:

#!usr/bin python3

from netmiko import ConnectHandler

ipaddrs = ["", "", "", "", ""]

devices = []
for ip in ipaddrs:
    devices.append(
        {
            "device_type": "cisco_ios_telnet",
            "ip": ip,
            "username": "cisco",
            "password": "cisco",
            "fast_cli": False,
            "conn_timeout": 15,
            "session_log": f"{ip}-session.log",
        }
    )

for device in devices:
    with ConnectHandler(**device) as net_connect:
        print(f'Connected to {device["ip"]}')
        hostname = net_connect.send_command("show version", use_textfsm=True)[0][
            "hostname"
        ]
        tech_support = net_connect.send_command("show tech-support", delay_factor=20)

    with open(f"{hostname}.txt", "w") as outfile:
        outfile.write(tech_support.lstrip())

    print(f'tech support of {device["ip"]} is saved successfully to {hostname}.txt')

print("Done")

Do you think this code will work in normal conditions: The devices are up and running and there are no issues in connecting to the devices?

My actual code has a try/except block for catching errors.

FYI, I have created a 'terminal_server' device_type. The general idea is that it won't do anything post SSH connection (or won't do much anyways).

Consequently, post SSH connection, you can then do:

>>> net_connect.write_channel("\r")
>>> net_connect.read_channel()
'\r\npynet-rtr1#'

In other words, you can directly interact with the terminal server to get logged-in to the end network device.

Once you have done this, you can then redispatch the connect (i.e. reset the device_type and class to the proper netmiko class.

>>> from netmiko import redispatch

# Dynamically reset the class back to CiscoIosSSH
>>> redispatch(net_connect, device_type='cisco_ios')
>>> 
>>> net_connect.device_type
'cisco_ios'
>>> net_connect.__class__
<class 'netmiko.cisco.cisco_ios.CiscoIosSSH'>

>>> net_connect.base_prompt
'pynet-rtr1'

I am looking for people that are able to test this?

The issue I am facing occurs when running the following code :

import netmiko

connection = netmiko.ConnectHandler(ip="*...", device_type="linux", username="admin", password="admin") output = (connection.send_command("admin display-config")) print(output) connection.disconnect()

When I change "connection.send_command(admin display-config") to "connection.send_command (ping 8.8.8.8)", it runs fine and returns the ping results. When I enter the code line by line in python cli, it returns the correct output of the command "display admin-config".

I need to ssh to an ASA after ssh into a jump router. I tried to use Connect Handler twice but not sure if that's the right way to do it. Can you please advise Kirk??

I have been trying to connect to Palo Alto firewall using netmiko to pull running configuration. Whenever i try, i get authentication error even though the credentials are correct. The Palo has the banner acknowledgement enabled.

====================================================================== Please see the script below

import getpass from netmiko import ConnectHandler

username = input('Username: ')
password = getpass.getpass('Password: ')

ip = input('Enter device ip: ')
ips = str(ip)
test = {
        'device_type': 'paloalto_panos', 
        'host': ips,
        'username': username, 
        'password': password,
        
    }
tcon = ConnectHandler(**test)

print('CONNECTED: ', ip)
   
palo_cmds = ['set cli pager off', 'show config running']

for show_cmd in palo_cmds:
    time.sleep(5)
    int_stat_result = tcon.send_command(show_cmd, cli_verify=False)
time.sleep(5)

print(int_stat_result)

========================================================== RESULTS WHEN I RUN THE SCRIPT

        Enter device ip: 10.8.250.88
       Authentication to device failed.

Common causes of this problem are:

1. Invalid username and password
2. Incorrect SSH-key file
3. Connecting to the wrong device

Device settings: paloalto_panos 10.8.250.88:22

Authentication failed.

===========================================================

@ktbyers and team, please help me here.

I am trying to use netmiko on a Juniper SRX but I am hitting Router prompt not found: error. Any help is appreciated.

Below is the exact error

  File "/home/user/eclipse-workspace/PyEZ/NetMiko-2.py", line 17, in <module>
    net_connect = ConnectHandler(**a_device)
  File "/usr/local/lib/python3.6/dist-packages/netmiko/ssh_dispatcher.py", line 131, in ConnectHandler
    return ConnectionClass(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/netmiko/base_connection.py", line 152, in __init__
    self.session_preparation()
  File "/usr/local/lib/python3.6/dist-packages/netmiko/juniper/juniper_ssh.py", line 25, in session_preparation
    self.set_base_prompt()
  File "/usr/local/lib/python3.6/dist-packages/netmiko/base_connection.py", line 672, in set_base_prompt
    raise ValueError("Router prompt not found: {0}".format(repr(prompt)))
ValueError: Router prompt not found: '%'

Below is my code

from netmiko import ConnectHandler
from datetime import datetime

juniper_srx = {
    'device_type': 'juniper',
    'ip':   '10.1.34.130',
    'username': 'root',
    'password': 'Password',
    'port': 22,               # there is a firewall performing NAT in front of this device
    'verbose': False,
    } 

all_devices = [juniper_srx]

start_time = datetime.now()
for a_device in all_devices:
    net_connect = ConnectHandler(**a_device)
    print ("1")
    output = net_connect.send_command("show interfaces terse")
    print ("\n\n>>>>>>>>> Device {0} <<<<<<<<<").format(a_device['device_type'])
    print (output)
    print (">>>>>>>>> End <<<<<<<<<") 
    
end_time = datetime.now()

total_time = end_time - start_time 
print (total_time)

Python 3.9.7 Python 3.8.2 Netmiko 4.1.2

There is an intermittent issue when trying to connect via netmiko to the following huawei platforms:

S5320
S6320

Some times it works fine and I face no issues (20% of the times) and other times I am getting back one of the following exceptions:

Please see picture attached.

Please note that the same piece of code works fine for other paltforms and huawei devices such as:

ATN CE6855

On a Dell S4048-ON switch running OS9 version 9.14(2.5), the current save_config() implementation does not work:

sw#copy running-configuration startup-configuration
% Error: The source file does not exist.

There are two ways to save on OS9: either "copy running-config startup-config" (but it requires a confirmation), or "write memory". We use the latter to avoid dealing with the confirmation prompt.

Also tested on a Dell S4810 running Dell OS 8.3.10.1, it has the same behaviour.

Unfortunately I don't have access to a device with the original Force10 OS, but according to old manuals found online, "write memory" seems to also be supported.

Defining a pattern is necessary to get good performance, otherwise Netmiko falls back to a sleep-based mechanism (read_channel_timing) for many common operations.

Hello,ktbyer, please review and consider this PR to enable support for hillstone (https://www.hillstonenet.com/)

Support for:

SSH send commands save config

I had run tests for ssh connection. show and config and save config Test run output bellow,

PS D:\netmiko\tests> py.test -v test_netmiko_show.py --test_device hillstone ============================================================================================================================ test session starts ============================================================================================================================ platform win32 -- Python 3.8.0, pytest-7.2.0, pluggy-1.0.0 -- d:\python38\python.exe cachedir: .pytest_cache rootdir: D:\netmiko, configfile: setup.cfg collected 25 items

test_netmiko_show.py::test_failed_key SKIPPED (Not using SSH-keys) [ 4%] test_netmiko_show.py::test_disable_paging PASSED [ 8%] test_netmiko_show.py::test_terminal_width PASSED [ 12%] test_netmiko_show.py::test_ssh_connect PASSED [ 16%] test_netmiko_show.py::test_ssh_connect_cm PASSED [ 20%] test_netmiko_show.py::test_send_command_timing PASSED [ 24%] test_netmiko_show.py::test_send_command_timing_no_cmd_verify SKIPPED [ 28%] test_netmiko_show.py::test_send_command PASSED [ 32%] test_netmiko_show.py::test_send_command_no_cmd_verify SKIPPED [ 36%] test_netmiko_show.py::test_complete_on_space_disabled SKIPPED [ 40%] test_netmiko_show.py::test_send_command_textfsm SKIPPED (TextFSM/ntc-templates not supported on this platform) [ 44%] test_netmiko_show.py::test_send_command_ttp SKIPPED (TTP template not existing for this platform) [ 48%] test_netmiko_show.py::test_send_command_genie SKIPPED (Genie not supported on this platform) [ 52%] test_netmiko_show.py::test_send_multiline_timing SKIPPED [ 56%] test_netmiko_show.py::test_send_multiline SKIPPED [ 60%] test_netmiko_show.py::test_send_multiline_prompt SKIPPED [ 64%] test_netmiko_show.py::test_send_multiline_simple SKIPPED [ 68%] test_netmiko_show.py::test_base_prompt PASSED [ 72%] test_netmiko_show.py::test_strip_prompt PASSED [ 76%] test_netmiko_show.py::test_strip_command PASSED [ 80%] test_netmiko_show.py::test_normalize_linefeeds PASSED [ 84%] test_netmiko_show.py::test_clear_buffer PASSED [ 88%] test_netmiko_show.py::test_enable_mode PASSED [ 92%] test_netmiko_show.py::test_disconnect PASSED [ 96%] test_netmiko_show.py::test_disconnect_no_enable SKIPPED [100%]

========================================================================================================================== short test summary info ========================================================================================================================== SKIPPED [1] test_netmiko_show.py:25: Not using SSH-keys SKIPPED [1] test_netmiko_show.py:88: Skipped SKIPPED [1] test_netmiko_show.py:106: Skipped SKIPPED [1] test_netmiko_show.py:128: Skipped SKIPPED [1] test_netmiko_show.py:149: TextFSM/ntc-templates not supported on this platform SKIPPED [1] test_netmiko_show.py:171: TTP template not existing for this platform SKIPPED [1] test_netmiko_show.py:211: Genie not supported on this platform SKIPPED [1] test_netmiko_show.py:231: Skipped SKIPPED [1] test_netmiko_show.py:247: Skipped SKIPPED [1] test_netmiko_show.py:272: Skipped SKIPPED [1] test_netmiko_show.py:296: Skipped SKIPPED [1] test_netmiko_show.py:401: Skipped ====================================================================================================================== 13 passed, 12 skipped in 19.74s ====================================================================================================================== PS D:\netmiko\tests> py.test -v test_netmiko_config.py --test_device hillstone ============================================================================================================================ test session starts ============================================================================================================================ platform win32 -- Python 3.8.0, pytest-7.2.0, pluggy-1.0.0 -- d:\python38\python.exe cachedir: .pytest_cache rootdir: D:\netmiko, configfile: setup.cfg collected 13 items

test_netmiko_config.py::test_ssh_connect PASSED [ 7%] test_netmiko_config.py::test_enable_mode PASSED [ 15%] test_netmiko_config.py::test_config_mode PASSED [ 23%] test_netmiko_config.py::test_exit_config_mode PASSED [ 30%] test_netmiko_config.py::test_config_set PASSED [ 38%] test_netmiko_config.py::test_config_set_generator PASSED [ 46%] test_netmiko_config.py::test_config_set_longcommand PASSED [ 53%] test_netmiko_config.py::test_config_hostname PASSED [ 61%] test_netmiko_config.py::test_config_from_file SKIPPED [ 69%] test_netmiko_config.py::test_config_error_pattern SKIPPED (No error_pattern defined.) [ 76%] test_netmiko_config.py::test_banner SKIPPED (No banner defined.) [ 84%] test_netmiko_config.py::test_global_cmd_verify SKIPPED (No banner defined.) [ 92%] test_netmiko_config.py::test_disconnect PASSED [100%]

========================================================================================================================== short test summary info ========================================================================================================================== SKIPPED [1] test_netmiko_config.py:163: Skipped SKIPPED [1] test_netmiko_config.py:175: No error_pattern defined. SKIPPED [1] test_netmiko_config.py:209: No banner defined. SKIPPED [1] test_netmiko_config.py:242: No banner defined. ======================================================================================================================= 9 passed, 4 skipped in 5.87s ======================================================================================================================== PS D:\netmiko\tests> py.test -v test_netmiko_save.py --test_device hillstone ============================================================================================================================ test session starts ============================================================================================================================ platform win32 -- Python 3.8.0, pytest-7.2.0, pluggy-1.0.0 -- d:\python38\python.exe cachedir: .pytest_cache rootdir: D:\netmiko, configfile: setup.cfg collected 2 items

test_netmiko_save.py::test_save_base PASSED [ 50%] test_netmiko_save.py::test_disconnect PASSED [100%]

============================================================================================================================= 2 passed in 7.28s ============================================================================================================================= PS D:\netmiko\tests>

Hello. I'm trying to add users to Cisco FTD automatically using paramiko. Adding Users by "configure user add" works fine but if a newly added user logs in to the device he needs to enter a new password instantly and the pattern of the base prompt does not appear. Any suggestions how to fix this?

Output from FTD: Cisco Firepower Extensible Operating System (FX-OS) v2.10.1 (build 175) Cisco Firepower 1140 Threat Defense v7.0.1 (build 84)

Hello testuser. You must change your password. Enter new password: Confirm new password: exit

Error `netmiko.exceptions.ReadTimeout:

Pattern not detected: '[>#]' in output.

Things you might try to fix this:

1. Adjust the regex pattern to better identify the terminating string. Note, in many situations the pattern is automatically based on the network device's prompt.
2. Increase the read_timeout to a larger value.

You can also look at the Netmiko session_log or debug log for more information.`

Hello! I have some proble when i try use this code. So I get error like : "Errno 11001 getaddrinfo failed" I have acess for all my devices by SSH and ICMP(ping). How i can fix this?

> import time
> from datetime import datetime
> import paramiko
> 
> login = 'ciscogtkz'
> passw = 'Jkbvgbflf80'
> 
> client = paramiko.SSHClient()
> client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
> file = open('device.txt', 'r')
> 
> for line in file:
>     timestamps = str(datetime.now())
>     print('Timestamp:', timestamps)
> 
>     def connector():
>         print('Connecting to IP:' + line)
>         client.connect(line, username=login, password=passw, look_for_keys=False, allow_agent=False)
> 
>     try:
>         connector()
>         with client.invoke_shell() as ssh:
>              ssh.send('enable\n')
>              ssh.send('terminal length 0\n')
>              ssh.send('show running-config\n')
>              time.sleep(10)
>              result = ssh.recv(10000).decode("utf-8")
>              fo = open(line.strip() + '.txt', 'w')
>              fo.writelines(result)
>              fo.close()
> 
>     except Exception as e:
>         error_log = str(e)
>         print(error_log + '\n')
> 
> file.close()