From 1c954561ae1afbe38316059c5803fd163d0092fc Mon Sep 17 00:00:00 2001
From: Kirk Byers <ktbyers@twb-tech.com>
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 917d3792..ffa59d3f 100644
--- a/docs/netmiko/a10/a10_ssh.html
+++ b/docs/netmiko/a10/a10_ssh.html
@@ -61,7 +61,7 @@ class A10SSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.a10.a10_ssh.A10SSH"><code class="flex name class">
<span>class <span class="ident">A10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>A10 support.</p>
diff --git a/docs/netmiko/a10/index.html b/docs/netmiko/a10/index.html
index 250f885b..16d62457 100644
--- a/docs/netmiko/a10/index.html
+++ b/docs/netmiko/a10/index.html
@@ -45,7 +45,7 @@ __all__ = ["A10SSH"]</code></pre>
<dl>
<dt id="netmiko.a10.A10SSH"><code class="flex name class">
<span>class <span class="ident">A10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>A10 support.</p>
diff --git a/docs/netmiko/accedian/accedian_ssh.html b/docs/netmiko/accedian/accedian_ssh.html
index 5fe4497b..2e180dd0 100644
--- a/docs/netmiko/accedian/accedian_ssh.html
+++ b/docs/netmiko/accedian/accedian_ssh.html
@@ -82,7 +82,7 @@ class AccedianSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.accedian.accedian_ssh.AccedianSSH"><code class="flex name class">
<span>class <span class="ident">AccedianSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/accedian/index.html b/docs/netmiko/accedian/index.html
index 82372226..bda9fb0b 100644
--- a/docs/netmiko/accedian/index.html
+++ b/docs/netmiko/accedian/index.html
@@ -45,7 +45,7 @@ __all__ = ["AccedianSSH"]</code></pre>
<dl>
<dt id="netmiko.accedian.AccedianSSH"><code class="flex name class">
<span>class <span class="ident">AccedianSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/alcatel/alcatel_aos_ssh.html b/docs/netmiko/alcatel/alcatel_aos_ssh.html
index a69bdab8..ca743956 100644
--- a/docs/netmiko/alcatel/alcatel_aos_ssh.html
+++ b/docs/netmiko/alcatel/alcatel_aos_ssh.html
@@ -83,7 +83,7 @@ class AlcatelAosSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.alcatel.alcatel_aos_ssh.AlcatelAosSSH"><code class="flex name class">
<span>class <span class="ident">AlcatelAosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).</p>
diff --git a/docs/netmiko/alcatel/index.html b/docs/netmiko/alcatel/index.html
index ed31aa3b..078d561b 100644
--- a/docs/netmiko/alcatel/index.html
+++ b/docs/netmiko/alcatel/index.html
@@ -45,7 +45,7 @@ __all__ = ["AlcatelAosSSH"]</code></pre>
<dl>
<dt id="netmiko.alcatel.AlcatelAosSSH"><code class="flex name class">
<span>class <span class="ident">AlcatelAosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).</p>
diff --git a/docs/netmiko/apresia/apresia_aeos.html b/docs/netmiko/apresia/apresia_aeos.html
index 0899b407..f1cbd891 100644
--- a/docs/netmiko/apresia/apresia_aeos.html
+++ b/docs/netmiko/apresia/apresia_aeos.html
@@ -68,7 +68,7 @@ class ApresiaAeosTelnet(ApresiaAeosBase):
<dl>
<dt id="netmiko.apresia.apresia_aeos.ApresiaAeosBase"><code class="flex name class">
<span>class <span class="ident">ApresiaAeosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -303,7 +303,7 @@ class ApresiaAeosTelnet(ApresiaAeosBase):
</dd>
<dt id="netmiko.apresia.apresia_aeos.ApresiaAeosSSH"><code class="flex name class">
<span>class <span class="ident">ApresiaAeosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/apresia/index.html b/docs/netmiko/apresia/index.html
index 5df5bc41..22f48fea 100644
--- a/docs/netmiko/apresia/index.html
+++ b/docs/netmiko/apresia/index.html
@@ -45,7 +45,7 @@ __all__ = ["ApresiaAeosSSH", "ApresiaAeosTelnet"]</code></pre>
<dl>
<dt id="netmiko.apresia.ApresiaAeosSSH"><code class="flex name class">
<span>class <span class="ident">ApresiaAeosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/arista/arista.html b/docs/netmiko/arista/arista.html
index 9ace0b99..6c2ece8c 100644
--- a/docs/netmiko/arista/arista.html
+++ b/docs/netmiko/arista/arista.html
@@ -25,7 +25,6 @@
<pre><code class="python">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 @@ class AristaBase(CiscoSSHConnection):
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 AristaFileTransfer(CiscoFileTransfer):
<dl>
<dt id="netmiko.arista.arista.AristaBase"><code class="flex name class">
<span>class <span class="ident">AristaBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -299,13 +299,14 @@ class AristaFileTransfer(CiscoFileTransfer):
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 @@ loc1-core01(s1)#</p>
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</code></pre>
</details>
</dd>
@@ -517,7 +519,7 @@ loc1-core01(s1)#</p>
</dd>
<dt id="netmiko.arista.arista.AristaSSH"><code class="flex name class">
<span>class <span class="ident">AristaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/arista/index.html b/docs/netmiko/arista/index.html
index 483c1c19..e5e8d4f7 100644
--- a/docs/netmiko/arista/index.html
+++ b/docs/netmiko/arista/index.html
@@ -137,7 +137,7 @@ __all__ = ["AristaSSH", "AristaTelnet", "AristaFileTransfer&
</dd>
<dt id="netmiko.arista.AristaSSH"><code class="flex name class">
<span>class <span class="ident">AristaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/aruba/aruba_ssh.html b/docs/netmiko/aruba/aruba_ssh.html
index 7e09c85e..1a254b0c 100644
--- a/docs/netmiko/aruba/aruba_ssh.html
+++ b/docs/netmiko/aruba/aruba_ssh.html
@@ -42,6 +42,9 @@ class ArubaSSH(CiscoSSHConnection):
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 @@ class ArubaSSH(CiscoSSHConnection):
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 @@ class ArubaSSH(CiscoSSHConnection):
<summary>Source code</summary>
<pre><code class="python">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 5a97540e..b8076d60 100644
--- a/docs/netmiko/aruba/index.html
+++ b/docs/netmiko/aruba/index.html
@@ -194,6 +194,9 @@ __all__ = ["ArubaSSH"]</code></pre>
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 @@ __all__ = ["ArubaSSH"]</code></pre>
<summary>Source code</summary>
<pre><code class="python">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 955d7e54..3669a933 100644
--- a/docs/netmiko/base_connection.html
+++ b/docs/netmiko/base_connection.html
@@ -90,11 +90,17 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
# 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 @@ class BaseConnection(object):
# 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 @@ class BaseConnection(object):
"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 @@ class BaseConnection(object):
# 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 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
: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 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
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 @@ class BaseConnection(object):
# 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 @@ class BaseConnection(object):
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 TelnetConnection(BaseConnection):
<dl>
<dt id="netmiko.base_connection.BaseConnection"><code class="flex name class">
<span>class <span class="ident">BaseConnection</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
@@ -2126,11 +2153,17 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
# 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 @@ class TelnetConnection(BaseConnection):
# 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 @@ class TelnetConnection(BaseConnection):
"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 @@ class TelnetConnection(BaseConnection):
# 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 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
: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 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
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 @@ class TelnetConnection(BaseConnection):
# 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 @@ class TelnetConnection(BaseConnection):
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 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
:type height: int</p></section>
<details class="source">
<summary>Source code</summary>
-<pre><code class="python">def establish_connection(self, width=511, height=1000):
- """Establish SSH connection to the network device
+<pre><code class="python"> 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 ""</code></pre>
+ # 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 ""</code></pre>
</details>
</dd>
<dt id="netmiko.base_connection.BaseConnection.exit_config_mode"><code class="name flex">
@@ -4438,7 +4508,6 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
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 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
<pre><code class="python">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</code></pre>
</details>
</dd>
@@ -5461,8 +5530,6 @@ Move cursor position leftward by x characters (1 in this case)</p>
: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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
# 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</code></pre>
</details>
@@ -5648,14 +5718,16 @@ Move cursor position leftward by x characters (1 in this case)</p>
# 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 @@ Move cursor position leftward by x characters (1 in this case)</p>
</dd>
<dt id="netmiko.base_connection.TelnetConnection"><code class="flex name class">
<span>class <span class="ident">TelnetConnection</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/broadcom/broadcom_icos_ssh.html b/docs/netmiko/broadcom/broadcom_icos_ssh.html
index 7ea4f6aa..83afc479 100644
--- a/docs/netmiko/broadcom/broadcom_icos_ssh.html
+++ b/docs/netmiko/broadcom/broadcom_icos_ssh.html
@@ -78,7 +78,7 @@ class BroadcomIcosSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.broadcom.broadcom_icos_ssh.BroadcomIcosSSH"><code class="flex name class">
<span>class <span class="ident">BroadcomIcosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Broadcom Icos devices.
diff --git a/docs/netmiko/broadcom/index.html b/docs/netmiko/broadcom/index.html
index 34eb0461..4b7d45b6 100644
--- a/docs/netmiko/broadcom/index.html
+++ b/docs/netmiko/broadcom/index.html
@@ -46,7 +46,7 @@ __all__ = ["BroadcomIcosSSH"]</code></pre>
<dl>
<dt id="netmiko.broadcom.BroadcomIcosSSH"><code class="flex name class">
<span>class <span class="ident">BroadcomIcosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Broadcom Icos devices.
diff --git a/docs/netmiko/centec/centec_os.html b/docs/netmiko/centec/centec_os.html
index a3bebb60..3ef16b73 100644
--- a/docs/netmiko/centec/centec_os.html
+++ b/docs/netmiko/centec/centec_os.html
@@ -66,7 +66,7 @@ class CentecOSTelnet(CentecOSBase):
<dl>
<dt id="netmiko.centec.centec_os.CentecOSBase"><code class="flex name class">
<span>class <span class="ident">CentecOSBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -310,7 +310,7 @@ class CentecOSTelnet(CentecOSBase):
</dd>
<dt id="netmiko.centec.centec_os.CentecOSSSH"><code class="flex name class">
<span>class <span class="ident">CentecOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -506,7 +506,7 @@ class CentecOSTelnet(CentecOSBase):
</dd>
<dt id="netmiko.centec.centec_os.CentecOSTelnet"><code class="flex name class">
<span>class <span class="ident">CentecOSTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/centec/index.html b/docs/netmiko/centec/index.html
index c2828c43..5aac0551 100644
--- a/docs/netmiko/centec/index.html
+++ b/docs/netmiko/centec/index.html
@@ -45,7 +45,7 @@ __all__ = ["CentecOSSSH", "CentecOSTelnet"]</code></pre>
<dl>
<dt id="netmiko.centec.CentecOSSSH"><code class="flex name class">
<span>class <span class="ident">CentecOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -241,7 +241,7 @@ __all__ = ["CentecOSSSH", "CentecOSTelnet"]</code></pre>
</dd>
<dt id="netmiko.centec.CentecOSTelnet"><code class="flex name class">
<span>class <span class="ident">CentecOSTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
index 5793fcf8..c5a3f912 100644
--- a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
+++ b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html
@@ -69,7 +69,7 @@ class CheckPointGaiaSSH(BaseConnection):
<dl>
<dt id="netmiko.checkpoint.checkpoint_gaia_ssh.CheckPointGaiaSSH"><code class="flex name class">
<span>class <span class="ident">CheckPointGaiaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements methods for communicating with Check Point Gaia
diff --git a/docs/netmiko/checkpoint/index.html b/docs/netmiko/checkpoint/index.html
index ab97157b..526163f2 100644
--- a/docs/netmiko/checkpoint/index.html
+++ b/docs/netmiko/checkpoint/index.html
@@ -45,7 +45,7 @@ __all__ = ["CheckPointGaiaSSH"]</code></pre>
<dl>
<dt id="netmiko.checkpoint.CheckPointGaiaSSH"><code class="flex name class">
<span>class <span class="ident">CheckPointGaiaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>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 2fffd017..a484ff1d 100644
--- a/docs/netmiko/ciena/ciena_saos.html
+++ b/docs/netmiko/ciena/ciena_saos.html
@@ -252,7 +252,7 @@ class CienaSaosFileTransfer(BaseFileTransfer):
<dl>
<dt id="netmiko.ciena.ciena_saos.CienaSaosBase"><code class="flex name class">
<span>class <span class="ident">CienaSaosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ciena SAOS support.</p>
@@ -823,7 +823,7 @@ tmpfs
</dd>
<dt id="netmiko.ciena.ciena_saos.CienaSaosSSH"><code class="flex name class">
<span>class <span class="ident">CienaSaosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ciena SAOS support.</p>
diff --git a/docs/netmiko/ciena/index.html b/docs/netmiko/ciena/index.html
index 4ce9b135..b556618e 100644
--- a/docs/netmiko/ciena/index.html
+++ b/docs/netmiko/ciena/index.html
@@ -284,7 +284,7 @@ tmpfs
</dd>
<dt id="netmiko.ciena.CienaSaosSSH"><code class="flex name class">
<span>class <span class="ident">CienaSaosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ciena SAOS support.</p>
diff --git a/docs/netmiko/cisco/cisco_asa_ssh.html b/docs/netmiko/cisco/cisco_asa_ssh.html
index 10534717..120c0887 100644
--- a/docs/netmiko/cisco/cisco_asa_ssh.html
+++ b/docs/netmiko/cisco/cisco_asa_ssh.html
@@ -166,7 +166,7 @@ class CiscoAsaFileTransfer(CiscoFileTransfer):
<dl>
<dt id="netmiko.cisco.cisco_asa_ssh.CiscoAsaFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoAsaFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco ASA SCP File Transfer driver.</p></section>
@@ -209,7 +209,7 @@ class CiscoAsaFileTransfer(CiscoFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_asa_ssh.CiscoAsaSSH"><code class="flex name class">
<span>class <span class="ident">CiscoAsaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Subclass specific to Cisco ASA.</p>
diff --git a/docs/netmiko/cisco/cisco_ios.html b/docs/netmiko/cisco/cisco_ios.html
index ff8b8218..0e230cd7 100644
--- a/docs/netmiko/cisco/cisco_ios.html
+++ b/docs/netmiko/cisco/cisco_ios.html
@@ -95,13 +95,24 @@ class InLineTransfer(CiscoIosFileTransfer):
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 InLineTransfer(CiscoIosFileTransfer):
<dl>
<dt id="netmiko.cisco.cisco_ios.CiscoIosBase"><code class="flex name class">
<span>class <span class="ident">CiscoIosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Common Methods for IOS (both SSH and telnet).</p>
@@ -526,7 +537,7 @@ class InLineTransfer(CiscoIosFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_ios.CiscoIosFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoIosFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS SCP File Transfer driver.</p></section>
@@ -573,7 +584,7 @@ class InLineTransfer(CiscoIosFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_ios.CiscoIosSSH"><code class="flex name class">
<span>class <span class="ident">CiscoIosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS SSH driver.</p>
@@ -770,7 +781,7 @@ class InLineTransfer(CiscoIosFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_ios.CiscoIosSerial"><code class="flex name class">
<span>class <span class="ident">CiscoIosSerial</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS Serial driver.</p>
@@ -967,7 +978,7 @@ class InLineTransfer(CiscoIosFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_ios.CiscoIosTelnet"><code class="flex name class">
<span>class <span class="ident">CiscoIosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS Telnet driver.</p>
@@ -1164,7 +1175,7 @@ class InLineTransfer(CiscoIosFileTransfer):
</dd>
<dt id="netmiko.cisco.cisco_ios.InLineTransfer"><code class="flex name class">
<span>class <span class="ident">InLineTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Use TCL on Cisco IOS to directly transfer file.</p></section>
@@ -1182,13 +1193,24 @@ class InLineTransfer(CiscoIosFileTransfer):
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 28d0b336..3c56e2cc 100644
--- a/docs/netmiko/cisco/cisco_nxos_ssh.html
+++ b/docs/netmiko/cisco/cisco_nxos_ssh.html
@@ -63,6 +63,8 @@ class CiscoNxosFileTransfer(CiscoFileTransfer):
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 @@ class CiscoNxosFileTransfer(CiscoFileTransfer):
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(CiscoFileTransfer):
<dl>
<dt id="netmiko.cisco.cisco_nxos_ssh.CiscoNxosFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoNxosFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco NXOS SCP File Transfer driver.</p></section>
@@ -175,6 +179,8 @@ class CiscoNxosFileTransfer(CiscoFileTransfer):
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 @@ class CiscoNxosFileTransfer(CiscoFileTransfer):
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 @@ def process_md5(md5_output, pattern=r"= (.*)"):
</dd>
<dt id="netmiko.cisco.cisco_nxos_ssh.CiscoNxosSSH"><code class="flex name class">
<span>class <span class="ident">CiscoNxosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/cisco/cisco_s300.html b/docs/netmiko/cisco/cisco_s300.html
index 7a71b839..3be820ce 100644
--- a/docs/netmiko/cisco/cisco_s300.html
+++ b/docs/netmiko/cisco/cisco_s300.html
@@ -63,7 +63,7 @@ class CiscoS300SSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.cisco.cisco_s300.CiscoS300SSH"><code class="flex name class">
<span>class <span class="ident">CiscoS300SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Cisco SG300 series of devices.</p>
diff --git a/docs/netmiko/cisco/cisco_wlc_ssh.html b/docs/netmiko/cisco/cisco_wlc_ssh.html
index bfb401c1..e0419553 100644
--- a/docs/netmiko/cisco/cisco_wlc_ssh.html
+++ b/docs/netmiko/cisco/cisco_wlc_ssh.html
@@ -230,7 +230,7 @@ class CiscoWlcSSH(BaseConnection):
<dl>
<dt id="netmiko.cisco.cisco_wlc_ssh.CiscoWlcSSH"><code class="flex name class">
<span>class <span class="ident">CiscoWlcSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko Cisco WLC support.</p>
diff --git a/docs/netmiko/cisco/cisco_xr.html b/docs/netmiko/cisco/cisco_xr.html
index a670b434..e01820c2 100644
--- a/docs/netmiko/cisco/cisco_xr.html
+++ b/docs/netmiko/cisco/cisco_xr.html
@@ -231,7 +231,7 @@ class CiscoXrFileTransfer(CiscoFileTransfer):
<dl>
<dt id="netmiko.cisco.cisco_xr.CiscoXrBase"><code class="flex name class">
<span>class <span class="ident">CiscoXrBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -775,7 +775,7 @@ an exception to be generated.</p></section>
</dd>
<dt id="netmiko.cisco.cisco_xr.CiscoXrFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoXrFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS-XR SCP File Transfer driver.</p></section>
@@ -906,7 +906,7 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
</dd>
<dt id="netmiko.cisco.cisco_xr.CiscoXrSSH"><code class="flex name class">
<span>class <span class="ident">CiscoXrSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco XR SSH driver.</p>
@@ -1103,7 +1103,7 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
</dd>
<dt id="netmiko.cisco.cisco_xr.CiscoXrTelnet"><code class="flex name class">
<span>class <span class="ident">CiscoXrTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco XR Telnet driver.</p>
diff --git a/docs/netmiko/cisco/index.html b/docs/netmiko/cisco/index.html
index 7d4f4029..190a8689 100644
--- a/docs/netmiko/cisco/index.html
+++ b/docs/netmiko/cisco/index.html
@@ -101,7 +101,7 @@ Expressway/VCS …</p></section>
<dl>
<dt id="netmiko.cisco.CiscoAsaFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoAsaFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco ASA SCP File Transfer driver.</p></section>
@@ -144,7 +144,7 @@ Expressway/VCS …</p></section>
</dd>
<dt id="netmiko.cisco.CiscoAsaSSH"><code class="flex name class">
<span>class <span class="ident">CiscoAsaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Subclass specific to Cisco ASA.</p>
@@ -631,7 +631,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoIosBase"><code class="flex name class">
<span>class <span class="ident">CiscoIosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Common Methods for IOS (both SSH and telnet).</p>
@@ -890,7 +890,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoIosFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoIosFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS SCP File Transfer driver.</p></section>
@@ -937,7 +937,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoIosSSH"><code class="flex name class">
<span>class <span class="ident">CiscoIosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS SSH driver.</p>
@@ -1134,7 +1134,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoIosSerial"><code class="flex name class">
<span>class <span class="ident">CiscoIosSerial</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS Serial driver.</p>
@@ -1331,7 +1331,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoIosTelnet"><code class="flex name class">
<span>class <span class="ident">CiscoIosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS Telnet driver.</p>
@@ -1528,7 +1528,7 @@ happens the trailing '(config*' needs stripped off.</p></section>
</dd>
<dt id="netmiko.cisco.CiscoNxosFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoNxosFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system='bootflash:', direction='put', socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco NXOS SCP File Transfer driver.</p></section>
@@ -1545,6 +1545,8 @@ happens the trailing '(config*' needs stripped off.</p></section>
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 @@ happens the trailing '(config*' needs stripped off.</p></section>
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 @@ def process_md5(md5_output, pattern=r"= (.*)"):
</dd>
<dt id="netmiko.cisco.CiscoNxosSSH"><code class="flex name class">
<span>class <span class="ident">CiscoNxosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -1938,7 +1942,7 @@ def process_md5(md5_output, pattern=r"= (.*)"):
</dd>
<dt id="netmiko.cisco.CiscoS300SSH"><code class="flex name class">
<span>class <span class="ident">CiscoS300SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Cisco SG300 series of devices.</p>
@@ -2568,7 +2572,7 @@ self.set_terminal_width()</p></section>
</dd>
<dt id="netmiko.cisco.CiscoWlcSSH"><code class="flex name class">
<span>class <span class="ident">CiscoWlcSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko Cisco WLC support.</p>
@@ -3182,7 +3186,7 @@ Arguments are the same as send_command_timing() method</p></section>
</dd>
<dt id="netmiko.cisco.CiscoXrFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoXrFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco IOS-XR SCP File Transfer driver.</p></section>
@@ -3313,7 +3317,7 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
</dd>
<dt id="netmiko.cisco.CiscoXrSSH"><code class="flex name class">
<span>class <span class="ident">CiscoXrSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco XR SSH driver.</p>
@@ -3510,7 +3514,7 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
</dd>
<dt id="netmiko.cisco.CiscoXrTelnet"><code class="flex name class">
<span>class <span class="ident">CiscoXrTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Cisco XR Telnet driver.</p>
@@ -3707,7 +3711,7 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
</dd>
<dt id="netmiko.cisco.InLineTransfer"><code class="flex name class">
<span>class <span class="ident">InLineTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Use TCL on Cisco IOS to directly transfer file.</p></section>
@@ -3725,13 +3729,24 @@ c84843f0030efd44b01343fdb8c2e801</p></section>
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 fc28bb28..4ac9ce6c 100644
--- a/docs/netmiko/cisco_base_connection.html
+++ b/docs/netmiko/cisco_base_connection.html
@@ -108,65 +108,76 @@ class CiscoBaseConnection(BaseConnection):
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 CiscoFileTransfer(BaseFileTransfer):
<dl>
<dt id="netmiko.cisco_base_connection.CiscoBaseConnection"><code class="flex name class">
<span>class <span class="ident">CiscoBaseConnection</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -479,65 +490,76 @@ class CiscoFileTransfer(BaseFileTransfer):
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 @@ class CiscoFileTransfer(BaseFileTransfer):
<li><a title="netmiko.huawei.huawei_smartax.HuaweiSmartAXSSH" href="huawei/huawei_smartax.html#netmiko.huawei.huawei_smartax.HuaweiSmartAXSSH">HuaweiSmartAXSSH</a></li>
<li><a title="netmiko.ipinfusion.ipinfusion_ocnos.IpInfusionOcNOSBase" href="ipinfusion/ipinfusion_ocnos.html#netmiko.ipinfusion.ipinfusion_ocnos.IpInfusionOcNOSBase">IpInfusionOcNOSBase</a></li>
<li><a title="netmiko.oneaccess.oneaccess_oneos.OneaccessOneOSBase" href="oneaccess/oneaccess_oneos.html#netmiko.oneaccess.oneaccess_oneos.OneaccessOneOSBase">OneaccessOneOSBase</a></li>
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="raisecom/raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></li>
<li><a title="netmiko.ruijie.ruijie_os.RuijieOSBase" href="ruijie/ruijie_os.html#netmiko.ruijie.ruijie_os.RuijieOSBase">RuijieOSBase</a></li>
<li><a title="netmiko.sixwind.sixwind_os.SixwindOSBase" href="sixwind/sixwind_os.html#netmiko.sixwind.sixwind_os.SixwindOSBase">SixwindOSBase</a></li>
<li><a title="netmiko.zte.zte_zxros.ZteZxrosBase" href="zte/zte_zxros.html#netmiko.zte.zte_zxros.ZteZxrosBase">ZteZxrosBase</a></li>
@@ -833,65 +856,76 @@ class CiscoFileTransfer(BaseFileTransfer):
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 @@ class CiscoFileTransfer(BaseFileTransfer):
</dd>
<dt id="netmiko.cisco_base_connection.CiscoFileTransfer"><code class="flex name class">
<span>class <span class="ident">CiscoFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Class to manage SCP file transfer and associated SSH control channel.</p></section>
@@ -999,7 +1033,7 @@ class CiscoFileTransfer(BaseFileTransfer):
</dd>
<dt id="netmiko.cisco_base_connection.CiscoSSHConnection"><code class="flex name class">
<span>class <span class="ident">CiscoSSHConnection</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/citrix/index.html b/docs/netmiko/citrix/index.html
index 4328b8b2..0cc67014 100644
--- a/docs/netmiko/citrix/index.html
+++ b/docs/netmiko/citrix/index.html
@@ -45,7 +45,7 @@ __all__ = ["NetscalerSSH"]</code></pre>
<dl>
<dt id="netmiko.citrix.NetscalerSSH"><code class="flex name class">
<span>class <span class="ident">NetscalerSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netscaler SSH class. </p>
diff --git a/docs/netmiko/citrix/netscaler_ssh.html b/docs/netmiko/citrix/netscaler_ssh.html
index b77859ef..f9bfd3e2 100644
--- a/docs/netmiko/citrix/netscaler_ssh.html
+++ b/docs/netmiko/citrix/netscaler_ssh.html
@@ -95,7 +95,7 @@ class NetscalerSSH(BaseConnection):
<dl>
<dt id="netmiko.citrix.netscaler_ssh.NetscalerSSH"><code class="flex name class">
<span>class <span class="ident">NetscalerSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netscaler SSH class. </p>
diff --git a/docs/netmiko/cloudgenix/cloudgenix_ion.html b/docs/netmiko/cloudgenix/cloudgenix_ion.html
index 2000c674..41897838 100644
--- a/docs/netmiko/cloudgenix/cloudgenix_ion.html
+++ b/docs/netmiko/cloudgenix/cloudgenix_ion.html
@@ -84,7 +84,7 @@ class CloudGenixIonSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.cloudgenix.cloudgenix_ion.CloudGenixIonSSH"><code class="flex name class">
<span>class <span class="ident">CloudGenixIonSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/cloudgenix/index.html b/docs/netmiko/cloudgenix/index.html
index 4bc2a676..c69e9ad9 100644
--- a/docs/netmiko/cloudgenix/index.html
+++ b/docs/netmiko/cloudgenix/index.html
@@ -45,7 +45,7 @@ __all__ = ["CloudGenixIonSSH"]</code></pre>
<dl>
<dt id="netmiko.cloudgenix.CloudGenixIonSSH"><code class="flex name class">
<span>class <span class="ident">CloudGenixIonSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/coriant/coriant_ssh.html b/docs/netmiko/coriant/coriant_ssh.html
index b39aed73..1c3885f2 100644
--- a/docs/netmiko/coriant/coriant_ssh.html
+++ b/docs/netmiko/coriant/coriant_ssh.html
@@ -78,7 +78,7 @@ class CoriantSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.coriant.coriant_ssh.CoriantSSH"><code class="flex name class">
<span>class <span class="ident">CoriantSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/coriant/index.html b/docs/netmiko/coriant/index.html
index 1784d0d5..5f7a096d 100644
--- a/docs/netmiko/coriant/index.html
+++ b/docs/netmiko/coriant/index.html
@@ -45,7 +45,7 @@ __all__ = ["CoriantSSH"]</code></pre>
<dl>
<dt id="netmiko.coriant.CoriantSSH"><code class="flex name class">
<span>class <span class="ident">CoriantSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/dell/dell_dnos6.html b/docs/netmiko/dell/dell_dnos6.html
index eda6b51d..f97e6ec5 100644
--- a/docs/netmiko/dell/dell_dnos6.html
+++ b/docs/netmiko/dell/dell_dnos6.html
@@ -72,7 +72,7 @@ class DellDNOS6Telnet(DellDNOS6Base):
<dl>
<dt id="netmiko.dell.dell_dnos6.DellDNOS6Base"><code class="flex name class">
<span>class <span class="ident">DellDNOS6Base</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -314,7 +314,7 @@ class DellDNOS6Telnet(DellDNOS6Base):
</dd>
<dt id="netmiko.dell.dell_dnos6.DellDNOS6SSH"><code class="flex name class">
<span>class <span class="ident">DellDNOS6SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -510,7 +510,7 @@ class DellDNOS6Telnet(DellDNOS6Base):
</dd>
<dt id="netmiko.dell.dell_dnos6.DellDNOS6Telnet"><code class="flex name class">
<span>class <span class="ident">DellDNOS6Telnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
diff --git a/docs/netmiko/dell/dell_force10_ssh.html b/docs/netmiko/dell/dell_force10_ssh.html
index 01484e82..6dda48fe 100644
--- a/docs/netmiko/dell/dell_force10_ssh.html
+++ b/docs/netmiko/dell/dell_force10_ssh.html
@@ -53,7 +53,7 @@ class DellForce10SSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.dell.dell_force10_ssh.DellForce10SSH"><code class="flex name class">
<span>class <span class="ident">DellForce10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell Force10 Driver - supports DNOS9.</p>
diff --git a/docs/netmiko/dell/dell_isilon_ssh.html b/docs/netmiko/dell/dell_isilon_ssh.html
index 573caa06..a096ccee 100644
--- a/docs/netmiko/dell/dell_isilon_ssh.html
+++ b/docs/netmiko/dell/dell_isilon_ssh.html
@@ -121,7 +121,7 @@ class DellIsilonSSH(BaseConnection):
<dl>
<dt id="netmiko.dell.dell_isilon_ssh.DellIsilonSSH"><code class="flex name class">
<span>class <span class="ident">DellIsilonSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/dell/dell_os10_ssh.html b/docs/netmiko/dell/dell_os10_ssh.html
index f92a69b7..89d62655 100644
--- a/docs/netmiko/dell/dell_os10_ssh.html
+++ b/docs/netmiko/dell/dell_os10_ssh.html
@@ -297,7 +297,7 @@ class DellOS10FileTransfer(BaseFileTransfer):
</dd>
<dt id="netmiko.dell.dell_os10_ssh.DellOS10SSH"><code class="flex name class">
<span>class <span class="ident">DellOS10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell EMC Networking OS10 Driver - supports dellos10.</p>
diff --git a/docs/netmiko/dell/dell_powerconnect.html b/docs/netmiko/dell/dell_powerconnect.html
index 2b5ea2d1..9f847af6 100644
--- a/docs/netmiko/dell/dell_powerconnect.html
+++ b/docs/netmiko/dell/dell_powerconnect.html
@@ -145,7 +145,7 @@ class DellPowerConnectTelnet(DellPowerConnectBase):
<dl>
<dt id="netmiko.dell.dell_powerconnect.DellPowerConnectBase"><code class="flex name class">
<span>class <span class="ident">DellPowerConnectBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -440,7 +440,7 @@ class DellPowerConnectTelnet(DellPowerConnectBase):
</dd>
<dt id="netmiko.dell.dell_powerconnect.DellPowerConnectSSH"><code class="flex name class">
<span>class <span class="ident">DellPowerConnectSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -727,7 +727,7 @@ If we use login/password, the ssh server use the (none) auth mechanism.</p>
</dd>
<dt id="netmiko.dell.dell_powerconnect.DellPowerConnectTelnet"><code class="flex name class">
<span>class <span class="ident">DellPowerConnectTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Telnet Driver.</p>
diff --git a/docs/netmiko/dell/index.html b/docs/netmiko/dell/index.html
index 122da847..ffadc054 100644
--- a/docs/netmiko/dell/index.html
+++ b/docs/netmiko/dell/index.html
@@ -76,7 +76,7 @@ __all__ = [
<dl>
<dt id="netmiko.dell.DellDNOS6SSH"><code class="flex name class">
<span>class <span class="ident">DellDNOS6SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -272,7 +272,7 @@ __all__ = [
</dd>
<dt id="netmiko.dell.DellDNOS6Telnet"><code class="flex name class">
<span>class <span class="ident">DellDNOS6Telnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -468,7 +468,7 @@ __all__ = [
</dd>
<dt id="netmiko.dell.DellForce10SSH"><code class="flex name class">
<span>class <span class="ident">DellForce10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell Force10 Driver - supports DNOS9.</p>
@@ -695,7 +695,7 @@ __all__ = [
</dd>
<dt id="netmiko.dell.DellIsilonSSH"><code class="flex name class">
<span>class <span class="ident">DellIsilonSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
@@ -1275,7 +1275,7 @@ __all__ = [
</dd>
<dt id="netmiko.dell.DellOS10SSH"><code class="flex name class">
<span>class <span class="ident">DellOS10SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell EMC Networking OS10 Driver - supports dellos10.</p>
@@ -1502,7 +1502,7 @@ __all__ = [
</dd>
<dt id="netmiko.dell.DellPowerConnectSSH"><code class="flex name class">
<span>class <span class="ident">DellPowerConnectSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Driver.</p>
@@ -1789,7 +1789,7 @@ If we use login/password, the ssh server use the (none) auth mechanism.</p>
</dd>
<dt id="netmiko.dell.DellPowerConnectTelnet"><code class="flex name class">
<span>class <span class="ident">DellPowerConnectTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Dell PowerConnect Telnet Driver.</p>
diff --git a/docs/netmiko/dlink/dlink_ds.html b/docs/netmiko/dlink/dlink_ds.html
index 67addb0c..3d06b24d 100644
--- a/docs/netmiko/dlink/dlink_ds.html
+++ b/docs/netmiko/dlink/dlink_ds.html
@@ -100,7 +100,7 @@ class DlinkDSTelnet(DlinkDSBase):
<dl>
<dt id="netmiko.dlink.dlink_ds.DlinkDSBase"><code class="flex name class">
<span>class <span class="ident">DlinkDSBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)</p>
@@ -459,7 +459,7 @@ class DlinkDSTelnet(DlinkDSBase):
</dd>
<dt id="netmiko.dlink.dlink_ds.DlinkDSSSH"><code class="flex name class">
<span>class <span class="ident">DlinkDSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)</p>
diff --git a/docs/netmiko/dlink/index.html b/docs/netmiko/dlink/index.html
index e7982b62..38fbf874 100644
--- a/docs/netmiko/dlink/index.html
+++ b/docs/netmiko/dlink/index.html
@@ -45,7 +45,7 @@ __all__ = ["DlinkDSTelnet", "DlinkDSSSH"]</code></pre>
<dl>
<dt id="netmiko.dlink.DlinkDSSSH"><code class="flex name class">
<span>class <span class="ident">DlinkDSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)</p>
diff --git a/docs/netmiko/eltex/eltex_esr_ssh.html b/docs/netmiko/eltex/eltex_esr_ssh.html
index 4b1f4cdf..c5feb34b 100644
--- a/docs/netmiko/eltex/eltex_esr_ssh.html
+++ b/docs/netmiko/eltex/eltex_esr_ssh.html
@@ -138,7 +138,7 @@ class EltexEsrSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.eltex.eltex_esr_ssh.EltexEsrSSH"><code class="flex name class">
<span>class <span class="ident">EltexEsrSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko support for routers Eltex ESR.</p>
diff --git a/docs/netmiko/eltex/eltex_ssh.html b/docs/netmiko/eltex/eltex_ssh.html
index 01cb343d..c6a8bd05 100644
--- a/docs/netmiko/eltex/eltex_ssh.html
+++ b/docs/netmiko/eltex/eltex_ssh.html
@@ -54,7 +54,7 @@ class EltexSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.eltex.eltex_ssh.EltexSSH"><code class="flex name class">
<span>class <span class="ident">EltexSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/eltex/index.html b/docs/netmiko/eltex/index.html
index 4b347f5e..df4a2d96 100644
--- a/docs/netmiko/eltex/index.html
+++ b/docs/netmiko/eltex/index.html
@@ -50,7 +50,7 @@ __all__ = ["EltexSSH", "EltexEsrSSH"]</code></pre>
<dl>
<dt id="netmiko.eltex.EltexEsrSSH"><code class="flex name class">
<span>class <span class="ident">EltexEsrSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko support for routers Eltex ESR.</p>
@@ -435,7 +435,7 @@ command_string = commit</p></section>
</dd>
<dt id="netmiko.eltex.EltexSSH"><code class="flex name class">
<span>class <span class="ident">EltexSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/endace/endace_ssh.html b/docs/netmiko/endace/endace_ssh.html
index 4e3bded8..0793fba8 100644
--- a/docs/netmiko/endace/endace_ssh.html
+++ b/docs/netmiko/endace/endace_ssh.html
@@ -74,7 +74,7 @@ class EndaceSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.endace.endace_ssh.EndaceSSH"><code class="flex name class">
<span>class <span class="ident">EndaceSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/endace/index.html b/docs/netmiko/endace/index.html
index 083591b7..efcbc258 100644
--- a/docs/netmiko/endace/index.html
+++ b/docs/netmiko/endace/index.html
@@ -45,7 +45,7 @@ __all__ = ["EndaceSSH"]</code></pre>
<dl>
<dt id="netmiko.endace.EndaceSSH"><code class="flex name class">
<span>class <span class="ident">EndaceSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/enterasys/enterasys_ssh.html b/docs/netmiko/enterasys/enterasys_ssh.html
index 0b8da516..ab6fdf14 100644
--- a/docs/netmiko/enterasys/enterasys_ssh.html
+++ b/docs/netmiko/enterasys/enterasys_ssh.html
@@ -56,7 +56,7 @@ class EnterasysSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.enterasys.enterasys_ssh.EnterasysSSH"><code class="flex name class">
<span>class <span class="ident">EnterasysSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Enterasys support.</p>
diff --git a/docs/netmiko/enterasys/index.html b/docs/netmiko/enterasys/index.html
index 537b976b..2b15ddf3 100644
--- a/docs/netmiko/enterasys/index.html
+++ b/docs/netmiko/enterasys/index.html
@@ -45,7 +45,7 @@ __all__ = ["EnterasysSSH"]</code></pre>
<dl>
<dt id="netmiko.enterasys.EnterasysSSH"><code class="flex name class">
<span>class <span class="ident">EnterasysSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Enterasys support.</p>
diff --git a/docs/netmiko/extreme/extreme_ers_ssh.html b/docs/netmiko/extreme/extreme_ers_ssh.html
index aa08fa4a..3fef1897 100644
--- a/docs/netmiko/extreme/extreme_ers_ssh.html
+++ b/docs/netmiko/extreme/extreme_ers_ssh.html
@@ -79,7 +79,7 @@ class ExtremeErsSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.extreme.extreme_ers_ssh.ExtremeErsSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeErsSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko support for Extreme Ethernet Routing Switch.</p>
diff --git a/docs/netmiko/extreme/extreme_exos.html b/docs/netmiko/extreme/extreme_exos.html
index bb8a2a40..e338fe54 100644
--- a/docs/netmiko/extreme/extreme_exos.html
+++ b/docs/netmiko/extreme/extreme_exos.html
@@ -121,7 +121,7 @@ class ExtremeExosTelnet(ExtremeExosBase):
<dl>
<dt id="netmiko.extreme.extreme_exos.ExtremeExosBase"><code class="flex name class">
<span>class <span class="ident">ExtremeExosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme Exos support.</p>
@@ -497,7 +497,7 @@ prompt, eg.</p>
</dd>
<dt id="netmiko.extreme.extreme_exos.ExtremeExosSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeExosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme Exos support.</p>
diff --git a/docs/netmiko/extreme/extreme_netiron.html b/docs/netmiko/extreme/extreme_netiron.html
index 83f01127..fbda2da1 100644
--- a/docs/netmiko/extreme/extreme_netiron.html
+++ b/docs/netmiko/extreme/extreme_netiron.html
@@ -55,7 +55,7 @@ class ExtremeNetironTelnet(ExtremeNetironBase):
<dl>
<dt id="netmiko.extreme.extreme_netiron.ExtremeNetironBase"><code class="flex name class">
<span>class <span class="ident">ExtremeNetironBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -275,7 +275,7 @@ class ExtremeNetironTelnet(ExtremeNetironBase):
</dd>
<dt id="netmiko.extreme.extreme_netiron.ExtremeNetironSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeNetironSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/extreme/extreme_nos_ssh.html b/docs/netmiko/extreme/extreme_nos_ssh.html
index 60f94d29..cd56667d 100644
--- a/docs/netmiko/extreme/extreme_nos_ssh.html
+++ b/docs/netmiko/extreme/extreme_nos_ssh.html
@@ -68,7 +68,7 @@ class ExtremeNosSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.extreme.extreme_nos_ssh.ExtremeNosSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeNosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Extreme NOS/VDX.</p>
diff --git a/docs/netmiko/extreme/extreme_slx_ssh.html b/docs/netmiko/extreme/extreme_slx_ssh.html
index b139cadf..830234f5 100644
--- a/docs/netmiko/extreme/extreme_slx_ssh.html
+++ b/docs/netmiko/extreme/extreme_slx_ssh.html
@@ -68,7 +68,7 @@ class ExtremeSlxSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.extreme.extreme_slx_ssh.ExtremeSlxSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeSlxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Extreme SLX.</p>
diff --git a/docs/netmiko/extreme/extreme_vsp_ssh.html b/docs/netmiko/extreme/extreme_vsp_ssh.html
index f1cfca02..1fcf404f 100644
--- a/docs/netmiko/extreme/extreme_vsp_ssh.html
+++ b/docs/netmiko/extreme/extreme_vsp_ssh.html
@@ -58,7 +58,7 @@ class ExtremeVspSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.extreme.extreme_vsp_ssh.ExtremeVspSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeVspSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme Virtual Services Platform Support.</p>
diff --git a/docs/netmiko/extreme/extreme_wing_ssh.html b/docs/netmiko/extreme/extreme_wing_ssh.html
index 723c5fa8..6cc7afb3 100644
--- a/docs/netmiko/extreme/extreme_wing_ssh.html
+++ b/docs/netmiko/extreme/extreme_wing_ssh.html
@@ -50,7 +50,7 @@ class ExtremeWingSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.extreme.extreme_wing_ssh.ExtremeWingSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeWingSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme WiNG support.</p>
diff --git a/docs/netmiko/extreme/index.html b/docs/netmiko/extreme/index.html
index 62447cc7..439bc2b9 100644
--- a/docs/netmiko/extreme/index.html
+++ b/docs/netmiko/extreme/index.html
@@ -87,7 +87,7 @@ __all__ = [
<dl>
<dt id="netmiko.extreme.ExtremeErsSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeErsSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Netmiko support for Extreme Ethernet Routing Switch.</p>
@@ -366,7 +366,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeExosSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeExosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme Exos support.</p>
@@ -763,7 +763,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeNetironSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeNetironSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -1158,7 +1158,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeNosSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeNosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Extreme NOS/VDX.</p>
@@ -1434,7 +1434,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeSlxSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeSlxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Support for Extreme SLX.</p>
@@ -1710,7 +1710,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeVspSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeVspSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme Virtual Services Platform Support.</p>
@@ -1952,7 +1952,7 @@ __all__ = [
</dd>
<dt id="netmiko.extreme.ExtremeWingSSH"><code class="flex name class">
<span>class <span class="ident">ExtremeWingSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Extreme WiNG support.</p>
diff --git a/docs/netmiko/f5/f5_linux_ssh.html b/docs/netmiko/f5/f5_linux_ssh.html
index cadecb94..a2cf4866 100644
--- a/docs/netmiko/f5/f5_linux_ssh.html
+++ b/docs/netmiko/f5/f5_linux_ssh.html
@@ -40,7 +40,7 @@ class F5LinuxSSH(LinuxSSH):
<dl>
<dt id="netmiko.f5.f5_linux_ssh.F5LinuxSSH"><code class="flex name class">
<span>class <span class="ident">F5LinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/f5/f5_tmsh_ssh.html b/docs/netmiko/f5/f5_tmsh_ssh.html
index f5480a69..13b8848b 100644
--- a/docs/netmiko/f5/f5_tmsh_ssh.html
+++ b/docs/netmiko/f5/f5_tmsh_ssh.html
@@ -62,7 +62,7 @@ class F5TmshSSH(BaseConnection):
<dl>
<dt id="netmiko.f5.f5_tmsh_ssh.F5TmshSSH"><code class="flex name class">
<span>class <span class="ident">F5TmshSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/f5/index.html b/docs/netmiko/f5/index.html
index a6988cdd..61c3d649 100644
--- a/docs/netmiko/f5/index.html
+++ b/docs/netmiko/f5/index.html
@@ -50,7 +50,7 @@ __all__ = ["F5TmshSSH", "F5LinuxSSH"]</code></pre>
<dl>
<dt id="netmiko.f5.F5LinuxSSH"><code class="flex name class">
<span>class <span class="ident">F5LinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -246,7 +246,7 @@ __all__ = ["F5TmshSSH", "F5LinuxSSH"]</code></pre>
</dd>
<dt id="netmiko.f5.F5TmshSSH"><code class="flex name class">
<span>class <span class="ident">F5TmshSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/flexvnf/flexvnf_ssh.html b/docs/netmiko/flexvnf/flexvnf_ssh.html
index 850de9f8..3623008e 100644
--- a/docs/netmiko/flexvnf/flexvnf_ssh.html
+++ b/docs/netmiko/flexvnf/flexvnf_ssh.html
@@ -239,7 +239,7 @@ class FlexvnfSSH(BaseConnection):
<dl>
<dt id="netmiko.flexvnf.flexvnf_ssh.FlexvnfSSH"><code class="flex name class">
<span>class <span class="ident">FlexvnfSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/flexvnf/index.html b/docs/netmiko/flexvnf/index.html
index ede6c736..ee21aea5 100644
--- a/docs/netmiko/flexvnf/index.html
+++ b/docs/netmiko/flexvnf/index.html
@@ -45,7 +45,7 @@ __all__ = ["FlexvnfSSH"]</code></pre>
<dl>
<dt id="netmiko.flexvnf.FlexvnfSSH"><code class="flex name class">
<span>class <span class="ident">FlexvnfSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/fortinet/fortinet_ssh.html b/docs/netmiko/fortinet/fortinet_ssh.html
index 1ed740f9..ad4e086c 100644
--- a/docs/netmiko/fortinet/fortinet_ssh.html
+++ b/docs/netmiko/fortinet/fortinet_ssh.html
@@ -146,7 +146,7 @@ class FortinetSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH"><code class="flex name class">
<span>class <span class="ident">FortinetSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/fortinet/index.html b/docs/netmiko/fortinet/index.html
index 11d0d906..38004bb0 100644
--- a/docs/netmiko/fortinet/index.html
+++ b/docs/netmiko/fortinet/index.html
@@ -45,7 +45,7 @@ __all__ = ["FortinetSSH"]</code></pre>
<dl>
<dt id="netmiko.fortinet.FortinetSSH"><code class="flex name class">
<span>class <span class="ident">FortinetSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/hp/hp_procurve.html b/docs/netmiko/hp/hp_procurve.html
index 4f2a3890..9218645f 100644
--- a/docs/netmiko/hp/hp_procurve.html
+++ b/docs/netmiko/hp/hp_procurve.html
@@ -224,7 +224,7 @@ class HPProcurveTelnet(HPProcurveBase):
<dl>
<dt id="netmiko.hp.hp_procurve.HPProcurveBase"><code class="flex name class">
<span>class <span class="ident">HPProcurveBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -619,7 +619,7 @@ class HPProcurveTelnet(HPProcurveBase):
</dd>
<dt id="netmiko.hp.hp_procurve.HPProcurveSSH"><code class="flex name class">
<span>class <span class="ident">HPProcurveSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -854,7 +854,7 @@ class HPProcurveTelnet(HPProcurveBase):
</dd>
<dt id="netmiko.hp.hp_procurve.HPProcurveTelnet"><code class="flex name class">
<span>class <span class="ident">HPProcurveTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/hp/index.html b/docs/netmiko/hp/index.html
index 3779d98f..45c68f55 100644
--- a/docs/netmiko/hp/index.html
+++ b/docs/netmiko/hp/index.html
@@ -445,7 +445,7 @@ __all__ = ["HPProcurveSSH", "HPProcurveTelnet", "HPComwareSS
</dd>
<dt id="netmiko.hp.HPProcurveSSH"><code class="flex name class">
<span>class <span class="ident">HPProcurveSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -680,7 +680,7 @@ __all__ = ["HPProcurveSSH", "HPProcurveTelnet", "HPComwareSS
</dd>
<dt id="netmiko.hp.HPProcurveTelnet"><code class="flex name class">
<span>class <span class="ident">HPProcurveTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/huawei/huawei.html b/docs/netmiko/huawei/huawei.html
index 1bc6c715..9944c497 100644
--- a/docs/netmiko/huawei/huawei.html
+++ b/docs/netmiko/huawei/huawei.html
@@ -272,7 +272,7 @@ class HuaweiVrpv8SSH(HuaweiSSH):
<dl>
<dt id="netmiko.huawei.huawei.HuaweiBase"><code class="flex name class">
<span>class <span class="ident">HuaweiBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -744,7 +744,7 @@ to move the cursor to the left one.</p>
</dd>
<dt id="netmiko.huawei.huawei.HuaweiSSH"><code class="flex name class">
<span>class <span class="ident">HuaweiSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei SSH driver.</p>
@@ -975,7 +975,7 @@ to move the cursor to the left one.</p>
</dd>
<dt id="netmiko.huawei.huawei.HuaweiTelnet"><code class="flex name class">
<span>class <span class="ident">HuaweiTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei Telnet driver.</p>
@@ -1326,7 +1326,7 @@ to move the cursor to the left one.</p>
</dd>
<dt id="netmiko.huawei.huawei.HuaweiVrpv8SSH"><code class="flex name class">
<span>class <span class="ident">HuaweiVrpv8SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei SSH driver.</p>
diff --git a/docs/netmiko/huawei/huawei_smartax.html b/docs/netmiko/huawei/huawei_smartax.html
index a28f6fa3..bff9051a 100644
--- a/docs/netmiko/huawei/huawei_smartax.html
+++ b/docs/netmiko/huawei/huawei_smartax.html
@@ -117,7 +117,7 @@ class HuaweiSmartAXSSH(CiscoBaseConnection):
<dl>
<dt id="netmiko.huawei.huawei_smartax.HuaweiSmartAXSSH"><code class="flex name class">
<span>class <span class="ident">HuaweiSmartAXSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Supports Huawei SmartAX and OLT.</p>
diff --git a/docs/netmiko/huawei/index.html b/docs/netmiko/huawei/index.html
index 7ce9e910..fe63955a 100644
--- a/docs/netmiko/huawei/index.html
+++ b/docs/netmiko/huawei/index.html
@@ -51,7 +51,7 @@ __all__ = ["HuaweiSmartAXSSH", "HuaweiSSH", "HuaweiVrpv8SSH&
<dl>
<dt id="netmiko.huawei.HuaweiSSH"><code class="flex name class">
<span>class <span class="ident">HuaweiSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei SSH driver.</p>
@@ -282,7 +282,7 @@ __all__ = ["HuaweiSmartAXSSH", "HuaweiSSH", "HuaweiVrpv8SSH&
</dd>
<dt id="netmiko.huawei.HuaweiSmartAXSSH"><code class="flex name class">
<span>class <span class="ident">HuaweiSmartAXSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Supports Huawei SmartAX and OLT.</p>
@@ -620,7 +620,7 @@ The extra space is problematic.</p></section>
</dd>
<dt id="netmiko.huawei.HuaweiTelnet"><code class="flex name class">
<span>class <span class="ident">HuaweiTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei Telnet driver.</p>
@@ -971,7 +971,7 @@ The extra space is problematic.</p></section>
</dd>
<dt id="netmiko.huawei.HuaweiVrpv8SSH"><code class="flex name class">
<span>class <span class="ident">HuaweiVrpv8SSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Huawei SSH driver.</p>
diff --git a/docs/netmiko/index.html b/docs/netmiko/index.html
index 5fa28d43..3a2fd5e6 100644
--- a/docs/netmiko/index.html
+++ b/docs/netmiko/index.html
@@ -42,12 +42,12 @@ from netmiko.ssh_exception import (
)
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 @@ __all__ = (
"BaseConnection",
"Netmiko",
"file_transfer",
+ "progress_bar",
)
# Cisco cntl-shift-six sequence
@@ -249,6 +250,10 @@ CNTL_SHIFT_6 = chr(30)</code></pre>
<dd>
<section class="desc"></section>
</dd>
+<dt><code class="name"><a title="netmiko.raisecom" href="raisecom/index.html">netmiko.raisecom</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
<dt><code class="name"><a title="netmiko.ruckus" href="ruckus/index.html">netmiko.ruckus</a></code></dt>
<dd>
<section class="desc"></section>
@@ -331,12 +336,17 @@ a new SSH connection with a remote host. This …</p></section>
<summary>Source code</summary>
<pre><code class="python">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)</code></pre>
</details>
</dd>
@@ -371,17 +381,22 @@ a new SSH connection with a remote host. This …</p></section>
<summary>Source code</summary>
<pre><code class="python">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)</code></pre>
</details>
</dd>
<dt id="netmiko.file_transfer"><code class="name flex">
-<span>def <span class="ident">file_transfer</span></span>(<span>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)</span>
+<span>def <span class="ident">file_transfer</span></span>(<span>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)</span>
</code></dt>
<dd>
<section class="desc"><p>Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.</p>
@@ -403,6 +418,8 @@ a new SSH connection with a remote host. This …</p></section>
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 @@ a new SSH connection with a remote host. This …</p></section>
"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 @@ a new SSH connection with a remote host. This …</p></section>
return transferred_and_notverified</code></pre>
</details>
</dd>
+<dt id="netmiko.progress_bar"><code class="name flex">
+<span>def <span class="ident">progress_bar</span></span>(<span>filename, size, sent, peername=None)</span>
+</code></dt>
+<dd>
+<section class="desc"></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+</dd>
<dt id="netmiko.redispatch"><code class="name flex">
<span>def <span class="ident">redispatch</span></span>(<span>obj, device_type, session_prep=True)</span>
</code></dt>
@@ -532,7 +581,7 @@ with terminal server.</p></section>
<dl>
<dt id="netmiko.BaseConnection"><code class="flex name class">
<span>class <span class="ident">BaseConnection</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
@@ -698,11 +747,17 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
# 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 @@ with terminal server.</p></section>
# 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 @@ with terminal server.</p></section>
"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 @@ with terminal server.</p></section>
# 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 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
: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 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
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 @@ with terminal server.</p></section>
# 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 @@ with terminal server.</p></section>
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 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
:type height: int</p></section>
<details class="source">
<summary>Source code</summary>
-<pre><code class="python">def establish_connection(self, width=511, height=1000):
- """Establish SSH connection to the network device
+<pre><code class="python"> 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 ""</code></pre>
+ 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 ""</code></pre>
</details>
</dd>
<dt id="netmiko.BaseConnection.exit_config_mode"><code class="name flex">
@@ -3010,7 +3102,6 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
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 @@ Authentication failure will generate a NetmikoAuthenticationException</p>
<pre><code class="python">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</code></pre>
</details>
</dd>
@@ -4033,8 +4124,6 @@ Move cursor position leftward by x characters (1 in this case)</p>
: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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
# 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</code></pre>
</details>
@@ -4220,14 +4312,16 @@ Move cursor position leftward by x characters (1 in this case)</p>
# 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 @@ Move cursor position leftward by x characters (1 in this case)</p>
</dd>
<dt id="netmiko.InLineTransfer"><code class="flex name class">
<span>class <span class="ident">InLineTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, source_file=None, dest_file=None, file_system=None, direction='put', source_config=None, socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Use TCL on Cisco IOS to directly transfer file.</p></section>
@@ -4310,13 +4404,24 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
</dd>
<dt id="netmiko.SCPConn"><code class="flex name class">
<span>class <span class="ident">SCPConn</span></span>
-<span>(</span><span>ssh_conn, socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Establish a secure copy channel to the remote network device.</p>
@@ -4630,9 +4735,11 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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 @@ Move cursor position leftward by x characters (1 in this case)</p>
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,
)</code></pre>
</details>
</dd>
@@ -5063,6 +5176,7 @@ Try to determine the device type.</p>
<li><code><a title="netmiko.pluribus" href="pluribus/index.html">netmiko.pluribus</a></code></li>
<li><code><a title="netmiko.quanta" href="quanta/index.html">netmiko.quanta</a></code></li>
<li><code><a title="netmiko.rad" href="rad/index.html">netmiko.rad</a></code></li>
+<li><code><a title="netmiko.raisecom" href="raisecom/index.html">netmiko.raisecom</a></code></li>
<li><code><a title="netmiko.ruckus" href="ruckus/index.html">netmiko.ruckus</a></code></li>
<li><code><a title="netmiko.ruijie" href="ruijie/index.html">netmiko.ruijie</a></code></li>
<li><code><a title="netmiko.scp_functions" href="scp_functions.html">netmiko.scp_functions</a></code></li>
@@ -5087,6 +5201,7 @@ Try to determine the device type.</p>
<li><code><a title="netmiko.FileTransfer" href="#netmiko.FileTransfer">FileTransfer</a></code></li>
<li><code><a title="netmiko.Netmiko" href="#netmiko.Netmiko">Netmiko</a></code></li>
<li><code><a title="netmiko.file_transfer" href="#netmiko.file_transfer">file_transfer</a></code></li>
+<li><code><a title="netmiko.progress_bar" href="#netmiko.progress_bar">progress_bar</a></code></li>
<li><code><a title="netmiko.redispatch" href="#netmiko.redispatch">redispatch</a></code></li>
<li><code><a title="netmiko.ssh_dispatcher" href="#netmiko.ssh_dispatcher">ssh_dispatcher</a></code></li>
</ul>
diff --git a/docs/netmiko/juniper/index.html b/docs/netmiko/juniper/index.html
index 13f77be8..c6d600cb 100644
--- a/docs/netmiko/juniper/index.html
+++ b/docs/netmiko/juniper/index.html
@@ -131,7 +131,7 @@ __all__ = ["JuniperSSH", "JuniperTelnet", "JuniperFileTransf
</dd>
<dt id="netmiko.juniper.JuniperSSH"><code class="flex name class">
<span>class <span class="ident">JuniperSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Juniper Networks devices.</p>
@@ -284,7 +284,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
<ul class="hlist">
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_config_mode" href="juniper.html#netmiko.juniper.juniper.JuniperBase.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_enable_mode" href="juniper.html#netmiko.juniper.juniper.JuniperBase.check_enable_mode">check_enable_mode</a></code></li>
-<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="juniper.html#netmiko.juniper.juniper.JuniperBase.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.commit" href="juniper.html#netmiko.juniper.juniper.JuniperBase.commit">commit</a></code></li>
@@ -330,7 +330,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
</dd>
<dt id="netmiko.juniper.JuniperScreenOsSSH"><code class="flex name class">
<span>class <span class="ident">JuniperScreenOsSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Juniper ScreenOS devices.</p>
@@ -826,7 +826,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
<ul class="hlist">
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_config_mode" href="juniper.html#netmiko.juniper.juniper.JuniperBase.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_enable_mode" href="juniper.html#netmiko.juniper.juniper.JuniperBase.check_enable_mode">check_enable_mode</a></code></li>
-<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="juniper.html#netmiko.juniper.juniper.JuniperBase.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.commit" href="juniper.html#netmiko.juniper.juniper.JuniperBase.commit">commit</a></code></li>
diff --git a/docs/netmiko/juniper/juniper.html b/docs/netmiko/juniper/juniper.html
index 0322a3dc..9ea1fb27 100644
--- a/docs/netmiko/juniper/juniper.html
+++ b/docs/netmiko/juniper/juniper.html
@@ -252,6 +252,18 @@ class JuniperBase(BaseConnection):
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 JuniperFileTransfer(BaseFileTransfer):
<dl>
<dt id="netmiko.juniper.juniper.JuniperBase"><code class="flex name class">
<span>class <span class="ident">JuniperBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Juniper Networks devices.</p>
@@ -680,7 +692,19 @@ Overrides several methods for Juniper-specific compatibility.</p>
for pattern in strings_to_strip:
if re.search(pattern, last_line):
return self.RESPONSE_RETURN.join(response_list[:-1])
- return a_string</code></pre>
+ 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)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
@@ -717,6 +741,26 @@ Overrides several methods for Juniper-specific compatibility.</p>
pass</code></pre>
</details>
</dd>
+<dt id="netmiko.juniper.juniper.JuniperBase.cleanup"><code class="name flex">
+<span>def <span class="ident">cleanup</span></span>(<span>self, command='exit')</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Gracefully exit the SSH session.</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+</dd>
<dt id="netmiko.juniper.juniper.JuniperBase.commit"><code class="name flex">
<span>def <span class="ident">commit</span></span>(<span>self, confirm=False, confirm_delay=None, check=False, comment='', and_quit=False, delay_factor=1)</span>
</code></dt>
@@ -1000,7 +1044,6 @@ Set the base prompt for interaction ('>').</p></section>
<ul class="hlist">
<li><code><b><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></b></code>:
<ul class="hlist">
-<li><code><a title="netmiko.base_connection.BaseConnection.cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.base_connection.BaseConnection.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.base_connection.BaseConnection.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
<li><code><a title="netmiko.base_connection.BaseConnection.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
@@ -1118,7 +1161,7 @@ Set the base prompt for interaction ('>').</p></section>
</dd>
<dt id="netmiko.juniper.juniper.JuniperSSH"><code class="flex name class">
<span>class <span class="ident">JuniperSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Juniper Networks devices.</p>
@@ -1271,7 +1314,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
<ul class="hlist">
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_config_mode" href="#netmiko.juniper.juniper.JuniperBase.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_enable_mode" href="#netmiko.juniper.juniper.JuniperBase.check_enable_mode">check_enable_mode</a></code></li>
-<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="#netmiko.juniper.juniper.JuniperBase.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.commit" href="#netmiko.juniper.juniper.JuniperBase.commit">commit</a></code></li>
@@ -1473,7 +1516,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
<ul class="hlist">
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_config_mode" href="#netmiko.juniper.juniper.JuniperBase.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_enable_mode" href="#netmiko.juniper.juniper.JuniperBase.check_enable_mode">check_enable_mode</a></code></li>
-<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="#netmiko.juniper.juniper.JuniperBase.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.commit" href="#netmiko.juniper.juniper.JuniperBase.commit">commit</a></code></li>
@@ -1538,6 +1581,7 @@ Overrides several methods for Juniper-specific compatibility.</p>
<ul class="two-column">
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_config_mode" href="#netmiko.juniper.juniper.JuniperBase.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.check_enable_mode" href="#netmiko.juniper.juniper.JuniperBase.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.juniper.juniper.JuniperBase.cleanup" href="#netmiko.juniper.juniper.JuniperBase.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.commit" href="#netmiko.juniper.juniper.JuniperBase.commit">commit</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.config_mode" href="#netmiko.juniper.juniper.JuniperBase.config_mode">config_mode</a></code></li>
<li><code><a title="netmiko.juniper.juniper.JuniperBase.enable" href="#netmiko.juniper.juniper.JuniperBase.enable">enable</a></code></li>
diff --git a/docs/netmiko/juniper/juniper_screenos.html b/docs/netmiko/juniper/juniper_screenos.html
index bce0749e..409d0d1e 100644
--- a/docs/netmiko/juniper/juniper_screenos.html
+++ b/docs/netmiko/juniper/juniper_screenos.html
@@ -85,7 +85,7 @@ class JuniperScreenOsSSH(BaseConnection):
<dl>
<dt id="netmiko.juniper.juniper_screenos.JuniperScreenOsSSH"><code class="flex name class">
<span>class <span class="ident">JuniperScreenOsSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Juniper ScreenOS devices.</p>
diff --git a/docs/netmiko/keymile/index.html b/docs/netmiko/keymile/index.html
index ff3fc269..bf95c733 100644
--- a/docs/netmiko/keymile/index.html
+++ b/docs/netmiko/keymile/index.html
@@ -50,7 +50,7 @@ __all__ = ["KeymileSSH", "KeymileNOSSSH"]</code></pre>
<dl>
<dt id="netmiko.keymile.KeymileNOSSSH"><code class="flex name class">
<span>class <span class="ident">KeymileNOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Common Methods for IOS (both SSH and telnet).</p>
diff --git a/docs/netmiko/keymile/keymile_nos_ssh.html b/docs/netmiko/keymile/keymile_nos_ssh.html
index 9a6f9ecc..dc9f571e 100644
--- a/docs/netmiko/keymile/keymile_nos_ssh.html
+++ b/docs/netmiko/keymile/keymile_nos_ssh.html
@@ -69,7 +69,7 @@ class KeymileNOSSSH(CiscoIosBase):
<dl>
<dt id="netmiko.keymile.keymile_nos_ssh.KeymileNOSSSH"><code class="flex name class">
<span>class <span class="ident">KeymileNOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Common Methods for IOS (both SSH and telnet).</p>
diff --git a/docs/netmiko/linux/index.html b/docs/netmiko/linux/index.html
index c1add5cd..57879222 100644
--- a/docs/netmiko/linux/index.html
+++ b/docs/netmiko/linux/index.html
@@ -148,7 +148,7 @@ __all__ = ["LinuxSSH", "LinuxFileTransfer"]</code></pre>
</dd>
<dt id="netmiko.linux.LinuxSSH"><code class="flex name class">
<span>class <span class="ident">LinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/linux/linux_ssh.html b/docs/netmiko/linux/linux_ssh.html
index 28cd08c1..df220101 100644
--- a/docs/netmiko/linux/linux_ssh.html
+++ b/docs/netmiko/linux/linux_ssh.html
@@ -314,7 +314,7 @@ class LinuxFileTransfer(CiscoFileTransfer):
</dd>
<dt id="netmiko.linux.linux_ssh.LinuxSSH"><code class="flex name class">
<span>class <span class="ident">LinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/mellanox/index.html b/docs/netmiko/mellanox/index.html
index 4969a500..27343370 100644
--- a/docs/netmiko/mellanox/index.html
+++ b/docs/netmiko/mellanox/index.html
@@ -45,7 +45,7 @@ __all__ = ["MellanoxMlnxosSSH"]</code></pre>
<dl>
<dt id="netmiko.mellanox.MellanoxMlnxosSSH"><code class="flex name class">
<span>class <span class="ident">MellanoxMlnxosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Mellanox MLNX-OS Switch support.</p>
diff --git a/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html
index a1c9780e..3706ca0c 100644
--- a/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html
+++ b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html
@@ -97,7 +97,7 @@ class MellanoxMlnxosSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.mellanox.mellanox_mlnxos_ssh.MellanoxMlnxosSSH"><code class="flex name class">
<span>class <span class="ident">MellanoxMlnxosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Mellanox MLNX-OS Switch support.</p>
diff --git a/docs/netmiko/mrv/index.html b/docs/netmiko/mrv/index.html
index 3207c197..7240ff88 100644
--- a/docs/netmiko/mrv/index.html
+++ b/docs/netmiko/mrv/index.html
@@ -50,7 +50,7 @@ __all__ = ["MrvOptiswitchSSH", "MrvLxSSH"]</code></pre>
<dl>
<dt id="netmiko.mrv.MrvLxSSH"><code class="flex name class">
<span>class <span class="ident">MrvLxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>MRV Communications Driver (LX).</p>
@@ -313,7 +313,7 @@ __all__ = ["MrvOptiswitchSSH", "MrvLxSSH"]</code></pre>
</dd>
<dt id="netmiko.mrv.MrvOptiswitchSSH"><code class="flex name class">
<span>class <span class="ident">MrvOptiswitchSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>MRV Communications Driver (OptiSwitch).</p>
diff --git a/docs/netmiko/mrv/mrv_lx.html b/docs/netmiko/mrv/mrv_lx.html
index b3450623..934e8bc2 100644
--- a/docs/netmiko/mrv/mrv_lx.html
+++ b/docs/netmiko/mrv/mrv_lx.html
@@ -69,7 +69,7 @@ class MrvLxSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.mrv.mrv_lx.MrvLxSSH"><code class="flex name class">
<span>class <span class="ident">MrvLxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>MRV Communications Driver (LX).</p>
diff --git a/docs/netmiko/mrv/mrv_ssh.html b/docs/netmiko/mrv/mrv_ssh.html
index 0ca9ac5a..884d51b8 100644
--- a/docs/netmiko/mrv/mrv_ssh.html
+++ b/docs/netmiko/mrv/mrv_ssh.html
@@ -78,7 +78,7 @@ class MrvOptiswitchSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.mrv.mrv_ssh.MrvOptiswitchSSH"><code class="flex name class">
<span>class <span class="ident">MrvOptiswitchSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>MRV Communications Driver (OptiSwitch).</p>
diff --git a/docs/netmiko/netapp/index.html b/docs/netmiko/netapp/index.html
index ad75279f..3068779f 100644
--- a/docs/netmiko/netapp/index.html
+++ b/docs/netmiko/netapp/index.html
@@ -45,7 +45,7 @@ __all__ = ["NetAppcDotSSH"]</code></pre>
<dl>
<dt id="netmiko.netapp.NetAppcDotSSH"><code class="flex name class">
<span>class <span class="ident">NetAppcDotSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/netapp/netapp_cdot_ssh.html b/docs/netmiko/netapp/netapp_cdot_ssh.html
index cd9008f0..8592efbc 100644
--- a/docs/netmiko/netapp/netapp_cdot_ssh.html
+++ b/docs/netmiko/netapp/netapp_cdot_ssh.html
@@ -73,7 +73,7 @@ class NetAppcDotSSH(BaseConnection):
<dl>
<dt id="netmiko.netapp.netapp_cdot_ssh.NetAppcDotSSH"><code class="flex name class">
<span>class <span class="ident">NetAppcDotSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
diff --git a/docs/netmiko/nokia/index.html b/docs/netmiko/nokia/index.html
index 039cb961..60944895 100644
--- a/docs/netmiko/nokia/index.html
+++ b/docs/netmiko/nokia/index.html
@@ -228,7 +228,7 @@ __all__ = ["NokiaSrosSSH", "NokiaSrosFileTransfer"]</code></pre>
</dd>
<dt id="netmiko.nokia.NokiaSrosSSH"><code class="flex name class">
<span>class <span class="ident">NokiaSrosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Nokia SR OS devices.</p>
@@ -474,8 +474,7 @@ __all__ = ["NokiaSrosSSH", "NokiaSrosFileTransfer"]</code></pre>
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."""
@@ -705,8 +704,7 @@ __all__ = ["NokiaSrosSSH", "NokiaSrosFileTransfer"]</code></pre>
<summary>Source code</summary>
<pre><code class="python">def save_config(self, *args, **kwargs):
"""Persist configuration to cflash for Nokia SR OS"""
- output = self.send_command(command_string="/admin save")
- return output</code></pre>
+ return self.send_command(command_string="/admin save", expect_string=r"#")</code></pre>
</details>
</dd>
<dt id="netmiko.nokia.NokiaSrosSSH.send_config_set"><code class="name flex">
diff --git a/docs/netmiko/nokia/nokia_sros_ssh.html b/docs/netmiko/nokia/nokia_sros_ssh.html
index 4c61176f..ac163751 100644
--- a/docs/netmiko/nokia/nokia_sros_ssh.html
+++ b/docs/netmiko/nokia/nokia_sros_ssh.html
@@ -136,8 +136,7 @@ class NokiaSrosSSH(BaseConnection):
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 @@ class NokiaSrosFileTransfer(BaseFileTransfer):
</dd>
<dt id="netmiko.nokia.nokia_sros_ssh.NokiaSrosSSH"><code class="flex name class">
<span>class <span class="ident">NokiaSrosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with Nokia SR OS devices.</p>
@@ -751,8 +750,7 @@ class NokiaSrosFileTransfer(BaseFileTransfer):
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 @@ class NokiaSrosFileTransfer(BaseFileTransfer):
<summary>Source code</summary>
<pre><code class="python">def save_config(self, *args, **kwargs):
"""Persist configuration to cflash for Nokia SR OS"""
- output = self.send_command(command_string="/admin save")
- return output</code></pre>
+ return self.send_command(command_string="/admin save", expect_string=r"#")</code></pre>
</details>
</dd>
<dt id="netmiko.nokia.nokia_sros_ssh.NokiaSrosSSH.send_config_set"><code class="name flex">
diff --git a/docs/netmiko/ovs/index.html b/docs/netmiko/ovs/index.html
index f9cc26d6..73bac68b 100644
--- a/docs/netmiko/ovs/index.html
+++ b/docs/netmiko/ovs/index.html
@@ -45,7 +45,7 @@ __all__ = ["OvsLinuxSSH"]</code></pre>
<dl>
<dt id="netmiko.ovs.OvsLinuxSSH"><code class="flex name class">
<span>class <span class="ident">OvsLinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/ovs/ovs_linux_ssh.html b/docs/netmiko/ovs/ovs_linux_ssh.html
index 785a3864..60bf21ee 100644
--- a/docs/netmiko/ovs/ovs_linux_ssh.html
+++ b/docs/netmiko/ovs/ovs_linux_ssh.html
@@ -40,7 +40,7 @@ class OvsLinuxSSH(LinuxSSH):
<dl>
<dt id="netmiko.ovs.ovs_linux_ssh.OvsLinuxSSH"><code class="flex name class">
<span>class <span class="ident">OvsLinuxSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/paloalto/index.html b/docs/netmiko/paloalto/index.html
index dec4b184..b2e60fdd 100644
--- a/docs/netmiko/paloalto/index.html
+++ b/docs/netmiko/paloalto/index.html
@@ -45,7 +45,7 @@ __all__ = ["PaloAltoPanosSSH", "PaloAltoPanosTelnet"]</code></pr
<dl>
<dt id="netmiko.paloalto.PaloAltoPanosSSH"><code class="flex name class">
<span>class <span class="ident">PaloAltoPanosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with PaloAlto devices.</p>
@@ -243,7 +243,7 @@ Overrides several methods for PaloAlto-specific compatibility.</p>
</dd>
<dt id="netmiko.paloalto.PaloAltoPanosTelnet"><code class="flex name class">
<span>class <span class="ident">PaloAltoPanosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with PaloAlto devices.</p>
diff --git a/docs/netmiko/paloalto/paloalto_panos.html b/docs/netmiko/paloalto/paloalto_panos.html
index be6bc6a7..4954f1d9 100644
--- a/docs/netmiko/paloalto/paloalto_panos.html
+++ b/docs/netmiko/paloalto/paloalto_panos.html
@@ -215,7 +215,7 @@ class PaloAltoPanosTelnet(PaloAltoPanosBase):
<dl>
<dt id="netmiko.paloalto.paloalto_panos.PaloAltoPanosBase"><code class="flex name class">
<span>class <span class="ident">PaloAltoPanosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with PaloAlto devices.</p>
@@ -856,7 +856,7 @@ Set the base prompt for interaction ('>').</p></section>
</dd>
<dt id="netmiko.paloalto.paloalto_panos.PaloAltoPanosSSH"><code class="flex name class">
<span>class <span class="ident">PaloAltoPanosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with PaloAlto devices.</p>
@@ -1054,7 +1054,7 @@ Overrides several methods for PaloAlto-specific compatibility.</p>
</dd>
<dt id="netmiko.paloalto.paloalto_panos.PaloAltoPanosTelnet"><code class="flex name class">
<span>class <span class="ident">PaloAltoPanosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with PaloAlto devices.</p>
diff --git a/docs/netmiko/quanta/index.html b/docs/netmiko/quanta/index.html
index 2be4e071..f8bd86a9 100644
--- a/docs/netmiko/quanta/index.html
+++ b/docs/netmiko/quanta/index.html
@@ -45,7 +45,7 @@ __all__ = ["QuantaMeshSSH"]</code></pre>
<dl>
<dt id="netmiko.quanta.QuantaMeshSSH"><code class="flex name class">
<span>class <span class="ident">QuantaMeshSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/quanta/quanta_mesh_ssh.html b/docs/netmiko/quanta/quanta_mesh_ssh.html
index dcde1e46..f5f38ec3 100644
--- a/docs/netmiko/quanta/quanta_mesh_ssh.html
+++ b/docs/netmiko/quanta/quanta_mesh_ssh.html
@@ -57,7 +57,7 @@ class QuantaMeshSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.quanta.quanta_mesh_ssh.QuantaMeshSSH"><code class="flex name class">
<span>class <span class="ident">QuantaMeshSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/rad/index.html b/docs/netmiko/rad/index.html
index 0d08479f..88670614 100644
--- a/docs/netmiko/rad/index.html
+++ b/docs/netmiko/rad/index.html
@@ -245,7 +245,7 @@ __all__ = ["RadETXSSH", "RadETXTelnet"]</code></pre>
</dd>
<dt id="netmiko.rad.RadETXTelnet"><code class="flex name class">
<span>class <span class="ident">RadETXTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>RAD ETX Telnet Support.</p>
diff --git a/docs/netmiko/rad/rad_etx.html b/docs/netmiko/rad/rad_etx.html
index 2f5c53cb..7e8cb946 100644
--- a/docs/netmiko/rad/rad_etx.html
+++ b/docs/netmiko/rad/rad_etx.html
@@ -121,7 +121,7 @@ class RadETXTelnet(RadETXBase):
<dl>
<dt id="netmiko.rad.rad_etx.RadETXBase"><code class="flex name class">
<span>class <span class="ident">RadETXBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>RAD ETX Support, Tested on RAD 203AX, 205A and 220A.</p>
@@ -663,7 +663,7 @@ class RadETXTelnet(RadETXBase):
</dd>
<dt id="netmiko.rad.rad_etx.RadETXTelnet"><code class="flex name class">
<span>class <span class="ident">RadETXTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>RAD ETX Telnet Support.</p>
diff --git a/docs/netmiko/raisecom/index.html b/docs/netmiko/raisecom/index.html
new file mode 100644
index 00000000..8ea4ed9e
--- /dev/null
+++ b/docs/netmiko/raisecom/index.html
@@ -0,0 +1,622 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.6.3" />
+<title>netmiko.raisecom API documentation</title>
+<meta name="description" content="" />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>netmiko.raisecom</code></h1>
+</header>
+<section id="section-intro">
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">from netmiko.raisecom.raisecom_roap import RaisecomRoapSSH
+from netmiko.raisecom.raisecom_roap import RaisecomRoapTelnet
+
+__all__ = ["RaisecomRoapSSH", "RaisecomRoapTelnet"]</code></pre>
+</details>
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="netmiko.raisecom.raisecom_roap" href="raisecom_roap.html">netmiko.raisecom.raisecom_roap</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="netmiko.raisecom.RaisecomRoapSSH"><code class="flex name class">
+<span>class <span class="ident">RaisecomRoapSSH</span></span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Base Class for cisco-like behavior.</p>
+<pre><code> 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:
+</code></pre>
+<p>).
+:type default_enter: str</p>
+<pre><code> :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+</code></pre>
+<p>)
+:type response_return: str</p>
+<pre><code> :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
+</code></pre></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></li>
+<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
+<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
+</ul>
+<h3>Methods</h3>
+<dl>
+<dt id="netmiko.raisecom.RaisecomRoapSSH.special_login_handler"><code class="name flex">
+<span>def <span class="ident">special_login_handler</span></span>(<span>self, delay_factor=1)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Raisecom presents with the following on login (in certain OS versions)
+Login: user
+Password:****</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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</code></pre>
+</details>
+</dd>
+</dl>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></b></code>:
+<ul class="hlist">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode">check_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.cleanup" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.config_mode">config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.open_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.open_session_log">open_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.save_config" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.save_config">save_config</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation">session_preparation</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+<dt id="netmiko.raisecom.RaisecomRoapTelnet"><code class="flex name class">
+<span>class <span class="ident">RaisecomRoapTelnet</span></span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Base Class for cisco-like behavior.</p>
+<pre><code> 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:
+</code></pre>
+<p>).
+:type default_enter: str</p>
+<pre><code> :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+</code></pre>
+<p>)
+:type response_return: str</p>
+<pre><code> :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
+</code></pre></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></li>
+<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
+<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
+</ul>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></b></code>:
+<ul class="hlist">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode">check_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.cleanup" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.config_mode">config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.open_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.open_session_log">open_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.save_config" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.save_config">save_config</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation" href="raisecom_roap.html#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation">session_preparation</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.special_login_handler" href="../base_connection.html#netmiko.base_connection.BaseConnection.special_login_handler">special_login_handler</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="netmiko" href="../index.html">netmiko</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="netmiko.raisecom.raisecom_roap" href="raisecom_roap.html">netmiko.raisecom.raisecom_roap</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="netmiko.raisecom.RaisecomRoapSSH" href="#netmiko.raisecom.RaisecomRoapSSH">RaisecomRoapSSH</a></code></h4>
+<ul class="">
+<li><code><a title="netmiko.raisecom.RaisecomRoapSSH.special_login_handler" href="#netmiko.raisecom.RaisecomRoapSSH.special_login_handler">special_login_handler</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="netmiko.raisecom.RaisecomRoapTelnet" href="#netmiko.raisecom.RaisecomRoapTelnet">RaisecomRoapTelnet</a></code></h4>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>
\ 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 00000000..31fcfddc
--- /dev/null
+++ b/docs/netmiko/raisecom/raisecom_roap.html
@@ -0,0 +1,1018 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.6.3" />
+<title>netmiko.raisecom.raisecom_roap API documentation</title>
+<meta name="description" content="" />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>netmiko.raisecom.raisecom_roap</code></h1>
+</header>
+<section id="section-intro">
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapBase"><code class="flex name class">
+<span>class <span class="ident">RaisecomRoapBase</span></span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Base Class for cisco-like behavior.</p>
+<pre><code> 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:
+</code></pre>
+<p>).
+:type default_enter: str</p>
+<pre><code> :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+</code></pre>
+<p>)
+:type response_return: str</p>
+<pre><code> :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
+</code></pre></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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
+ )</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
+<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
+</ul>
+<h3>Subclasses</h3>
+<ul class="hlist">
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapSSH" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapSSH">RaisecomRoapSSH</a></li>
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapTelnet" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapTelnet">RaisecomRoapTelnet</a></li>
+</ul>
+<h3>Methods</h3>
+<dl>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode"><code class="name flex">
+<span>def <span class="ident">check_config_mode</span></span>(<span>self, check_string=')#', pattern='#')</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Checks if the device is in configuration mode or not.</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+</dd>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation"><code class="name flex">
+<span>def <span class="ident">session_preparation</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Prepare the session after the connection has been established.</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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()</code></pre>
+</details>
+</dd>
+</dl>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></b></code>:
+<ul class="hlist">
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.cleanup" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.config_mode">config_mode</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.open_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.open_session_log">open_session_log</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.save_config" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.save_config">save_config</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.special_login_handler" href="../base_connection.html#netmiko.base_connection.BaseConnection.special_login_handler">special_login_handler</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
+<li><code><a title="netmiko.cisco_base_connection.CiscoBaseConnection.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapSSH"><code class="flex name class">
+<span>class <span class="ident">RaisecomRoapSSH</span></span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Base Class for cisco-like behavior.</p>
+<pre><code> 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:
+</code></pre>
+<p>).
+:type default_enter: str</p>
+<pre><code> :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+</code></pre>
+<p>)
+:type response_return: str</p>
+<pre><code> :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
+</code></pre></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></li>
+<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
+<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
+</ul>
+<h3>Methods</h3>
+<dl>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapSSH.special_login_handler"><code class="name flex">
+<span>def <span class="ident">special_login_handler</span></span>(<span>self, delay_factor=1)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Raisecom presents with the following on login (in certain OS versions)
+Login: user
+Password:****</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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</code></pre>
+</details>
+</dd>
+</dl>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></b></code>:
+<ul class="hlist">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode">check_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.cleanup" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.config_mode">config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.open_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.open_session_log">open_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.save_config" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.save_config">save_config</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation">session_preparation</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+<dt id="netmiko.raisecom.raisecom_roap.RaisecomRoapTelnet"><code class="flex name class">
+<span>class <span class="ident">RaisecomRoapTelnet</span></span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Base Class for cisco-like behavior.</p>
+<pre><code> 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:
+</code></pre>
+<p>).
+:type default_enter: str</p>
+<pre><code> :param response_return: Character(s) to use in normalized return data to represent
+ enter key (default:
+</code></pre>
+<p>)
+:type response_return: str</p>
+<pre><code> :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
+</code></pre></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></li>
+<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
+<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
+</ul>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></b></code>:
+<ul class="hlist">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode">check_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.cleanup" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.cleanup">cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.close_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.close_session_log">close_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.config_mode">config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disable_paging" href="../base_connection.html#netmiko.base_connection.BaseConnection.disable_paging">disable_paging</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.open_session_log" href="../base_connection.html#netmiko.base_connection.BaseConnection.open_session_log">open_session_log</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.save_config" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.save_config">save_config</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation">session_preparation</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.special_login_handler" href="../base_connection.html#netmiko.base_connection.BaseConnection.special_login_handler">special_login_handler</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="netmiko.raisecom" href="index.html">netmiko.raisecom</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase">RaisecomRoapBase</a></code></h4>
+<ul class="">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.check_config_mode">check_config_mode</a></code></li>
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapBase.session_preparation">session_preparation</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapSSH" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapSSH">RaisecomRoapSSH</a></code></h4>
+<ul class="">
+<li><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapSSH.special_login_handler" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapSSH.special_login_handler">special_login_handler</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="netmiko.raisecom.raisecom_roap.RaisecomRoapTelnet" href="#netmiko.raisecom.raisecom_roap.RaisecomRoapTelnet">RaisecomRoapTelnet</a></code></h4>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/netmiko/ruckus/index.html b/docs/netmiko/ruckus/index.html
index ff945187..c4c9bc63 100644
--- a/docs/netmiko/ruckus/index.html
+++ b/docs/netmiko/ruckus/index.html
@@ -46,7 +46,7 @@ __all__ = ["RuckusFastironSSH", "RuckusFastironTelnet"]</code></
<dl>
<dt id="netmiko.ruckus.RuckusFastironSSH"><code class="flex name class">
<span>class <span class="ident">RuckusFastironSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ruckus FastIron aka ICX support.</p>
diff --git a/docs/netmiko/ruckus/ruckus_fastiron.html b/docs/netmiko/ruckus/ruckus_fastiron.html
index bfe64500..9b6a4565 100644
--- a/docs/netmiko/ruckus/ruckus_fastiron.html
+++ b/docs/netmiko/ruckus/ruckus_fastiron.html
@@ -133,7 +133,7 @@ class RuckusFastironSSH(RuckusFastironBase):
<dl>
<dt id="netmiko.ruckus.ruckus_fastiron.RuckusFastironBase"><code class="flex name class">
<span>class <span class="ident">RuckusFastironBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ruckus FastIron aka ICX support.</p>
@@ -484,7 +484,7 @@ SSH@Lab-ICX7250#</p></section>
</dd>
<dt id="netmiko.ruckus.ruckus_fastiron.RuckusFastironSSH"><code class="flex name class">
<span>class <span class="ident">RuckusFastironSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Ruckus FastIron aka ICX support.</p>
diff --git a/docs/netmiko/ruijie/index.html b/docs/netmiko/ruijie/index.html
index e78fccf0..b775fc10 100644
--- a/docs/netmiko/ruijie/index.html
+++ b/docs/netmiko/ruijie/index.html
@@ -45,7 +45,7 @@ __all__ = ["RuijieOSSSH", "RuijieOSTelnet"]</code></pre>
<dl>
<dt id="netmiko.ruijie.RuijieOSSSH"><code class="flex name class">
<span>class <span class="ident">RuijieOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/ruijie/ruijie_os.html b/docs/netmiko/ruijie/ruijie_os.html
index f65ff3e8..fd77a383 100644
--- a/docs/netmiko/ruijie/ruijie_os.html
+++ b/docs/netmiko/ruijie/ruijie_os.html
@@ -71,7 +71,7 @@ class RuijieOSTelnet(RuijieOSBase):
<dl>
<dt id="netmiko.ruijie.ruijie_os.RuijieOSBase"><code class="flex name class">
<span>class <span class="ident">RuijieOSBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -321,7 +321,7 @@ class RuijieOSTelnet(RuijieOSBase):
</dd>
<dt id="netmiko.ruijie.ruijie_os.RuijieOSSSH"><code class="flex name class">
<span>class <span class="ident">RuijieOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/scp_functions.html b/docs/netmiko/scp_functions.html
index b85b6d7b..87fbf95b 100644
--- a/docs/netmiko/scp_functions.html
+++ b/docs/netmiko/scp_functions.html
@@ -38,6 +38,29 @@ Currently only supports Cisco IOS and Cisco ASA.
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 @@ def file_transfer(
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 @@ def file_transfer(
"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 @@ def file_transfer(
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="netmiko.scp_functions.file_transfer"><code class="name flex">
-<span>def <span class="ident">file_transfer</span></span>(<span>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)</span>
+<span>def <span class="ident">file_transfer</span></span>(<span>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)</span>
</code></dt>
<dd>
<section class="desc"><p>Use Secure Copy or Inline (IOS-only) to transfer files to/from network devices.</p>
@@ -174,6 +201,8 @@ def file_transfer(
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 @@ def file_transfer(
"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 @@ def file_transfer(
return transferred_and_notverified</code></pre>
</details>
</dd>
+<dt id="netmiko.scp_functions.progress_bar"><code class="name flex">
+<span>def <span class="ident">progress_bar</span></span>(<span>filename, size, sent, peername=None)</span>
+</code></dt>
+<dd>
+<section class="desc"></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">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)</code></pre>
+</details>
+</dd>
<dt id="netmiko.scp_functions.verifyspace_and_transferfile"><code class="name flex">
<span>def <span class="ident">verifyspace_and_transferfile</span></span>(<span>scp_transfer)</span>
</code></dt>
@@ -296,6 +357,7 @@ def file_transfer(
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="netmiko.scp_functions.file_transfer" href="#netmiko.scp_functions.file_transfer">file_transfer</a></code></li>
+<li><code><a title="netmiko.scp_functions.progress_bar" href="#netmiko.scp_functions.progress_bar">progress_bar</a></code></li>
<li><code><a title="netmiko.scp_functions.verifyspace_and_transferfile" href="#netmiko.scp_functions.verifyspace_and_transferfile">verifyspace_and_transferfile</a></code></li>
</ul>
</li>
diff --git a/docs/netmiko/scp_handler.html b/docs/netmiko/scp_handler.html
index bb2d1d04..44e75ba8 100644
--- a/docs/netmiko/scp_handler.html
+++ b/docs/netmiko/scp_handler.html
@@ -50,9 +50,11 @@ class SCPConn(object):
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 @@ class SCPConn(object):
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 @@ class BaseFileTransfer(object):
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 @@ class BaseFileTransfer(object):
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 @@ class BaseFileTransfer(object):
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(object):
<dl>
<dt id="netmiko.scp_handler.BaseFileTransfer"><code class="flex name class">
<span>class <span class="ident">BaseFileTransfer</span></span>
-<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, hash_supported=True)</span>
+<span>(</span><span>ssh_conn, source_file, dest_file, file_system=None, direction='put', socket_timeout=10.0, progress=None, progress4=None, hash_supported=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Class to manage SCP file transfer and associated SSH control channel.</p></section>
@@ -438,6 +452,8 @@ class BaseFileTransfer(object):
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 @@ class BaseFileTransfer(object):
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 @@ class BaseFileTransfer(object):
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 @@ def process_md5(md5_output, pattern=r"=\s+(\S+)"):
<summary>Source code</summary>
<pre><code class="python">def establish_scp_conn(self):
"""Establish SCP connection."""
- self.scp_conn = SCPConn(self.ssh_ctl_chan, socket_timeout=self.socket_timeout)</code></pre>
+ self.scp_conn = SCPConn(
+ self.ssh_ctl_chan,
+ socket_timeout=self.socket_timeout,
+ progress=self.progress,
+ progress4=self.progress4,
+ )</code></pre>
</details>
</dd>
<dt id="netmiko.scp_handler.BaseFileTransfer.file_md5"><code class="name flex">
@@ -1120,7 +1148,7 @@ the string</p>
</dd>
<dt id="netmiko.scp_handler.SCPConn"><code class="flex name class">
<span>class <span class="ident">SCPConn</span></span>
-<span>(</span><span>ssh_conn, socket_timeout=10.0)</span>
+<span>(</span><span>ssh_conn, socket_timeout=10.0, progress=None, progress4=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Establish a secure copy channel to the remote network device.</p>
@@ -1134,9 +1162,11 @@ the string</p>
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 @@ the string</p>
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 @@ the string</p>
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,
)</code></pre>
</details>
</dd>
diff --git a/docs/netmiko/sixwind/index.html b/docs/netmiko/sixwind/index.html
index 31d5ad44..87a8b736 100644
--- a/docs/netmiko/sixwind/index.html
+++ b/docs/netmiko/sixwind/index.html
@@ -45,7 +45,7 @@ __all__ = ["SixwindOSSSH"]</code></pre>
<dl>
<dt id="netmiko.sixwind.SixwindOSSSH"><code class="flex name class">
<span>class <span class="ident">SixwindOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/sixwind/sixwind_os.html b/docs/netmiko/sixwind/sixwind_os.html
index 4368a557..883da569 100644
--- a/docs/netmiko/sixwind/sixwind_os.html
+++ b/docs/netmiko/sixwind/sixwind_os.html
@@ -136,7 +136,7 @@ class SixwindOSSSH(SixwindOSBase):
<dl>
<dt id="netmiko.sixwind.sixwind_os.SixwindOSBase"><code class="flex name class">
<span>class <span class="ident">SixwindOSBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -597,7 +597,7 @@ class SixwindOSSSH(SixwindOSBase):
</dd>
<dt id="netmiko.sixwind.sixwind_os.SixwindOSSSH"><code class="flex name class">
<span>class <span class="ident">SixwindOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/sophos/index.html b/docs/netmiko/sophos/index.html
index ee2a4441..026d103f 100644
--- a/docs/netmiko/sophos/index.html
+++ b/docs/netmiko/sophos/index.html
@@ -45,7 +45,7 @@ __all__ = ["SophosSfosSSH"]</code></pre>
<dl>
<dt id="netmiko.sophos.SophosSfosSSH"><code class="flex name class">
<span>class <span class="ident">SophosSfosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/sophos/sophos_sfos_ssh.html b/docs/netmiko/sophos/sophos_sfos_ssh.html
index 722975df..5ca165a6 100644
--- a/docs/netmiko/sophos/sophos_sfos_ssh.html
+++ b/docs/netmiko/sophos/sophos_sfos_ssh.html
@@ -95,7 +95,7 @@ class SophosSfosSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.sophos.sophos_sfos_ssh.SophosSfosSSH"><code class="flex name class">
<span>class <span class="ident">SophosSfosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/terminal_server/index.html b/docs/netmiko/terminal_server/index.html
index aff420a4..26f873dd 100644
--- a/docs/netmiko/terminal_server/index.html
+++ b/docs/netmiko/terminal_server/index.html
@@ -46,7 +46,7 @@ __all__ = ["TerminalServerSSH", "TerminalServerTelnet"]</code></
<dl>
<dt id="netmiko.terminal_server.TerminalServerSSH"><code class="flex name class">
<span>class <span class="ident">TerminalServerSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Generic Terminal Server driver SSH.</p>
@@ -242,7 +242,7 @@ __all__ = ["TerminalServerSSH", "TerminalServerTelnet"]</code></
</dd>
<dt id="netmiko.terminal_server.TerminalServerTelnet"><code class="flex name class">
<span>class <span class="ident">TerminalServerTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Generic Terminal Server driver telnet.</p>
diff --git a/docs/netmiko/terminal_server/terminal_server.html b/docs/netmiko/terminal_server/terminal_server.html
index 0d50dbe1..c3422ca2 100644
--- a/docs/netmiko/terminal_server/terminal_server.html
+++ b/docs/netmiko/terminal_server/terminal_server.html
@@ -67,7 +67,7 @@ class TerminalServerTelnet(TerminalServer):
<dl>
<dt id="netmiko.terminal_server.terminal_server.TerminalServer"><code class="flex name class">
<span>class <span class="ident">TerminalServer</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Generic Terminal Server driver.</p>
@@ -289,7 +289,7 @@ an exception.</p>
</dd>
<dt id="netmiko.terminal_server.terminal_server.TerminalServerSSH"><code class="flex name class">
<span>class <span class="ident">TerminalServerSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Generic Terminal Server driver SSH.</p>
@@ -485,7 +485,7 @@ an exception.</p>
</dd>
<dt id="netmiko.terminal_server.terminal_server.TerminalServerTelnet"><code class="flex name class">
<span>class <span class="ident">TerminalServerTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Generic Terminal Server driver telnet.</p>
diff --git a/docs/netmiko/ubiquiti/edge_ssh.html b/docs/netmiko/ubiquiti/edge_ssh.html
index f24cb61f..4c5ffed5 100644
--- a/docs/netmiko/ubiquiti/edge_ssh.html
+++ b/docs/netmiko/ubiquiti/edge_ssh.html
@@ -81,7 +81,7 @@ class UbiquitiEdgeSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.ubiquiti.edge_ssh.UbiquitiEdgeSSH"><code class="flex name class">
<span>class <span class="ident">UbiquitiEdgeSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Ubiquity EdgeSwitch devices.</p>
diff --git a/docs/netmiko/ubiquiti/index.html b/docs/netmiko/ubiquiti/index.html
index 9aa61b41..f210c049 100644
--- a/docs/netmiko/ubiquiti/index.html
+++ b/docs/netmiko/ubiquiti/index.html
@@ -50,7 +50,7 @@ __all__ = ["UbiquitiEdgeSSH", "UnifiSwitchSSH", "UbiquitiUni
<dl>
<dt id="netmiko.ubiquiti.UbiquitiEdgeSSH"><code class="flex name class">
<span>class <span class="ident">UbiquitiEdgeSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Ubiquity EdgeSwitch devices.</p>
@@ -351,7 +351,7 @@ __all__ = ["UbiquitiEdgeSSH", "UnifiSwitchSSH", "UbiquitiUni
</dd>
<dt id="netmiko.ubiquiti.UbiquitiUnifiSwitchSSH"><code class="flex name class">
<span>class <span class="ident">UbiquitiUnifiSwitchSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Ubiquity EdgeSwitch devices.</p>
diff --git a/docs/netmiko/ubiquiti/unifiswitch_ssh.html b/docs/netmiko/ubiquiti/unifiswitch_ssh.html
index 3b632a9a..b221741c 100644
--- a/docs/netmiko/ubiquiti/unifiswitch_ssh.html
+++ b/docs/netmiko/ubiquiti/unifiswitch_ssh.html
@@ -75,7 +75,7 @@ class UbiquitiUnifiSwitchSSH(UbiquitiEdgeSSH):
<dl>
<dt id="netmiko.ubiquiti.unifiswitch_ssh.UbiquitiUnifiSwitchSSH"><code class="flex name class">
<span>class <span class="ident">UbiquitiUnifiSwitchSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements support for Ubiquity EdgeSwitch devices.</p>
diff --git a/docs/netmiko/vyos/index.html b/docs/netmiko/vyos/index.html
index 923a6df6..63eba10d 100644
--- a/docs/netmiko/vyos/index.html
+++ b/docs/netmiko/vyos/index.html
@@ -45,7 +45,7 @@ __all__ = ["VyOSSSH"]</code></pre>
<dl>
<dt id="netmiko.vyos.VyOSSSH"><code class="flex name class">
<span>class <span class="ident">VyOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with VyOS network devices.</p>
diff --git a/docs/netmiko/vyos/vyos_ssh.html b/docs/netmiko/vyos/vyos_ssh.html
index 1e57a3c2..ac665440 100644
--- a/docs/netmiko/vyos/vyos_ssh.html
+++ b/docs/netmiko/vyos/vyos_ssh.html
@@ -141,7 +141,7 @@ class VyOSSSH(CiscoSSHConnection):
<dl>
<dt id="netmiko.vyos.vyos_ssh.VyOSSSH"><code class="flex name class">
<span>class <span class="ident">VyOSSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implement methods for interacting with VyOS network devices.</p>
diff --git a/docs/netmiko/watchguard/fireware_ssh.html b/docs/netmiko/watchguard/fireware_ssh.html
index 98f766c6..0258b3b1 100644
--- a/docs/netmiko/watchguard/fireware_ssh.html
+++ b/docs/netmiko/watchguard/fireware_ssh.html
@@ -71,7 +71,7 @@ class WatchguardFirewareSSH(BaseConnection):
<dl>
<dt id="netmiko.watchguard.fireware_ssh.WatchguardFirewareSSH"><code class="flex name class">
<span>class <span class="ident">WatchguardFirewareSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements methods for communicating with Watchguard Firebox firewalls.</p>
diff --git a/docs/netmiko/watchguard/index.html b/docs/netmiko/watchguard/index.html
index b5a39688..83594f1b 100644
--- a/docs/netmiko/watchguard/index.html
+++ b/docs/netmiko/watchguard/index.html
@@ -45,7 +45,7 @@ __all__ = ["WatchguardFirewareSSH"]</code></pre>
<dl>
<dt id="netmiko.watchguard.WatchguardFirewareSSH"><code class="flex name class">
<span>class <span class="ident">WatchguardFirewareSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Implements methods for communicating with Watchguard Firebox firewalls.</p>
diff --git a/docs/netmiko/yamaha/index.html b/docs/netmiko/yamaha/index.html
index 1a89b3e9..de577155 100644
--- a/docs/netmiko/yamaha/index.html
+++ b/docs/netmiko/yamaha/index.html
@@ -46,7 +46,7 @@ __all__ = ["YamahaSSH", "YamahaTelnet"]</code></pre>
<dl>
<dt id="netmiko.yamaha.YamahaSSH"><code class="flex name class">
<span>class <span class="ident">YamahaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Yamaha SSH driver.</p>
@@ -242,7 +242,7 @@ __all__ = ["YamahaSSH", "YamahaTelnet"]</code></pre>
</dd>
<dt id="netmiko.yamaha.YamahaTelnet"><code class="flex name class">
<span>class <span class="ident">YamahaTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Yamaha Telnet driver.</p>
diff --git a/docs/netmiko/yamaha/yamaha.html b/docs/netmiko/yamaha/yamaha.html
index 39e5665f..df28b093 100644
--- a/docs/netmiko/yamaha/yamaha.html
+++ b/docs/netmiko/yamaha/yamaha.html
@@ -105,7 +105,7 @@ class YamahaTelnet(YamahaBase):
<dl>
<dt id="netmiko.yamaha.yamaha.YamahaBase"><code class="flex name class">
<span>class <span class="ident">YamahaBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Defines vendor independent methods.</p>
@@ -451,7 +451,7 @@ appears before exiting. Ignore this by entering 'N'.</p></section>
</dd>
<dt id="netmiko.yamaha.yamaha.YamahaSSH"><code class="flex name class">
<span>class <span class="ident">YamahaSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Yamaha SSH driver.</p>
@@ -647,7 +647,7 @@ appears before exiting. Ignore this by entering 'N'.</p></section>
</dd>
<dt id="netmiko.yamaha.yamaha.YamahaTelnet"><code class="flex name class">
<span>class <span class="ident">YamahaTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Yamaha Telnet driver.</p>
diff --git a/docs/netmiko/zte/index.html b/docs/netmiko/zte/index.html
index ee6632b0..ab7170fe 100644
--- a/docs/netmiko/zte/index.html
+++ b/docs/netmiko/zte/index.html
@@ -46,7 +46,7 @@ __all__ = ["ZteZxrosSSH", "ZteZxrosTelnet"]</code></pre>
<dl>
<dt id="netmiko.zte.ZteZxrosSSH"><code class="flex name class">
<span>class <span class="ident">ZteZxrosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -241,7 +241,7 @@ __all__ = ["ZteZxrosSSH", "ZteZxrosTelnet"]</code></pre>
</dd>
<dt id="netmiko.zte.ZteZxrosTelnet"><code class="flex name class">
<span>class <span class="ident">ZteZxrosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
diff --git a/docs/netmiko/zte/zte_zxros.html b/docs/netmiko/zte/zte_zxros.html
index 0e4a1f26..357ce04f 100644
--- a/docs/netmiko/zte/zte_zxros.html
+++ b/docs/netmiko/zte/zte_zxros.html
@@ -93,7 +93,7 @@ class ZteZxrosTelnet(ZteZxrosBase):
<dl>
<dt id="netmiko.zte.zte_zxros.ZteZxrosBase"><code class="flex name class">
<span>class <span class="ident">ZteZxrosBase</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -356,7 +356,7 @@ class ZteZxrosTelnet(ZteZxrosBase):
</dd>
<dt id="netmiko.zte.zte_zxros.ZteZxrosSSH"><code class="flex name class">
<span>class <span class="ident">ZteZxrosSSH</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
@@ -551,7 +551,7 @@ class ZteZxrosTelnet(ZteZxrosBase):
</dd>
<dt id="netmiko.zte.zte_zxros.ZteZxrosTelnet"><code class="flex name class">
<span>class <span class="ident">ZteZxrosTelnet</span></span>
-<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
+<span>(</span><span>ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=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)</span>
</code></dt>
<dd>
<section class="desc"><p>Base Class for cisco-like behavior.</p>
--
GitLab