From 1c954561ae1afbe38316059c5803fd163d0092fc Mon Sep 17 00:00:00 2001
From: Kirk Byers
Date: Fri, 31 Jul 2020 14:41:59 -0700
Subject: [PATCH] Updating docs
---
docs/netmiko/a10/a10_ssh.html | 2 +-
docs/netmiko/a10/index.html | 2 +-
docs/netmiko/accedian/accedian_ssh.html | 2 +-
docs/netmiko/accedian/index.html | 2 +-
docs/netmiko/alcatel/alcatel_aos_ssh.html | 2 +-
docs/netmiko/alcatel/index.html | 2 +-
docs/netmiko/apresia/apresia_aeos.html | 4 +-
docs/netmiko/apresia/index.html | 2 +-
docs/netmiko/arista/arista.html | 32 +-
docs/netmiko/arista/index.html | 2 +-
docs/netmiko/aruba/aruba_ssh.html | 9 +
docs/netmiko/aruba/index.html | 6 +
docs/netmiko/base_connection.html | 304 +++--
docs/netmiko/broadcom/broadcom_icos_ssh.html | 2 +-
docs/netmiko/broadcom/index.html | 2 +-
docs/netmiko/centec/centec_os.html | 6 +-
docs/netmiko/centec/index.html | 4 +-
.../checkpoint/checkpoint_gaia_ssh.html | 2 +-
docs/netmiko/checkpoint/index.html | 2 +-
docs/netmiko/ciena/ciena_saos.html | 4 +-
docs/netmiko/ciena/index.html | 2 +-
docs/netmiko/cisco/cisco_asa_ssh.html | 4 +-
docs/netmiko/cisco/cisco_ios.html | 34 +-
docs/netmiko/cisco/cisco_nxos_ssh.html | 12 +-
docs/netmiko/cisco/cisco_s300.html | 2 +-
docs/netmiko/cisco/cisco_wlc_ssh.html | 2 +-
docs/netmiko/cisco/cisco_xr.html | 8 +-
docs/netmiko/cisco/index.html | 45 +-
docs/netmiko/cisco_base_connection.html | 318 ++---
docs/netmiko/citrix/index.html | 2 +-
docs/netmiko/citrix/netscaler_ssh.html | 2 +-
docs/netmiko/cloudgenix/cloudgenix_ion.html | 2 +-
docs/netmiko/cloudgenix/index.html | 2 +-
docs/netmiko/coriant/coriant_ssh.html | 2 +-
docs/netmiko/coriant/index.html | 2 +-
docs/netmiko/dell/dell_dnos6.html | 6 +-
docs/netmiko/dell/dell_force10_ssh.html | 2 +-
docs/netmiko/dell/dell_isilon_ssh.html | 2 +-
docs/netmiko/dell/dell_os10_ssh.html | 2 +-
docs/netmiko/dell/dell_powerconnect.html | 6 +-
docs/netmiko/dell/index.html | 14 +-
docs/netmiko/dlink/dlink_ds.html | 4 +-
docs/netmiko/dlink/index.html | 2 +-
docs/netmiko/eltex/eltex_esr_ssh.html | 2 +-
docs/netmiko/eltex/eltex_ssh.html | 2 +-
docs/netmiko/eltex/index.html | 4 +-
docs/netmiko/endace/endace_ssh.html | 2 +-
docs/netmiko/endace/index.html | 2 +-
docs/netmiko/enterasys/enterasys_ssh.html | 2 +-
docs/netmiko/enterasys/index.html | 2 +-
docs/netmiko/extreme/extreme_ers_ssh.html | 2 +-
docs/netmiko/extreme/extreme_exos.html | 4 +-
docs/netmiko/extreme/extreme_netiron.html | 4 +-
docs/netmiko/extreme/extreme_nos_ssh.html | 2 +-
docs/netmiko/extreme/extreme_slx_ssh.html | 2 +-
docs/netmiko/extreme/extreme_vsp_ssh.html | 2 +-
docs/netmiko/extreme/extreme_wing_ssh.html | 2 +-
docs/netmiko/extreme/index.html | 14 +-
docs/netmiko/f5/f5_linux_ssh.html | 2 +-
docs/netmiko/f5/f5_tmsh_ssh.html | 2 +-
docs/netmiko/f5/index.html | 4 +-
docs/netmiko/flexvnf/flexvnf_ssh.html | 2 +-
docs/netmiko/flexvnf/index.html | 2 +-
docs/netmiko/fortinet/fortinet_ssh.html | 2 +-
docs/netmiko/fortinet/index.html | 2 +-
docs/netmiko/hp/hp_procurve.html | 6 +-
docs/netmiko/hp/index.html | 4 +-
docs/netmiko/huawei/huawei.html | 8 +-
docs/netmiko/huawei/huawei_smartax.html | 2 +-
docs/netmiko/huawei/index.html | 8 +-
docs/netmiko/index.html | 325 ++++--
docs/netmiko/juniper/index.html | 8 +-
docs/netmiko/juniper/juniper.html | 56 +-
docs/netmiko/juniper/juniper_screenos.html | 2 +-
docs/netmiko/keymile/index.html | 2 +-
docs/netmiko/keymile/keymile_nos_ssh.html | 2 +-
docs/netmiko/linux/index.html | 2 +-
docs/netmiko/linux/linux_ssh.html | 2 +-
docs/netmiko/mellanox/index.html | 2 +-
.../netmiko/mellanox/mellanox_mlnxos_ssh.html | 2 +-
docs/netmiko/mrv/index.html | 4 +-
docs/netmiko/mrv/mrv_lx.html | 2 +-
docs/netmiko/mrv/mrv_ssh.html | 2 +-
docs/netmiko/netapp/index.html | 2 +-
docs/netmiko/netapp/netapp_cdot_ssh.html | 2 +-
docs/netmiko/nokia/index.html | 8 +-
docs/netmiko/nokia/nokia_sros_ssh.html | 11 +-
docs/netmiko/ovs/index.html | 2 +-
docs/netmiko/ovs/ovs_linux_ssh.html | 2 +-
docs/netmiko/paloalto/index.html | 4 +-
docs/netmiko/paloalto/paloalto_panos.html | 6 +-
docs/netmiko/quanta/index.html | 2 +-
docs/netmiko/quanta/quanta_mesh_ssh.html | 2 +-
docs/netmiko/rad/index.html | 2 +-
docs/netmiko/rad/rad_etx.html | 4 +-
docs/netmiko/raisecom/index.html | 622 ++++++++++
docs/netmiko/raisecom/raisecom_roap.html | 1018 +++++++++++++++++
docs/netmiko/ruckus/index.html | 2 +-
docs/netmiko/ruckus/ruckus_fastiron.html | 4 +-
docs/netmiko/ruijie/index.html | 2 +-
docs/netmiko/ruijie/ruijie_os.html | 4 +-
docs/netmiko/scp_functions.html | 64 +-
docs/netmiko/scp_handler.html | 56 +-
docs/netmiko/sixwind/index.html | 2 +-
docs/netmiko/sixwind/sixwind_os.html | 4 +-
docs/netmiko/sophos/index.html | 2 +-
docs/netmiko/sophos/sophos_sfos_ssh.html | 2 +-
docs/netmiko/terminal_server/index.html | 4 +-
.../terminal_server/terminal_server.html | 6 +-
docs/netmiko/ubiquiti/edge_ssh.html | 2 +-
docs/netmiko/ubiquiti/index.html | 4 +-
docs/netmiko/ubiquiti/unifiswitch_ssh.html | 2 +-
docs/netmiko/vyos/index.html | 2 +-
docs/netmiko/vyos/vyos_ssh.html | 2 +-
docs/netmiko/watchguard/fireware_ssh.html | 2 +-
docs/netmiko/watchguard/index.html | 2 +-
docs/netmiko/yamaha/index.html | 4 +-
docs/netmiko/yamaha/yamaha.html | 6 +-
docs/netmiko/zte/index.html | 4 +-
docs/netmiko/zte/zte_zxros.html | 6 +-
120 files changed, 2654 insertions(+), 594 deletions(-)
create mode 100644 docs/netmiko/raisecom/index.html
create mode 100644 docs/netmiko/raisecom/raisecom_roap.html
diff --git a/docs/netmiko/a10/a10_ssh.html b/docs/netmiko/a10/a10_ssh.html
index 917d3792c..ffa59d3fb 100644
--- a/docs/netmiko/a10/a10_ssh.html
+++ b/docs/netmiko/a10/a10_ssh.html
@@ -61,7 +61,7 @@
class A10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
A10 support.
diff --git a/docs/netmiko/a10/index.html b/docs/netmiko/a10/index.html
index 250f885b2..16d62457c 100644
--- a/docs/netmiko/a10/index.html
+++ b/docs/netmiko/a10/index.html
@@ -45,7 +45,7 @@
class A10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
A10 support.
diff --git a/docs/netmiko/accedian/accedian_ssh.html b/docs/netmiko/accedian/accedian_ssh.html
index 5fe4497bc..2e180dd02 100644
--- a/docs/netmiko/accedian/accedian_ssh.html
+++ b/docs/netmiko/accedian/accedian_ssh.html
@@ -82,7 +82,7 @@
class AccedianSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/accedian/index.html b/docs/netmiko/accedian/index.html
index 823722262..bda9fb0bf 100644
--- a/docs/netmiko/accedian/index.html
+++ b/docs/netmiko/accedian/index.html
@@ -45,7 +45,7 @@
class AccedianSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/alcatel/alcatel_aos_ssh.html b/docs/netmiko/alcatel/alcatel_aos_ssh.html
index a69bdab8a..ca743956c 100644
--- a/docs/netmiko/alcatel/alcatel_aos_ssh.html
+++ b/docs/netmiko/alcatel/alcatel_aos_ssh.html
@@ -83,7 +83,7 @@
class AlcatelAosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).
diff --git a/docs/netmiko/alcatel/index.html b/docs/netmiko/alcatel/index.html
index ed31aa3b0..078d561b8 100644
--- a/docs/netmiko/alcatel/index.html
+++ b/docs/netmiko/alcatel/index.html
@@ -45,7 +45,7 @@
class AlcatelAosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).
diff --git a/docs/netmiko/apresia/apresia_aeos.html b/docs/netmiko/apresia/apresia_aeos.html
index 0899b407d..f1cbd8913 100644
--- a/docs/netmiko/apresia/apresia_aeos.html
+++ b/docs/netmiko/apresia/apresia_aeos.html
@@ -68,7 +68,7 @@
class ApresiaAeosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -303,7 +303,7 @@ Inherited members
class ApresiaAeosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/apresia/index.html b/docs/netmiko/apresia/index.html
index 5df5bc411..22f48fea4 100644
--- a/docs/netmiko/apresia/index.html
+++ b/docs/netmiko/apresia/index.html
@@ -45,7 +45,7 @@
class ApresiaAeosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/arista/arista.html b/docs/netmiko/arista/arista.html
index 9ace0b999..6c2ece8c1 100644
--- a/docs/netmiko/arista/arista.html
+++ b/docs/netmiko/arista/arista.html
@@ -25,7 +25,6 @@ Module netmiko.arista.arista
import time
from netmiko.cisco_base_connection import CiscoSSHConnection
from netmiko.cisco_base_connection import CiscoFileTransfer
-from netmiko import log
class AristaBase(CiscoSSHConnection):
@@ -48,13 +47,14 @@ Module netmiko.arista.arista
Can also be (s2)
"""
- log.debug(f"pattern: {pattern}")
self.write_channel(self.RETURN)
- output = self.read_until_pattern(pattern=pattern)
- log.debug(f"check_config_mode: {repr(output)}")
+ # You can encounter an issue here (on router name changes) prefer delay-based solution
+ if not pattern:
+ output = self._read_channel_timing()
+ else:
+ output = self.read_until_pattern(pattern=pattern)
output = output.replace("(s1)", "")
output = output.replace("(s2)", "")
- log.debug(f"check_config_mode: {repr(output)}")
return check_string in output
def _enter_shell(self):
@@ -143,7 +143,7 @@
class AristaBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -299,13 +299,14 @@
Can also be (s2)
"""
- log.debug(f"pattern: {pattern}")
self.write_channel(self.RETURN)
- output = self.read_until_pattern(pattern=pattern)
- log.debug(f"check_config_mode: {repr(output)}")
+ # You can encounter an issue here (on router name changes) prefer delay-based solution
+ if not pattern:
+ output = self._read_channel_timing()
+ else:
+ output = self.read_until_pattern(pattern=pattern)
output = output.replace("(s1)", "")
output = output.replace("(s2)", "")
- log.debug(f"check_config_mode: {repr(output)}")
return check_string in output
def _enter_shell(self):
@@ -348,13 +349,14 @@ Methods
Can also be (s2)
"""
- log.debug(f"pattern: {pattern}")
self.write_channel(self.RETURN)
- output = self.read_until_pattern(pattern=pattern)
- log.debug(f"check_config_mode: {repr(output)}")
+ # You can encounter an issue here (on router name changes) prefer delay-based solution
+ if not pattern:
+ output = self._read_channel_timing()
+ else:
+ output = self.read_until_pattern(pattern=pattern)
output = output.replace("(s1)", "")
output = output.replace("(s2)", "")
- log.debug(f"check_config_mode: {repr(output)}")
return check_string in output
@@ -517,7 +519,7 @@ Inherited members
class AristaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/arista/index.html b/docs/netmiko/arista/index.html
index 483c1c199..e5e8d4f77 100644
--- a/docs/netmiko/arista/index.html
+++ b/docs/netmiko/arista/index.html
@@ -137,7 +137,7 @@ Inherited members
class AristaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/aruba/aruba_ssh.html b/docs/netmiko/aruba/aruba_ssh.html
index 7e09c85e2..1a254b0c3 100644
--- a/docs/netmiko/aruba/aruba_ssh.html
+++ b/docs/netmiko/aruba/aruba_ssh.html
@@ -42,6 +42,9 @@ Module netmiko.aruba.aruba_ssh
def session_preparation(self):
"""Aruba OS requires enable mode to disable paging."""
+ # Aruba switches output ansi codes
+ self.ansi_escape_codes = True
+
delay_factor = self.select_delay_factor(delay_factor=0)
time.sleep(1 * delay_factor)
self._test_channel_read()
@@ -229,6 +232,9 @@
def session_preparation(self):
"""Aruba OS requires enable mode to disable paging."""
+ # Aruba switches output ansi codes
+ self.ansi_escape_codes = True
+
delay_factor = self.select_delay_factor(delay_factor=0)
time.sleep(1 * delay_factor)
self._test_channel_read()
@@ -305,6 +311,9 @@ Methods
Source code
def session_preparation(self):
"""Aruba OS requires enable mode to disable paging."""
+ # Aruba switches output ansi codes
+ self.ansi_escape_codes = True
+
delay_factor = self.select_delay_factor(delay_factor=0)
time.sleep(1 * delay_factor)
self._test_channel_read()
diff --git a/docs/netmiko/aruba/index.html b/docs/netmiko/aruba/index.html
index 5a97540e7..b8076d60d 100644
--- a/docs/netmiko/aruba/index.html
+++ b/docs/netmiko/aruba/index.html
@@ -194,6 +194,9 @@
def session_preparation(self):
"""Aruba OS requires enable mode to disable paging."""
+ # Aruba switches output ansi codes
+ self.ansi_escape_codes = True
+
delay_factor = self.select_delay_factor(delay_factor=0)
time.sleep(1 * delay_factor)
self._test_channel_read()
@@ -270,6 +273,9 @@ Methods
Source code
def session_preparation(self):
"""Aruba OS requires enable mode to disable paging."""
+ # Aruba switches output ansi codes
+ self.ansi_escape_codes = True
+
delay_factor = self.select_delay_factor(delay_factor=0)
time.sleep(1 * delay_factor)
self._test_channel_read()
diff --git a/docs/netmiko/base_connection.html b/docs/netmiko/base_connection.html
index 955d7e54e..3669a9339 100644
--- a/docs/netmiko/base_connection.html
+++ b/docs/netmiko/base_connection.html
@@ -90,11 +90,17 @@ Module netmiko.base_connection
alt_host_keys=False,
alt_key_file="",
ssh_config_file=None,
- timeout=100,
- session_timeout=60,
- auth_timeout=None,
- blocking_timeout=20,
- banner_timeout=15,
+ #
+ # Connect timeouts
+ # ssh-connect --> TCP conn (conn_timeout) --> SSH-banner (banner_timeout)
+ # --> Auth response (auth_timeout)
+ conn_timeout=5,
+ auth_timeout=None, # Timeout to wait for authentication response
+ banner_timeout=15, # Timeout to wait for the banner to be presented (post TCP-connect)
+ # Other timeouts
+ blocking_timeout=20, # Read blocking timeout
+ timeout=100, # TCP connect timeout | overloaded to read-loop timeout
+ session_timeout=60, # Used for locking/sharing the connection
keepalive=0,
default_enter=None,
response_return=None,
@@ -269,11 +275,12 @@ Module netmiko.base_connection
self.device_type = device_type
self.ansi_escape_codes = False
self.verbose = verbose
- self.timeout = timeout
self.auth_timeout = auth_timeout
self.banner_timeout = banner_timeout
- self.session_timeout = session_timeout
self.blocking_timeout = blocking_timeout
+ self.conn_timeout = conn_timeout
+ self.session_timeout = session_timeout
+ self.timeout = timeout
self.keepalive = keepalive
self.allow_auto_change = allow_auto_change
self.encoding = encoding
@@ -344,7 +351,9 @@ Module netmiko.base_connection
# Options for SSH host_keys
self.use_keys = use_keys
- self.key_file = key_file
+ self.key_file = (
+ path.abspath(path.expanduser(key_file)) if key_file else None
+ )
self.pkey = pkey
self.passphrase = passphrase
self.allow_agent = allow_agent
@@ -734,14 +743,16 @@ Module netmiko.base_connection
# Search for username pattern / send username
if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
time.sleep(1 * delay_factor)
output = self.read_channel()
return_msg += output
# Search for password pattern / send password
if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
time.sleep(0.5 * delay_factor)
output = self.read_channel()
return_msg += output
@@ -873,7 +884,7 @@ Module netmiko.base_connection
"key_filename": self.key_file,
"pkey": self.pkey,
"passphrase": self.passphrase,
- "timeout": self.timeout,
+ "timeout": self.conn_timeout,
"auth_timeout": self.auth_timeout,
"banner_timeout": self.banner_timeout,
"sock": self.sock,
@@ -930,11 +941,27 @@ Module netmiko.base_connection
# initiate SSH connection
try:
self.remote_conn_pre.connect(**ssh_connect_params)
- except socket.error:
+ except socket.error as conn_error:
self.paramiko_cleanup()
- msg = "Connection to device timed-out: {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
- )
+ msg = f"""TCP connection to device failed.
+
+Common causes of this problem are:
+1. Incorrect hostname or IP address.
+2. Wrong TCP port.
+3. Intermediate firewall blocking access.
+
+Device settings: {self.device_type} {self.host}:{self.port}
+
+"""
+
+ # Handle DNS failures separately
+ if "Name or service not known" in str(conn_error):
+ msg = (
+ f"DNS failure--the hostname you provided was not resolvable "
+ f"in DNS: {self.host}:{self.port}"
+ )
+
+ msg = msg.lstrip()
raise NetmikoTimeoutException(msg)
except paramiko.ssh_exception.AuthenticationException as auth_err:
self.paramiko_cleanup()
@@ -1133,7 +1160,6 @@ Module netmiko.base_connection
prompt = self.read_channel().strip()
if not prompt:
self.write_channel(self.RETURN)
- # log.debug(f"find_prompt sleep time: {sleep_time}")
time.sleep(sleep_time)
if sleep_time <= 3:
# Double the sleep_time when it is small
@@ -1830,8 +1856,6 @@ Module netmiko.base_connection
:param string_buffer: The string to be processed to remove ANSI escape codes
:type string_buffer: str
""" # noqa
- log.debug("In strip_ansi_escape_codes")
- log.debug(f"repr = {repr(string_buffer)}")
code_position_cursor = chr(27) + r"\[\d+;\d+H"
code_show_cursor = chr(27) + r"\[\?25h"
@@ -1840,19 +1864,19 @@ Module netmiko.base_connection
code_erase_line = chr(27) + r"\[2K"
code_erase_start_line = chr(27) + r"\[K"
code_enable_scroll = chr(27) + r"\[\d+;\d+r"
- code_form_feed = chr(27) + r"\[1L"
+ code_insert_line = chr(27) + r"\[(\d+)L"
code_carriage_return = chr(27) + r"\[1M"
code_disable_line_wrapping = chr(27) + r"\[\?7l"
code_reset_mode_screen_options = chr(27) + r"\[\?\d+l"
code_reset_graphics_mode = chr(27) + r"\[00m"
code_erase_display = chr(27) + r"\[2J"
+ code_erase_display_0 = chr(27) + r"\[J"
code_graphics_mode = chr(27) + r"\[\d\d;\d\dm"
code_graphics_mode2 = chr(27) + r"\[\d\d;\d\d;\d\dm"
code_graphics_mode3 = chr(27) + r"\[(3|4)\dm"
code_graphics_mode4 = chr(27) + r"\[(9|10)[0-7]m"
code_get_cursor_position = chr(27) + r"\[6n"
code_cursor_position = chr(27) + r"\[m"
- code_erase_display = chr(27) + r"\[J"
code_attrs_off = chr(27) + r"\[0m"
code_reverse = chr(27) + r"\[7m"
code_cursor_left = chr(27) + r"\[\d+D"
@@ -1863,7 +1887,6 @@ Module netmiko.base_connection
code_erase_line,
code_enable_scroll,
code_erase_start_line,
- code_form_feed,
code_carriage_return,
code_disable_line_wrapping,
code_erase_line_end,
@@ -1877,6 +1900,7 @@ Module netmiko.base_connection
code_get_cursor_position,
code_cursor_position,
code_erase_display,
+ code_erase_display_0,
code_attrs_off,
code_reverse,
code_cursor_left,
@@ -1889,9 +1913,12 @@ Module netmiko.base_connection
# CODE_NEXT_LINE must substitute with return
output = re.sub(code_next_line, self.RETURN, output)
- log.debug("Stripping ANSI escape codes")
- log.debug(f"new_output = {output}")
- log.debug(f"repr = {repr(output)}")
+ # Aruba and ProCurve switches can use code_insert_line for <enter>
+ insert_line_match = re.search(code_insert_line, output)
+ if insert_line_match:
+ # Substitute each insert_line with a new <enter>
+ count = int(insert_line_match.group(1))
+ output = re.sub(code_insert_line, count * self.RETURN, output)
return output
@@ -1933,9 +1960,9 @@ Module netmiko.base_connection
def open_session_log(self, filename, mode="write"):
"""Open the session_log file."""
if mode == "append":
- self.session_log = open(filename, mode="a")
+ self.session_log = open(filename, mode="a", encoding=self.encoding)
else:
- self.session_log = open(filename, mode="w")
+ self.session_log = open(filename, mode="w", encoding=self.encoding)
self._session_log_close = True
def close_session_log(self):
@@ -1960,7 +1987,7 @@
class BaseConnection
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
@@ -2126,11 +2153,17 @@
alt_host_keys=False,
alt_key_file="",
ssh_config_file=None,
- timeout=100,
- session_timeout=60,
- auth_timeout=None,
- blocking_timeout=20,
- banner_timeout=15,
+ #
+ # Connect timeouts
+ # ssh-connect --> TCP conn (conn_timeout) --> SSH-banner (banner_timeout)
+ # --> Auth response (auth_timeout)
+ conn_timeout=5,
+ auth_timeout=None, # Timeout to wait for authentication response
+ banner_timeout=15, # Timeout to wait for the banner to be presented (post TCP-connect)
+ # Other timeouts
+ blocking_timeout=20, # Read blocking timeout
+ timeout=100, # TCP connect timeout | overloaded to read-loop timeout
+ session_timeout=60, # Used for locking/sharing the connection
keepalive=0,
default_enter=None,
response_return=None,
@@ -2305,11 +2338,12 @@
self.device_type = device_type
self.ansi_escape_codes = False
self.verbose = verbose
- self.timeout = timeout
self.auth_timeout = auth_timeout
self.banner_timeout = banner_timeout
- self.session_timeout = session_timeout
self.blocking_timeout = blocking_timeout
+ self.conn_timeout = conn_timeout
+ self.session_timeout = session_timeout
+ self.timeout = timeout
self.keepalive = keepalive
self.allow_auto_change = allow_auto_change
self.encoding = encoding
@@ -2380,7 +2414,9 @@
# Options for SSH host_keys
self.use_keys = use_keys
- self.key_file = key_file
+ self.key_file = (
+ path.abspath(path.expanduser(key_file)) if key_file else None
+ )
self.pkey = pkey
self.passphrase = passphrase
self.allow_agent = allow_agent
@@ -2770,14 +2806,16 @@
# Search for username pattern / send username
if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
time.sleep(1 * delay_factor)
output = self.read_channel()
return_msg += output
# Search for password pattern / send password
if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
time.sleep(0.5 * delay_factor)
output = self.read_channel()
return_msg += output
@@ -2909,7 +2947,7 @@
"key_filename": self.key_file,
"pkey": self.pkey,
"passphrase": self.passphrase,
- "timeout": self.timeout,
+ "timeout": self.conn_timeout,
"auth_timeout": self.auth_timeout,
"banner_timeout": self.banner_timeout,
"sock": self.sock,
@@ -2966,11 +3004,27 @@
# initiate SSH connection
try:
self.remote_conn_pre.connect(**ssh_connect_params)
- except socket.error:
+ except socket.error as conn_error:
self.paramiko_cleanup()
- msg = "Connection to device timed-out: {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
- )
+ msg = f"""TCP connection to device failed.
+
+Common causes of this problem are:
+1. Incorrect hostname or IP address.
+2. Wrong TCP port.
+3. Intermediate firewall blocking access.
+
+Device settings: {self.device_type} {self.host}:{self.port}
+
+"""
+
+ # Handle DNS failures separately
+ if "Name or service not known" in str(conn_error):
+ msg = (
+ f"DNS failure--the hostname you provided was not resolvable "
+ f"in DNS: {self.host}:{self.port}"
+ )
+
+ msg = msg.lstrip()
raise NetmikoTimeoutException(msg)
except paramiko.ssh_exception.AuthenticationException as auth_err:
self.paramiko_cleanup()
@@ -3169,7 +3223,6 @@
prompt = self.read_channel().strip()
if not prompt:
self.write_channel(self.RETURN)
- # log.debug(f"find_prompt sleep time: {sleep_time}")
time.sleep(sleep_time)
if sleep_time <= 3:
# Double the sleep_time when it is small
@@ -3866,8 +3919,6 @@
:param string_buffer: The string to be processed to remove ANSI escape codes
:type string_buffer: str
""" # noqa
- log.debug("In strip_ansi_escape_codes")
- log.debug(f"repr = {repr(string_buffer)}")
code_position_cursor = chr(27) + r"\[\d+;\d+H"
code_show_cursor = chr(27) + r"\[\?25h"
@@ -3876,19 +3927,19 @@
code_erase_line = chr(27) + r"\[2K"
code_erase_start_line = chr(27) + r"\[K"
code_enable_scroll = chr(27) + r"\[\d+;\d+r"
- code_form_feed = chr(27) + r"\[1L"
+ code_insert_line = chr(27) + r"\[(\d+)L"
code_carriage_return = chr(27) + r"\[1M"
code_disable_line_wrapping = chr(27) + r"\[\?7l"
code_reset_mode_screen_options = chr(27) + r"\[\?\d+l"
code_reset_graphics_mode = chr(27) + r"\[00m"
code_erase_display = chr(27) + r"\[2J"
+ code_erase_display_0 = chr(27) + r"\[J"
code_graphics_mode = chr(27) + r"\[\d\d;\d\dm"
code_graphics_mode2 = chr(27) + r"\[\d\d;\d\d;\d\dm"
code_graphics_mode3 = chr(27) + r"\[(3|4)\dm"
code_graphics_mode4 = chr(27) + r"\[(9|10)[0-7]m"
code_get_cursor_position = chr(27) + r"\[6n"
code_cursor_position = chr(27) + r"\[m"
- code_erase_display = chr(27) + r"\[J"
code_attrs_off = chr(27) + r"\[0m"
code_reverse = chr(27) + r"\[7m"
code_cursor_left = chr(27) + r"\[\d+D"
@@ -3899,7 +3950,6 @@
code_erase_line,
code_enable_scroll,
code_erase_start_line,
- code_form_feed,
code_carriage_return,
code_disable_line_wrapping,
code_erase_line_end,
@@ -3913,6 +3963,7 @@
code_get_cursor_position,
code_cursor_position,
code_erase_display,
+ code_erase_display_0,
code_attrs_off,
code_reverse,
code_cursor_left,
@@ -3925,9 +3976,12 @@
# CODE_NEXT_LINE must substitute with return
output = re.sub(code_next_line, self.RETURN, output)
- log.debug("Stripping ANSI escape codes")
- log.debug(f"new_output = {output}")
- log.debug(f"repr = {repr(output)}")
+ # Aruba and ProCurve switches can use code_insert_line for <enter>
+ insert_line_match = re.search(code_insert_line, output)
+ if insert_line_match:
+ # Substitute each insert_line with a new <enter>
+ count = int(insert_line_match.group(1))
+ output = re.sub(code_insert_line, count * self.RETURN, output)
return output
@@ -3969,9 +4023,9 @@
def open_session_log(self, filename, mode="write"):
"""Open the session_log file."""
if mode == "append":
- self.session_log = open(filename, mode="a")
+ self.session_log = open(filename, mode="a", encoding=self.encoding)
else:
- self.session_log = open(filename, mode="w")
+ self.session_log = open(filename, mode="w", encoding=self.encoding)
self._session_log_close = True
def close_session_log(self):
@@ -4289,62 +4343,78 @@ Methods
:type height: int
Source code
-def establish_connection(self, width=511, height=1000):
- """Establish SSH connection to the network device
+ def establish_connection(self, width=511, height=1000):
+ """Establish SSH connection to the network device
- Timeout will generate a NetmikoTimeoutException
- Authentication failure will generate a NetmikoAuthenticationException
+ Timeout will generate a NetmikoTimeoutException
+ Authentication failure will generate a NetmikoAuthenticationException
- :param width: Specified width of the VT100 terminal window (default: 511)
- :type width: int
+ :param width: Specified width of the VT100 terminal window (default: 511)
+ :type width: int
- :param height: Specified height of the VT100 terminal window (default: 1000)
- :type height: int
- """
- if self.protocol == "telnet":
- self.remote_conn = telnetlib.Telnet(
- self.host, port=self.port, timeout=self.timeout
- )
- self.telnet_login()
- elif self.protocol == "serial":
- self.remote_conn = serial.Serial(**self.serial_settings)
- self.serial_login()
- elif self.protocol == "ssh":
- ssh_connect_params = self._connect_params_dict()
- self.remote_conn_pre = self._build_ssh_client()
-
- # initiate SSH connection
- try:
- self.remote_conn_pre.connect(**ssh_connect_params)
- except socket.error:
- self.paramiko_cleanup()
- msg = "Connection to device timed-out: {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
- )
- raise NetmikoTimeoutException(msg)
- except paramiko.ssh_exception.AuthenticationException as auth_err:
- self.paramiko_cleanup()
- msg = "Authentication failure: unable to connect {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
+ :param height: Specified height of the VT100 terminal window (default: 1000)
+ :type height: int
+ """
+ if self.protocol == "telnet":
+ self.remote_conn = telnetlib.Telnet(
+ self.host, port=self.port, timeout=self.timeout
)
- msg += self.RETURN + str(auth_err)
- raise NetmikoAuthenticationException(msg)
+ self.telnet_login()
+ elif self.protocol == "serial":
+ self.remote_conn = serial.Serial(**self.serial_settings)
+ self.serial_login()
+ elif self.protocol == "ssh":
+ ssh_connect_params = self._connect_params_dict()
+ self.remote_conn_pre = self._build_ssh_client()
- if self.verbose:
- print(f"SSH connection established to {self.host}:{self.port}")
+ # initiate SSH connection
+ try:
+ self.remote_conn_pre.connect(**ssh_connect_params)
+ except socket.error as conn_error:
+ self.paramiko_cleanup()
+ msg = f"""TCP connection to device failed.
- # Use invoke_shell to establish an 'interactive session'
- self.remote_conn = self.remote_conn_pre.invoke_shell(
- term="vt100", width=width, height=height
- )
+Common causes of this problem are:
+1. Incorrect hostname or IP address.
+2. Wrong TCP port.
+3. Intermediate firewall blocking access.
+
+Device settings: {self.device_type} {self.host}:{self.port}
+
+"""
+
+ # Handle DNS failures separately
+ if "Name or service not known" in str(conn_error):
+ msg = (
+ f"DNS failure--the hostname you provided was not resolvable "
+ f"in DNS: {self.host}:{self.port}"
+ )
+
+ msg = msg.lstrip()
+ raise NetmikoTimeoutException(msg)
+ except paramiko.ssh_exception.AuthenticationException as auth_err:
+ self.paramiko_cleanup()
+ msg = "Authentication failure: unable to connect {device_type} {ip}:{port}".format(
+ device_type=self.device_type, ip=self.host, port=self.port
+ )
+ msg += self.RETURN + str(auth_err)
+ raise NetmikoAuthenticationException(msg)
+
+ if self.verbose:
+ print(f"SSH connection established to {self.host}:{self.port}")
- self.remote_conn.settimeout(self.blocking_timeout)
- if self.keepalive:
- self.remote_conn.transport.set_keepalive(self.keepalive)
- self.special_login_handler()
- if self.verbose:
- print("Interactive SSH session established")
- return ""
+ # Use invoke_shell to establish an 'interactive session'
+ self.remote_conn = self.remote_conn_pre.invoke_shell(
+ term="vt100", width=width, height=height
+ )
+
+ self.remote_conn.settimeout(self.blocking_timeout)
+ if self.keepalive:
+ self.remote_conn.transport.set_keepalive(self.keepalive)
+ self.special_login_handler()
+ if self.verbose:
+ print("Interactive SSH session established")
+ return ""
@@ -4438,7 +4508,6 @@ Methods
prompt = self.read_channel().strip()
if not prompt:
self.write_channel(self.RETURN)
- # log.debug(f"find_prompt sleep time: {sleep_time}")
time.sleep(sleep_time)
if sleep_time <= 3:
# Double the sleep_time when it is small
@@ -4559,9 +4628,9 @@ Methods
def open_session_log(self, filename, mode="write"):
"""Open the session_log file."""
if mode == "append":
- self.session_log = open(filename, mode="a")
+ self.session_log = open(filename, mode="a", encoding=self.encoding)
else:
- self.session_log = open(filename, mode="w")
+ self.session_log = open(filename, mode="w", encoding=self.encoding)
self._session_log_close = True
@@ -5461,8 +5530,6 @@ Methods
:param string_buffer: The string to be processed to remove ANSI escape codes
:type string_buffer: str
""" # noqa
- log.debug("In strip_ansi_escape_codes")
- log.debug(f"repr = {repr(string_buffer)}")
code_position_cursor = chr(27) + r"\[\d+;\d+H"
code_show_cursor = chr(27) + r"\[\?25h"
@@ -5471,19 +5538,19 @@ Methods
code_erase_line = chr(27) + r"\[2K"
code_erase_start_line = chr(27) + r"\[K"
code_enable_scroll = chr(27) + r"\[\d+;\d+r"
- code_form_feed = chr(27) + r"\[1L"
+ code_insert_line = chr(27) + r"\[(\d+)L"
code_carriage_return = chr(27) + r"\[1M"
code_disable_line_wrapping = chr(27) + r"\[\?7l"
code_reset_mode_screen_options = chr(27) + r"\[\?\d+l"
code_reset_graphics_mode = chr(27) + r"\[00m"
code_erase_display = chr(27) + r"\[2J"
+ code_erase_display_0 = chr(27) + r"\[J"
code_graphics_mode = chr(27) + r"\[\d\d;\d\dm"
code_graphics_mode2 = chr(27) + r"\[\d\d;\d\d;\d\dm"
code_graphics_mode3 = chr(27) + r"\[(3|4)\dm"
code_graphics_mode4 = chr(27) + r"\[(9|10)[0-7]m"
code_get_cursor_position = chr(27) + r"\[6n"
code_cursor_position = chr(27) + r"\[m"
- code_erase_display = chr(27) + r"\[J"
code_attrs_off = chr(27) + r"\[0m"
code_reverse = chr(27) + r"\[7m"
code_cursor_left = chr(27) + r"\[\d+D"
@@ -5494,7 +5561,6 @@ Methods
code_erase_line,
code_enable_scroll,
code_erase_start_line,
- code_form_feed,
code_carriage_return,
code_disable_line_wrapping,
code_erase_line_end,
@@ -5508,6 +5574,7 @@ Methods
code_get_cursor_position,
code_cursor_position,
code_erase_display,
+ code_erase_display_0,
code_attrs_off,
code_reverse,
code_cursor_left,
@@ -5520,9 +5587,12 @@ Methods
# CODE_NEXT_LINE must substitute with return
output = re.sub(code_next_line, self.RETURN, output)
- log.debug("Stripping ANSI escape codes")
- log.debug(f"new_output = {output}")
- log.debug(f"repr = {repr(output)}")
+ # Aruba and ProCurve switches can use code_insert_line for <enter>
+ insert_line_match = re.search(code_insert_line, output)
+ if insert_line_match:
+ # Substitute each insert_line with a new <enter>
+ count = int(insert_line_match.group(1))
+ output = re.sub(code_insert_line, count * self.RETURN, output)
return output
@@ -5648,14 +5718,16 @@ Methods
# Search for username pattern / send username
if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
time.sleep(1 * delay_factor)
output = self.read_channel()
return_msg += output
# Search for password pattern / send password
if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
time.sleep(0.5 * delay_factor)
output = self.read_channel()
return_msg += output
@@ -5720,7 +5792,7 @@ Methods
class TelnetConnection
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/broadcom/broadcom_icos_ssh.html b/docs/netmiko/broadcom/broadcom_icos_ssh.html
index 7ea4f6aa8..83afc4792 100644
--- a/docs/netmiko/broadcom/broadcom_icos_ssh.html
+++ b/docs/netmiko/broadcom/broadcom_icos_ssh.html
@@ -78,7 +78,7 @@
class BroadcomIcosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Broadcom Icos devices.
diff --git a/docs/netmiko/broadcom/index.html b/docs/netmiko/broadcom/index.html
index 34eb0461a..4b7d45b64 100644
--- a/docs/netmiko/broadcom/index.html
+++ b/docs/netmiko/broadcom/index.html
@@ -46,7 +46,7 @@
class BroadcomIcosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Broadcom Icos devices.
diff --git a/docs/netmiko/centec/centec_os.html b/docs/netmiko/centec/centec_os.html
index a3bebb600..3ef16b736 100644
--- a/docs/netmiko/centec/centec_os.html
+++ b/docs/netmiko/centec/centec_os.html
@@ -66,7 +66,7 @@
class CentecOSBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -310,7 +310,7 @@ Inherited members
class CentecOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -506,7 +506,7 @@ Inherited members
class CentecOSTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/centec/index.html b/docs/netmiko/centec/index.html
index c2828c430..5aac05519 100644
--- a/docs/netmiko/centec/index.html
+++ b/docs/netmiko/centec/index.html
@@ -45,7 +45,7 @@
class CentecOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -241,7 +241,7 @@ Inherited members
class CentecOSTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
index 5793fcf8f..c5a3f9123 100644
--- a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
+++ b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
@@ -69,7 +69,7 @@
class CheckPointGaiaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements methods for communicating with Check Point Gaia
diff --git a/docs/netmiko/checkpoint/index.html b/docs/netmiko/checkpoint/index.html
index ab97157b9..526163f23 100644
--- a/docs/netmiko/checkpoint/index.html
+++ b/docs/netmiko/checkpoint/index.html
@@ -45,7 +45,7 @@
class CheckPointGaiaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements methods for communicating with Check Point Gaia
diff --git a/docs/netmiko/ciena/ciena_saos.html b/docs/netmiko/ciena/ciena_saos.html
index 2fffd017c..a484ff1dd 100644
--- a/docs/netmiko/ciena/ciena_saos.html
+++ b/docs/netmiko/ciena/ciena_saos.html
@@ -252,7 +252,7 @@
class CienaSaosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ciena SAOS support.
@@ -823,7 +823,7 @@ Inherited members
class CienaSaosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ciena SAOS support.
diff --git a/docs/netmiko/ciena/index.html b/docs/netmiko/ciena/index.html
index 4ce9b135f..b556618e6 100644
--- a/docs/netmiko/ciena/index.html
+++ b/docs/netmiko/ciena/index.html
@@ -284,7 +284,7 @@ Inherited members
class CienaSaosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ciena SAOS support.
diff --git a/docs/netmiko/cisco/cisco_asa_ssh.html b/docs/netmiko/cisco/cisco_asa_ssh.html
index 105347174..120c0887a 100644
--- a/docs/netmiko/cisco/cisco_asa_ssh.html
+++ b/docs/netmiko/cisco/cisco_asa_ssh.html
@@ -166,7 +166,7 @@
class CiscoAsaFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco ASA SCP File Transfer driver.
@@ -209,7 +209,7 @@ Inherited members
class CiscoAsaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Subclass specific to Cisco ASA.
diff --git a/docs/netmiko/cisco/cisco_ios.html b/docs/netmiko/cisco/cisco_ios.html
index ff8b8218f..0e230cd79 100644
--- a/docs/netmiko/cisco/cisco_ios.html
+++ b/docs/netmiko/cisco/cisco_ios.html
@@ -95,13 +95,24 @@ Module netmiko.cisco.cisco_ios
direction="put",
source_config=None,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
+
if source_file and source_config:
msg = "Invalid call to InLineTransfer both source_file and source_config specified."
raise ValueError(msg)
if direction != "put":
raise ValueError("Only put operation supported by InLineTransfer.")
+ if progress is not None or progress4 is not None:
+ raise NotImplementedError(
+ "Progress bar is not supported on inline transfers."
+ )
+ else:
+ self.progress = progress
+ self.progress4 = progress4
+
self.ssh_ctl_chan = ssh_conn
if source_file:
self.source_file = source_file
@@ -267,7 +278,7 @@
class CiscoIosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Common Methods for IOS (both SSH and telnet).
@@ -526,7 +537,7 @@ Inherited members
class CiscoIosFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco IOS SCP File Transfer driver.
@@ -573,7 +584,7 @@ Inherited members
class CiscoIosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS SSH driver.
@@ -770,7 +781,7 @@ Inherited members
class CiscoIosSerial
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS Serial driver.
@@ -967,7 +978,7 @@ Inherited members
class CiscoIosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS Telnet driver.
@@ -1164,7 +1175,7 @@ Inherited members
class InLineTransfer
-( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)
+( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)
Use TCL on Cisco IOS to directly transfer file.
@@ -1182,13 +1193,24 @@ Inherited members
direction="put",
source_config=None,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
+
if source_file and source_config:
msg = "Invalid call to InLineTransfer both source_file and source_config specified."
raise ValueError(msg)
if direction != "put":
raise ValueError("Only put operation supported by InLineTransfer.")
+ if progress is not None or progress4 is not None:
+ raise NotImplementedError(
+ "Progress bar is not supported on inline transfers."
+ )
+ else:
+ self.progress = progress
+ self.progress4 = progress4
+
self.ssh_ctl_chan = ssh_conn
if source_file:
self.source_file = source_file
diff --git a/docs/netmiko/cisco/cisco_nxos_ssh.html b/docs/netmiko/cisco/cisco_nxos_ssh.html
index 28d0b3362..3c56e2cc3 100644
--- a/docs/netmiko/cisco/cisco_nxos_ssh.html
+++ b/docs/netmiko/cisco/cisco_nxos_ssh.html
@@ -63,6 +63,8 @@ Module netmiko.cisco.cisco_nxos_ssh
file_system="bootflash:",
direction="put",
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
self.ssh_ctl_chan = ssh_conn
self.source_file = source_file
@@ -84,6 +86,8 @@ Module netmiko.cisco.cisco_nxos_ssh
raise ValueError("Invalid direction specified")
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
def check_file_exists(self, remote_cmd=""):
"""Check if the dest_file already exists on the file system (return boolean)."""
@@ -158,7 +162,7 @@
class CiscoNxosFileTransfer
-( ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0)
+( ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0, progress=None, progress4=None)
Cisco NXOS SCP File Transfer driver.
@@ -175,6 +179,8 @@
file_system="bootflash:",
direction="put",
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
self.ssh_ctl_chan = ssh_conn
self.source_file = source_file
@@ -196,6 +202,8 @@
raise ValueError("Invalid direction specified")
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
def check_file_exists(self, remote_cmd=""):
"""Check if the dest_file already exists on the file system (return boolean)."""
@@ -305,7 +313,7 @@ Inherited members
class CiscoNxosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/cisco/cisco_s300.html b/docs/netmiko/cisco/cisco_s300.html
index 7a71b8393..3be820ce7 100644
--- a/docs/netmiko/cisco/cisco_s300.html
+++ b/docs/netmiko/cisco/cisco_s300.html
@@ -63,7 +63,7 @@
class CiscoS300SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Cisco SG300 series of devices.
diff --git a/docs/netmiko/cisco/cisco_wlc_ssh.html b/docs/netmiko/cisco/cisco_wlc_ssh.html
index bfb401c15..e04195533 100644
--- a/docs/netmiko/cisco/cisco_wlc_ssh.html
+++ b/docs/netmiko/cisco/cisco_wlc_ssh.html
@@ -230,7 +230,7 @@
class CiscoWlcSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Netmiko Cisco WLC support.
diff --git a/docs/netmiko/cisco/cisco_xr.html b/docs/netmiko/cisco/cisco_xr.html
index a670b434e..e01820c26 100644
--- a/docs/netmiko/cisco/cisco_xr.html
+++ b/docs/netmiko/cisco/cisco_xr.html
@@ -231,7 +231,7 @@
class CiscoXrBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -775,7 +775,7 @@ Inherited members
class CiscoXrFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco IOS-XR SCP File Transfer driver.
@@ -906,7 +906,7 @@ Inherited members
Cisco XR SSH driver.
@@ -1103,7 +1103,7 @@ Inherited members
class CiscoXrTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco XR Telnet driver.
diff --git a/docs/netmiko/cisco/index.html b/docs/netmiko/cisco/index.html
index 7d4f4029e..190a86897 100644
--- a/docs/netmiko/cisco/index.html
+++ b/docs/netmiko/cisco/index.html
@@ -101,7 +101,7 @@
class CiscoAsaFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco ASA SCP File Transfer driver.
@@ -144,7 +144,7 @@ Inherited members
class CiscoAsaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Subclass specific to Cisco ASA.
@@ -631,7 +631,7 @@ Inherited members
class CiscoIosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Common Methods for IOS (both SSH and telnet).
@@ -890,7 +890,7 @@ Inherited members
class CiscoIosFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco IOS SCP File Transfer driver.
@@ -937,7 +937,7 @@ Inherited members
class CiscoIosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS SSH driver.
@@ -1134,7 +1134,7 @@ Inherited members
class CiscoIosSerial
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS Serial driver.
@@ -1331,7 +1331,7 @@ Inherited members
class CiscoIosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco IOS Telnet driver.
@@ -1528,7 +1528,7 @@ Inherited members
class CiscoNxosFileTransfer
-( ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0)
+( ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0, progress=None, progress4=None)
Cisco NXOS SCP File Transfer driver.
@@ -1545,6 +1545,8 @@ Inherited members
file_system="bootflash:",
direction="put",
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
self.ssh_ctl_chan = ssh_conn
self.source_file = source_file
@@ -1566,6 +1568,8 @@ Inherited members
raise ValueError("Invalid direction specified")
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
def check_file_exists(self, remote_cmd=""):
"""Check if the dest_file already exists on the file system (return boolean)."""
@@ -1675,7 +1679,7 @@ Inherited members
class CiscoNxosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -1938,7 +1942,7 @@ Inherited members
class CiscoS300SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Cisco SG300 series of devices.
@@ -2568,7 +2572,7 @@ Inherited members
class CiscoWlcSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Netmiko Cisco WLC support.
@@ -3182,7 +3186,7 @@ Inherited members
class CiscoXrFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Cisco IOS-XR SCP File Transfer driver.
@@ -3313,7 +3317,7 @@ Inherited members
Cisco XR SSH driver.
@@ -3510,7 +3514,7 @@ Inherited members
class CiscoXrTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Cisco XR Telnet driver.
@@ -3707,7 +3711,7 @@ Inherited members
class InLineTransfer
-( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)
+( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)
Use TCL on Cisco IOS to directly transfer file.
@@ -3725,13 +3729,24 @@ Inherited members
direction="put",
source_config=None,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
+
if source_file and source_config:
msg = "Invalid call to InLineTransfer both source_file and source_config specified."
raise ValueError(msg)
if direction != "put":
raise ValueError("Only put operation supported by InLineTransfer.")
+ if progress is not None or progress4 is not None:
+ raise NotImplementedError(
+ "Progress bar is not supported on inline transfers."
+ )
+ else:
+ self.progress = progress
+ self.progress4 = progress4
+
self.ssh_ctl_chan = ssh_conn
if source_file:
self.source_file = source_file
diff --git a/docs/netmiko/cisco_base_connection.html b/docs/netmiko/cisco_base_connection.html
index fc28bb28d..4ac9ce6cd 100644
--- a/docs/netmiko/cisco_base_connection.html
+++ b/docs/netmiko/cisco_base_connection.html
@@ -108,65 +108,76 @@ Module netmiko.cisco_base_connection
output = ""
return_msg = ""
+ outer_loops = 3
+ inner_loops = int(max_loops / outer_loops)
i = 1
- while i <= max_loops:
- try:
- output = self.read_channel()
- return_msg += output
-
- # Search for username pattern / send username
- if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
- time.sleep(1 * delay_factor)
+ for _ in range(outer_loops):
+ while i <= inner_loops:
+ try:
output = self.read_channel()
return_msg += output
- # Search for password pattern / send password
- if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- output = self.read_channel()
- return_msg += output
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Support direct telnet through terminal server
+ if re.search(
+ r"initial configuration dialog\? \[yes/no\]: ", output
+ ):
+ self.write_channel("no" + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ count = 0
+ while count < 15:
+ output = self.read_channel()
+ return_msg += output
+ if re.search(r"ress RETURN to get started", output):
+ output = ""
+ break
+ time.sleep(2 * delay_factor)
+ count += 1
+
+ # Check for device with no password configured
+ if re.search(r"assword required, but none set", output):
+ self.remote_conn.close()
+ msg = "Login failed - Password required, but none set: {}".format(
+ self.host
+ )
+ raise NetmikoAuthenticationException(msg)
+
+ # Check if proper data received
if re.search(
pri_prompt_terminator, output, flags=re.M
) or re.search(alt_prompt_terminator, output, flags=re.M):
return return_msg
- # Support direct telnet through terminal server
- if re.search(r"initial configuration dialog\? \[yes/no\]: ", output):
- self.write_channel("no" + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- count = 0
- while count < 15:
- output = self.read_channel()
- return_msg += output
- if re.search(r"ress RETURN to get started", output):
- output = ""
- break
- time.sleep(2 * delay_factor)
- count += 1
+ i += 1
- # Check for device with no password configured
- if re.search(r"assword required, but none set", output):
+ except EOFError:
self.remote_conn.close()
- msg = "Login failed - Password required, but none set: {}".format(
- self.host
- )
+ msg = f"Login failed: {self.host}"
raise NetmikoAuthenticationException(msg)
- # Check if proper data received
- if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
- alt_prompt_terminator, output, flags=re.M
- ):
- return return_msg
-
- self.write_channel(self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- i += 1
- except EOFError:
- self.remote_conn.close()
- msg = f"Login failed: {self.host}"
- raise NetmikoAuthenticationException(msg)
+ # Try sending an <enter> to restart the login process
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ i = 1
# Last try to see if we already logged in
self.write_channel(self.TELNET_RETURN)
@@ -266,7 +277,7 @@
class CiscoBaseConnection
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -479,65 +490,76 @@
output = ""
return_msg = ""
+ outer_loops = 3
+ inner_loops = int(max_loops / outer_loops)
i = 1
- while i <= max_loops:
- try:
- output = self.read_channel()
- return_msg += output
-
- # Search for username pattern / send username
- if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
- time.sleep(1 * delay_factor)
+ for _ in range(outer_loops):
+ while i <= inner_loops:
+ try:
output = self.read_channel()
return_msg += output
- # Search for password pattern / send password
- if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- output = self.read_channel()
- return_msg += output
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Support direct telnet through terminal server
+ if re.search(
+ r"initial configuration dialog\? \[yes/no\]: ", output
+ ):
+ self.write_channel("no" + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ count = 0
+ while count < 15:
+ output = self.read_channel()
+ return_msg += output
+ if re.search(r"ress RETURN to get started", output):
+ output = ""
+ break
+ time.sleep(2 * delay_factor)
+ count += 1
+
+ # Check for device with no password configured
+ if re.search(r"assword required, but none set", output):
+ self.remote_conn.close()
+ msg = "Login failed - Password required, but none set: {}".format(
+ self.host
+ )
+ raise NetmikoAuthenticationException(msg)
+
+ # Check if proper data received
if re.search(
pri_prompt_terminator, output, flags=re.M
) or re.search(alt_prompt_terminator, output, flags=re.M):
return return_msg
- # Support direct telnet through terminal server
- if re.search(r"initial configuration dialog\? \[yes/no\]: ", output):
- self.write_channel("no" + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- count = 0
- while count < 15:
- output = self.read_channel()
- return_msg += output
- if re.search(r"ress RETURN to get started", output):
- output = ""
- break
- time.sleep(2 * delay_factor)
- count += 1
+ i += 1
- # Check for device with no password configured
- if re.search(r"assword required, but none set", output):
+ except EOFError:
self.remote_conn.close()
- msg = "Login failed - Password required, but none set: {}".format(
- self.host
- )
+ msg = f"Login failed: {self.host}"
raise NetmikoAuthenticationException(msg)
- # Check if proper data received
- if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
- alt_prompt_terminator, output, flags=re.M
- ):
- return return_msg
-
- self.write_channel(self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- i += 1
- except EOFError:
- self.remote_conn.close()
- msg = f"Login failed: {self.host}"
- raise NetmikoAuthenticationException(msg)
+ # Try sending an <enter> to restart the login process
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ i = 1
# Last try to see if we already logged in
self.write_channel(self.TELNET_RETURN)
@@ -632,6 +654,7 @@ Subclasses
HuaweiSmartAXSSH
IpInfusionOcNOSBase
OneaccessOneOSBase
+RaisecomRoapBase
RuijieOSBase
SixwindOSBase
ZteZxrosBase
@@ -833,65 +856,76 @@ Methods
output = ""
return_msg = ""
+ outer_loops = 3
+ inner_loops = int(max_loops / outer_loops)
i = 1
- while i <= max_loops:
- try:
- output = self.read_channel()
- return_msg += output
-
- # Search for username pattern / send username
- if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
- time.sleep(1 * delay_factor)
+ for _ in range(outer_loops):
+ while i <= inner_loops:
+ try:
output = self.read_channel()
return_msg += output
- # Search for password pattern / send password
- if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- output = self.read_channel()
- return_msg += output
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Support direct telnet through terminal server
+ if re.search(
+ r"initial configuration dialog\? \[yes/no\]: ", output
+ ):
+ self.write_channel("no" + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ count = 0
+ while count < 15:
+ output = self.read_channel()
+ return_msg += output
+ if re.search(r"ress RETURN to get started", output):
+ output = ""
+ break
+ time.sleep(2 * delay_factor)
+ count += 1
+
+ # Check for device with no password configured
+ if re.search(r"assword required, but none set", output):
+ self.remote_conn.close()
+ msg = "Login failed - Password required, but none set: {}".format(
+ self.host
+ )
+ raise NetmikoAuthenticationException(msg)
+
+ # Check if proper data received
if re.search(
pri_prompt_terminator, output, flags=re.M
) or re.search(alt_prompt_terminator, output, flags=re.M):
return return_msg
- # Support direct telnet through terminal server
- if re.search(r"initial configuration dialog\? \[yes/no\]: ", output):
- self.write_channel("no" + self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- count = 0
- while count < 15:
- output = self.read_channel()
- return_msg += output
- if re.search(r"ress RETURN to get started", output):
- output = ""
- break
- time.sleep(2 * delay_factor)
- count += 1
-
- # Check for device with no password configured
- if re.search(r"assword required, but none set", output):
+ i += 1
+
+ except EOFError:
self.remote_conn.close()
- msg = "Login failed - Password required, but none set: {}".format(
- self.host
- )
+ msg = f"Login failed: {self.host}"
raise NetmikoAuthenticationException(msg)
- # Check if proper data received
- if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
- alt_prompt_terminator, output, flags=re.M
- ):
- return return_msg
-
- self.write_channel(self.TELNET_RETURN)
- time.sleep(0.5 * delay_factor)
- i += 1
- except EOFError:
- self.remote_conn.close()
- msg = f"Login failed: {self.host}"
- raise NetmikoAuthenticationException(msg)
+ # Try sending an <enter> to restart the login process
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ i = 1
# Last try to see if we already logged in
self.write_channel(self.TELNET_RETURN)
@@ -950,7 +984,7 @@ Inherited members
class CiscoFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Class to manage SCP file transfer and associated SSH control channel.
@@ -999,7 +1033,7 @@ Inherited members
class CiscoSSHConnection
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/citrix/index.html b/docs/netmiko/citrix/index.html
index 4328b8b22..0cc670143 100644
--- a/docs/netmiko/citrix/index.html
+++ b/docs/netmiko/citrix/index.html
@@ -45,7 +45,7 @@
Netscaler SSH class.
diff --git a/docs/netmiko/citrix/netscaler_ssh.html b/docs/netmiko/citrix/netscaler_ssh.html
index b77859ef5..f9bfd3e27 100644
--- a/docs/netmiko/citrix/netscaler_ssh.html
+++ b/docs/netmiko/citrix/netscaler_ssh.html
@@ -95,7 +95,7 @@
Netscaler SSH class.
diff --git a/docs/netmiko/cloudgenix/cloudgenix_ion.html b/docs/netmiko/cloudgenix/cloudgenix_ion.html
index 2000c6740..418978380 100644
--- a/docs/netmiko/cloudgenix/cloudgenix_ion.html
+++ b/docs/netmiko/cloudgenix/cloudgenix_ion.html
@@ -84,7 +84,7 @@
class CloudGenixIonSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/cloudgenix/index.html b/docs/netmiko/cloudgenix/index.html
index 4bc2a676f..c69e9ad9a 100644
--- a/docs/netmiko/cloudgenix/index.html
+++ b/docs/netmiko/cloudgenix/index.html
@@ -45,7 +45,7 @@
class CloudGenixIonSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/coriant/coriant_ssh.html b/docs/netmiko/coriant/coriant_ssh.html
index b39aed730..1c3885f2f 100644
--- a/docs/netmiko/coriant/coriant_ssh.html
+++ b/docs/netmiko/coriant/coriant_ssh.html
@@ -78,7 +78,7 @@
class CoriantSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/coriant/index.html b/docs/netmiko/coriant/index.html
index 1784d0d52..5f7a096d1 100644
--- a/docs/netmiko/coriant/index.html
+++ b/docs/netmiko/coriant/index.html
@@ -45,7 +45,7 @@
class CoriantSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/dell/dell_dnos6.html b/docs/netmiko/dell/dell_dnos6.html
index eda6b51d4..f97e6ec5c 100644
--- a/docs/netmiko/dell/dell_dnos6.html
+++ b/docs/netmiko/dell/dell_dnos6.html
@@ -72,7 +72,7 @@
class DellDNOS6Base
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -314,7 +314,7 @@ Inherited members
class DellDNOS6SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -510,7 +510,7 @@ Inherited members
class DellDNOS6Telnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
diff --git a/docs/netmiko/dell/dell_force10_ssh.html b/docs/netmiko/dell/dell_force10_ssh.html
index 01484e826..6dda48fea 100644
--- a/docs/netmiko/dell/dell_force10_ssh.html
+++ b/docs/netmiko/dell/dell_force10_ssh.html
@@ -53,7 +53,7 @@
class DellForce10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell Force10 Driver - supports DNOS9.
diff --git a/docs/netmiko/dell/dell_isilon_ssh.html b/docs/netmiko/dell/dell_isilon_ssh.html
index 573caa06f..a096ccee9 100644
--- a/docs/netmiko/dell/dell_isilon_ssh.html
+++ b/docs/netmiko/dell/dell_isilon_ssh.html
@@ -121,7 +121,7 @@
class DellIsilonSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/dell/dell_os10_ssh.html b/docs/netmiko/dell/dell_os10_ssh.html
index f92a69b7b..89d62655e 100644
--- a/docs/netmiko/dell/dell_os10_ssh.html
+++ b/docs/netmiko/dell/dell_os10_ssh.html
@@ -297,7 +297,7 @@ Inherited members
class DellOS10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell EMC Networking OS10 Driver - supports dellos10.
diff --git a/docs/netmiko/dell/dell_powerconnect.html b/docs/netmiko/dell/dell_powerconnect.html
index 2b5ea2d16..9f847af6b 100644
--- a/docs/netmiko/dell/dell_powerconnect.html
+++ b/docs/netmiko/dell/dell_powerconnect.html
@@ -145,7 +145,7 @@
class DellPowerConnectBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -440,7 +440,7 @@ Inherited members
class DellPowerConnectSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -727,7 +727,7 @@ Inherited members
class DellPowerConnectTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Telnet Driver.
diff --git a/docs/netmiko/dell/index.html b/docs/netmiko/dell/index.html
index 122da8471..ffadc0543 100644
--- a/docs/netmiko/dell/index.html
+++ b/docs/netmiko/dell/index.html
@@ -76,7 +76,7 @@
class DellDNOS6SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -272,7 +272,7 @@ Inherited members
class DellDNOS6Telnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -468,7 +468,7 @@ Inherited members
class DellForce10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell Force10 Driver - supports DNOS9.
@@ -695,7 +695,7 @@ Inherited members
class DellIsilonSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
@@ -1275,7 +1275,7 @@ Inherited members
class DellOS10SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell EMC Networking OS10 Driver - supports dellos10.
@@ -1502,7 +1502,7 @@ Inherited members
class DellPowerConnectSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Driver.
@@ -1789,7 +1789,7 @@ Inherited members
class DellPowerConnectTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Dell PowerConnect Telnet Driver.
diff --git a/docs/netmiko/dlink/dlink_ds.html b/docs/netmiko/dlink/dlink_ds.html
index 67addb0c8..3d06b24d1 100644
--- a/docs/netmiko/dlink/dlink_ds.html
+++ b/docs/netmiko/dlink/dlink_ds.html
@@ -100,7 +100,7 @@
class DlinkDSBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)
@@ -459,7 +459,7 @@ Inherited members
class DlinkDSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)
diff --git a/docs/netmiko/dlink/index.html b/docs/netmiko/dlink/index.html
index e7982b629..38fbf8741 100644
--- a/docs/netmiko/dlink/index.html
+++ b/docs/netmiko/dlink/index.html
@@ -45,7 +45,7 @@
class DlinkDSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)
diff --git a/docs/netmiko/eltex/eltex_esr_ssh.html b/docs/netmiko/eltex/eltex_esr_ssh.html
index 4b1f4cdff..c5feb34b2 100644
--- a/docs/netmiko/eltex/eltex_esr_ssh.html
+++ b/docs/netmiko/eltex/eltex_esr_ssh.html
@@ -138,7 +138,7 @@
Netmiko support for routers Eltex ESR.
diff --git a/docs/netmiko/eltex/eltex_ssh.html b/docs/netmiko/eltex/eltex_ssh.html
index 01cb343df..c6a8bd050 100644
--- a/docs/netmiko/eltex/eltex_ssh.html
+++ b/docs/netmiko/eltex/eltex_ssh.html
@@ -54,7 +54,7 @@
class EltexSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/eltex/index.html b/docs/netmiko/eltex/index.html
index 4b347f5e9..df4a2d96c 100644
--- a/docs/netmiko/eltex/index.html
+++ b/docs/netmiko/eltex/index.html
@@ -50,7 +50,7 @@
Netmiko support for routers Eltex ESR.
@@ -435,7 +435,7 @@ Inherited members
class EltexSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/endace/endace_ssh.html b/docs/netmiko/endace/endace_ssh.html
index 4e3bded80..0793fba89 100644
--- a/docs/netmiko/endace/endace_ssh.html
+++ b/docs/netmiko/endace/endace_ssh.html
@@ -74,7 +74,7 @@
class EndaceSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/endace/index.html b/docs/netmiko/endace/index.html
index 083591b72..efcbc258a 100644
--- a/docs/netmiko/endace/index.html
+++ b/docs/netmiko/endace/index.html
@@ -45,7 +45,7 @@
class EndaceSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/enterasys/enterasys_ssh.html b/docs/netmiko/enterasys/enterasys_ssh.html
index 0b8da5163..ab6fdf143 100644
--- a/docs/netmiko/enterasys/enterasys_ssh.html
+++ b/docs/netmiko/enterasys/enterasys_ssh.html
@@ -56,7 +56,7 @@
class EnterasysSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Enterasys support.
diff --git a/docs/netmiko/enterasys/index.html b/docs/netmiko/enterasys/index.html
index 537b976b0..2b15ddf31 100644
--- a/docs/netmiko/enterasys/index.html
+++ b/docs/netmiko/enterasys/index.html
@@ -45,7 +45,7 @@
class EnterasysSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Enterasys support.
diff --git a/docs/netmiko/extreme/extreme_ers_ssh.html b/docs/netmiko/extreme/extreme_ers_ssh.html
index aa08fa4aa..3fef18979 100644
--- a/docs/netmiko/extreme/extreme_ers_ssh.html
+++ b/docs/netmiko/extreme/extreme_ers_ssh.html
@@ -79,7 +79,7 @@
Netmiko support for Extreme Ethernet Routing Switch.
diff --git a/docs/netmiko/extreme/extreme_exos.html b/docs/netmiko/extreme/extreme_exos.html
index bb8a2a409..e338fe543 100644
--- a/docs/netmiko/extreme/extreme_exos.html
+++ b/docs/netmiko/extreme/extreme_exos.html
@@ -121,7 +121,7 @@
class ExtremeExosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme Exos support.
@@ -497,7 +497,7 @@ Inherited members
class ExtremeExosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme Exos support.
diff --git a/docs/netmiko/extreme/extreme_netiron.html b/docs/netmiko/extreme/extreme_netiron.html
index 83f01127b..fbda2da10 100644
--- a/docs/netmiko/extreme/extreme_netiron.html
+++ b/docs/netmiko/extreme/extreme_netiron.html
@@ -55,7 +55,7 @@
class ExtremeNetironBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -275,7 +275,7 @@ Inherited members
class ExtremeNetironSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/extreme/extreme_nos_ssh.html b/docs/netmiko/extreme/extreme_nos_ssh.html
index 60f94d296..cd56667d7 100644
--- a/docs/netmiko/extreme/extreme_nos_ssh.html
+++ b/docs/netmiko/extreme/extreme_nos_ssh.html
@@ -68,7 +68,7 @@
class ExtremeNosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Extreme NOS/VDX.
diff --git a/docs/netmiko/extreme/extreme_slx_ssh.html b/docs/netmiko/extreme/extreme_slx_ssh.html
index b139cadff..830234f51 100644
--- a/docs/netmiko/extreme/extreme_slx_ssh.html
+++ b/docs/netmiko/extreme/extreme_slx_ssh.html
@@ -68,7 +68,7 @@
class ExtremeSlxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Extreme SLX.
diff --git a/docs/netmiko/extreme/extreme_vsp_ssh.html b/docs/netmiko/extreme/extreme_vsp_ssh.html
index f1cfca02a..1fcf404fd 100644
--- a/docs/netmiko/extreme/extreme_vsp_ssh.html
+++ b/docs/netmiko/extreme/extreme_vsp_ssh.html
@@ -58,7 +58,7 @@
class ExtremeVspSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme Virtual Services Platform Support.
diff --git a/docs/netmiko/extreme/extreme_wing_ssh.html b/docs/netmiko/extreme/extreme_wing_ssh.html
index 723c5fa8b..6cc7afb30 100644
--- a/docs/netmiko/extreme/extreme_wing_ssh.html
+++ b/docs/netmiko/extreme/extreme_wing_ssh.html
@@ -50,7 +50,7 @@
class ExtremeWingSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme WiNG support.
diff --git a/docs/netmiko/extreme/index.html b/docs/netmiko/extreme/index.html
index 62447cc7a..439bc2b9d 100644
--- a/docs/netmiko/extreme/index.html
+++ b/docs/netmiko/extreme/index.html
@@ -87,7 +87,7 @@
Netmiko support for Extreme Ethernet Routing Switch.
@@ -366,7 +366,7 @@ Inherited members
class ExtremeExosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme Exos support.
@@ -763,7 +763,7 @@ Inherited members
class ExtremeNetironSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -1158,7 +1158,7 @@ Inherited members
class ExtremeNosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Extreme NOS/VDX.
@@ -1434,7 +1434,7 @@ Inherited members
class ExtremeSlxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Support for Extreme SLX.
@@ -1710,7 +1710,7 @@ Inherited members
class ExtremeVspSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme Virtual Services Platform Support.
@@ -1952,7 +1952,7 @@ Inherited members
class ExtremeWingSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Extreme WiNG support.
diff --git a/docs/netmiko/f5/f5_linux_ssh.html b/docs/netmiko/f5/f5_linux_ssh.html
index cadecb947..a2cf48664 100644
--- a/docs/netmiko/f5/f5_linux_ssh.html
+++ b/docs/netmiko/f5/f5_linux_ssh.html
@@ -40,7 +40,7 @@
class F5LinuxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/f5/f5_tmsh_ssh.html b/docs/netmiko/f5/f5_tmsh_ssh.html
index f5480a693..13b8848b3 100644
--- a/docs/netmiko/f5/f5_tmsh_ssh.html
+++ b/docs/netmiko/f5/f5_tmsh_ssh.html
@@ -62,7 +62,7 @@
class F5TmshSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/f5/index.html b/docs/netmiko/f5/index.html
index a6988cdde..61c3d649f 100644
--- a/docs/netmiko/f5/index.html
+++ b/docs/netmiko/f5/index.html
@@ -50,7 +50,7 @@
class F5LinuxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -246,7 +246,7 @@ Inherited members
class F5TmshSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/flexvnf/flexvnf_ssh.html b/docs/netmiko/flexvnf/flexvnf_ssh.html
index 850de9f85..3623008ef 100644
--- a/docs/netmiko/flexvnf/flexvnf_ssh.html
+++ b/docs/netmiko/flexvnf/flexvnf_ssh.html
@@ -239,7 +239,7 @@
class FlexvnfSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/flexvnf/index.html b/docs/netmiko/flexvnf/index.html
index ede6c7367..ee21aea5f 100644
--- a/docs/netmiko/flexvnf/index.html
+++ b/docs/netmiko/flexvnf/index.html
@@ -45,7 +45,7 @@
class FlexvnfSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
diff --git a/docs/netmiko/fortinet/fortinet_ssh.html b/docs/netmiko/fortinet/fortinet_ssh.html
index 1ed740f9a..ad4e086c2 100644
--- a/docs/netmiko/fortinet/fortinet_ssh.html
+++ b/docs/netmiko/fortinet/fortinet_ssh.html
@@ -146,7 +146,7 @@
class FortinetSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/fortinet/index.html b/docs/netmiko/fortinet/index.html
index 11d0d9067..38004bb03 100644
--- a/docs/netmiko/fortinet/index.html
+++ b/docs/netmiko/fortinet/index.html
@@ -45,7 +45,7 @@
class FortinetSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/hp/hp_procurve.html b/docs/netmiko/hp/hp_procurve.html
index 4f2a38902..9218645fd 100644
--- a/docs/netmiko/hp/hp_procurve.html
+++ b/docs/netmiko/hp/hp_procurve.html
@@ -224,7 +224,7 @@
class HPProcurveBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -619,7 +619,7 @@ Inherited members
class HPProcurveSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -854,7 +854,7 @@ Inherited members
class HPProcurveTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/hp/index.html b/docs/netmiko/hp/index.html
index 3779d98f0..45c68f55f 100644
--- a/docs/netmiko/hp/index.html
+++ b/docs/netmiko/hp/index.html
@@ -445,7 +445,7 @@ Inherited members
class HPProcurveSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -680,7 +680,7 @@ Inherited members
class HPProcurveTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/huawei/huawei.html b/docs/netmiko/huawei/huawei.html
index 1bc6c7155..9944c4977 100644
--- a/docs/netmiko/huawei/huawei.html
+++ b/docs/netmiko/huawei/huawei.html
@@ -272,7 +272,7 @@
class HuaweiBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -744,7 +744,7 @@ Inherited members
class HuaweiSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei SSH driver.
@@ -975,7 +975,7 @@ Inherited members
class HuaweiTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei Telnet driver.
@@ -1326,7 +1326,7 @@ Inherited members
class HuaweiVrpv8SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei SSH driver.
diff --git a/docs/netmiko/huawei/huawei_smartax.html b/docs/netmiko/huawei/huawei_smartax.html
index a28f6fa3e..bff9051aa 100644
--- a/docs/netmiko/huawei/huawei_smartax.html
+++ b/docs/netmiko/huawei/huawei_smartax.html
@@ -117,7 +117,7 @@
class HuaweiSmartAXSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Supports Huawei SmartAX and OLT.
diff --git a/docs/netmiko/huawei/index.html b/docs/netmiko/huawei/index.html
index 7ce9e9103..fe63955a8 100644
--- a/docs/netmiko/huawei/index.html
+++ b/docs/netmiko/huawei/index.html
@@ -51,7 +51,7 @@
class HuaweiSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei SSH driver.
@@ -282,7 +282,7 @@ Inherited members
class HuaweiSmartAXSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Supports Huawei SmartAX and OLT.
@@ -620,7 +620,7 @@ Inherited members
class HuaweiTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei Telnet driver.
@@ -971,7 +971,7 @@ Inherited members
class HuaweiVrpv8SSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Huawei SSH driver.
diff --git a/docs/netmiko/index.html b/docs/netmiko/index.html
index 5fa28d437..3a2fd5e6c 100644
--- a/docs/netmiko/index.html
+++ b/docs/netmiko/index.html
@@ -42,12 +42,12 @@ Module netmiko
)
from netmiko.ssh_autodetect import SSHDetect
from netmiko.base_connection import BaseConnection
-from netmiko.scp_functions import file_transfer
+from netmiko.scp_functions import file_transfer, progress_bar
# Alternate naming
Netmiko = ConnectHandler
-__version__ = "3.1.1"
+__version__ = "3.2.0"
__all__ = (
"ConnectHandler",
"ssh_dispatcher",
@@ -64,6 +64,7 @@ Module netmiko
"BaseConnection",
"Netmiko",
"file_transfer",
+ "progress_bar",
)
# Cisco cntl-shift-six sequence
@@ -249,6 +250,10 @@
+netmiko.raisecom
+
+
+
netmiko.ruckus
@@ -331,12 +336,17 @@
Source code
def ConnectHandler(*args, **kwargs):
"""Factory function selects the proper class and creates object based on device_type."""
- if kwargs["device_type"] not in platforms:
+ device_type = kwargs["device_type"]
+ if device_type not in platforms:
+ if device_type is None:
+ msg_str = platforms_str
+ else:
+ msg_str = telnet_platforms_str if "telnet" in device_type else platforms_str
raise ValueError(
- "Unsupported device_type: "
- "currently supported platforms are: {}".format(platforms_str)
+ "Unsupported 'device_type' "
+ "currently supported platforms are: {}".format(msg_str)
)
- ConnectionClass = ssh_dispatcher(kwargs["device_type"])
+ ConnectionClass = ssh_dispatcher(device_type)
return ConnectionClass(*args, **kwargs)
@@ -371,17 +381,22 @@
Source code
def ConnectHandler(*args, **kwargs):
"""Factory function selects the proper class and creates object based on device_type."""
- if kwargs["device_type"] not in platforms:
+ device_type = kwargs["device_type"]
+ if device_type not in platforms:
+ if device_type is None:
+ msg_str = platforms_str
+ else:
+ msg_str = telnet_platforms_str if "telnet" in device_type else platforms_str
raise ValueError(
- "Unsupported device_type: "
- "currently supported platforms are: {}".format(platforms_str)
+ "Unsupported 'device_type' "
+ "currently supported platforms are: {}".format(msg_str)
)
- ConnectionClass = ssh_dispatcher(kwargs["device_type"])
+ ConnectionClass = ssh_dispatcher(device_type)
return ConnectionClass(*args, **kwargs)
-def file_transfer (ssh_conn, source_file, dest_file, file_system=None, direction='put', disable_md5=False, inline_transfer=False, overwrite_file=False, socket_timeout=10.0, verify_file=None)
+def file_transfer (ssh_conn, source_file, dest_file, file_system=None, direction='put', disable_md5=False, inline_transfer=False, overwrite_file=False, socket_timeout=10.0, progress=None, progress4=None, verify_file=None)
Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.
@@ -403,6 +418,8 @@
inline_transfer=False,
overwrite_file=False,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
verify_file=None,
):
"""Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.
@@ -448,6 +465,8 @@
"dest_file": dest_file,
"direction": direction,
"socket_timeout": socket_timeout,
+ "progress": progress,
+ "progress4": progress4,
}
if file_system is not None:
scp_args["file_system"] = file_system
@@ -492,6 +511,36 @@
return transferred_and_notverified
+
+def progress_bar (filename, size, sent, peername=None)
+
+
+
+
+Source code
+def progress_bar(filename, size, sent, peername=None):
+ max_width = 50
+ filename = filename.decode()
+ clear_screen = chr(27) + "[2J"
+ terminating_char = "|"
+
+ # Percentage done
+ percent_complete = sent / size
+ percent_str = f"{percent_complete*100:.2f}%"
+ hash_count = int(percent_complete * max_width)
+ progress = hash_count * ">"
+
+ if peername is None:
+ header_msg = f"Transferring file: {filename}\n"
+ else:
+ header_msg = f"Transferring file to {peername}: {filename}\n"
+
+ msg = f"{progress:<50}{terminating_char:1} ({percent_str})"
+ print(clear_screen)
+ print(header_msg)
+ print(msg)
+
+
def redispatch (obj, device_type, session_prep=True)
@@ -532,7 +581,7 @@
class BaseConnection
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
@@ -698,11 +747,17 @@
alt_host_keys=False,
alt_key_file="",
ssh_config_file=None,
- timeout=100,
- session_timeout=60,
- auth_timeout=None,
- blocking_timeout=20,
- banner_timeout=15,
+ #
+ # Connect timeouts
+ # ssh-connect --> TCP conn (conn_timeout) --> SSH-banner (banner_timeout)
+ # --> Auth response (auth_timeout)
+ conn_timeout=5,
+ auth_timeout=None, # Timeout to wait for authentication response
+ banner_timeout=15, # Timeout to wait for the banner to be presented (post TCP-connect)
+ # Other timeouts
+ blocking_timeout=20, # Read blocking timeout
+ timeout=100, # TCP connect timeout | overloaded to read-loop timeout
+ session_timeout=60, # Used for locking/sharing the connection
keepalive=0,
default_enter=None,
response_return=None,
@@ -877,11 +932,12 @@
self.device_type = device_type
self.ansi_escape_codes = False
self.verbose = verbose
- self.timeout = timeout
self.auth_timeout = auth_timeout
self.banner_timeout = banner_timeout
- self.session_timeout = session_timeout
self.blocking_timeout = blocking_timeout
+ self.conn_timeout = conn_timeout
+ self.session_timeout = session_timeout
+ self.timeout = timeout
self.keepalive = keepalive
self.allow_auto_change = allow_auto_change
self.encoding = encoding
@@ -952,7 +1008,9 @@
# Options for SSH host_keys
self.use_keys = use_keys
- self.key_file = key_file
+ self.key_file = (
+ path.abspath(path.expanduser(key_file)) if key_file else None
+ )
self.pkey = pkey
self.passphrase = passphrase
self.allow_agent = allow_agent
@@ -1342,14 +1400,16 @@
# Search for username pattern / send username
if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
time.sleep(1 * delay_factor)
output = self.read_channel()
return_msg += output
# Search for password pattern / send password
if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
time.sleep(0.5 * delay_factor)
output = self.read_channel()
return_msg += output
@@ -1481,7 +1541,7 @@
"key_filename": self.key_file,
"pkey": self.pkey,
"passphrase": self.passphrase,
- "timeout": self.timeout,
+ "timeout": self.conn_timeout,
"auth_timeout": self.auth_timeout,
"banner_timeout": self.banner_timeout,
"sock": self.sock,
@@ -1538,11 +1598,27 @@
# initiate SSH connection
try:
self.remote_conn_pre.connect(**ssh_connect_params)
- except socket.error:
+ except socket.error as conn_error:
self.paramiko_cleanup()
- msg = "Connection to device timed-out: {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
- )
+ msg = f"""TCP connection to device failed.
+
+Common causes of this problem are:
+1. Incorrect hostname or IP address.
+2. Wrong TCP port.
+3. Intermediate firewall blocking access.
+
+Device settings: {self.device_type} {self.host}:{self.port}
+
+"""
+
+ # Handle DNS failures separately
+ if "Name or service not known" in str(conn_error):
+ msg = (
+ f"DNS failure--the hostname you provided was not resolvable "
+ f"in DNS: {self.host}:{self.port}"
+ )
+
+ msg = msg.lstrip()
raise NetmikoTimeoutException(msg)
except paramiko.ssh_exception.AuthenticationException as auth_err:
self.paramiko_cleanup()
@@ -1741,7 +1817,6 @@
prompt = self.read_channel().strip()
if not prompt:
self.write_channel(self.RETURN)
- # log.debug(f"find_prompt sleep time: {sleep_time}")
time.sleep(sleep_time)
if sleep_time <= 3:
# Double the sleep_time when it is small
@@ -2438,8 +2513,6 @@
:param string_buffer: The string to be processed to remove ANSI escape codes
:type string_buffer: str
""" # noqa
- log.debug("In strip_ansi_escape_codes")
- log.debug(f"repr = {repr(string_buffer)}")
code_position_cursor = chr(27) + r"\[\d+;\d+H"
code_show_cursor = chr(27) + r"\[\?25h"
@@ -2448,19 +2521,19 @@
code_erase_line = chr(27) + r"\[2K"
code_erase_start_line = chr(27) + r"\[K"
code_enable_scroll = chr(27) + r"\[\d+;\d+r"
- code_form_feed = chr(27) + r"\[1L"
+ code_insert_line = chr(27) + r"\[(\d+)L"
code_carriage_return = chr(27) + r"\[1M"
code_disable_line_wrapping = chr(27) + r"\[\?7l"
code_reset_mode_screen_options = chr(27) + r"\[\?\d+l"
code_reset_graphics_mode = chr(27) + r"\[00m"
code_erase_display = chr(27) + r"\[2J"
+ code_erase_display_0 = chr(27) + r"\[J"
code_graphics_mode = chr(27) + r"\[\d\d;\d\dm"
code_graphics_mode2 = chr(27) + r"\[\d\d;\d\d;\d\dm"
code_graphics_mode3 = chr(27) + r"\[(3|4)\dm"
code_graphics_mode4 = chr(27) + r"\[(9|10)[0-7]m"
code_get_cursor_position = chr(27) + r"\[6n"
code_cursor_position = chr(27) + r"\[m"
- code_erase_display = chr(27) + r"\[J"
code_attrs_off = chr(27) + r"\[0m"
code_reverse = chr(27) + r"\[7m"
code_cursor_left = chr(27) + r"\[\d+D"
@@ -2471,7 +2544,6 @@
code_erase_line,
code_enable_scroll,
code_erase_start_line,
- code_form_feed,
code_carriage_return,
code_disable_line_wrapping,
code_erase_line_end,
@@ -2485,6 +2557,7 @@
code_get_cursor_position,
code_cursor_position,
code_erase_display,
+ code_erase_display_0,
code_attrs_off,
code_reverse,
code_cursor_left,
@@ -2497,9 +2570,12 @@
# CODE_NEXT_LINE must substitute with return
output = re.sub(code_next_line, self.RETURN, output)
- log.debug("Stripping ANSI escape codes")
- log.debug(f"new_output = {output}")
- log.debug(f"repr = {repr(output)}")
+ # Aruba and ProCurve switches can use code_insert_line for <enter>
+ insert_line_match = re.search(code_insert_line, output)
+ if insert_line_match:
+ # Substitute each insert_line with a new <enter>
+ count = int(insert_line_match.group(1))
+ output = re.sub(code_insert_line, count * self.RETURN, output)
return output
@@ -2541,9 +2617,9 @@
def open_session_log(self, filename, mode="write"):
"""Open the session_log file."""
if mode == "append":
- self.session_log = open(filename, mode="a")
+ self.session_log = open(filename, mode="a", encoding=self.encoding)
else:
- self.session_log = open(filename, mode="w")
+ self.session_log = open(filename, mode="w", encoding=self.encoding)
self._session_log_close = True
def close_session_log(self):
@@ -2861,62 +2937,78 @@ Methods
:type height: int
Source code
-def establish_connection(self, width=511, height=1000):
- """Establish SSH connection to the network device
+ def establish_connection(self, width=511, height=1000):
+ """Establish SSH connection to the network device
- Timeout will generate a NetmikoTimeoutException
- Authentication failure will generate a NetmikoAuthenticationException
+ Timeout will generate a NetmikoTimeoutException
+ Authentication failure will generate a NetmikoAuthenticationException
- :param width: Specified width of the VT100 terminal window (default: 511)
- :type width: int
+ :param width: Specified width of the VT100 terminal window (default: 511)
+ :type width: int
- :param height: Specified height of the VT100 terminal window (default: 1000)
- :type height: int
- """
- if self.protocol == "telnet":
- self.remote_conn = telnetlib.Telnet(
- self.host, port=self.port, timeout=self.timeout
- )
- self.telnet_login()
- elif self.protocol == "serial":
- self.remote_conn = serial.Serial(**self.serial_settings)
- self.serial_login()
- elif self.protocol == "ssh":
- ssh_connect_params = self._connect_params_dict()
- self.remote_conn_pre = self._build_ssh_client()
-
- # initiate SSH connection
- try:
- self.remote_conn_pre.connect(**ssh_connect_params)
- except socket.error:
- self.paramiko_cleanup()
- msg = "Connection to device timed-out: {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
- )
- raise NetmikoTimeoutException(msg)
- except paramiko.ssh_exception.AuthenticationException as auth_err:
- self.paramiko_cleanup()
- msg = "Authentication failure: unable to connect {device_type} {ip}:{port}".format(
- device_type=self.device_type, ip=self.host, port=self.port
+ :param height: Specified height of the VT100 terminal window (default: 1000)
+ :type height: int
+ """
+ if self.protocol == "telnet":
+ self.remote_conn = telnetlib.Telnet(
+ self.host, port=self.port, timeout=self.timeout
)
- msg += self.RETURN + str(auth_err)
- raise NetmikoAuthenticationException(msg)
+ self.telnet_login()
+ elif self.protocol == "serial":
+ self.remote_conn = serial.Serial(**self.serial_settings)
+ self.serial_login()
+ elif self.protocol == "ssh":
+ ssh_connect_params = self._connect_params_dict()
+ self.remote_conn_pre = self._build_ssh_client()
- if self.verbose:
- print(f"SSH connection established to {self.host}:{self.port}")
+ # initiate SSH connection
+ try:
+ self.remote_conn_pre.connect(**ssh_connect_params)
+ except socket.error as conn_error:
+ self.paramiko_cleanup()
+ msg = f"""TCP connection to device failed.
- # Use invoke_shell to establish an 'interactive session'
- self.remote_conn = self.remote_conn_pre.invoke_shell(
- term="vt100", width=width, height=height
- )
+Common causes of this problem are:
+1. Incorrect hostname or IP address.
+2. Wrong TCP port.
+3. Intermediate firewall blocking access.
+
+Device settings: {self.device_type} {self.host}:{self.port}
+
+"""
+
+ # Handle DNS failures separately
+ if "Name or service not known" in str(conn_error):
+ msg = (
+ f"DNS failure--the hostname you provided was not resolvable "
+ f"in DNS: {self.host}:{self.port}"
+ )
- self.remote_conn.settimeout(self.blocking_timeout)
- if self.keepalive:
- self.remote_conn.transport.set_keepalive(self.keepalive)
- self.special_login_handler()
- if self.verbose:
- print("Interactive SSH session established")
- return ""
+ msg = msg.lstrip()
+ raise NetmikoTimeoutException(msg)
+ except paramiko.ssh_exception.AuthenticationException as auth_err:
+ self.paramiko_cleanup()
+ msg = "Authentication failure: unable to connect {device_type} {ip}:{port}".format(
+ device_type=self.device_type, ip=self.host, port=self.port
+ )
+ msg += self.RETURN + str(auth_err)
+ raise NetmikoAuthenticationException(msg)
+
+ if self.verbose:
+ print(f"SSH connection established to {self.host}:{self.port}")
+
+ # Use invoke_shell to establish an 'interactive session'
+ self.remote_conn = self.remote_conn_pre.invoke_shell(
+ term="vt100", width=width, height=height
+ )
+
+ self.remote_conn.settimeout(self.blocking_timeout)
+ if self.keepalive:
+ self.remote_conn.transport.set_keepalive(self.keepalive)
+ self.special_login_handler()
+ if self.verbose:
+ print("Interactive SSH session established")
+ return ""
@@ -3010,7 +3102,6 @@ Methods
prompt = self.read_channel().strip()
if not prompt:
self.write_channel(self.RETURN)
- # log.debug(f"find_prompt sleep time: {sleep_time}")
time.sleep(sleep_time)
if sleep_time <= 3:
# Double the sleep_time when it is small
@@ -3131,9 +3222,9 @@ Methods
def open_session_log(self, filename, mode="write"):
"""Open the session_log file."""
if mode == "append":
- self.session_log = open(filename, mode="a")
+ self.session_log = open(filename, mode="a", encoding=self.encoding)
else:
- self.session_log = open(filename, mode="w")
+ self.session_log = open(filename, mode="w", encoding=self.encoding)
self._session_log_close = True
@@ -4033,8 +4124,6 @@ Methods
:param string_buffer: The string to be processed to remove ANSI escape codes
:type string_buffer: str
""" # noqa
- log.debug("In strip_ansi_escape_codes")
- log.debug(f"repr = {repr(string_buffer)}")
code_position_cursor = chr(27) + r"\[\d+;\d+H"
code_show_cursor = chr(27) + r"\[\?25h"
@@ -4043,19 +4132,19 @@ Methods
code_erase_line = chr(27) + r"\[2K"
code_erase_start_line = chr(27) + r"\[K"
code_enable_scroll = chr(27) + r"\[\d+;\d+r"
- code_form_feed = chr(27) + r"\[1L"
+ code_insert_line = chr(27) + r"\[(\d+)L"
code_carriage_return = chr(27) + r"\[1M"
code_disable_line_wrapping = chr(27) + r"\[\?7l"
code_reset_mode_screen_options = chr(27) + r"\[\?\d+l"
code_reset_graphics_mode = chr(27) + r"\[00m"
code_erase_display = chr(27) + r"\[2J"
+ code_erase_display_0 = chr(27) + r"\[J"
code_graphics_mode = chr(27) + r"\[\d\d;\d\dm"
code_graphics_mode2 = chr(27) + r"\[\d\d;\d\d;\d\dm"
code_graphics_mode3 = chr(27) + r"\[(3|4)\dm"
code_graphics_mode4 = chr(27) + r"\[(9|10)[0-7]m"
code_get_cursor_position = chr(27) + r"\[6n"
code_cursor_position = chr(27) + r"\[m"
- code_erase_display = chr(27) + r"\[J"
code_attrs_off = chr(27) + r"\[0m"
code_reverse = chr(27) + r"\[7m"
code_cursor_left = chr(27) + r"\[\d+D"
@@ -4066,7 +4155,6 @@ Methods
code_erase_line,
code_enable_scroll,
code_erase_start_line,
- code_form_feed,
code_carriage_return,
code_disable_line_wrapping,
code_erase_line_end,
@@ -4080,6 +4168,7 @@ Methods
code_get_cursor_position,
code_cursor_position,
code_erase_display,
+ code_erase_display_0,
code_attrs_off,
code_reverse,
code_cursor_left,
@@ -4092,9 +4181,12 @@ Methods
# CODE_NEXT_LINE must substitute with return
output = re.sub(code_next_line, self.RETURN, output)
- log.debug("Stripping ANSI escape codes")
- log.debug(f"new_output = {output}")
- log.debug(f"repr = {repr(output)}")
+ # Aruba and ProCurve switches can use code_insert_line for <enter>
+ insert_line_match = re.search(code_insert_line, output)
+ if insert_line_match:
+ # Substitute each insert_line with a new <enter>
+ count = int(insert_line_match.group(1))
+ output = re.sub(code_insert_line, count * self.RETURN, output)
return output
@@ -4220,14 +4312,16 @@ Methods
# Search for username pattern / send username
if re.search(username_pattern, output, flags=re.I):
- self.write_channel(self.username + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.username + "\r")
time.sleep(1 * delay_factor)
output = self.read_channel()
return_msg += output
# Search for password pattern / send password
if re.search(pwd_pattern, output, flags=re.I):
- self.write_channel(self.password + self.TELNET_RETURN)
+ # Sometimes username/password must be terminated with "\r" and not "\r\n"
+ self.write_channel(self.password + "\r")
time.sleep(0.5 * delay_factor)
output = self.read_channel()
return_msg += output
@@ -4292,7 +4386,7 @@ Methods
class InLineTransfer
-( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)
+( ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)
Use TCL on Cisco IOS to directly transfer file.
@@ -4310,13 +4404,24 @@ Methods
direction="put",
source_config=None,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
):
+
if source_file and source_config:
msg = "Invalid call to InLineTransfer both source_file and source_config specified."
raise ValueError(msg)
if direction != "put":
raise ValueError("Only put operation supported by InLineTransfer.")
+ if progress is not None or progress4 is not None:
+ raise NotImplementedError(
+ "Progress bar is not supported on inline transfers."
+ )
+ else:
+ self.progress = progress
+ self.progress4 = progress4
+
self.ssh_ctl_chan = ssh_conn
if source_file:
self.source_file = source_file
@@ -4616,7 +4721,7 @@ Ancestors
class SCPConn
-( ssh_conn, socket_timeout=10.0)
+( ssh_conn, socket_timeout=10.0, progress=None, progress4=None)
Establish a secure copy channel to the remote network device.
@@ -4630,9 +4735,11 @@ Ancestors
Must close the SCP connection to get the file to write to the remote filesystem
"""
- def __init__(self, ssh_conn, socket_timeout=10.0):
+ def __init__(self, ssh_conn, socket_timeout=10.0, progress=None, progress4=None):
self.ssh_ctl_chan = ssh_conn
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
self.establish_scp_conn()
def establish_scp_conn(self):
@@ -4641,7 +4748,10 @@ Ancestors
self.scp_conn = self.ssh_ctl_chan._build_ssh_client()
self.scp_conn.connect(**ssh_connect_params)
self.scp_client = scp.SCPClient(
- self.scp_conn.get_transport(), socket_timeout=self.socket_timeout
+ self.scp_conn.get_transport(),
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
)
def scp_transfer_file(self, source_file, dest_file):
@@ -4687,7 +4797,10 @@ Methods
self.scp_conn = self.ssh_ctl_chan._build_ssh_client()
self.scp_conn.connect(**ssh_connect_params)
self.scp_client = scp.SCPClient(
- self.scp_conn.get_transport(), socket_timeout=self.socket_timeout
+ self.scp_conn.get_transport(),
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
)
@@ -5063,6 +5176,7 @@ Index
netmiko.pluribus
netmiko.quanta
netmiko.rad
+netmiko.raisecom
netmiko.ruckus
netmiko.ruijie
netmiko.scp_functions
@@ -5087,6 +5201,7 @@ Index
FileTransfer
Netmiko
file_transfer
+progress_bar
redispatch
ssh_dispatcher
diff --git a/docs/netmiko/juniper/index.html b/docs/netmiko/juniper/index.html
index 13f77be8b..c6d600cbc 100644
--- a/docs/netmiko/juniper/index.html
+++ b/docs/netmiko/juniper/index.html
@@ -131,7 +131,7 @@ Inherited members
Implement methods for interacting with Juniper Networks devices.
@@ -284,7 +284,7 @@ Inherited members
class JuniperScreenOsSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with Juniper ScreenOS devices.
@@ -826,7 +826,7 @@ Inherited members
check_config_mode
check_enable_mode
-cleanup
+cleanup
clear_buffer
close_session_log
commit
diff --git a/docs/netmiko/juniper/juniper.html b/docs/netmiko/juniper/juniper.html
index 0322a3dc7..9ea1fb273 100644
--- a/docs/netmiko/juniper/juniper.html
+++ b/docs/netmiko/juniper/juniper.html
@@ -252,6 +252,18 @@ Module netmiko.juniper.juniper
return self.RESPONSE_RETURN.join(response_list[:-1])
return a_string
+ def cleanup(self, command="exit"):
+ """Gracefully exit the SSH session."""
+ try:
+ # The pattern="" forces use of send_command_timing
+ if self.check_config_mode(pattern=""):
+ self.exit_config_mode()
+ except Exception:
+ pass
+ # Always try to send final 'exit' (command)
+ self._session_log_fin = True
+ self.write_channel(command + self.RETURN)
+
class JuniperSSH(JuniperBase):
pass
@@ -320,7 +332,7 @@
class JuniperBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with Juniper Networks devices.
@@ -680,7 +692,19 @@
for pattern in strings_to_strip:
if re.search(pattern, last_line):
return self.RESPONSE_RETURN.join(response_list[:-1])
- return a_string
+ return a_string
+
+ def cleanup(self, command="exit"):
+ """Gracefully exit the SSH session."""
+ try:
+ # The pattern="" forces use of send_command_timing
+ if self.check_config_mode(pattern=""):
+ self.exit_config_mode()
+ except Exception:
+ pass
+ # Always try to send final 'exit' (command)
+ self._session_log_fin = True
+ self.write_channel(command + self.RETURN)
Ancestors
@@ -717,6 +741,26 @@ Methods
pass
+
+def cleanup (self, command='exit')
+
+
+Gracefully exit the SSH session.
+
+Source code
+def cleanup(self, command="exit"):
+ """Gracefully exit the SSH session."""
+ try:
+ # The pattern="" forces use of send_command_timing
+ if self.check_config_mode(pattern=""):
+ self.exit_config_mode()
+ except Exception:
+ pass
+ # Always try to send final 'exit' (command)
+ self._session_log_fin = True
+ self.write_channel(command + self.RETURN)
+
+
def commit (self, confirm=False, confirm_delay=None, check=False, comment='', and_quit=False, delay_factor=1)
@@ -1000,7 +1044,6 @@ Inherited members
Implement methods for interacting with Juniper Networks devices.
@@ -1271,7 +1314,7 @@ Inherited members
diff --git a/docs/netmiko/nokia/nokia_sros_ssh.html b/docs/netmiko/nokia/nokia_sros_ssh.html
index 4c61176f8..ac1637511 100644
--- a/docs/netmiko/nokia/nokia_sros_ssh.html
+++ b/docs/netmiko/nokia/nokia_sros_ssh.html
@@ -136,8 +136,7 @@ Module netmiko.nokia.nokia_sros_ssh
def save_config(self, *args, **kwargs):
"""Persist configuration to cflash for Nokia SR OS"""
- output = self.send_command(command_string="/admin save")
- return output
+ return self.send_command(command_string="/admin save", expect_string=r"#")
def send_config_set(self, config_commands=None, exit_config_mode=None, **kwargs):
"""Model driven CLI requires you not exit from configuration mode."""
@@ -505,7 +504,7 @@ Inherited members
class NokiaSrosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with Nokia SR OS devices.
@@ -751,8 +750,7 @@ Inherited members
def save_config(self, *args, **kwargs):
"""Persist configuration to cflash for Nokia SR OS"""
- output = self.send_command(command_string="/admin save")
- return output
+ return self.send_command(command_string="/admin save", expect_string=r"#")
def send_config_set(self, config_commands=None, exit_config_mode=None, **kwargs):
"""Model driven CLI requires you not exit from configuration mode."""
@@ -982,8 +980,7 @@ Methods
Source code
def save_config(self, *args, **kwargs):
"""Persist configuration to cflash for Nokia SR OS"""
- output = self.send_command(command_string="/admin save")
- return output
+ return self.send_command(command_string="/admin save", expect_string=r"#")
diff --git a/docs/netmiko/ovs/index.html b/docs/netmiko/ovs/index.html
index f9cc26d63..73bac68bd 100644
--- a/docs/netmiko/ovs/index.html
+++ b/docs/netmiko/ovs/index.html
@@ -45,7 +45,7 @@
class OvsLinuxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/ovs/ovs_linux_ssh.html b/docs/netmiko/ovs/ovs_linux_ssh.html
index 785a3864d..60bf21eea 100644
--- a/docs/netmiko/ovs/ovs_linux_ssh.html
+++ b/docs/netmiko/ovs/ovs_linux_ssh.html
@@ -40,7 +40,7 @@
class OvsLinuxSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/paloalto/index.html b/docs/netmiko/paloalto/index.html
index dec4b184f..b2e60fdda 100644
--- a/docs/netmiko/paloalto/index.html
+++ b/docs/netmiko/paloalto/index.html
@@ -45,7 +45,7 @@
class PaloAltoPanosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with PaloAlto devices.
@@ -243,7 +243,7 @@ Inherited members
class PaloAltoPanosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with PaloAlto devices.
diff --git a/docs/netmiko/paloalto/paloalto_panos.html b/docs/netmiko/paloalto/paloalto_panos.html
index be6bc6a7c..4954f1d95 100644
--- a/docs/netmiko/paloalto/paloalto_panos.html
+++ b/docs/netmiko/paloalto/paloalto_panos.html
@@ -215,7 +215,7 @@
class PaloAltoPanosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with PaloAlto devices.
@@ -856,7 +856,7 @@ Inherited members
class PaloAltoPanosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with PaloAlto devices.
@@ -1054,7 +1054,7 @@ Inherited members
class PaloAltoPanosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with PaloAlto devices.
diff --git a/docs/netmiko/quanta/index.html b/docs/netmiko/quanta/index.html
index 2be4e0719..f8bd86a9e 100644
--- a/docs/netmiko/quanta/index.html
+++ b/docs/netmiko/quanta/index.html
@@ -45,7 +45,7 @@
class QuantaMeshSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/quanta/quanta_mesh_ssh.html b/docs/netmiko/quanta/quanta_mesh_ssh.html
index dcde1e46e..f5f38ec30 100644
--- a/docs/netmiko/quanta/quanta_mesh_ssh.html
+++ b/docs/netmiko/quanta/quanta_mesh_ssh.html
@@ -57,7 +57,7 @@
class QuantaMeshSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/rad/index.html b/docs/netmiko/rad/index.html
index 0d08479f4..886706144 100644
--- a/docs/netmiko/rad/index.html
+++ b/docs/netmiko/rad/index.html
@@ -245,7 +245,7 @@ Inherited members
class RadETXTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
RAD ETX Telnet Support.
diff --git a/docs/netmiko/rad/rad_etx.html b/docs/netmiko/rad/rad_etx.html
index 2f5c53cbe..7e8cb946d 100644
--- a/docs/netmiko/rad/rad_etx.html
+++ b/docs/netmiko/rad/rad_etx.html
@@ -121,7 +121,7 @@
class RadETXBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
RAD ETX Support, Tested on RAD 203AX, 205A and 220A.
@@ -663,7 +663,7 @@ Inherited members
class RadETXTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
RAD ETX Telnet Support.
diff --git a/docs/netmiko/raisecom/index.html b/docs/netmiko/raisecom/index.html
new file mode 100644
index 000000000..8ea4ed9e2
--- /dev/null
+++ b/docs/netmiko/raisecom/index.html
@@ -0,0 +1,622 @@
+
+
+
+
+
+
+netmiko.raisecom API documentation
+
+
+
+
+
+
+
+
+
+
+
+
+Module netmiko.raisecom
+
+
+
+Source code
+from netmiko.raisecom.raisecom_roap import RaisecomRoapSSH
+from netmiko.raisecom.raisecom_roap import RaisecomRoapTelnet
+
+__all__ = ["RaisecomRoapSSH", "RaisecomRoapTelnet"]
+
+
+
+
+
+
+
+
+
+class RaisecomRoapSSH
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+
+
+Base Class for cisco-like behavior.
+ Initialize attributes for establishing connection to target device.
+
+ :param ip: IP address of target device. Not required if `host` is
+ provided.
+ :type ip: str
+
+ :param host: Hostname of target device. Not required if `ip` is
+ provided.
+ :type host: str
+
+ :param username: Username to authenticate against target device if
+ required.
+ :type username: str
+
+ :param password: Password to authenticate against target device if
+ required.
+ :type password: str
+
+ :param secret: The enable password if target device requires one.
+ :type secret: str
+
+ :param port: The destination port used to connect to the target
+ device.
+ :type port: int or None
+
+ :param device_type: Class selection based on device type.
+ :type device_type: str
+
+ :param verbose: Enable additional messages to standard output.
+ :type verbose: bool
+
+ :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
+ :type global_delay_factor: int
+
+ :param use_keys: Connect to target device using SSH keys.
+ :type use_keys: bool
+
+ :param key_file: Filename path of the SSH key file to use.
+ :type key_file: str
+
+ :param pkey: SSH key object to use.
+ :type pkey: paramiko.PKey
+
+ :param passphrase: Passphrase to use for encrypted key; password will be used for key
+ decryption if not specified.
+ :type passphrase: str
+
+ :param allow_agent: Enable use of SSH key-agent.
+ :type allow_agent: bool
+
+ :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
+ means unknown SSH host keys will be accepted).
+ :type ssh_strict: bool
+
+ :param system_host_keys: Load host keys from the users known_hosts file.
+ :type system_host_keys: bool
+ :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ alt_key_file.
+ :type alt_host_keys: bool
+
+ :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
+ :type alt_key_file: str
+
+ :param ssh_config_file: File name of OpenSSH configuration file.
+ :type ssh_config_file: str
+
+ :param timeout: Connection timeout.
+ :type timeout: float
+
+ :param session_timeout: Set a timeout for parallel requests.
+ :type session_timeout: float
+
+ :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
+ :type auth_timeout: float
+
+ :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
+ :type banner_timeout: float
+
+ :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
+ Currently defaults to 0, for backwards compatibility (it will not attempt
+ to keep the connection alive).
+ :type keepalive: int
+
+ :param default_enter: Character(s) to send to correspond to enter key (default:
+
+).
+:type default_enter: str
+ :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+
+)
+:type response_return: str
+ :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
+ to select smallest of global and specific. Sets default global_delay_factor to .1
+ (default: False)
+ :type fast_cli: boolean
+
+ :param session_log: File path or BufferedIOBase subclass object to write the session log to.
+ :type session_log: str
+
+ :param session_log_record_writes: The session log generally only records channel reads due
+ to eliminate command duplication due to command echo. You can enable this if you
+ want to record both channel reads and channel writes in the log (default: False).
+ :type session_log_record_writes: boolean
+
+ :param session_log_file_mode: "write" or "append" for session_log file mode
+ (default: "write")
+ :type session_log_file_mode: str
+
+ :param allow_auto_change: Allow automatic configuration changes for terminal settings.
+ (default: False)
+ :type allow_auto_change: bool
+
+ :param encoding: Encoding to be used when writing bytes to the output channel.
+ (default: ascii)
+ :type encoding: str
+
+ :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ communication to the target host (default: None).
+ :type sock: socket
+
+ :param global_cmd_verify: Control whether command echo verification is enabled or disabled
+ (default: None). Global attribute takes precedence over function `cmd_verify`
+ argument. Value of `None` indicates to use function `cmd_verify` argument.
+ :type global_cmd_verify: bool|None
+
+ :param auto_connect: Control whether Netmiko automatically establishes the connection as
+ part of the object creation (default: True).
+ :type auto_connect: bool
+
+
+Source code
+class RaisecomRoapSSH(RaisecomRoapBase):
+ def special_login_handler(self, delay_factor=1):
+ """
+ Raisecom presents with the following on login (in certain OS versions)
+ Login: user
+ Password:****
+ """
+ delay_factor = self.select_delay_factor(delay_factor)
+ i = 0
+ time.sleep(delay_factor * 0.5)
+ output = ""
+ while i <= 12:
+ output = self.read_channel()
+ if output:
+ if "Login:" in output:
+ self.write_channel(self.username + self.RETURN)
+ elif "Password:" in output:
+ self.write_channel(self.password + self.RETURN)
+ break
+ time.sleep(delay_factor * 1)
+ else:
+ self.write_channel(self.RETURN)
+ time.sleep(delay_factor * 1.5)
+ i += 1
+
+Ancestors
+
+Methods
+
+
+def special_login_handler (self, delay_factor=1)
+
+
+Raisecom presents with the following on login (in certain OS versions)
+Login: user
+Password:****
+
+Source code
+def special_login_handler(self, delay_factor=1):
+ """
+ Raisecom presents with the following on login (in certain OS versions)
+ Login: user
+ Password:****
+ """
+ delay_factor = self.select_delay_factor(delay_factor)
+ i = 0
+ time.sleep(delay_factor * 0.5)
+ output = ""
+ while i <= 12:
+ output = self.read_channel()
+ if output:
+ if "Login:" in output:
+ self.write_channel(self.username + self.RETURN)
+ elif "Password:" in output:
+ self.write_channel(self.password + self.RETURN)
+ break
+ time.sleep(delay_factor * 1)
+ else:
+ self.write_channel(self.RETURN)
+ time.sleep(delay_factor * 1.5)
+ i += 1
+
+
+
+Inherited members
+
+
+
+class RaisecomRoapTelnet
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+
+
+Base Class for cisco-like behavior.
+ Initialize attributes for establishing connection to target device.
+
+ :param ip: IP address of target device. Not required if `host` is
+ provided.
+ :type ip: str
+
+ :param host: Hostname of target device. Not required if `ip` is
+ provided.
+ :type host: str
+
+ :param username: Username to authenticate against target device if
+ required.
+ :type username: str
+
+ :param password: Password to authenticate against target device if
+ required.
+ :type password: str
+
+ :param secret: The enable password if target device requires one.
+ :type secret: str
+
+ :param port: The destination port used to connect to the target
+ device.
+ :type port: int or None
+
+ :param device_type: Class selection based on device type.
+ :type device_type: str
+
+ :param verbose: Enable additional messages to standard output.
+ :type verbose: bool
+
+ :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
+ :type global_delay_factor: int
+
+ :param use_keys: Connect to target device using SSH keys.
+ :type use_keys: bool
+
+ :param key_file: Filename path of the SSH key file to use.
+ :type key_file: str
+
+ :param pkey: SSH key object to use.
+ :type pkey: paramiko.PKey
+
+ :param passphrase: Passphrase to use for encrypted key; password will be used for key
+ decryption if not specified.
+ :type passphrase: str
+
+ :param allow_agent: Enable use of SSH key-agent.
+ :type allow_agent: bool
+
+ :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
+ means unknown SSH host keys will be accepted).
+ :type ssh_strict: bool
+
+ :param system_host_keys: Load host keys from the users known_hosts file.
+ :type system_host_keys: bool
+ :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ alt_key_file.
+ :type alt_host_keys: bool
+
+ :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
+ :type alt_key_file: str
+
+ :param ssh_config_file: File name of OpenSSH configuration file.
+ :type ssh_config_file: str
+
+ :param timeout: Connection timeout.
+ :type timeout: float
+
+ :param session_timeout: Set a timeout for parallel requests.
+ :type session_timeout: float
+
+ :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
+ :type auth_timeout: float
+
+ :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
+ :type banner_timeout: float
+
+ :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
+ Currently defaults to 0, for backwards compatibility (it will not attempt
+ to keep the connection alive).
+ :type keepalive: int
+
+ :param default_enter: Character(s) to send to correspond to enter key (default:
+
+).
+:type default_enter: str
+ :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+
+)
+:type response_return: str
+ :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
+ to select smallest of global and specific. Sets default global_delay_factor to .1
+ (default: False)
+ :type fast_cli: boolean
+
+ :param session_log: File path or BufferedIOBase subclass object to write the session log to.
+ :type session_log: str
+
+ :param session_log_record_writes: The session log generally only records channel reads due
+ to eliminate command duplication due to command echo. You can enable this if you
+ want to record both channel reads and channel writes in the log (default: False).
+ :type session_log_record_writes: boolean
+
+ :param session_log_file_mode: "write" or "append" for session_log file mode
+ (default: "write")
+ :type session_log_file_mode: str
+
+ :param allow_auto_change: Allow automatic configuration changes for terminal settings.
+ (default: False)
+ :type allow_auto_change: bool
+
+ :param encoding: Encoding to be used when writing bytes to the output channel.
+ (default: ascii)
+ :type encoding: str
+
+ :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ communication to the target host (default: None).
+ :type sock: socket
+
+ :param global_cmd_verify: Control whether command echo verification is enabled or disabled
+ (default: None). Global attribute takes precedence over function `cmd_verify`
+ argument. Value of `None` indicates to use function `cmd_verify` argument.
+ :type global_cmd_verify: bool|None
+
+ :param auto_connect: Control whether Netmiko automatically establishes the connection as
+ part of the object creation (default: True).
+ :type auto_connect: bool
+
+
+Source code
+class RaisecomRoapTelnet(RaisecomRoapBase):
+ @staticmethod
+ def _process_option(telnet_sock, cmd, opt):
+ """
+ enable ECHO, SGA, set window size to [500, 50]
+ """
+ if cmd == WILL:
+ if opt in [ECHO, SGA]:
+ # reply DO ECHO / DO SGA
+ telnet_sock.sendall(IAC + DO + opt)
+ else:
+ telnet_sock.sendall(IAC + DONT + opt)
+ elif cmd == DO:
+ if opt == NAWS:
+ # negotiate about window size
+ telnet_sock.sendall(IAC + WILL + opt)
+ # Width:500, Weight:50
+ telnet_sock.sendall(IAC + SB + NAWS + b"\x01\xf4\x00\x32" + IAC + SE)
+ else:
+ telnet_sock.sendall(IAC + WONT + opt)
+
+ def telnet_login(
+ self,
+ pri_prompt_terminator=r"#\s*$",
+ alt_prompt_terminator=r">\s*$",
+ username_pattern=r"(Login|Username)",
+ pwd_pattern=r"Password",
+ delay_factor=1,
+ max_loops=20,
+ ):
+
+ # set callback function to handle telnet options.
+ self.remote_conn.set_option_negotiation_callback(self._process_option)
+ delay_factor = self.select_delay_factor(delay_factor)
+ time.sleep(1 * delay_factor)
+
+ output = ""
+ return_msg = ""
+ i = 1
+ while i <= max_loops:
+ try:
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ self.write_channel(self.username + self.TELNET_RETURN)
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ self.write_channel(self.password + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Check if proper data received
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ time.sleep(0.5 * delay_factor)
+ i += 1
+ except EOFError:
+ self.remote_conn.close()
+ msg = f"Login failed: {self.host}"
+ raise NetmikoAuthenticationException(msg)
+
+ # Last try to see if we already logged in
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ msg = f"Login failed: {self.host}"
+ self.remote_conn.close()
+ raise NetmikoAuthenticationException(msg)
+
+Ancestors
+
+Inherited members
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/netmiko/raisecom/raisecom_roap.html b/docs/netmiko/raisecom/raisecom_roap.html
new file mode 100644
index 000000000..31fcfddcf
--- /dev/null
+++ b/docs/netmiko/raisecom/raisecom_roap.html
@@ -0,0 +1,1018 @@
+
+
+
+
+
+
+netmiko.raisecom.raisecom_roap API documentation
+
+
+
+
+
+
+
+
+
+
+
+
+Module netmiko.raisecom.raisecom_roap
+
+
+
+Source code
+from netmiko.cisco_base_connection import CiscoBaseConnection
+import re
+import time
+from telnetlib import IAC, DO, DONT, WILL, WONT, SB, SE, ECHO, SGA, NAWS
+from netmiko.ssh_exception import NetmikoAuthenticationException
+
+
+class RaisecomRoapBase(CiscoBaseConnection):
+ def session_preparation(self):
+ """Prepare the session after the connection has been established."""
+ self._test_channel_read(pattern=r"[>#]")
+ self.set_base_prompt()
+ self.enable()
+ self.disable_paging("terminal page-break disable")
+ # Clear the read buffer
+ time.sleep(0.3 * self.global_delay_factor)
+ self.clear_buffer()
+
+ def check_config_mode(self, check_string=")#", pattern="#"):
+ """
+ Checks if the device is in configuration mode or not.
+ """
+ return super().check_config_mode(check_string=check_string, pattern=pattern)
+
+ def save_config(
+ self, cmd="write startup-config", confirm=False, confirm_response=""
+ ):
+ """Saves Config."""
+ self.exit_config_mode()
+ self.enable()
+ return super().save_config(
+ cmd=cmd, confirm=confirm, confirm_response=confirm_response
+ )
+
+
+class RaisecomRoapSSH(RaisecomRoapBase):
+ def special_login_handler(self, delay_factor=1):
+ """
+ Raisecom presents with the following on login (in certain OS versions)
+ Login: user
+ Password:****
+ """
+ delay_factor = self.select_delay_factor(delay_factor)
+ i = 0
+ time.sleep(delay_factor * 0.5)
+ output = ""
+ while i <= 12:
+ output = self.read_channel()
+ if output:
+ if "Login:" in output:
+ self.write_channel(self.username + self.RETURN)
+ elif "Password:" in output:
+ self.write_channel(self.password + self.RETURN)
+ break
+ time.sleep(delay_factor * 1)
+ else:
+ self.write_channel(self.RETURN)
+ time.sleep(delay_factor * 1.5)
+ i += 1
+
+
+class RaisecomRoapTelnet(RaisecomRoapBase):
+ @staticmethod
+ def _process_option(telnet_sock, cmd, opt):
+ """
+ enable ECHO, SGA, set window size to [500, 50]
+ """
+ if cmd == WILL:
+ if opt in [ECHO, SGA]:
+ # reply DO ECHO / DO SGA
+ telnet_sock.sendall(IAC + DO + opt)
+ else:
+ telnet_sock.sendall(IAC + DONT + opt)
+ elif cmd == DO:
+ if opt == NAWS:
+ # negotiate about window size
+ telnet_sock.sendall(IAC + WILL + opt)
+ # Width:500, Weight:50
+ telnet_sock.sendall(IAC + SB + NAWS + b"\x01\xf4\x00\x32" + IAC + SE)
+ else:
+ telnet_sock.sendall(IAC + WONT + opt)
+
+ def telnet_login(
+ self,
+ pri_prompt_terminator=r"#\s*$",
+ alt_prompt_terminator=r">\s*$",
+ username_pattern=r"(Login|Username)",
+ pwd_pattern=r"Password",
+ delay_factor=1,
+ max_loops=20,
+ ):
+
+ # set callback function to handle telnet options.
+ self.remote_conn.set_option_negotiation_callback(self._process_option)
+ delay_factor = self.select_delay_factor(delay_factor)
+ time.sleep(1 * delay_factor)
+
+ output = ""
+ return_msg = ""
+ i = 1
+ while i <= max_loops:
+ try:
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ self.write_channel(self.username + self.TELNET_RETURN)
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ self.write_channel(self.password + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Check if proper data received
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ time.sleep(0.5 * delay_factor)
+ i += 1
+ except EOFError:
+ self.remote_conn.close()
+ msg = f"Login failed: {self.host}"
+ raise NetmikoAuthenticationException(msg)
+
+ # Last try to see if we already logged in
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ msg = f"Login failed: {self.host}"
+ self.remote_conn.close()
+ raise NetmikoAuthenticationException(msg)
+
+
+
+
+
+
+
+
+
+class RaisecomRoapBase
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+
+
+Base Class for cisco-like behavior.
+ Initialize attributes for establishing connection to target device.
+
+ :param ip: IP address of target device. Not required if `host` is
+ provided.
+ :type ip: str
+
+ :param host: Hostname of target device. Not required if `ip` is
+ provided.
+ :type host: str
+
+ :param username: Username to authenticate against target device if
+ required.
+ :type username: str
+
+ :param password: Password to authenticate against target device if
+ required.
+ :type password: str
+
+ :param secret: The enable password if target device requires one.
+ :type secret: str
+
+ :param port: The destination port used to connect to the target
+ device.
+ :type port: int or None
+
+ :param device_type: Class selection based on device type.
+ :type device_type: str
+
+ :param verbose: Enable additional messages to standard output.
+ :type verbose: bool
+
+ :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
+ :type global_delay_factor: int
+
+ :param use_keys: Connect to target device using SSH keys.
+ :type use_keys: bool
+
+ :param key_file: Filename path of the SSH key file to use.
+ :type key_file: str
+
+ :param pkey: SSH key object to use.
+ :type pkey: paramiko.PKey
+
+ :param passphrase: Passphrase to use for encrypted key; password will be used for key
+ decryption if not specified.
+ :type passphrase: str
+
+ :param allow_agent: Enable use of SSH key-agent.
+ :type allow_agent: bool
+
+ :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
+ means unknown SSH host keys will be accepted).
+ :type ssh_strict: bool
+
+ :param system_host_keys: Load host keys from the users known_hosts file.
+ :type system_host_keys: bool
+ :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ alt_key_file.
+ :type alt_host_keys: bool
+
+ :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
+ :type alt_key_file: str
+
+ :param ssh_config_file: File name of OpenSSH configuration file.
+ :type ssh_config_file: str
+
+ :param timeout: Connection timeout.
+ :type timeout: float
+
+ :param session_timeout: Set a timeout for parallel requests.
+ :type session_timeout: float
+
+ :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
+ :type auth_timeout: float
+
+ :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
+ :type banner_timeout: float
+
+ :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
+ Currently defaults to 0, for backwards compatibility (it will not attempt
+ to keep the connection alive).
+ :type keepalive: int
+
+ :param default_enter: Character(s) to send to correspond to enter key (default:
+
+).
+:type default_enter: str
+ :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+
+)
+:type response_return: str
+ :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
+ to select smallest of global and specific. Sets default global_delay_factor to .1
+ (default: False)
+ :type fast_cli: boolean
+
+ :param session_log: File path or BufferedIOBase subclass object to write the session log to.
+ :type session_log: str
+
+ :param session_log_record_writes: The session log generally only records channel reads due
+ to eliminate command duplication due to command echo. You can enable this if you
+ want to record both channel reads and channel writes in the log (default: False).
+ :type session_log_record_writes: boolean
+
+ :param session_log_file_mode: "write" or "append" for session_log file mode
+ (default: "write")
+ :type session_log_file_mode: str
+
+ :param allow_auto_change: Allow automatic configuration changes for terminal settings.
+ (default: False)
+ :type allow_auto_change: bool
+
+ :param encoding: Encoding to be used when writing bytes to the output channel.
+ (default: ascii)
+ :type encoding: str
+
+ :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ communication to the target host (default: None).
+ :type sock: socket
+
+ :param global_cmd_verify: Control whether command echo verification is enabled or disabled
+ (default: None). Global attribute takes precedence over function `cmd_verify`
+ argument. Value of `None` indicates to use function `cmd_verify` argument.
+ :type global_cmd_verify: bool|None
+
+ :param auto_connect: Control whether Netmiko automatically establishes the connection as
+ part of the object creation (default: True).
+ :type auto_connect: bool
+
+
+Source code
+class RaisecomRoapBase(CiscoBaseConnection):
+ def session_preparation(self):
+ """Prepare the session after the connection has been established."""
+ self._test_channel_read(pattern=r"[>#]")
+ self.set_base_prompt()
+ self.enable()
+ self.disable_paging("terminal page-break disable")
+ # Clear the read buffer
+ time.sleep(0.3 * self.global_delay_factor)
+ self.clear_buffer()
+
+ def check_config_mode(self, check_string=")#", pattern="#"):
+ """
+ Checks if the device is in configuration mode or not.
+ """
+ return super().check_config_mode(check_string=check_string, pattern=pattern)
+
+ def save_config(
+ self, cmd="write startup-config", confirm=False, confirm_response=""
+ ):
+ """Saves Config."""
+ self.exit_config_mode()
+ self.enable()
+ return super().save_config(
+ cmd=cmd, confirm=confirm, confirm_response=confirm_response
+ )
+
+Ancestors
+
+Subclasses
+
+Methods
+
+
+def check_config_mode (self, check_string=')#', pattern='#')
+
+
+Checks if the device is in configuration mode or not.
+
+Source code
+def check_config_mode(self, check_string=")#", pattern="#"):
+ """
+ Checks if the device is in configuration mode or not.
+ """
+ return super().check_config_mode(check_string=check_string, pattern=pattern)
+
+
+
+def session_preparation (self)
+
+
+Prepare the session after the connection has been established.
+
+Source code
+def session_preparation(self):
+ """Prepare the session after the connection has been established."""
+ self._test_channel_read(pattern=r"[>#]")
+ self.set_base_prompt()
+ self.enable()
+ self.disable_paging("terminal page-break disable")
+ # Clear the read buffer
+ time.sleep(0.3 * self.global_delay_factor)
+ self.clear_buffer()
+
+
+
+Inherited members
+
+
+
+class RaisecomRoapSSH
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+
+
+Base Class for cisco-like behavior.
+ Initialize attributes for establishing connection to target device.
+
+ :param ip: IP address of target device. Not required if `host` is
+ provided.
+ :type ip: str
+
+ :param host: Hostname of target device. Not required if `ip` is
+ provided.
+ :type host: str
+
+ :param username: Username to authenticate against target device if
+ required.
+ :type username: str
+
+ :param password: Password to authenticate against target device if
+ required.
+ :type password: str
+
+ :param secret: The enable password if target device requires one.
+ :type secret: str
+
+ :param port: The destination port used to connect to the target
+ device.
+ :type port: int or None
+
+ :param device_type: Class selection based on device type.
+ :type device_type: str
+
+ :param verbose: Enable additional messages to standard output.
+ :type verbose: bool
+
+ :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
+ :type global_delay_factor: int
+
+ :param use_keys: Connect to target device using SSH keys.
+ :type use_keys: bool
+
+ :param key_file: Filename path of the SSH key file to use.
+ :type key_file: str
+
+ :param pkey: SSH key object to use.
+ :type pkey: paramiko.PKey
+
+ :param passphrase: Passphrase to use for encrypted key; password will be used for key
+ decryption if not specified.
+ :type passphrase: str
+
+ :param allow_agent: Enable use of SSH key-agent.
+ :type allow_agent: bool
+
+ :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
+ means unknown SSH host keys will be accepted).
+ :type ssh_strict: bool
+
+ :param system_host_keys: Load host keys from the users known_hosts file.
+ :type system_host_keys: bool
+ :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ alt_key_file.
+ :type alt_host_keys: bool
+
+ :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
+ :type alt_key_file: str
+
+ :param ssh_config_file: File name of OpenSSH configuration file.
+ :type ssh_config_file: str
+
+ :param timeout: Connection timeout.
+ :type timeout: float
+
+ :param session_timeout: Set a timeout for parallel requests.
+ :type session_timeout: float
+
+ :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
+ :type auth_timeout: float
+
+ :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
+ :type banner_timeout: float
+
+ :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
+ Currently defaults to 0, for backwards compatibility (it will not attempt
+ to keep the connection alive).
+ :type keepalive: int
+
+ :param default_enter: Character(s) to send to correspond to enter key (default:
+
+).
+:type default_enter: str
+ :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+
+)
+:type response_return: str
+ :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
+ to select smallest of global and specific. Sets default global_delay_factor to .1
+ (default: False)
+ :type fast_cli: boolean
+
+ :param session_log: File path or BufferedIOBase subclass object to write the session log to.
+ :type session_log: str
+
+ :param session_log_record_writes: The session log generally only records channel reads due
+ to eliminate command duplication due to command echo. You can enable this if you
+ want to record both channel reads and channel writes in the log (default: False).
+ :type session_log_record_writes: boolean
+
+ :param session_log_file_mode: "write" or "append" for session_log file mode
+ (default: "write")
+ :type session_log_file_mode: str
+
+ :param allow_auto_change: Allow automatic configuration changes for terminal settings.
+ (default: False)
+ :type allow_auto_change: bool
+
+ :param encoding: Encoding to be used when writing bytes to the output channel.
+ (default: ascii)
+ :type encoding: str
+
+ :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ communication to the target host (default: None).
+ :type sock: socket
+
+ :param global_cmd_verify: Control whether command echo verification is enabled or disabled
+ (default: None). Global attribute takes precedence over function `cmd_verify`
+ argument. Value of `None` indicates to use function `cmd_verify` argument.
+ :type global_cmd_verify: bool|None
+
+ :param auto_connect: Control whether Netmiko automatically establishes the connection as
+ part of the object creation (default: True).
+ :type auto_connect: bool
+
+
+Source code
+class RaisecomRoapSSH(RaisecomRoapBase):
+ def special_login_handler(self, delay_factor=1):
+ """
+ Raisecom presents with the following on login (in certain OS versions)
+ Login: user
+ Password:****
+ """
+ delay_factor = self.select_delay_factor(delay_factor)
+ i = 0
+ time.sleep(delay_factor * 0.5)
+ output = ""
+ while i <= 12:
+ output = self.read_channel()
+ if output:
+ if "Login:" in output:
+ self.write_channel(self.username + self.RETURN)
+ elif "Password:" in output:
+ self.write_channel(self.password + self.RETURN)
+ break
+ time.sleep(delay_factor * 1)
+ else:
+ self.write_channel(self.RETURN)
+ time.sleep(delay_factor * 1.5)
+ i += 1
+
+Ancestors
+
+Methods
+
+
+def special_login_handler (self, delay_factor=1)
+
+
+Raisecom presents with the following on login (in certain OS versions)
+Login: user
+Password:****
+
+Source code
+def special_login_handler(self, delay_factor=1):
+ """
+ Raisecom presents with the following on login (in certain OS versions)
+ Login: user
+ Password:****
+ """
+ delay_factor = self.select_delay_factor(delay_factor)
+ i = 0
+ time.sleep(delay_factor * 0.5)
+ output = ""
+ while i <= 12:
+ output = self.read_channel()
+ if output:
+ if "Login:" in output:
+ self.write_channel(self.username + self.RETURN)
+ elif "Password:" in output:
+ self.write_channel(self.password + self.RETURN)
+ break
+ time.sleep(delay_factor * 1)
+ else:
+ self.write_channel(self.RETURN)
+ time.sleep(delay_factor * 1.5)
+ i += 1
+
+
+
+Inherited members
+
+
+
+class RaisecomRoapTelnet
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+
+
+Base Class for cisco-like behavior.
+ Initialize attributes for establishing connection to target device.
+
+ :param ip: IP address of target device. Not required if `host` is
+ provided.
+ :type ip: str
+
+ :param host: Hostname of target device. Not required if `ip` is
+ provided.
+ :type host: str
+
+ :param username: Username to authenticate against target device if
+ required.
+ :type username: str
+
+ :param password: Password to authenticate against target device if
+ required.
+ :type password: str
+
+ :param secret: The enable password if target device requires one.
+ :type secret: str
+
+ :param port: The destination port used to connect to the target
+ device.
+ :type port: int or None
+
+ :param device_type: Class selection based on device type.
+ :type device_type: str
+
+ :param verbose: Enable additional messages to standard output.
+ :type verbose: bool
+
+ :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
+ :type global_delay_factor: int
+
+ :param use_keys: Connect to target device using SSH keys.
+ :type use_keys: bool
+
+ :param key_file: Filename path of the SSH key file to use.
+ :type key_file: str
+
+ :param pkey: SSH key object to use.
+ :type pkey: paramiko.PKey
+
+ :param passphrase: Passphrase to use for encrypted key; password will be used for key
+ decryption if not specified.
+ :type passphrase: str
+
+ :param allow_agent: Enable use of SSH key-agent.
+ :type allow_agent: bool
+
+ :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
+ means unknown SSH host keys will be accepted).
+ :type ssh_strict: bool
+
+ :param system_host_keys: Load host keys from the users known_hosts file.
+ :type system_host_keys: bool
+ :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ alt_key_file.
+ :type alt_host_keys: bool
+
+ :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
+ :type alt_key_file: str
+
+ :param ssh_config_file: File name of OpenSSH configuration file.
+ :type ssh_config_file: str
+
+ :param timeout: Connection timeout.
+ :type timeout: float
+
+ :param session_timeout: Set a timeout for parallel requests.
+ :type session_timeout: float
+
+ :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
+ :type auth_timeout: float
+
+ :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
+ :type banner_timeout: float
+
+ :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
+ Currently defaults to 0, for backwards compatibility (it will not attempt
+ to keep the connection alive).
+ :type keepalive: int
+
+ :param default_enter: Character(s) to send to correspond to enter key (default:
+
+).
+:type default_enter: str
+ :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+
+)
+:type response_return: str
+ :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
+ to select smallest of global and specific. Sets default global_delay_factor to .1
+ (default: False)
+ :type fast_cli: boolean
+
+ :param session_log: File path or BufferedIOBase subclass object to write the session log to.
+ :type session_log: str
+
+ :param session_log_record_writes: The session log generally only records channel reads due
+ to eliminate command duplication due to command echo. You can enable this if you
+ want to record both channel reads and channel writes in the log (default: False).
+ :type session_log_record_writes: boolean
+
+ :param session_log_file_mode: "write" or "append" for session_log file mode
+ (default: "write")
+ :type session_log_file_mode: str
+
+ :param allow_auto_change: Allow automatic configuration changes for terminal settings.
+ (default: False)
+ :type allow_auto_change: bool
+
+ :param encoding: Encoding to be used when writing bytes to the output channel.
+ (default: ascii)
+ :type encoding: str
+
+ :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ communication to the target host (default: None).
+ :type sock: socket
+
+ :param global_cmd_verify: Control whether command echo verification is enabled or disabled
+ (default: None). Global attribute takes precedence over function `cmd_verify`
+ argument. Value of `None` indicates to use function `cmd_verify` argument.
+ :type global_cmd_verify: bool|None
+
+ :param auto_connect: Control whether Netmiko automatically establishes the connection as
+ part of the object creation (default: True).
+ :type auto_connect: bool
+
+
+Source code
+class RaisecomRoapTelnet(RaisecomRoapBase):
+ @staticmethod
+ def _process_option(telnet_sock, cmd, opt):
+ """
+ enable ECHO, SGA, set window size to [500, 50]
+ """
+ if cmd == WILL:
+ if opt in [ECHO, SGA]:
+ # reply DO ECHO / DO SGA
+ telnet_sock.sendall(IAC + DO + opt)
+ else:
+ telnet_sock.sendall(IAC + DONT + opt)
+ elif cmd == DO:
+ if opt == NAWS:
+ # negotiate about window size
+ telnet_sock.sendall(IAC + WILL + opt)
+ # Width:500, Weight:50
+ telnet_sock.sendall(IAC + SB + NAWS + b"\x01\xf4\x00\x32" + IAC + SE)
+ else:
+ telnet_sock.sendall(IAC + WONT + opt)
+
+ def telnet_login(
+ self,
+ pri_prompt_terminator=r"#\s*$",
+ alt_prompt_terminator=r">\s*$",
+ username_pattern=r"(Login|Username)",
+ pwd_pattern=r"Password",
+ delay_factor=1,
+ max_loops=20,
+ ):
+
+ # set callback function to handle telnet options.
+ self.remote_conn.set_option_negotiation_callback(self._process_option)
+ delay_factor = self.select_delay_factor(delay_factor)
+ time.sleep(1 * delay_factor)
+
+ output = ""
+ return_msg = ""
+ i = 1
+ while i <= max_loops:
+ try:
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for username pattern / send username
+ if re.search(username_pattern, output, flags=re.I):
+ self.write_channel(self.username + self.TELNET_RETURN)
+ time.sleep(1 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+
+ # Search for password pattern / send password
+ if re.search(pwd_pattern, output, flags=re.I):
+ self.write_channel(self.password + self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(
+ pri_prompt_terminator, output, flags=re.M
+ ) or re.search(alt_prompt_terminator, output, flags=re.M):
+ return return_msg
+
+ # Check if proper data received
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ time.sleep(0.5 * delay_factor)
+ i += 1
+ except EOFError:
+ self.remote_conn.close()
+ msg = f"Login failed: {self.host}"
+ raise NetmikoAuthenticationException(msg)
+
+ # Last try to see if we already logged in
+ self.write_channel(self.TELNET_RETURN)
+ time.sleep(0.5 * delay_factor)
+ output = self.read_channel()
+ return_msg += output
+ if re.search(pri_prompt_terminator, output, flags=re.M) or re.search(
+ alt_prompt_terminator, output, flags=re.M
+ ):
+ return return_msg
+
+ msg = f"Login failed: {self.host}"
+ self.remote_conn.close()
+ raise NetmikoAuthenticationException(msg)
+
+Ancestors
+
+Inherited members
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/netmiko/ruckus/index.html b/docs/netmiko/ruckus/index.html
index ff9451870..c4c9bc63e 100644
--- a/docs/netmiko/ruckus/index.html
+++ b/docs/netmiko/ruckus/index.html
@@ -46,7 +46,7 @@
class RuckusFastironSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ruckus FastIron aka ICX support.
diff --git a/docs/netmiko/ruckus/ruckus_fastiron.html b/docs/netmiko/ruckus/ruckus_fastiron.html
index bfe645001..9b6a4565a 100644
--- a/docs/netmiko/ruckus/ruckus_fastiron.html
+++ b/docs/netmiko/ruckus/ruckus_fastiron.html
@@ -133,7 +133,7 @@
class RuckusFastironBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ruckus FastIron aka ICX support.
@@ -484,7 +484,7 @@ Inherited members
class RuckusFastironSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Ruckus FastIron aka ICX support.
diff --git a/docs/netmiko/ruijie/index.html b/docs/netmiko/ruijie/index.html
index e78fccf04..b775fc10f 100644
--- a/docs/netmiko/ruijie/index.html
+++ b/docs/netmiko/ruijie/index.html
@@ -45,7 +45,7 @@
class RuijieOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/ruijie/ruijie_os.html b/docs/netmiko/ruijie/ruijie_os.html
index f65ff3e83..fd77a3832 100644
--- a/docs/netmiko/ruijie/ruijie_os.html
+++ b/docs/netmiko/ruijie/ruijie_os.html
@@ -71,7 +71,7 @@
class RuijieOSBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -321,7 +321,7 @@ Inherited members
class RuijieOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/scp_functions.html b/docs/netmiko/scp_functions.html
index b85b6d7bf..87fbf95ba 100644
--- a/docs/netmiko/scp_functions.html
+++ b/docs/netmiko/scp_functions.html
@@ -38,6 +38,29 @@ Module netmiko.scp_functions
from netmiko import FileTransfer, InLineTransfer
+def progress_bar(filename, size, sent, peername=None):
+ max_width = 50
+ filename = filename.decode()
+ clear_screen = chr(27) + "[2J"
+ terminating_char = "|"
+
+ # Percentage done
+ percent_complete = sent / size
+ percent_str = f"{percent_complete*100:.2f}%"
+ hash_count = int(percent_complete * max_width)
+ progress = hash_count * ">"
+
+ if peername is None:
+ header_msg = f"Transferring file: {filename}\n"
+ else:
+ header_msg = f"Transferring file to {peername}: {filename}\n"
+
+ msg = f"{progress:<50}{terminating_char:1} ({percent_str})"
+ print(clear_screen)
+ print(header_msg)
+ print(msg)
+
+
def verifyspace_and_transferfile(scp_transfer):
"""Verify space and transfer file."""
if not scp_transfer.verify_space_available():
@@ -55,6 +78,8 @@ Module netmiko.scp_functions
inline_transfer=False,
overwrite_file=False,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
verify_file=None,
):
"""Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.
@@ -100,6 +125,8 @@ Module netmiko.scp_functions
"dest_file": dest_file,
"direction": direction,
"socket_timeout": socket_timeout,
+ "progress": progress,
+ "progress4": progress4,
}
if file_system is not None:
scp_args["file_system"] = file_system
@@ -152,7 +179,7 @@ Module netmiko.scp_functions
-def file_transfer (ssh_conn, source_file, dest_file, file_system=None, direction='put', disable_md5=False, inline_transfer=False, overwrite_file=False, socket_timeout=10.0, verify_file=None)
+def file_transfer (ssh_conn, source_file, dest_file, file_system=None, direction='put', disable_md5=False, inline_transfer=False, overwrite_file=False, socket_timeout=10.0, progress=None, progress4=None, verify_file=None)
Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.
@@ -174,6 +201,8 @@
inline_transfer=False,
overwrite_file=False,
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
verify_file=None,
):
"""Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.
@@ -219,6 +248,8 @@
"dest_file": dest_file,
"direction": direction,
"socket_timeout": socket_timeout,
+ "progress": progress,
+ "progress4": progress4,
}
if file_system is not None:
scp_args["file_system"] = file_system
@@ -263,6 +294,36 @@
return transferred_and_notverified
+
+def progress_bar (filename, size, sent, peername=None)
+
+
+
+
+Source code
+def progress_bar(filename, size, sent, peername=None):
+ max_width = 50
+ filename = filename.decode()
+ clear_screen = chr(27) + "[2J"
+ terminating_char = "|"
+
+ # Percentage done
+ percent_complete = sent / size
+ percent_str = f"{percent_complete*100:.2f}%"
+ hash_count = int(percent_complete * max_width)
+ progress = hash_count * ">"
+
+ if peername is None:
+ header_msg = f"Transferring file: {filename}\n"
+ else:
+ header_msg = f"Transferring file to {peername}: {filename}\n"
+
+ msg = f"{progress:<50}{terminating_char:1} ({percent_str})"
+ print(clear_screen)
+ print(header_msg)
+ print(msg)
+
+
def verifyspace_and_transferfile (scp_transfer)
@@ -296,6 +357,7 @@ Index
Functions
diff --git a/docs/netmiko/scp_handler.html b/docs/netmiko/scp_handler.html
index bb2d1d044..44e75ba8e 100644
--- a/docs/netmiko/scp_handler.html
+++ b/docs/netmiko/scp_handler.html
@@ -50,9 +50,11 @@ Module netmiko.scp_handler
Must close the SCP connection to get the file to write to the remote filesystem
"""
- def __init__(self, ssh_conn, socket_timeout=10.0):
+ def __init__(self, ssh_conn, socket_timeout=10.0, progress=None, progress4=None):
self.ssh_ctl_chan = ssh_conn
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
self.establish_scp_conn()
def establish_scp_conn(self):
@@ -61,7 +63,10 @@ Module netmiko.scp_handler
self.scp_conn = self.ssh_ctl_chan._build_ssh_client()
self.scp_conn.connect(**ssh_connect_params)
self.scp_client = scp.SCPClient(
- self.scp_conn.get_transport(), socket_timeout=self.socket_timeout
+ self.scp_conn.get_transport(),
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
)
def scp_transfer_file(self, source_file, dest_file):
@@ -92,6 +97,8 @@ Module netmiko.scp_handler
file_system=None,
direction="put",
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
hash_supported=True,
):
self.ssh_ctl_chan = ssh_conn
@@ -99,6 +106,8 @@ Module netmiko.scp_handler
self.dest_file = dest_file
self.direction = direction
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
auto_flag = (
"cisco_ios" in ssh_conn.device_type
@@ -135,7 +144,12 @@ Module netmiko.scp_handler
def establish_scp_conn(self):
"""Establish SCP connection."""
- self.scp_conn = SCPConn(self.ssh_ctl_chan, socket_timeout=self.socket_timeout)
+ self.scp_conn = SCPConn(
+ self.ssh_ctl_chan,
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
+ )
def close_scp_chan(self):
"""Close the SCP connection to the remote network device."""
@@ -421,7 +435,7 @@
class BaseFileTransfer
-( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)
+( ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)
Class to manage SCP file transfer and associated SSH control channel.
@@ -438,6 +452,8 @@
file_system=None,
direction="put",
socket_timeout=10.0,
+ progress=None,
+ progress4=None,
hash_supported=True,
):
self.ssh_ctl_chan = ssh_conn
@@ -445,6 +461,8 @@
self.dest_file = dest_file
self.direction = direction
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
auto_flag = (
"cisco_ios" in ssh_conn.device_type
@@ -481,7 +499,12 @@
def establish_scp_conn(self):
"""Establish SCP connection."""
- self.scp_conn = SCPConn(self.ssh_ctl_chan, socket_timeout=self.socket_timeout)
+ self.scp_conn = SCPConn(
+ self.ssh_ctl_chan,
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
+ )
def close_scp_chan(self):
"""Close the SCP connection to the remote network device."""
@@ -903,7 +926,12 @@ Methods
Source code
def establish_scp_conn(self):
"""Establish SCP connection."""
- self.scp_conn = SCPConn(self.ssh_ctl_chan, socket_timeout=self.socket_timeout)
+ self.scp_conn = SCPConn(
+ self.ssh_ctl_chan,
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
+ )
@@ -1120,7 +1148,7 @@ Args
class SCPConn
-( ssh_conn, socket_timeout=10.0)
+( ssh_conn, socket_timeout=10.0, progress=None, progress4=None)
Establish a secure copy channel to the remote network device.
@@ -1134,9 +1162,11 @@ Args
Must close the SCP connection to get the file to write to the remote filesystem
"""
- def __init__(self, ssh_conn, socket_timeout=10.0):
+ def __init__(self, ssh_conn, socket_timeout=10.0, progress=None, progress4=None):
self.ssh_ctl_chan = ssh_conn
self.socket_timeout = socket_timeout
+ self.progress = progress
+ self.progress4 = progress4
self.establish_scp_conn()
def establish_scp_conn(self):
@@ -1145,7 +1175,10 @@ Args
self.scp_conn = self.ssh_ctl_chan._build_ssh_client()
self.scp_conn.connect(**ssh_connect_params)
self.scp_client = scp.SCPClient(
- self.scp_conn.get_transport(), socket_timeout=self.socket_timeout
+ self.scp_conn.get_transport(),
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
)
def scp_transfer_file(self, source_file, dest_file):
@@ -1191,7 +1224,10 @@ Methods
self.scp_conn = self.ssh_ctl_chan._build_ssh_client()
self.scp_conn.connect(**ssh_connect_params)
self.scp_client = scp.SCPClient(
- self.scp_conn.get_transport(), socket_timeout=self.socket_timeout
+ self.scp_conn.get_transport(),
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
)
diff --git a/docs/netmiko/sixwind/index.html b/docs/netmiko/sixwind/index.html
index 31d5ad446..87a8b7363 100644
--- a/docs/netmiko/sixwind/index.html
+++ b/docs/netmiko/sixwind/index.html
@@ -45,7 +45,7 @@
class SixwindOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/sixwind/sixwind_os.html b/docs/netmiko/sixwind/sixwind_os.html
index 4368a5572..883da569d 100644
--- a/docs/netmiko/sixwind/sixwind_os.html
+++ b/docs/netmiko/sixwind/sixwind_os.html
@@ -136,7 +136,7 @@
class SixwindOSBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -597,7 +597,7 @@ Inherited members
class SixwindOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/sophos/index.html b/docs/netmiko/sophos/index.html
index ee2a44410..026d103f1 100644
--- a/docs/netmiko/sophos/index.html
+++ b/docs/netmiko/sophos/index.html
@@ -45,7 +45,7 @@
class SophosSfosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/sophos/sophos_sfos_ssh.html b/docs/netmiko/sophos/sophos_sfos_ssh.html
index 722975df4..5ca165a62 100644
--- a/docs/netmiko/sophos/sophos_sfos_ssh.html
+++ b/docs/netmiko/sophos/sophos_sfos_ssh.html
@@ -95,7 +95,7 @@
class SophosSfosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/terminal_server/index.html b/docs/netmiko/terminal_server/index.html
index aff420a46..26f873dd5 100644
--- a/docs/netmiko/terminal_server/index.html
+++ b/docs/netmiko/terminal_server/index.html
@@ -46,7 +46,7 @@
Generic Terminal Server driver SSH.
@@ -242,7 +242,7 @@ Inherited members
class TerminalServerTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Generic Terminal Server driver telnet.
diff --git a/docs/netmiko/terminal_server/terminal_server.html b/docs/netmiko/terminal_server/terminal_server.html
index 0d50dbe11..c3422ca2a 100644
--- a/docs/netmiko/terminal_server/terminal_server.html
+++ b/docs/netmiko/terminal_server/terminal_server.html
@@ -67,7 +67,7 @@
class TerminalServer
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Generic Terminal Server driver.
@@ -289,7 +289,7 @@ Inherited members
Generic Terminal Server driver SSH.
@@ -485,7 +485,7 @@ Inherited members
class TerminalServerTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Generic Terminal Server driver telnet.
diff --git a/docs/netmiko/ubiquiti/edge_ssh.html b/docs/netmiko/ubiquiti/edge_ssh.html
index f24cb61f3..4c5ffed5e 100644
--- a/docs/netmiko/ubiquiti/edge_ssh.html
+++ b/docs/netmiko/ubiquiti/edge_ssh.html
@@ -81,7 +81,7 @@
class UbiquitiEdgeSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Ubiquity EdgeSwitch devices.
diff --git a/docs/netmiko/ubiquiti/index.html b/docs/netmiko/ubiquiti/index.html
index 9aa61b413..f210c0491 100644
--- a/docs/netmiko/ubiquiti/index.html
+++ b/docs/netmiko/ubiquiti/index.html
@@ -50,7 +50,7 @@
class UbiquitiEdgeSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Ubiquity EdgeSwitch devices.
@@ -351,7 +351,7 @@ Inherited members
class UbiquitiUnifiSwitchSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Ubiquity EdgeSwitch devices.
diff --git a/docs/netmiko/ubiquiti/unifiswitch_ssh.html b/docs/netmiko/ubiquiti/unifiswitch_ssh.html
index 3b632a9aa..b221741cd 100644
--- a/docs/netmiko/ubiquiti/unifiswitch_ssh.html
+++ b/docs/netmiko/ubiquiti/unifiswitch_ssh.html
@@ -75,7 +75,7 @@
class UbiquitiUnifiSwitchSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements support for Ubiquity EdgeSwitch devices.
diff --git a/docs/netmiko/vyos/index.html b/docs/netmiko/vyos/index.html
index 923a6df6f..63eba10d3 100644
--- a/docs/netmiko/vyos/index.html
+++ b/docs/netmiko/vyos/index.html
@@ -45,7 +45,7 @@
class VyOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with VyOS network devices.
diff --git a/docs/netmiko/vyos/vyos_ssh.html b/docs/netmiko/vyos/vyos_ssh.html
index 1e57a3c2d..ac665440e 100644
--- a/docs/netmiko/vyos/vyos_ssh.html
+++ b/docs/netmiko/vyos/vyos_ssh.html
@@ -141,7 +141,7 @@
class VyOSSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implement methods for interacting with VyOS network devices.
diff --git a/docs/netmiko/watchguard/fireware_ssh.html b/docs/netmiko/watchguard/fireware_ssh.html
index 98f766c62..0258b3b1e 100644
--- a/docs/netmiko/watchguard/fireware_ssh.html
+++ b/docs/netmiko/watchguard/fireware_ssh.html
@@ -71,7 +71,7 @@
class WatchguardFirewareSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements methods for communicating with Watchguard Firebox firewalls.
diff --git a/docs/netmiko/watchguard/index.html b/docs/netmiko/watchguard/index.html
index b5a396883..83594f1b2 100644
--- a/docs/netmiko/watchguard/index.html
+++ b/docs/netmiko/watchguard/index.html
@@ -45,7 +45,7 @@
class WatchguardFirewareSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Implements methods for communicating with Watchguard Firebox firewalls.
diff --git a/docs/netmiko/yamaha/index.html b/docs/netmiko/yamaha/index.html
index 1a89b3e97..de5771555 100644
--- a/docs/netmiko/yamaha/index.html
+++ b/docs/netmiko/yamaha/index.html
@@ -46,7 +46,7 @@
class YamahaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Yamaha SSH driver.
@@ -242,7 +242,7 @@ Inherited members
class YamahaTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Yamaha Telnet driver.
diff --git a/docs/netmiko/yamaha/yamaha.html b/docs/netmiko/yamaha/yamaha.html
index 39e5665f4..df28b0930 100644
--- a/docs/netmiko/yamaha/yamaha.html
+++ b/docs/netmiko/yamaha/yamaha.html
@@ -105,7 +105,7 @@
class YamahaBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Defines vendor independent methods.
@@ -451,7 +451,7 @@ Inherited members
class YamahaSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Yamaha SSH driver.
@@ -647,7 +647,7 @@ Inherited members
class YamahaTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Yamaha Telnet driver.
diff --git a/docs/netmiko/zte/index.html b/docs/netmiko/zte/index.html
index ee6632b01..ab7170fee 100644
--- a/docs/netmiko/zte/index.html
+++ b/docs/netmiko/zte/index.html
@@ -46,7 +46,7 @@
class ZteZxrosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -241,7 +241,7 @@ Inherited members
class ZteZxrosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
diff --git a/docs/netmiko/zte/zte_zxros.html b/docs/netmiko/zte/zte_zxros.html
index 0e4a1f264..357ce04f9 100644
--- a/docs/netmiko/zte/zte_zxros.html
+++ b/docs/netmiko/zte/zte_zxros.html
@@ -93,7 +93,7 @@
class ZteZxrosBase
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -356,7 +356,7 @@ Inherited members
class ZteZxrosSSH
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.
@@ -551,7 +551,7 @@ Inherited members
class ZteZxrosTelnet
-( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
+( ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True)
Base Class for cisco-like behavior.