From bc3650ada2b9eee7a95fe3bb5926a23e2b11e8d4 Mon Sep 17 00:00:00 2001 From: Kirk Byers Date: Fri, 17 Nov 2023 09:36:42 -0800 Subject: [PATCH] Update Docs --- docs/netmiko/a10/a10_ssh.html | 10 +- docs/netmiko/a10/index.html | 10 +- docs/netmiko/accedian/accedian_ssh.html | 10 +- docs/netmiko/accedian/index.html | 10 +- docs/netmiko/adtran/adtran.html | 145 +++- docs/netmiko/adtran/index.html | 18 +- docs/netmiko/alcatel/alcatel_aos_ssh.html | 10 +- docs/netmiko/alcatel/index.html | 10 +- .../allied_telesis/allied_telesis_awplus.html | 20 +- docs/netmiko/allied_telesis/index.html | 10 +- docs/netmiko/apresia/apresia_aeos.html | 28 +- docs/netmiko/apresia/index.html | 18 +- docs/netmiko/arista/arista.html | 28 +- docs/netmiko/arista/index.html | 18 +- docs/netmiko/arris/arris_cer.html | 20 +- docs/netmiko/arris/index.html | 20 +- docs/netmiko/aruba/aruba_ssh.html | 8 +- docs/netmiko/aruba/index.html | 8 +- docs/netmiko/audiocode/audiocode_ssh.html | 80 +- docs/netmiko/audiocode/index.html | 48 +- docs/netmiko/base_connection.html | 156 +++- docs/netmiko/broadcom/broadcom_icos_ssh.html | 10 +- docs/netmiko/broadcom/index.html | 10 +- docs/netmiko/calix/calix_b6.html | 24 +- docs/netmiko/calix/index.html | 16 +- docs/netmiko/casa/casa_cmts.html | 20 +- docs/netmiko/casa/index.html | 20 +- docs/netmiko/cdot/cdot_cros_ssh.html | 10 +- docs/netmiko/cdot/index.html | 10 +- docs/netmiko/centec/centec_os.html | 30 +- docs/netmiko/centec/index.html | 20 +- .../checkpoint/checkpoint_gaia_ssh.html | 10 +- docs/netmiko/checkpoint/index.html | 10 +- docs/netmiko/ciena/ciena_saos.html | 34 +- docs/netmiko/ciena/index.html | 18 +- docs/netmiko/cisco/cisco_asa_ssh.html | 8 +- docs/netmiko/cisco/cisco_ftd_ssh.html | 10 +- docs/netmiko/cisco/cisco_ios.html | 40 +- docs/netmiko/cisco/cisco_nxos_ssh.html | 10 +- docs/netmiko/cisco/cisco_s200.html | 30 +- docs/netmiko/cisco/cisco_s300.html | 30 +- docs/netmiko/cisco/cisco_tp_tcce.html | 8 +- docs/netmiko/cisco/cisco_viptela.html | 10 +- docs/netmiko/cisco/cisco_wlc_ssh.html | 10 +- docs/netmiko/cisco/cisco_xr.html | 30 +- docs/netmiko/cisco/index.html | 156 ++-- docs/netmiko/cisco_base_connection.html | 23 +- docs/netmiko/citrix/index.html | 10 +- docs/netmiko/citrix/netscaler_ssh.html | 10 +- docs/netmiko/cloudgenix/cloudgenix_ion.html | 10 +- docs/netmiko/cloudgenix/index.html | 10 +- docs/netmiko/coriant/coriant_ssh.html | 10 +- docs/netmiko/coriant/index.html | 10 +- docs/netmiko/dell/dell_dnos6.html | 30 +- docs/netmiko/dell/dell_force10_ssh.html | 10 +- docs/netmiko/dell/dell_isilon_ssh.html | 10 +- docs/netmiko/dell/dell_os10_ssh.html | 10 +- docs/netmiko/dell/dell_powerconnect.html | 30 +- docs/netmiko/dell/dell_sonic_ssh.html | 10 +- docs/netmiko/dell/index.html | 80 +- docs/netmiko/digi/digi_transport.html | 272 +++++++ docs/netmiko/digi/index.html | 161 ++++ docs/netmiko/dlink/dlink_ds.html | 28 +- docs/netmiko/dlink/index.html | 18 +- docs/netmiko/eltex/eltex_esr_ssh.html | 10 +- docs/netmiko/eltex/eltex_ssh.html | 10 +- docs/netmiko/eltex/index.html | 20 +- docs/netmiko/endace/endace_ssh.html | 10 +- docs/netmiko/endace/index.html | 10 +- docs/netmiko/enterasys/enterasys_ssh.html | 10 +- docs/netmiko/enterasys/index.html | 10 +- docs/netmiko/ericsson/ericsson_ipos.html | 10 +- docs/netmiko/ericsson/index.html | 10 +- docs/netmiko/extreme/extreme_ers_ssh.html | 34 +- docs/netmiko/extreme/extreme_exos.html | 28 +- docs/netmiko/extreme/extreme_netiron.html | 28 +- docs/netmiko/extreme/extreme_nos_ssh.html | 10 +- docs/netmiko/extreme/extreme_slx_ssh.html | 10 +- .../netmiko/extreme/extreme_tierraos_ssh.html | 10 +- docs/netmiko/extreme/extreme_vsp_ssh.html | 10 +- docs/netmiko/extreme/extreme_wing_ssh.html | 10 +- docs/netmiko/extreme/index.html | 112 ++- docs/netmiko/f5/f5_linux_ssh.html | 10 +- docs/netmiko/f5/f5_tmsh_ssh.html | 10 +- docs/netmiko/f5/index.html | 20 +- docs/netmiko/fiberstore/fiberstore_fsos.html | 526 +++++++++++++ docs/netmiko/fiberstore/index.html | 432 ++++++++++ docs/netmiko/flexvnf/flexvnf_ssh.html | 10 +- docs/netmiko/flexvnf/index.html | 10 +- docs/netmiko/fortinet/fortinet_ssh.html | 26 +- docs/netmiko/fortinet/index.html | 18 +- docs/netmiko/hillstone/hillstone.html | 20 +- docs/netmiko/hillstone/index.html | 10 +- docs/netmiko/hp/hp_comware.html | 39 +- docs/netmiko/hp/hp_procurve.html | 30 +- docs/netmiko/hp/index.html | 32 +- docs/netmiko/huawei/huawei.html | 60 +- docs/netmiko/huawei/huawei_smartax.html | 10 +- docs/netmiko/huawei/index.html | 50 +- docs/netmiko/index.html | 125 ++- docs/netmiko/ipinfusion/index.html | 16 +- docs/netmiko/ipinfusion/ipinfusion_ocnos.html | 24 +- docs/netmiko/juniper/index.html | 28 +- docs/netmiko/juniper/juniper.html | 28 +- docs/netmiko/juniper/juniper_screenos.html | 10 +- docs/netmiko/keymile/index.html | 10 +- docs/netmiko/keymile/keymile_nos_ssh.html | 10 +- docs/netmiko/linux/index.html | 10 +- docs/netmiko/linux/linux_ssh.html | 10 +- docs/netmiko/maipu/index.html | 465 +++++++++++ docs/netmiko/maipu/maipu.html | 737 ++++++++++++++++++ docs/netmiko/mellanox/index.html | 10 +- .../netmiko/mellanox/mellanox_mlnxos_ssh.html | 10 +- docs/netmiko/mikrotik/mikrotik_ssh.html | 12 +- docs/netmiko/mrv/index.html | 20 +- docs/netmiko/mrv/mrv_lx.html | 10 +- docs/netmiko/mrv/mrv_ssh.html | 10 +- docs/netmiko/netapp/index.html | 10 +- docs/netmiko/netapp/netapp_cdot_ssh.html | 10 +- docs/netmiko/netgear/index.html | 8 +- docs/netmiko/netgear/netgear_prosafe_ssh.html | 8 +- docs/netmiko/no_config.html | 1 + docs/netmiko/no_enable.html | 2 + docs/netmiko/nokia/index.html | 30 +- docs/netmiko/nokia/nokia_srl.html | 10 +- docs/netmiko/nokia/nokia_sros.html | 36 +- docs/netmiko/ovs/index.html | 10 +- docs/netmiko/ovs/ovs_linux_ssh.html | 10 +- docs/netmiko/paloalto/index.html | 20 +- docs/netmiko/paloalto/paloalto_panos.html | 30 +- docs/netmiko/quanta/index.html | 10 +- docs/netmiko/quanta/quanta_mesh_ssh.html | 10 +- docs/netmiko/rad/index.html | 18 +- docs/netmiko/rad/rad_etx.html | 28 +- docs/netmiko/raisecom/index.html | 20 +- docs/netmiko/raisecom/raisecom_roap.html | 30 +- docs/netmiko/ruckus/index.html | 18 +- docs/netmiko/ruckus/ruckus_fastiron.html | 28 +- docs/netmiko/ruijie/index.html | 18 +- docs/netmiko/ruijie/ruijie_os.html | 28 +- docs/netmiko/scp_handler.html | 9 +- docs/netmiko/session_log.html | 148 +++- docs/netmiko/sixwind/index.html | 10 +- docs/netmiko/sixwind/sixwind_os.html | 20 +- docs/netmiko/snmp_autodetect.html | 133 +++- docs/netmiko/sophos/index.html | 10 +- docs/netmiko/sophos/sophos_sfos_ssh.html | 10 +- docs/netmiko/ssh_autodetect.html | 24 +- docs/netmiko/supermicro/index.html | 20 +- docs/netmiko/supermicro/smci_smis.html | 30 +- docs/netmiko/teldat/index.html | 20 +- docs/netmiko/teldat/teldat_cit.html | 30 +- docs/netmiko/telnet_proxy.html | 304 ++++++++ docs/netmiko/terminal_server/index.html | 20 +- .../terminal_server/terminal_server.html | 30 +- docs/netmiko/tplink/index.html | 20 +- docs/netmiko/tplink/tplink_jetstream.html | 65 +- docs/netmiko/ubiquiti/edge_ssh.html | 10 +- docs/netmiko/ubiquiti/edgerouter_ssh.html | 10 +- docs/netmiko/ubiquiti/index.html | 30 +- docs/netmiko/ubiquiti/unifiswitch_ssh.html | 10 +- docs/netmiko/utilities.html | 10 +- docs/netmiko/vyos/index.html | 14 +- docs/netmiko/vyos/vyos_ssh.html | 18 +- docs/netmiko/watchguard/fireware_ssh.html | 10 +- docs/netmiko/watchguard/index.html | 10 +- docs/netmiko/yamaha/index.html | 18 +- docs/netmiko/yamaha/yamaha.html | 28 +- docs/netmiko/zte/index.html | 20 +- docs/netmiko/zte/zte_zxros.html | 30 +- docs/netmiko/zyxel/index.html | 10 +- docs/netmiko/zyxel/zyxel_ssh.html | 10 +- 172 files changed, 5699 insertions(+), 1056 deletions(-) create mode 100644 docs/netmiko/digi/digi_transport.html create mode 100644 docs/netmiko/digi/index.html create mode 100644 docs/netmiko/fiberstore/fiberstore_fsos.html create mode 100644 docs/netmiko/fiberstore/index.html create mode 100644 docs/netmiko/maipu/index.html create mode 100644 docs/netmiko/maipu/maipu.html create mode 100644 docs/netmiko/telnet_proxy.html diff --git a/docs/netmiko/a10/a10_ssh.html b/docs/netmiko/a10/a10_ssh.html index 881e26abe..348d2b42d 100644 --- a/docs/netmiko/a10/a10_ssh.html +++ b/docs/netmiko/a10/a10_ssh.html @@ -62,7 +62,7 @@

Classes

class A10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

A10 support.

@@ -149,7 +149,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -162,11 +163,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/a10/index.html b/docs/netmiko/a10/index.html index 67c855d2e..4deeb6205 100644 --- a/docs/netmiko/a10/index.html +++ b/docs/netmiko/a10/index.html @@ -49,7 +49,7 @@

Classes

class A10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

A10 support.

@@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/accedian/accedian_ssh.html b/docs/netmiko/accedian/accedian_ssh.html index 7c18aafb4..0a392c2bf 100644 --- a/docs/netmiko/accedian/accedian_ssh.html +++ b/docs/netmiko/accedian/accedian_ssh.html @@ -71,7 +71,7 @@

Classes

class AccedianSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Class for platforms that have no enable mode.

@@ -165,7 +165,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -178,11 +179,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/accedian/index.html b/docs/netmiko/accedian/index.html index 2f5adf1e5..6e7d0dc91 100644 --- a/docs/netmiko/accedian/index.html +++ b/docs/netmiko/accedian/index.html @@ -49,7 +49,7 @@

Classes

class AccedianSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Class for platforms that have no enable mode.

@@ -143,7 +143,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/adtran/adtran.html b/docs/netmiko/adtran/adtran.html index 4a8fd9f44..1b157201b 100644 --- a/docs/netmiko/adtran/adtran.html +++ b/docs/netmiko/adtran/adtran.html @@ -29,16 +29,12 @@

Module netmiko.adtran.adtran

from typing import Any, Optional
 import re
 from netmiko.cisco_base_connection import CiscoBaseConnection
+from netmiko.exceptions import NetmikoTimeoutException
 
 
 class AdtranOSBase(CiscoBaseConnection):
     prompt_pattern = r"[>#]"
 
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        if kwargs.get("global_cmd_verify") is None:
-            kwargs["global_cmd_verify"] = False
-        return super().__init__(*args, **kwargs)
-
     def session_preparation(self) -> None:
         """Prepare the session after the connection has been established."""
         self.ansi_escape_codes = True
@@ -59,14 +55,55 @@ 

Module netmiko.adtran.adtran

check_state: bool = True, re_flags: int = re.IGNORECASE, ) -> str: - return super().enable( - cmd=cmd, - pattern=pattern, - enable_pattern=enable_pattern, - check_state=check_state, - re_flags=re_flags, + output = "" + msg = ( + "Failed to enter enable mode. Please ensure you pass " + "the 'secret' argument to ConnectHandler." ) + # Check if in enable mode already. + if check_state and self.check_enable_mode(): + return output + + # Send "enable" mode command + self.write_channel(self.normalize_cmd(cmd)) + try: + # Read the command echo + if self.global_cmd_verify is not False: + output += self.read_until_pattern(pattern=re.escape(cmd.strip())) + + # Search for trailing prompt or password pattern + output += self.read_until_prompt_or_pattern( + pattern=pattern, re_flags=re_flags + ) + + # Send the "secret" in response to password pattern + if re.search(pattern, output): + self.write_channel(self.normalize_cmd(self.secret)) + + # Handle the fallback to local authentication case + fallback_pattern = r"Falling back" + new_output = self.read_until_prompt_or_pattern( + pattern=fallback_pattern, re_flags=re_flags + ) + output += new_output + + if "Falling back" in new_output: + self.write_channel(self.normalize_cmd(self.secret)) + output += self.read_until_prompt() + + # Search for terminating pattern if defined + if enable_pattern and not re.search(enable_pattern, output): + output += self.read_until_pattern(pattern=enable_pattern) + else: + if not self.check_enable_mode(): + raise ValueError(msg) + + except NetmikoTimeoutException: + raise ValueError(msg) + + return output + def exit_enable_mode(self, exit_command: str = "disable") -> str: return super().exit_enable_mode(exit_command=exit_command) @@ -123,7 +160,7 @@

Classes

class AdtranOSBase -(*args: Any, **kwargs: Any) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -210,7 +247,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -223,11 +261,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -249,11 +290,6 @@

Classes

class AdtranOSBase(CiscoBaseConnection):
     prompt_pattern = r"[>#]"
 
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        if kwargs.get("global_cmd_verify") is None:
-            kwargs["global_cmd_verify"] = False
-        return super().__init__(*args, **kwargs)
-
     def session_preparation(self) -> None:
         """Prepare the session after the connection has been established."""
         self.ansi_escape_codes = True
@@ -274,14 +310,55 @@ 

Classes

check_state: bool = True, re_flags: int = re.IGNORECASE, ) -> str: - return super().enable( - cmd=cmd, - pattern=pattern, - enable_pattern=enable_pattern, - check_state=check_state, - re_flags=re_flags, + output = "" + msg = ( + "Failed to enter enable mode. Please ensure you pass " + "the 'secret' argument to ConnectHandler." ) + # Check if in enable mode already. + if check_state and self.check_enable_mode(): + return output + + # Send "enable" mode command + self.write_channel(self.normalize_cmd(cmd)) + try: + # Read the command echo + if self.global_cmd_verify is not False: + output += self.read_until_pattern(pattern=re.escape(cmd.strip())) + + # Search for trailing prompt or password pattern + output += self.read_until_prompt_or_pattern( + pattern=pattern, re_flags=re_flags + ) + + # Send the "secret" in response to password pattern + if re.search(pattern, output): + self.write_channel(self.normalize_cmd(self.secret)) + + # Handle the fallback to local authentication case + fallback_pattern = r"Falling back" + new_output = self.read_until_prompt_or_pattern( + pattern=fallback_pattern, re_flags=re_flags + ) + output += new_output + + if "Falling back" in new_output: + self.write_channel(self.normalize_cmd(self.secret)) + output += self.read_until_prompt() + + # Search for terminating pattern if defined + if enable_pattern and not re.search(enable_pattern, output): + output += self.read_until_pattern(pattern=enable_pattern) + else: + if not self.check_enable_mode(): + raise ValueError(msg) + + except NetmikoTimeoutException: + raise ValueError(msg) + + return output + def exit_enable_mode(self, exit_command: str = "disable") -> str: return super().exit_enable_mode(exit_command=exit_command) @@ -421,7 +498,7 @@

Inherited members

class AdtranOSSSH -(*args: Any, **kwargs: Any) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -508,7 +585,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -521,11 +599,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -691,7 +772,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -704,11 +786,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/adtran/index.html b/docs/netmiko/adtran/index.html index d690a0f13..2ab1ac752 100644 --- a/docs/netmiko/adtran/index.html +++ b/docs/netmiko/adtran/index.html @@ -49,7 +49,7 @@

Classes

class AdtranOSSSH -(*args: Any, **kwargs: Any) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -319,7 +323,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -332,11 +337,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/alcatel/alcatel_aos_ssh.html b/docs/netmiko/alcatel/alcatel_aos_ssh.html index 316d7cb7a..fd67d123d 100644 --- a/docs/netmiko/alcatel/alcatel_aos_ssh.html +++ b/docs/netmiko/alcatel/alcatel_aos_ssh.html @@ -64,7 +64,7 @@

Classes

class AlcatelAosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).

@@ -151,7 +151,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -164,11 +165,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/alcatel/index.html b/docs/netmiko/alcatel/index.html index 605db1aa4..e9de54c4a 100644 --- a/docs/netmiko/alcatel/index.html +++ b/docs/netmiko/alcatel/index.html @@ -49,7 +49,7 @@

Classes

class AlcatelAosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Alcatel-Lucent Enterprise AOS support (AOS6 and AOS8).

@@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/allied_telesis/allied_telesis_awplus.html b/docs/netmiko/allied_telesis/allied_telesis_awplus.html index 18f43505f..17797dbf4 100644 --- a/docs/netmiko/allied_telesis/allied_telesis_awplus.html +++ b/docs/netmiko/allied_telesis/allied_telesis_awplus.html @@ -85,7 +85,7 @@

Classes

class AlliedTelesisAwplusBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Implement methods for interacting with Allied Telesis devices.

@@ -172,7 +172,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -185,11 +186,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -358,7 +362,7 @@

Inherited members

class AlliedTelesisAwplusSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Implement methods for interacting with Allied Telesis devices.

@@ -445,7 +449,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -458,11 +463,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/allied_telesis/index.html b/docs/netmiko/allied_telesis/index.html index 304bf5f76..5e2a13d46 100644 --- a/docs/netmiko/allied_telesis/index.html +++ b/docs/netmiko/allied_telesis/index.html @@ -49,7 +49,7 @@

Classes

class AlliedTelesisAwplusSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Implement methods for interacting with Allied Telesis devices.

@@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/apresia/apresia_aeos.html b/docs/netmiko/apresia/apresia_aeos.html index b82ba3b8a..b1d44c421 100644 --- a/docs/netmiko/apresia/apresia_aeos.html +++ b/docs/netmiko/apresia/apresia_aeos.html @@ -83,7 +83,7 @@

Classes

class ApresiaAeosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -170,7 +170,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -183,11 +184,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -316,7 +320,7 @@

Inherited members

class ApresiaAeosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -403,7 +407,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -416,11 +421,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -587,7 +595,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -600,11 +609,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/apresia/index.html b/docs/netmiko/apresia/index.html index 4a7e9911f..b214cab60 100644 --- a/docs/netmiko/apresia/index.html +++ b/docs/netmiko/apresia/index.html @@ -49,7 +49,7 @@

Classes

class ApresiaAeosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -320,7 +324,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -333,11 +338,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/arista/arista.html b/docs/netmiko/arista/arista.html index 54c3b28ca..857e02a34 100644 --- a/docs/netmiko/arista/arista.html +++ b/docs/netmiko/arista/arista.html @@ -209,7 +209,7 @@

Classes

class AristaBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -296,7 +296,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -309,11 +310,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -701,7 +705,7 @@

Inherited members

class AristaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -788,7 +792,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -801,11 +806,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -972,7 +980,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -985,11 +994,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/arista/index.html b/docs/netmiko/arista/index.html index 58719d2b1..058e4c65f 100644 --- a/docs/netmiko/arista/index.html +++ b/docs/netmiko/arista/index.html @@ -145,7 +145,7 @@

Inherited members

class AristaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Base Class for cisco-like behavior.

@@ -232,7 +232,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -245,11 +246,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -416,7 +420,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -429,11 +434,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/arris/arris_cer.html b/docs/netmiko/arris/arris_cer.html index 73845117b..89d1a8e1d 100644 --- a/docs/netmiko/arris/arris_cer.html +++ b/docs/netmiko/arris/arris_cer.html @@ -78,7 +78,7 @@

Classes

class ArrisCERBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Arris CER Support.

@@ -166,7 +166,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -179,11 +180,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -339,7 +343,7 @@

Inherited members

class ArrisCERSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Arris CER SSH Driver.

@@ -426,7 +430,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -439,11 +444,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/arris/index.html b/docs/netmiko/arris/index.html index b2a7cf62d..948b6a9e1 100644 --- a/docs/netmiko/arris/index.html +++ b/docs/netmiko/arris/index.html @@ -49,7 +49,7 @@

Classes

class ArrisCERBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Arris CER Support.

@@ -137,7 +137,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -310,7 +314,7 @@

Inherited members

class ArrisCERSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Arris CER SSH Driver.

@@ -397,7 +401,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -410,11 +415,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/aruba/aruba_ssh.html b/docs/netmiko/aruba/aruba_ssh.html index f8c601b5d..e1089bf30 100644 --- a/docs/netmiko/aruba/aruba_ssh.html +++ b/docs/netmiko/aruba/aruba_ssh.html @@ -181,7 +181,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -194,11 +195,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/aruba/index.html b/docs/netmiko/aruba/index.html index 1b1211cd0..fecf5e266 100644 --- a/docs/netmiko/aruba/index.html +++ b/docs/netmiko/aruba/index.html @@ -136,7 +136,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/audiocode/audiocode_ssh.html b/docs/netmiko/audiocode/audiocode_ssh.html index 20ce32390..ed2a3a644 100644 --- a/docs/netmiko/audiocode/audiocode_ssh.html +++ b/docs/netmiko/audiocode/audiocode_ssh.html @@ -628,7 +628,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -641,11 +642,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -811,7 +815,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -824,11 +829,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -994,7 +1002,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1007,11 +1016,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1233,7 +1245,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1246,11 +1259,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1416,7 +1432,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1429,11 +1446,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1599,7 +1619,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1612,11 +1633,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2083,7 +2107,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2096,11 +2121,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2321,7 +2349,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2334,11 +2363,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2676,7 +2708,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2689,11 +2722,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2860,7 +2896,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2873,11 +2910,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/audiocode/index.html b/docs/netmiko/audiocode/index.html index e1e60a874..47150dd0c 100644 --- a/docs/netmiko/audiocode/index.html +++ b/docs/netmiko/audiocode/index.html @@ -150,7 +150,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -163,11 +164,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -333,7 +337,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -346,11 +351,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -516,7 +524,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -529,11 +538,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -699,7 +711,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -712,11 +725,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -882,7 +898,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -895,11 +912,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1066,7 +1086,8 @@

Inherited members

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1079,11 +1100,14 @@

Inherited members

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/base_connection.html b/docs/netmiko/base_connection.html index 22eed35c0..74cd45057 100644 --- a/docs/netmiko/base_connection.html +++ b/docs/netmiko/base_connection.html @@ -93,6 +93,7 @@

Module netmiko.base_connection

calc_old_timeout, ) from netmiko.utilities import m_exec_time # noqa +from netmiko import telnet_proxy if TYPE_CHECKING: from os import PathLike @@ -134,6 +135,20 @@

Module netmiko.base_connection

return cast(F, wrapper_decorator) +def flush_session_log(func: F) -> F: + @functools.wraps(func) + def wrapper_decorator(self: "BaseConnection", *args: Any, **kwargs: Any) -> Any: + try: + return_val = func(self, *args, **kwargs) + finally: + # Always flush the session_log + if self.session_log: + self.session_log.flush() + return return_val + + return cast(F, wrapper_decorator) + + def log_writes(func: F) -> F: """Handle both session_log and log of writes.""" @@ -213,6 +228,7 @@

Module netmiko.base_connection

allow_auto_change: bool = False, encoding: str = "utf-8", sock: Optional[socket.socket] = None, + sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False, @@ -299,7 +315,8 @@

Module netmiko.base_connection

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -312,11 +329,14 @@

Module netmiko.base_connection

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a `.Channel`) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :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. @@ -383,6 +403,7 @@

Module netmiko.base_connection

self.allow_auto_change = allow_auto_change self.encoding = encoding self.sock = sock + self.sock_telnet = sock_telnet self.fast_cli = fast_cli self._legacy_mode = _legacy_mode self.global_delay_factor = global_delay_factor @@ -398,6 +419,7 @@

Module netmiko.base_connection

no_log["password"] = self.password if self.secret: no_log["secret"] = self.secret + # Always sanitize username and password log.addFilter(SecretsFilter(no_log=no_log)) # Netmiko will close the session_log if we open the file @@ -418,10 +440,14 @@

Module netmiko.base_connection

no_log=no_log, record_writes=session_log_record_writes, ) + elif isinstance(session_log, SessionLog): + # SessionLog object + self.session_log = session_log + self.session_log.open() else: raise ValueError( "session_log must be a path to a file, a file handle, " - "or a BufferedIOBase subclass." + "SessionLog object, or a BufferedIOBase subclass." ) # Default values @@ -699,7 +725,6 @@

Module netmiko.base_connection

start_time = time.time() # if read_timeout == 0 or 0.0 keep reading indefinitely while (time.time() - start_time < read_timeout) or (not read_timeout): - output += self.read_channel() if re.search(pattern, output, flags=re_flags): @@ -1116,9 +1141,17 @@

Module netmiko.base_connection

""" self.channel: Channel if self.protocol == "telnet": - self.remote_conn = telnetlib.Telnet( - self.host, port=self.port, timeout=self.timeout - ) + if self.sock_telnet: + self.remote_conn = telnet_proxy.Telnet( + self.host, + port=self.port, + timeout=self.timeout, + proxy_dict=self.sock_telnet, + ) + else: + self.remote_conn = telnetlib.Telnet( + self.host, port=self.port, timeout=self.timeout + ) # Migrating communication to channel class self.channel = TelnetChannel(conn=self.remote_conn, encoding=self.encoding) self.telnet_login() @@ -1479,7 +1512,6 @@

Module netmiko.base_connection

return output def command_echo_read(self, cmd: str, read_timeout: float) -> str: - # Make sure you read until you detect the command echo (avoid getting out of sync) new_data = self.read_until_pattern( pattern=re.escape(cmd), read_timeout=read_timeout @@ -1496,6 +1528,7 @@

Module netmiko.base_connection

pass return new_data + @flush_session_log @select_cmd_verify def send_command_timing( self, @@ -1644,6 +1677,7 @@

Module netmiko.base_connection

prompt = self.base_prompt return re.escape(prompt.strip()) + @flush_session_log @select_cmd_verify def send_command( self, @@ -2167,6 +2201,7 @@

Module netmiko.base_connection

commands = cfg_file.readlines() return self.send_config_set(commands, **kwargs) + @flush_session_log def send_config_set( self, config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None, @@ -2536,6 +2571,29 @@

Module netmiko.base_connection

Functions

+
+def flush_session_log(func: ~F) ‑> ~F +
+
+
+
+ +Expand source code + +
def flush_session_log(func: F) -> F:
+    @functools.wraps(func)
+    def wrapper_decorator(self: "BaseConnection", *args: Any, **kwargs: Any) -> Any:
+        try:
+            return_val = func(self, *args, **kwargs)
+        finally:
+            # Always flush the session_log
+            if self.session_log:
+                self.session_log.flush()
+        return return_val
+
+    return cast(F, wrapper_decorator)
+
+
def lock_channel(func: ~F) ‑> ~F
@@ -2598,7 +2656,7 @@

Classes

class BaseConnection -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Defines vendor independent methods.

@@ -2686,7 +2744,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2699,11 +2758,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2778,6 +2840,7 @@

Classes

allow_auto_change: bool = False, encoding: str = "utf-8", sock: Optional[socket.socket] = None, + sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False, @@ -2864,7 +2927,8 @@

Classes

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2877,11 +2941,14 @@

Classes

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a `.Channel`) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :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. @@ -2948,6 +3015,7 @@

Classes

self.allow_auto_change = allow_auto_change self.encoding = encoding self.sock = sock + self.sock_telnet = sock_telnet self.fast_cli = fast_cli self._legacy_mode = _legacy_mode self.global_delay_factor = global_delay_factor @@ -2963,6 +3031,7 @@

Classes

no_log["password"] = self.password if self.secret: no_log["secret"] = self.secret + # Always sanitize username and password log.addFilter(SecretsFilter(no_log=no_log)) # Netmiko will close the session_log if we open the file @@ -2983,10 +3052,14 @@

Classes

no_log=no_log, record_writes=session_log_record_writes, ) + elif isinstance(session_log, SessionLog): + # SessionLog object + self.session_log = session_log + self.session_log.open() else: raise ValueError( "session_log must be a path to a file, a file handle, " - "or a BufferedIOBase subclass." + "SessionLog object, or a BufferedIOBase subclass." ) # Default values @@ -3264,7 +3337,6 @@

Classes

start_time = time.time() # if read_timeout == 0 or 0.0 keep reading indefinitely while (time.time() - start_time < read_timeout) or (not read_timeout): - output += self.read_channel() if re.search(pattern, output, flags=re_flags): @@ -3681,9 +3753,17 @@

Classes

""" self.channel: Channel if self.protocol == "telnet": - self.remote_conn = telnetlib.Telnet( - self.host, port=self.port, timeout=self.timeout - ) + if self.sock_telnet: + self.remote_conn = telnet_proxy.Telnet( + self.host, + port=self.port, + timeout=self.timeout, + proxy_dict=self.sock_telnet, + ) + else: + self.remote_conn = telnetlib.Telnet( + self.host, port=self.port, timeout=self.timeout + ) # Migrating communication to channel class self.channel = TelnetChannel(conn=self.remote_conn, encoding=self.encoding) self.telnet_login() @@ -4044,7 +4124,6 @@

Classes

return output def command_echo_read(self, cmd: str, read_timeout: float) -> str: - # Make sure you read until you detect the command echo (avoid getting out of sync) new_data = self.read_until_pattern( pattern=re.escape(cmd), read_timeout=read_timeout @@ -4061,6 +4140,7 @@

Classes

pass return new_data + @flush_session_log @select_cmd_verify def send_command_timing( self, @@ -4209,6 +4289,7 @@

Classes

prompt = self.base_prompt return re.escape(prompt.strip()) + @flush_session_log @select_cmd_verify def send_command( self, @@ -4732,6 +4813,7 @@

Classes

commands = cfg_file.readlines() return self.send_config_set(commands, **kwargs) + @flush_session_log def send_config_set( self, config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None, @@ -5269,7 +5351,6 @@

Methods

Expand source code
def command_echo_read(self, cmd: str, read_timeout: float) -> str:
-
     # Make sure you read until you detect the command echo (avoid getting out of sync)
     new_data = self.read_until_pattern(
         pattern=re.escape(cmd), read_timeout=read_timeout
@@ -5539,9 +5620,17 @@ 

Methods

""" self.channel: Channel if self.protocol == "telnet": - self.remote_conn = telnetlib.Telnet( - self.host, port=self.port, timeout=self.timeout - ) + if self.sock_telnet: + self.remote_conn = telnet_proxy.Telnet( + self.host, + port=self.port, + timeout=self.timeout, + proxy_dict=self.sock_telnet, + ) + else: + self.remote_conn = telnetlib.Telnet( + self.host, port=self.port, timeout=self.timeout + ) # Migrating communication to channel class self.channel = TelnetChannel(conn=self.remote_conn, encoding=self.encoding) self.telnet_login() @@ -6077,7 +6166,6 @@

Methods

start_time = time.time() # if read_timeout == 0 or 0.0 keep reading indefinitely while (time.time() - start_time < read_timeout) or (not read_timeout): - output += self.read_channel() if re.search(pattern, output, flags=re_flags): @@ -6330,7 +6418,8 @@

Methods

Expand source code -
    @select_cmd_verify
+
    @flush_session_log
+    @select_cmd_verify
     def send_command(
         self,
         command_string: str,
@@ -6572,7 +6661,8 @@ 

Methods

Expand source code -
@select_cmd_verify
+
@flush_session_log
+@select_cmd_verify
 def send_command_timing(
     self,
     command_string: str,
@@ -6726,7 +6816,8 @@ 

Methods

Expand source code -
def send_config_set(
+
@flush_session_log
+def send_config_set(
     self,
     config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None,
     *,
@@ -7586,7 +7677,7 @@ 

Methods

class TelnetConnection -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Defines vendor independent methods.

@@ -7674,7 +7765,8 @@

Methods

to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -7687,11 +7779,14 @@

Methods

(default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -7782,6 +7877,7 @@

Index

  • Functions

    diff --git a/docs/netmiko/broadcom/broadcom_icos_ssh.html b/docs/netmiko/broadcom/broadcom_icos_ssh.html index 138eda1e0..43643ad50 100644 --- a/docs/netmiko/broadcom/broadcom_icos_ssh.html +++ b/docs/netmiko/broadcom/broadcom_icos_ssh.html @@ -88,7 +88,7 @@

    Classes

    class BroadcomIcosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Broadcom Icos devices. @@ -176,7 +176,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -189,11 +190,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/broadcom/index.html b/docs/netmiko/broadcom/index.html index 951e649e1..62cc0cff4 100644 --- a/docs/netmiko/broadcom/index.html +++ b/docs/netmiko/broadcom/index.html @@ -50,7 +50,7 @@

    Classes

    class BroadcomIcosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Broadcom Icos devices. @@ -138,7 +138,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -151,11 +152,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/calix/calix_b6.html b/docs/netmiko/calix/calix_b6.html index 199cac654..0d4b31dd6 100644 --- a/docs/netmiko/calix/calix_b6.html +++ b/docs/netmiko/calix/calix_b6.html @@ -239,7 +239,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -252,11 +253,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -576,7 +580,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -589,11 +594,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -783,7 +791,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -796,11 +805,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/calix/index.html b/docs/netmiko/calix/index.html index 8f6c2e545..96abb4a57 100644 --- a/docs/netmiko/calix/index.html +++ b/docs/netmiko/calix/index.html @@ -138,7 +138,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -151,11 +152,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -345,7 +349,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -358,11 +363,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/casa/casa_cmts.html b/docs/netmiko/casa/casa_cmts.html index dacf1d5a3..67159baba 100644 --- a/docs/netmiko/casa/casa_cmts.html +++ b/docs/netmiko/casa/casa_cmts.html @@ -106,7 +106,7 @@

    Classes

    class CasaCMTSBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Casa CMTS support.

    @@ -194,7 +194,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -207,11 +208,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -434,7 +438,7 @@

    Inherited members

    class CasaCMTSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Casa CMTS SSH Driver.

    @@ -521,7 +525,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -534,11 +539,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/casa/index.html b/docs/netmiko/casa/index.html index d83c3f0fc..f07b5fa47 100644 --- a/docs/netmiko/casa/index.html +++ b/docs/netmiko/casa/index.html @@ -49,7 +49,7 @@

    Classes

    class CasaCMTSBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Casa CMTS support.

    @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -377,7 +381,7 @@

    Inherited members

    class CasaCMTSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Casa CMTS SSH Driver.

    @@ -464,7 +468,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -477,11 +482,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cdot/cdot_cros_ssh.html b/docs/netmiko/cdot/cdot_cros_ssh.html index 5aaa3e7e4..657f6358e 100644 --- a/docs/netmiko/cdot/cdot_cros_ssh.html +++ b/docs/netmiko/cdot/cdot_cros_ssh.html @@ -157,7 +157,7 @@

    Classes

    class CdotCrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with CROS network devices.

    @@ -244,7 +244,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -257,11 +258,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cdot/index.html b/docs/netmiko/cdot/index.html index 3184c52ac..2bd6d23eb 100644 --- a/docs/netmiko/cdot/index.html +++ b/docs/netmiko/cdot/index.html @@ -49,7 +49,7 @@

    Classes

    class CdotCrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with CROS network devices.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/centec/centec_os.html b/docs/netmiko/centec/centec_os.html index 7cc1d14b0..aadf3543f 100644 --- a/docs/netmiko/centec/centec_os.html +++ b/docs/netmiko/centec/centec_os.html @@ -68,7 +68,7 @@

    Classes

    class CentecOSBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -155,7 +155,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -168,11 +169,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -302,7 +306,7 @@

    Inherited members

    class CentecOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -389,7 +393,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -402,11 +407,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -486,7 +494,7 @@

    Inherited members

    class CentecOSTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -573,7 +581,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -586,11 +595,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/centec/index.html b/docs/netmiko/centec/index.html index 90572912f..feb8bf4fb 100644 --- a/docs/netmiko/centec/index.html +++ b/docs/netmiko/centec/index.html @@ -49,7 +49,7 @@

    Classes

    class CentecOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -233,7 +237,7 @@

    Inherited members

    class CentecOSTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -320,7 +324,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -333,11 +338,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html index e5634025d..053922572 100644 --- a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html +++ b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html @@ -63,7 +63,7 @@

    Classes

    class CheckPointGaiaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements methods for communicating with Check Point Gaia @@ -151,7 +151,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -164,11 +165,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/checkpoint/index.html b/docs/netmiko/checkpoint/index.html index 65cbafeca..0e0f0788f 100644 --- a/docs/netmiko/checkpoint/index.html +++ b/docs/netmiko/checkpoint/index.html @@ -49,7 +49,7 @@

    Classes

    class CheckPointGaiaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements methods for communicating with Check Point Gaia @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ciena/ciena_saos.html b/docs/netmiko/ciena/ciena_saos.html index 8ebd655f6..d129c8b6f 100644 --- a/docs/netmiko/ciena/ciena_saos.html +++ b/docs/netmiko/ciena/ciena_saos.html @@ -57,7 +57,7 @@

    Module netmiko.ciena.ciena_saos

    prompt = self.find_prompt(delay_factor=delay_factor) pattern = rf"^.+{self.prompt_pattern}$" - if re.search(pattern, prompt): + if not re.search(pattern, prompt): raise ValueError(f"Router prompt not found: {repr(prompt)}") # Strip off trailing terminator self.base_prompt = prompt[:-1] @@ -258,7 +258,7 @@

    Classes

    class CienaSaosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ciena SAOS support.

    @@ -346,7 +346,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -359,11 +360,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -402,7 +406,7 @@

    Classes

    prompt = self.find_prompt(delay_factor=delay_factor) pattern = rf"^.+{self.prompt_pattern}$" - if re.search(pattern, prompt): + if not re.search(pattern, prompt): raise ValueError(f"Router prompt not found: {repr(prompt)}") # Strip off trailing terminator self.base_prompt = prompt[:-1] @@ -497,7 +501,7 @@

    Methods

    prompt = self.find_prompt(delay_factor=delay_factor) pattern = rf"^.+{self.prompt_pattern}$" - if re.search(pattern, prompt): + if not re.search(pattern, prompt): raise ValueError(f"Router prompt not found: {repr(prompt)}") # Strip off trailing terminator self.base_prompt = prompt[:-1] @@ -797,7 +801,7 @@

    Inherited members

    class CienaSaosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ciena SAOS support.

    @@ -885,7 +889,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -898,11 +903,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1070,7 +1078,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1083,11 +1092,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ciena/index.html b/docs/netmiko/ciena/index.html index 5636ea9a6..2aaa8ff3a 100644 --- a/docs/netmiko/ciena/index.html +++ b/docs/netmiko/ciena/index.html @@ -296,7 +296,7 @@

    Inherited members

    class CienaSaosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ciena SAOS support.

    @@ -384,7 +384,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -397,11 +398,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -569,7 +573,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -582,11 +587,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_asa_ssh.html b/docs/netmiko/cisco/cisco_asa_ssh.html index 48b2ea847..9fa53494e 100644 --- a/docs/netmiko/cisco/cisco_asa_ssh.html +++ b/docs/netmiko/cisco/cisco_asa_ssh.html @@ -353,7 +353,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -366,11 +367,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_ftd_ssh.html b/docs/netmiko/cisco/cisco_ftd_ssh.html index 5895b8c23..9f16a152a 100644 --- a/docs/netmiko/cisco/cisco_ftd_ssh.html +++ b/docs/netmiko/cisco/cisco_ftd_ssh.html @@ -64,7 +64,7 @@

    Classes

    class CiscoFtdSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Subclass specific to Cisco FTD.

    @@ -151,7 +151,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -164,11 +165,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_ios.html b/docs/netmiko/cisco/cisco_ios.html index b1a09f011..597d2e35c 100644 --- a/docs/netmiko/cisco/cisco_ios.html +++ b/docs/netmiko/cisco/cisco_ios.html @@ -330,7 +330,7 @@

    Classes

    class CiscoIosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Common Methods for IOS (both SSH and telnet).

    @@ -417,7 +417,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -430,11 +431,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -708,7 +712,7 @@

    Inherited members

    class CiscoIosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS SSH driver.

    @@ -795,7 +799,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -808,11 +813,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -893,7 +901,7 @@

    Inherited members

    class CiscoIosSerial -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS Serial driver.

    @@ -980,7 +988,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -993,11 +1002,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1078,7 +1090,7 @@

    Inherited members

    class CiscoIosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS Telnet driver.

    @@ -1165,7 +1177,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1178,11 +1191,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_nxos_ssh.html b/docs/netmiko/cisco/cisco_nxos_ssh.html index abd84692a..c83c12a5f 100644 --- a/docs/netmiko/cisco/cisco_nxos_ssh.html +++ b/docs/netmiko/cisco/cisco_nxos_ssh.html @@ -387,7 +387,7 @@

    Inherited members

    class CiscoNxosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -474,7 +474,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -487,11 +488,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_s200.html b/docs/netmiko/cisco/cisco_s200.html index 3de677f41..eaf5f52e9 100644 --- a/docs/netmiko/cisco/cisco_s200.html +++ b/docs/netmiko/cisco/cisco_s200.html @@ -143,7 +143,7 @@

    Classes

    class CiscoS200Base -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG200 series of devices.

    @@ -233,7 +233,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -246,11 +247,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -500,7 +504,7 @@

    Inherited members

    class CiscoS200SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG200 series of devices.

    @@ -590,7 +594,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -603,11 +608,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -687,7 +695,7 @@

    Inherited members

    class CiscoS200Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG200 series of devices.

    @@ -777,7 +785,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -790,11 +799,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_s300.html b/docs/netmiko/cisco/cisco_s300.html index eb4ee45ff..9bd0dbf73 100644 --- a/docs/netmiko/cisco/cisco_s300.html +++ b/docs/netmiko/cisco/cisco_s300.html @@ -82,7 +82,7 @@

    Classes

    class CiscoS300Base -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG300 series of devices.

    @@ -172,7 +172,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -185,11 +186,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -318,7 +322,7 @@

    Inherited members

    class CiscoS300SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG300 series of devices.

    @@ -408,7 +412,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -421,11 +426,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -505,7 +513,7 @@

    Inherited members

    class CiscoS300Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG300 series of devices, with telnet. @@ -593,7 +601,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -606,11 +615,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_tp_tcce.html b/docs/netmiko/cisco/cisco_tp_tcce.html index 20bc17be2..db7eccdd8 100644 --- a/docs/netmiko/cisco/cisco_tp_tcce.html +++ b/docs/netmiko/cisco/cisco_tp_tcce.html @@ -222,7 +222,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -235,11 +236,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_viptela.html b/docs/netmiko/cisco/cisco_viptela.html index 378fac506..81a751854 100644 --- a/docs/netmiko/cisco/cisco_viptela.html +++ b/docs/netmiko/cisco/cisco_viptela.html @@ -122,7 +122,7 @@

    Classes

    class CiscoViptelaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Subclass specific to Cisco Viptela.

    @@ -209,7 +209,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -222,11 +223,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_wlc_ssh.html b/docs/netmiko/cisco/cisco_wlc_ssh.html index ecf9cb019..37f1f08b7 100644 --- a/docs/netmiko/cisco/cisco_wlc_ssh.html +++ b/docs/netmiko/cisco/cisco_wlc_ssh.html @@ -300,7 +300,7 @@

    Classes

    class CiscoWlcSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko Cisco WLC support.

    @@ -387,7 +387,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -400,11 +401,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/cisco_xr.html b/docs/netmiko/cisco/cisco_xr.html index 9026064ff..5b7105cf1 100644 --- a/docs/netmiko/cisco/cisco_xr.html +++ b/docs/netmiko/cisco/cisco_xr.html @@ -300,7 +300,7 @@

    Classes

    class CiscoXrBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -387,7 +387,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -400,11 +401,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1130,7 +1134,7 @@

    Inherited members

    class CiscoXrSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco XR SSH driver.

    @@ -1217,7 +1221,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1230,11 +1235,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1315,7 +1323,7 @@

    Inherited members

    class CiscoXrTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco XR Telnet driver.

    @@ -1402,7 +1410,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1415,11 +1424,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco/index.html b/docs/netmiko/cisco/index.html index fea7e9caa..2d3f24238 100644 --- a/docs/netmiko/cisco/index.html +++ b/docs/netmiko/cisco/index.html @@ -259,7 +259,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -272,11 +273,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -733,7 +737,7 @@

    Inherited members

    class CiscoFtdSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Subclass specific to Cisco FTD.

    @@ -820,7 +824,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -833,11 +838,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -978,7 +986,7 @@

    Inherited members

    class CiscoIosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Common Methods for IOS (both SSH and telnet).

    @@ -1065,7 +1073,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1078,11 +1087,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1356,7 +1368,7 @@

    Inherited members

    class CiscoIosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS SSH driver.

    @@ -1443,7 +1455,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1456,11 +1469,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1541,7 +1557,7 @@

    Inherited members

    class CiscoIosSerial -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS Serial driver.

    @@ -1628,7 +1644,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1641,11 +1658,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1726,7 +1746,7 @@

    Inherited members

    class CiscoIosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco IOS Telnet driver.

    @@ -1813,7 +1833,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1826,11 +1847,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2080,7 +2104,7 @@

    Inherited members

    class CiscoNxosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -2167,7 +2191,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2180,11 +2205,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2361,7 +2389,7 @@

    Inherited members

    class CiscoS200SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG200 series of devices.

    @@ -2451,7 +2479,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2464,11 +2493,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2548,7 +2580,7 @@

    Inherited members

    class CiscoS200Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG200 series of devices.

    @@ -2638,7 +2670,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2651,11 +2684,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2735,7 +2771,7 @@

    Inherited members

    class CiscoS300SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG300 series of devices.

    @@ -2825,7 +2861,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2838,11 +2875,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2922,7 +2962,7 @@

    Inherited members

    class CiscoS300Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Cisco SG300 series of devices, with telnet. @@ -3010,7 +3050,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -3023,11 +3064,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -3199,7 +3243,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -3212,11 +3257,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -3512,7 +3560,7 @@

    Inherited members

    class CiscoViptelaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Subclass specific to Cisco Viptela.

    @@ -3599,7 +3647,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -3612,11 +3661,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -3841,7 +3893,7 @@

    Inherited members

    class CiscoWlcSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko Cisco WLC support.

    @@ -3928,7 +3980,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -3941,11 +3994,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -4698,7 +4754,7 @@

    Inherited members

    class CiscoXrSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco XR SSH driver.

    @@ -4785,7 +4841,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -4798,11 +4855,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -4883,7 +4943,7 @@

    Inherited members

    class CiscoXrTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Cisco XR Telnet driver.

    @@ -4970,7 +5030,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -4983,11 +5044,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cisco_base_connection.html b/docs/netmiko/cisco_base_connection.html index a9e52a5a6..8d53083c0 100644 --- a/docs/netmiko/cisco_base_connection.html +++ b/docs/netmiko/cisco_base_connection.html @@ -311,7 +311,7 @@

    Classes

    class CiscoBaseConnection -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -398,7 +398,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -411,11 +412,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -707,6 +711,7 @@

    Subclasses

  • HuaweiBase
  • HuaweiSmartAXSSH
  • IpInfusionOcNOSBase
  • +
  • MaipuBase
  • OneaccessOneOSBase
  • RaisecomRoapBase
  • RuijieOSBase
  • @@ -1117,7 +1122,7 @@

    Inherited members

    class CiscoSSHConnection -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -1204,7 +1209,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1217,11 +1223,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1275,6 +1284,7 @@

    Subclasses

  • DellForce10SSH
  • DellOS10SSH
  • DellSonicSSH
  • +
  • DigiTransportBase
  • DlinkDSBase
  • EltexEsrSSH
  • EltexSSH
  • @@ -1288,6 +1298,7 @@

    Subclasses

  • ExtremeTierraSSH
  • ExtremeVspSSH
  • ExtremeWingSSH
  • +
  • FiberstoreFsosSSH
  • FortinetSSH
  • HPComwareBase
  • HPProcurveBase
  • diff --git a/docs/netmiko/citrix/index.html b/docs/netmiko/citrix/index.html index 78ecc9466..e2ae1ea44 100644 --- a/docs/netmiko/citrix/index.html +++ b/docs/netmiko/citrix/index.html @@ -49,7 +49,7 @@

    Classes

    class NetscalerSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netscaler SSH class.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/citrix/netscaler_ssh.html b/docs/netmiko/citrix/netscaler_ssh.html index 4109e6a35..d61bc4fae 100644 --- a/docs/netmiko/citrix/netscaler_ssh.html +++ b/docs/netmiko/citrix/netscaler_ssh.html @@ -85,7 +85,7 @@

    Classes

    class NetscalerSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netscaler SSH class.

    @@ -172,7 +172,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -185,11 +186,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cloudgenix/cloudgenix_ion.html b/docs/netmiko/cloudgenix/cloudgenix_ion.html index 6bf677cb5..fee5eb5f3 100644 --- a/docs/netmiko/cloudgenix/cloudgenix_ion.html +++ b/docs/netmiko/cloudgenix/cloudgenix_ion.html @@ -85,7 +85,7 @@

    Classes

    class CloudGenixIonSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -177,7 +177,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -190,11 +191,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/cloudgenix/index.html b/docs/netmiko/cloudgenix/index.html index 013a72816..a4b147c20 100644 --- a/docs/netmiko/cloudgenix/index.html +++ b/docs/netmiko/cloudgenix/index.html @@ -49,7 +49,7 @@

    Classes

    class CloudGenixIonSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/coriant/coriant_ssh.html b/docs/netmiko/coriant/coriant_ssh.html index e64221320..529dc1e03 100644 --- a/docs/netmiko/coriant/coriant_ssh.html +++ b/docs/netmiko/coriant/coriant_ssh.html @@ -69,7 +69,7 @@

    Classes

    class CoriantSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -163,7 +163,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -176,11 +177,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/coriant/index.html b/docs/netmiko/coriant/index.html index c7cb05ac9..1bcf77a16 100644 --- a/docs/netmiko/coriant/index.html +++ b/docs/netmiko/coriant/index.html @@ -49,7 +49,7 @@

    Classes

    class CoriantSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -143,7 +143,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_dnos6.html b/docs/netmiko/dell/dell_dnos6.html index 143e8cc0e..8492e799b 100644 --- a/docs/netmiko/dell/dell_dnos6.html +++ b/docs/netmiko/dell/dell_dnos6.html @@ -72,7 +72,7 @@

    Classes

    class DellDNOS6Base -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -159,7 +159,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -172,11 +173,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -301,7 +305,7 @@

    Inherited members

    class DellDNOS6SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -388,7 +392,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -401,11 +406,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -485,7 +493,7 @@

    Inherited members

    class DellDNOS6Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -572,7 +580,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -585,11 +594,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_force10_ssh.html b/docs/netmiko/dell/dell_force10_ssh.html index 04b517752..431dac419 100644 --- a/docs/netmiko/dell/dell_force10_ssh.html +++ b/docs/netmiko/dell/dell_force10_ssh.html @@ -77,7 +77,7 @@

    Classes

    class DellForce10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell Force10 Driver - supports DNOS9.

    @@ -164,7 +164,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -177,11 +178,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_isilon_ssh.html b/docs/netmiko/dell/dell_isilon_ssh.html index 4a6b56baa..cc00f54e4 100644 --- a/docs/netmiko/dell/dell_isilon_ssh.html +++ b/docs/netmiko/dell/dell_isilon_ssh.html @@ -149,7 +149,7 @@

    Classes

    class DellIsilonSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -237,7 +237,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -250,11 +251,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_os10_ssh.html b/docs/netmiko/dell/dell_os10_ssh.html index e74e48e4f..14f590974 100644 --- a/docs/netmiko/dell/dell_os10_ssh.html +++ b/docs/netmiko/dell/dell_os10_ssh.html @@ -350,7 +350,7 @@

    Inherited members

    class DellOS10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell EMC Networking OS10 Driver - supports dellos10.

    @@ -437,7 +437,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -450,11 +451,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_powerconnect.html b/docs/netmiko/dell/dell_powerconnect.html index 56fafff57..1620f47c6 100644 --- a/docs/netmiko/dell/dell_powerconnect.html +++ b/docs/netmiko/dell/dell_powerconnect.html @@ -158,7 +158,7 @@

    Classes

    class DellPowerConnectBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -245,7 +245,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -258,11 +259,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -453,7 +457,7 @@

    Inherited members

    class DellPowerConnectSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -542,7 +546,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -555,11 +560,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -735,7 +743,7 @@

    Inherited members

    class DellPowerConnectTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Telnet Driver.

    @@ -822,7 +830,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -835,11 +844,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/dell_sonic_ssh.html b/docs/netmiko/dell/dell_sonic_ssh.html index 38fc54135..8cf71e723 100644 --- a/docs/netmiko/dell/dell_sonic_ssh.html +++ b/docs/netmiko/dell/dell_sonic_ssh.html @@ -82,7 +82,7 @@

    Classes

    class DellSonicSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell EMC PowerSwitch platforms running Enterprise SONiC Distribution @@ -170,7 +170,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -183,11 +184,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dell/index.html b/docs/netmiko/dell/index.html index b33070e66..2675dd835 100644 --- a/docs/netmiko/dell/index.html +++ b/docs/netmiko/dell/index.html @@ -87,7 +87,7 @@

    Classes

    class DellDNOS6SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -174,7 +174,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -187,11 +188,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -271,7 +275,7 @@

    Inherited members

    class DellDNOS6Telnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -358,7 +362,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -371,11 +376,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -455,7 +463,7 @@

    Inherited members

    class DellForce10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell Force10 Driver - supports DNOS9.

    @@ -542,7 +550,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -555,11 +564,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -708,7 +720,7 @@

    Inherited members

    class DellIsilonSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -796,7 +808,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -809,11 +822,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1275,7 +1291,7 @@

    Inherited members

    class DellOS10SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell EMC Networking OS10 Driver - supports dellos10.

    @@ -1362,7 +1378,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1375,11 +1392,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1528,7 +1548,7 @@

    Inherited members

    class DellPowerConnectSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Driver.

    @@ -1617,7 +1637,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1630,11 +1651,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1810,7 +1834,7 @@

    Inherited members

    class DellPowerConnectTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell PowerConnect Telnet Driver.

    @@ -1897,7 +1921,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1910,11 +1935,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1995,7 +2023,7 @@

    Inherited members

    class DellSonicSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Dell EMC PowerSwitch platforms running Enterprise SONiC Distribution @@ -2083,7 +2111,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2096,11 +2125,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/digi/digi_transport.html b/docs/netmiko/digi/digi_transport.html new file mode 100644 index 000000000..cb2485bd4 --- /dev/null +++ b/docs/netmiko/digi/digi_transport.html @@ -0,0 +1,272 @@ + + + + + + +netmiko.digi.digi_transport API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.digi.digi_transport

    +
    +
    +

    Digi TransPort Routers

    +
    + +Expand source code + +
    """Digi TransPort Routers"""
    +from typing import Any
    +from netmiko.no_enable import NoEnable
    +from netmiko.no_config import NoConfig
    +from netmiko.cisco_base_connection import CiscoSSHConnection
    +
    +
    +class DigiTransportBase(NoEnable, NoConfig, CiscoSSHConnection):
    +    def __init__(self, *args: Any, **kwargs: Any) -> None:
    +        default_enter = kwargs.get("default_enter")
    +        kwargs["default_enter"] = "\r\n" if default_enter is None else default_enter
    +        super().__init__(*args, **kwargs)
    +
    +    def save_config(
    +        self,
    +        cmd: str = "config 0 save",
    +        confirm: bool = False,
    +        confirm_response: str = "",
    +    ) -> str:
    +        output = self._send_command_str(
    +            command_string=cmd, expect_string="Please wait..."
    +        )
    +        return output
    +
    +
    +class DigiTransportSSH(DigiTransportBase):
    +    pass
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class DigiTransportBase +(*args: Any, **kwargs: Any) +
    +
    +

    Class for platforms that have no enable mode.

    +

    Netmiko translates the meaning of "enable" mode to be a proxy for "can +go into config mode". In other words, that you ultimately have privileges +to execute configuration changes.

    +

    The expectation on platforms that have no method for elevating privileges +is that the standard default privileges allow configuration changes.

    +

    Consequently check_enable_mode returns True by default for platforms that +don't explicitly support enable mode.

    +
    + +Expand source code + +
    class DigiTransportBase(NoEnable, NoConfig, CiscoSSHConnection):
    +    def __init__(self, *args: Any, **kwargs: Any) -> None:
    +        default_enter = kwargs.get("default_enter")
    +        kwargs["default_enter"] = "\r\n" if default_enter is None else default_enter
    +        super().__init__(*args, **kwargs)
    +
    +    def save_config(
    +        self,
    +        cmd: str = "config 0 save",
    +        confirm: bool = False,
    +        confirm_response: str = "",
    +    ) -> str:
    +        output = self._send_command_str(
    +            command_string=cmd, expect_string="Please wait..."
    +        )
    +        return output
    +
    +

    Ancestors

    + +

    Subclasses

    + +

    Inherited members

    + +
    +
    +class DigiTransportSSH +(*args: Any, **kwargs: Any) +
    +
    +

    Class for platforms that have no enable mode.

    +

    Netmiko translates the meaning of "enable" mode to be a proxy for "can +go into config mode". In other words, that you ultimately have privileges +to execute configuration changes.

    +

    The expectation on platforms that have no method for elevating privileges +is that the standard default privileges allow configuration changes.

    +

    Consequently check_enable_mode returns True by default for platforms that +don't explicitly support enable mode.

    +
    + +Expand source code + +
    class DigiTransportSSH(DigiTransportBase):
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/digi/index.html b/docs/netmiko/digi/index.html new file mode 100644 index 000000000..54b5a402e --- /dev/null +++ b/docs/netmiko/digi/index.html @@ -0,0 +1,161 @@ + + + + + + +netmiko.digi API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.digi

    +
    +
    +
    + +Expand source code + +
    from netmiko.digi.digi_transport import DigiTransportSSH
    +
    +__all__ = ["DigiTransportSSH"]
    +
    +
    +
    +

    Sub-modules

    +
    +
    netmiko.digi.digi_transport
    +
    +

    Digi TransPort Routers

    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class DigiTransportSSH +(*args: Any, **kwargs: Any) +
    +
    +

    Class for platforms that have no enable mode.

    +

    Netmiko translates the meaning of "enable" mode to be a proxy for "can +go into config mode". In other words, that you ultimately have privileges +to execute configuration changes.

    +

    The expectation on platforms that have no method for elevating privileges +is that the standard default privileges allow configuration changes.

    +

    Consequently check_enable_mode returns True by default for platforms that +don't explicitly support enable mode.

    +
    + +Expand source code + +
    class DigiTransportSSH(DigiTransportBase):
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/dlink/dlink_ds.html b/docs/netmiko/dlink/dlink_ds.html index bcdaab28a..452bfb8fb 100644 --- a/docs/netmiko/dlink/dlink_ds.html +++ b/docs/netmiko/dlink/dlink_ds.html @@ -78,7 +78,7 @@

    Classes

    Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)

    @@ -165,7 +165,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -178,11 +179,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -338,7 +342,7 @@

    Inherited members

    Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)

    @@ -425,7 +429,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -438,11 +443,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -611,7 +619,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -624,11 +633,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/dlink/index.html b/docs/netmiko/dlink/index.html index a5076e889..80975e355 100644 --- a/docs/netmiko/dlink/index.html +++ b/docs/netmiko/dlink/index.html @@ -49,7 +49,7 @@

    Classes

    class DlinkDSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Supports D-Link DGS/DES device series (there are some DGS/DES devices that are web-only)

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -322,7 +326,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -335,11 +340,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/eltex/eltex_esr_ssh.html b/docs/netmiko/eltex/eltex_esr_ssh.html index cfb0546ea..210691637 100644 --- a/docs/netmiko/eltex/eltex_esr_ssh.html +++ b/docs/netmiko/eltex/eltex_esr_ssh.html @@ -173,7 +173,7 @@

    Classes

    class EltexEsrSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko support for routers Eltex ESR.

    @@ -260,7 +260,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -273,11 +274,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/eltex/eltex_ssh.html b/docs/netmiko/eltex/eltex_ssh.html index 158211fa5..56f3533e6 100644 --- a/docs/netmiko/eltex/eltex_ssh.html +++ b/docs/netmiko/eltex/eltex_ssh.html @@ -54,7 +54,7 @@

    Classes

    class EltexSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/eltex/index.html b/docs/netmiko/eltex/index.html index e7edbe029..5da4b5d02 100644 --- a/docs/netmiko/eltex/index.html +++ b/docs/netmiko/eltex/index.html @@ -54,7 +54,7 @@

    Classes

    class EltexEsrSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko support for routers Eltex ESR.

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -482,7 +486,7 @@

    Inherited members

    class EltexSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -569,7 +573,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -582,11 +587,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/endace/endace_ssh.html b/docs/netmiko/endace/endace_ssh.html index 96bec98e7..d86584e27 100644 --- a/docs/netmiko/endace/endace_ssh.html +++ b/docs/netmiko/endace/endace_ssh.html @@ -105,7 +105,7 @@

    Classes

    class EndaceSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -192,7 +192,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -205,11 +206,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/endace/index.html b/docs/netmiko/endace/index.html index d8af1e555..573427e73 100644 --- a/docs/netmiko/endace/index.html +++ b/docs/netmiko/endace/index.html @@ -49,7 +49,7 @@

    Classes

    class EndaceSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/enterasys/enterasys_ssh.html b/docs/netmiko/enterasys/enterasys_ssh.html index 22cb3bfc7..3e034e0ad 100644 --- a/docs/netmiko/enterasys/enterasys_ssh.html +++ b/docs/netmiko/enterasys/enterasys_ssh.html @@ -57,7 +57,7 @@

    Classes

    class EnterasysSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Enterasys support.

    @@ -144,7 +144,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -157,11 +158,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/enterasys/index.html b/docs/netmiko/enterasys/index.html index cd88eaaf8..6131d869f 100644 --- a/docs/netmiko/enterasys/index.html +++ b/docs/netmiko/enterasys/index.html @@ -49,7 +49,7 @@

    Classes

    class EnterasysSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Enterasys support.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ericsson/ericsson_ipos.html b/docs/netmiko/ericsson/ericsson_ipos.html index 8617013a0..4a606cda6 100644 --- a/docs/netmiko/ericsson/ericsson_ipos.html +++ b/docs/netmiko/ericsson/ericsson_ipos.html @@ -193,7 +193,7 @@

    Classes

    class EricssonIposSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -281,7 +281,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -294,11 +295,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ericsson/index.html b/docs/netmiko/ericsson/index.html index 9d8399b7f..c1f97ff28 100644 --- a/docs/netmiko/ericsson/index.html +++ b/docs/netmiko/ericsson/index.html @@ -54,7 +54,7 @@

    Classes

    class EricssonIposSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -142,7 +142,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -155,11 +156,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_ers_ssh.html b/docs/netmiko/extreme/extreme_ers_ssh.html index 773831a26..f59b34f36 100644 --- a/docs/netmiko/extreme/extreme_ers_ssh.html +++ b/docs/netmiko/extreme/extreme_ers_ssh.html @@ -31,6 +31,7 @@

    Module netmiko.extreme.extreme_ers_ssh

    import re from netmiko.cisco_base_connection import CiscoSSHConnection from netmiko.exceptions import NetmikoAuthenticationException +import time # Extreme ERS presents Enter Ctrl-Y to begin. CTRL_Y = "\x19" @@ -56,6 +57,10 @@

    Module netmiko.extreme.extreme_ers_ssh

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this). + Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern \ + + prompt appears after Enter/Return ( tested ). + Newer devices this is after SSH-login. """ @@ -75,6 +80,9 @@

    Module netmiko.extreme.extreme_ers_ssh

    if cntl_y in new_data: self.write_channel(CTRL_Y) + time.sleep(1 * delay_factor) + # no pattern, blank for few devices till Return keypress + self.write_channel(self.RETURN) elif "Press ENTER" in new_data: self.write_channel(self.RETURN) elif uname in new_data: @@ -121,7 +129,7 @@

    Classes

    class ExtremeErsSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko support for Extreme Ethernet Routing Switch.

    @@ -208,7 +216,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -221,11 +230,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -263,6 +275,10 @@

    Classes

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this). + Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern \ + + prompt appears after Enter/Return ( tested ). + Newer devices this is after SSH-login. """ @@ -282,6 +298,9 @@

    Classes

    if cntl_y in new_data: self.write_channel(CTRL_Y) + time.sleep(1 * delay_factor) + # no pattern, blank for few devices till Return keypress + self.write_channel(self.RETURN) elif "Press ENTER" in new_data: self.write_channel(self.RETURN) elif uname in new_data: @@ -359,6 +378,8 @@

    Methods

    Extreme ERS presents the following as part of the login process:

    Enter Ctrl-Y to begin

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this).

    +

    Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern +prompt appears after Enter/Return ( tested ).

    Newer devices this is after SSH-login.

    @@ -372,6 +393,10 @@

    Methods

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this). + Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern \ + + prompt appears after Enter/Return ( tested ). + Newer devices this is after SSH-login. """ @@ -391,6 +416,9 @@

    Methods

    if cntl_y in new_data: self.write_channel(CTRL_Y) + time.sleep(1 * delay_factor) + # no pattern, blank for few devices till Return keypress + self.write_channel(self.RETURN) elif "Press ENTER" in new_data: self.write_channel(self.RETURN) elif uname in new_data: diff --git a/docs/netmiko/extreme/extreme_exos.html b/docs/netmiko/extreme/extreme_exos.html index e6064ecad..e73eb37af 100644 --- a/docs/netmiko/extreme/extreme_exos.html +++ b/docs/netmiko/extreme/extreme_exos.html @@ -258,7 +258,7 @@

    Classes

    class ExtremeExosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme Exos support.

    @@ -346,7 +346,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -359,11 +360,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -794,7 +798,7 @@

    Inherited members

    class ExtremeExosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme Exos support.

    @@ -882,7 +886,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -895,11 +900,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1068,7 +1076,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1081,11 +1090,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_netiron.html b/docs/netmiko/extreme/extreme_netiron.html index af02e5839..3a08d06ff 100644 --- a/docs/netmiko/extreme/extreme_netiron.html +++ b/docs/netmiko/extreme/extreme_netiron.html @@ -72,7 +72,7 @@

    Classes

    class ExtremeNetironBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -159,7 +159,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -172,11 +173,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -315,7 +319,7 @@

    Inherited members

    class ExtremeNetironSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -402,7 +406,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -415,11 +420,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -586,7 +594,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -599,11 +608,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_nos_ssh.html b/docs/netmiko/extreme/extreme_nos_ssh.html index 8028c87e4..74a5ca71f 100644 --- a/docs/netmiko/extreme/extreme_nos_ssh.html +++ b/docs/netmiko/extreme/extreme_nos_ssh.html @@ -71,7 +71,7 @@

    Classes

    class ExtremeNosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme NOS/VDX.

    @@ -158,7 +158,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -171,11 +172,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_slx_ssh.html b/docs/netmiko/extreme/extreme_slx_ssh.html index d2b666f80..72446a9e1 100644 --- a/docs/netmiko/extreme/extreme_slx_ssh.html +++ b/docs/netmiko/extreme/extreme_slx_ssh.html @@ -71,7 +71,7 @@

    Classes

    class ExtremeSlxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme SLX.

    @@ -158,7 +158,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -171,11 +172,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_tierraos_ssh.html b/docs/netmiko/extreme/extreme_tierraos_ssh.html index 4ce29edb4..1229efea3 100644 --- a/docs/netmiko/extreme/extreme_tierraos_ssh.html +++ b/docs/netmiko/extreme/extreme_tierraos_ssh.html @@ -71,7 +71,7 @@

    Classes

    class ExtremeTierraSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme TierraOS.

    @@ -158,7 +158,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -171,11 +172,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_vsp_ssh.html b/docs/netmiko/extreme/extreme_vsp_ssh.html index 59a94587d..56d7e649c 100644 --- a/docs/netmiko/extreme/extreme_vsp_ssh.html +++ b/docs/netmiko/extreme/extreme_vsp_ssh.html @@ -63,7 +63,7 @@

    Classes

    class ExtremeVspSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme Virtual Services Platform Support.

    @@ -150,7 +150,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -163,11 +164,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/extreme_wing_ssh.html b/docs/netmiko/extreme/extreme_wing_ssh.html index 38149a335..2a4d12b2b 100644 --- a/docs/netmiko/extreme/extreme_wing_ssh.html +++ b/docs/netmiko/extreme/extreme_wing_ssh.html @@ -51,7 +51,7 @@

    Classes

    class ExtremeWingSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme WiNG support.

    @@ -138,7 +138,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -151,11 +152,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/extreme/index.html b/docs/netmiko/extreme/index.html index 0b70e14f9..2ee2f1cca 100644 --- a/docs/netmiko/extreme/index.html +++ b/docs/netmiko/extreme/index.html @@ -98,7 +98,7 @@

    Classes

    class ExtremeErsSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Netmiko support for Extreme Ethernet Routing Switch.

    @@ -185,7 +185,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -198,11 +199,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -240,6 +244,10 @@

    Classes

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this). + Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern \ + + prompt appears after Enter/Return ( tested ). + Newer devices this is after SSH-login. """ @@ -259,6 +267,9 @@

    Classes

    if cntl_y in new_data: self.write_channel(CTRL_Y) + time.sleep(1 * delay_factor) + # no pattern, blank for few devices till Return keypress + self.write_channel(self.RETURN) elif "Press ENTER" in new_data: self.write_channel(self.RETURN) elif uname in new_data: @@ -336,6 +347,8 @@

    Methods

    Extreme ERS presents the following as part of the login process:

    Enter Ctrl-Y to begin

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this).

    +

    Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern +prompt appears after Enter/Return ( tested ).

    Newer devices this is after SSH-login.

    @@ -349,6 +362,10 @@

    Methods

    Older devices the Ctrl-Y is before SSH-login (not 100% sure of this). + Few devices after SSH-login the Ctrl-Y turns to blank screen-no pattern \ + + prompt appears after Enter/Return ( tested ). + Newer devices this is after SSH-login. """ @@ -368,6 +385,9 @@

    Methods

    if cntl_y in new_data: self.write_channel(CTRL_Y) + time.sleep(1 * delay_factor) + # no pattern, blank for few devices till Return keypress + self.write_channel(self.RETURN) elif "Press ENTER" in new_data: self.write_channel(self.RETURN) elif uname in new_data: @@ -645,7 +665,7 @@

    Inherited members

    class ExtremeExosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme Exos support.

    @@ -733,7 +753,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -746,11 +767,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -919,7 +943,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -932,11 +957,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1020,7 +1048,7 @@

    Inherited members

    class ExtremeNetironSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -1107,7 +1135,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1120,11 +1149,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1291,7 +1323,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1304,11 +1337,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1391,7 +1427,7 @@

    Inherited members

    class ExtremeNosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme NOS/VDX.

    @@ -1478,7 +1514,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1491,11 +1528,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1636,7 +1676,7 @@

    Inherited members

    class ExtremeSlxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme SLX.

    @@ -1723,7 +1763,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1736,11 +1777,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1881,7 +1925,7 @@

    Inherited members

    class ExtremeTierraSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Support for Extreme TierraOS.

    @@ -1968,7 +2012,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1981,11 +2026,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2126,7 +2174,7 @@

    Inherited members

    class ExtremeVspSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme Virtual Services Platform Support.

    @@ -2213,7 +2261,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2226,11 +2275,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -2364,7 +2416,7 @@

    Inherited members

    class ExtremeWingSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Extreme WiNG support.

    @@ -2451,7 +2503,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -2464,11 +2517,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/f5/f5_linux_ssh.html b/docs/netmiko/f5/f5_linux_ssh.html index 5174dee02..2709c9aa2 100644 --- a/docs/netmiko/f5/f5_linux_ssh.html +++ b/docs/netmiko/f5/f5_linux_ssh.html @@ -44,7 +44,7 @@

    Classes

    class F5LinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -131,7 +131,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -144,11 +145,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/f5/f5_tmsh_ssh.html b/docs/netmiko/f5/f5_tmsh_ssh.html index 892877268..451229182 100644 --- a/docs/netmiko/f5/f5_tmsh_ssh.html +++ b/docs/netmiko/f5/f5_tmsh_ssh.html @@ -77,7 +77,7 @@

    Classes

    class F5TmshSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -169,7 +169,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -182,11 +183,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/f5/index.html b/docs/netmiko/f5/index.html index 366ee06a5..c6249fab1 100644 --- a/docs/netmiko/f5/index.html +++ b/docs/netmiko/f5/index.html @@ -54,7 +54,7 @@

    Classes

    class F5LinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -238,7 +242,7 @@

    Inherited members

    class F5TmshSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -330,7 +334,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -343,11 +348,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/fiberstore/fiberstore_fsos.html b/docs/netmiko/fiberstore/fiberstore_fsos.html new file mode 100644 index 000000000..3bb0b76bc --- /dev/null +++ b/docs/netmiko/fiberstore/fiberstore_fsos.html @@ -0,0 +1,526 @@ + + + + + + +netmiko.fiberstore.fiberstore_fsos API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.fiberstore.fiberstore_fsos

    +
    +
    +

    Fiberstore FSOS Driver.

    +
    + +Expand source code + +
    """Fiberstore FSOS Driver."""
    +from typing import Optional
    +from paramiko import SSHClient
    +from netmiko.ssh_auth import SSHClient_noauth
    +from netmiko.no_enable import NoEnable
    +import time
    +from os import path
    +from netmiko.cisco_base_connection import CiscoSSHConnection
    +from netmiko.exceptions import NetmikoAuthenticationException
    +
    +
    +class FiberstoreFsosSSH(NoEnable, CiscoSSHConnection):
    +    """
    +    Fiberstore FSOS uses a non-standard SSH login mechanism. Consequently,
    +    to make the login work, we have to override the SSHClient _auth method.
    +    """
    +
    +    def session_preparation(self) -> None:
    +        """Prepare the session after the connection has been established."""
    +        self.ansi_escape_codes = True
    +        output = self._test_channel_read()
    +        if "% Authentication Failed" in output:
    +            assert self.remote_conn is not None
    +            self.remote_conn.close()
    +            msg = f"Login failed: {self.host}"
    +            raise NetmikoAuthenticationException(msg)
    +
    +        self.set_base_prompt()
    +        self.disable_paging(command="terminal length 0")
    +        # Clear the read buffer
    +        time.sleep(0.3 * self.global_delay_factor)
    +        self.clear_buffer()
    +
    +    def set_base_prompt(
    +        self,
    +        pri_prompt_terminator: str = ">",
    +        alt_prompt_terminator: str = "#",
    +        delay_factor: float = 1.0,
    +        pattern: Optional[str] = None,
    +    ) -> str:
    +        prompt = super().set_base_prompt(
    +            pri_prompt_terminator=pri_prompt_terminator,
    +            alt_prompt_terminator=alt_prompt_terminator,
    +            delay_factor=delay_factor,
    +            pattern=pattern,
    +        )
    +        prompt = prompt.strip()
    +        self.base_prompt = prompt
    +        return self.base_prompt
    +
    +    def check_config_mode(
    +        self,
    +        check_string: str = "(config)#",
    +        pattern: str = "",
    +        force_regex: bool = False,
    +    ) -> bool:
    +        return super().check_config_mode(
    +            check_string=check_string, pattern=pattern, force_regex=force_regex
    +        )
    +
    +    def config_mode(
    +        self, config_command: str = "config", pattern: str = "", re_flags: int = 0
    +    ) -> str:
    +        return super().config_mode(
    +            config_command=config_command, pattern=pattern, re_flags=re_flags
    +        )
    +
    +    def _build_ssh_client(self) -> SSHClient:
    +        """Allows you to bypass standard SSH auth while still supporting SSH keys."""
    +
    +        # If user does not provide SSH key, we use noauth
    +        remote_conn_pre: SSHClient
    +        if not self.use_keys:
    +            remote_conn_pre = SSHClient_noauth()
    +        else:
    +            remote_conn_pre = SSHClient()
    +
    +        # Load host_keys for better SSH security
    +        if self.system_host_keys:
    +            remote_conn_pre.load_system_host_keys()
    +        if self.alt_host_keys and path.isfile(self.alt_key_file):
    +            remote_conn_pre.load_host_keys(self.alt_key_file)
    +
    +        # Default is to automatically add untrusted hosts (make sure appropriate for your env)
    +        remote_conn_pre.set_missing_host_key_policy(self.key_policy)
    +        return remote_conn_pre
    +
    +    def special_login_handler(self, delay_factor: float = 1.0) -> None:
    +        """
    +        Fiberstore S3200 presents with the following on login
    +        Username:
    +        Password: ****
    +        """
    +        delay_factor = self.select_delay_factor(delay_factor)
    +        i = 0
    +        output = ""
    +        while i <= 12:
    +            i += 1
    +            time.sleep(delay_factor)
    +            output = self.read_channel()
    +            if output:
    +                if "Username:" in output:
    +                    assert self.username is not None
    +                    self.write_channel(self.username + self.RETURN)
    +                elif "Password:" in output:
    +                    assert self.password is not None
    +                    self.write_channel(self.password + self.RETURN)
    +                    return
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class FiberstoreFsosSSH +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    Fiberstore FSOS uses a non-standard SSH login mechanism. Consequently, +to make the login work, we have to override the SSHClient _auth method.

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class FiberstoreFsosSSH(NoEnable, CiscoSSHConnection):
    +    """
    +    Fiberstore FSOS uses a non-standard SSH login mechanism. Consequently,
    +    to make the login work, we have to override the SSHClient _auth method.
    +    """
    +
    +    def session_preparation(self) -> None:
    +        """Prepare the session after the connection has been established."""
    +        self.ansi_escape_codes = True
    +        output = self._test_channel_read()
    +        if "% Authentication Failed" in output:
    +            assert self.remote_conn is not None
    +            self.remote_conn.close()
    +            msg = f"Login failed: {self.host}"
    +            raise NetmikoAuthenticationException(msg)
    +
    +        self.set_base_prompt()
    +        self.disable_paging(command="terminal length 0")
    +        # Clear the read buffer
    +        time.sleep(0.3 * self.global_delay_factor)
    +        self.clear_buffer()
    +
    +    def set_base_prompt(
    +        self,
    +        pri_prompt_terminator: str = ">",
    +        alt_prompt_terminator: str = "#",
    +        delay_factor: float = 1.0,
    +        pattern: Optional[str] = None,
    +    ) -> str:
    +        prompt = super().set_base_prompt(
    +            pri_prompt_terminator=pri_prompt_terminator,
    +            alt_prompt_terminator=alt_prompt_terminator,
    +            delay_factor=delay_factor,
    +            pattern=pattern,
    +        )
    +        prompt = prompt.strip()
    +        self.base_prompt = prompt
    +        return self.base_prompt
    +
    +    def check_config_mode(
    +        self,
    +        check_string: str = "(config)#",
    +        pattern: str = "",
    +        force_regex: bool = False,
    +    ) -> bool:
    +        return super().check_config_mode(
    +            check_string=check_string, pattern=pattern, force_regex=force_regex
    +        )
    +
    +    def config_mode(
    +        self, config_command: str = "config", pattern: str = "", re_flags: int = 0
    +    ) -> str:
    +        return super().config_mode(
    +            config_command=config_command, pattern=pattern, re_flags=re_flags
    +        )
    +
    +    def _build_ssh_client(self) -> SSHClient:
    +        """Allows you to bypass standard SSH auth while still supporting SSH keys."""
    +
    +        # If user does not provide SSH key, we use noauth
    +        remote_conn_pre: SSHClient
    +        if not self.use_keys:
    +            remote_conn_pre = SSHClient_noauth()
    +        else:
    +            remote_conn_pre = SSHClient()
    +
    +        # Load host_keys for better SSH security
    +        if self.system_host_keys:
    +            remote_conn_pre.load_system_host_keys()
    +        if self.alt_host_keys and path.isfile(self.alt_key_file):
    +            remote_conn_pre.load_host_keys(self.alt_key_file)
    +
    +        # Default is to automatically add untrusted hosts (make sure appropriate for your env)
    +        remote_conn_pre.set_missing_host_key_policy(self.key_policy)
    +        return remote_conn_pre
    +
    +    def special_login_handler(self, delay_factor: float = 1.0) -> None:
    +        """
    +        Fiberstore S3200 presents with the following on login
    +        Username:
    +        Password: ****
    +        """
    +        delay_factor = self.select_delay_factor(delay_factor)
    +        i = 0
    +        output = ""
    +        while i <= 12:
    +            i += 1
    +            time.sleep(delay_factor)
    +            output = self.read_channel()
    +            if output:
    +                if "Username:" in output:
    +                    assert self.username is not None
    +                    self.write_channel(self.username + self.RETURN)
    +                elif "Password:" in output:
    +                    assert self.password is not None
    +                    self.write_channel(self.password + self.RETURN)
    +                    return
    +
    +

    Ancestors

    + +

    Methods

    +
    +
    +def session_preparation(self) ‑> None +
    +
    +

    Prepare the session after the connection has been established.

    +
    + +Expand source code + +
    def session_preparation(self) -> None:
    +    """Prepare the session after the connection has been established."""
    +    self.ansi_escape_codes = True
    +    output = self._test_channel_read()
    +    if "% Authentication Failed" in output:
    +        assert self.remote_conn is not None
    +        self.remote_conn.close()
    +        msg = f"Login failed: {self.host}"
    +        raise NetmikoAuthenticationException(msg)
    +
    +    self.set_base_prompt()
    +    self.disable_paging(command="terminal length 0")
    +    # Clear the read buffer
    +    time.sleep(0.3 * self.global_delay_factor)
    +    self.clear_buffer()
    +
    +
    +
    +def special_login_handler(self, delay_factor: float = 1.0) ‑> None +
    +
    +

    Fiberstore S3200 presents with the following on login +Username: +Password: ****

    +
    + +Expand source code + +
    def special_login_handler(self, delay_factor: float = 1.0) -> None:
    +    """
    +    Fiberstore S3200 presents with the following on login
    +    Username:
    +    Password: ****
    +    """
    +    delay_factor = self.select_delay_factor(delay_factor)
    +    i = 0
    +    output = ""
    +    while i <= 12:
    +        i += 1
    +        time.sleep(delay_factor)
    +        output = self.read_channel()
    +        if output:
    +            if "Username:" in output:
    +                assert self.username is not None
    +                self.write_channel(self.username + self.RETURN)
    +            elif "Password:" in output:
    +                assert self.password is not None
    +                self.write_channel(self.password + self.RETURN)
    +                return
    +
    +
    +
    +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/fiberstore/index.html b/docs/netmiko/fiberstore/index.html new file mode 100644 index 000000000..266e091da --- /dev/null +++ b/docs/netmiko/fiberstore/index.html @@ -0,0 +1,432 @@ + + + + + + +netmiko.fiberstore API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.fiberstore

    +
    +
    +
    + +Expand source code + +
    from netmiko.fiberstore.fiberstore_fsos import FiberstoreFsosSSH
    +
    +__all__ = ["FiberstoreFsosSSH"]
    +
    +
    +
    +

    Sub-modules

    +
    +
    netmiko.fiberstore.fiberstore_fsos
    +
    +

    Fiberstore FSOS Driver.

    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class FiberstoreFsosSSH +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    Fiberstore FSOS uses a non-standard SSH login mechanism. Consequently, +to make the login work, we have to override the SSHClient _auth method.

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class FiberstoreFsosSSH(NoEnable, CiscoSSHConnection):
    +    """
    +    Fiberstore FSOS uses a non-standard SSH login mechanism. Consequently,
    +    to make the login work, we have to override the SSHClient _auth method.
    +    """
    +
    +    def session_preparation(self) -> None:
    +        """Prepare the session after the connection has been established."""
    +        self.ansi_escape_codes = True
    +        output = self._test_channel_read()
    +        if "% Authentication Failed" in output:
    +            assert self.remote_conn is not None
    +            self.remote_conn.close()
    +            msg = f"Login failed: {self.host}"
    +            raise NetmikoAuthenticationException(msg)
    +
    +        self.set_base_prompt()
    +        self.disable_paging(command="terminal length 0")
    +        # Clear the read buffer
    +        time.sleep(0.3 * self.global_delay_factor)
    +        self.clear_buffer()
    +
    +    def set_base_prompt(
    +        self,
    +        pri_prompt_terminator: str = ">",
    +        alt_prompt_terminator: str = "#",
    +        delay_factor: float = 1.0,
    +        pattern: Optional[str] = None,
    +    ) -> str:
    +        prompt = super().set_base_prompt(
    +            pri_prompt_terminator=pri_prompt_terminator,
    +            alt_prompt_terminator=alt_prompt_terminator,
    +            delay_factor=delay_factor,
    +            pattern=pattern,
    +        )
    +        prompt = prompt.strip()
    +        self.base_prompt = prompt
    +        return self.base_prompt
    +
    +    def check_config_mode(
    +        self,
    +        check_string: str = "(config)#",
    +        pattern: str = "",
    +        force_regex: bool = False,
    +    ) -> bool:
    +        return super().check_config_mode(
    +            check_string=check_string, pattern=pattern, force_regex=force_regex
    +        )
    +
    +    def config_mode(
    +        self, config_command: str = "config", pattern: str = "", re_flags: int = 0
    +    ) -> str:
    +        return super().config_mode(
    +            config_command=config_command, pattern=pattern, re_flags=re_flags
    +        )
    +
    +    def _build_ssh_client(self) -> SSHClient:
    +        """Allows you to bypass standard SSH auth while still supporting SSH keys."""
    +
    +        # If user does not provide SSH key, we use noauth
    +        remote_conn_pre: SSHClient
    +        if not self.use_keys:
    +            remote_conn_pre = SSHClient_noauth()
    +        else:
    +            remote_conn_pre = SSHClient()
    +
    +        # Load host_keys for better SSH security
    +        if self.system_host_keys:
    +            remote_conn_pre.load_system_host_keys()
    +        if self.alt_host_keys and path.isfile(self.alt_key_file):
    +            remote_conn_pre.load_host_keys(self.alt_key_file)
    +
    +        # Default is to automatically add untrusted hosts (make sure appropriate for your env)
    +        remote_conn_pre.set_missing_host_key_policy(self.key_policy)
    +        return remote_conn_pre
    +
    +    def special_login_handler(self, delay_factor: float = 1.0) -> None:
    +        """
    +        Fiberstore S3200 presents with the following on login
    +        Username:
    +        Password: ****
    +        """
    +        delay_factor = self.select_delay_factor(delay_factor)
    +        i = 0
    +        output = ""
    +        while i <= 12:
    +            i += 1
    +            time.sleep(delay_factor)
    +            output = self.read_channel()
    +            if output:
    +                if "Username:" in output:
    +                    assert self.username is not None
    +                    self.write_channel(self.username + self.RETURN)
    +                elif "Password:" in output:
    +                    assert self.password is not None
    +                    self.write_channel(self.password + self.RETURN)
    +                    return
    +
    +

    Ancestors

    + +

    Methods

    +
    +
    +def session_preparation(self) ‑> None +
    +
    +

    Prepare the session after the connection has been established.

    +
    + +Expand source code + +
    def session_preparation(self) -> None:
    +    """Prepare the session after the connection has been established."""
    +    self.ansi_escape_codes = True
    +    output = self._test_channel_read()
    +    if "% Authentication Failed" in output:
    +        assert self.remote_conn is not None
    +        self.remote_conn.close()
    +        msg = f"Login failed: {self.host}"
    +        raise NetmikoAuthenticationException(msg)
    +
    +    self.set_base_prompt()
    +    self.disable_paging(command="terminal length 0")
    +    # Clear the read buffer
    +    time.sleep(0.3 * self.global_delay_factor)
    +    self.clear_buffer()
    +
    +
    +
    +def special_login_handler(self, delay_factor: float = 1.0) ‑> None +
    +
    +

    Fiberstore S3200 presents with the following on login +Username: +Password: ****

    +
    + +Expand source code + +
    def special_login_handler(self, delay_factor: float = 1.0) -> None:
    +    """
    +    Fiberstore S3200 presents with the following on login
    +    Username:
    +    Password: ****
    +    """
    +    delay_factor = self.select_delay_factor(delay_factor)
    +    i = 0
    +    output = ""
    +    while i <= 12:
    +        i += 1
    +        time.sleep(delay_factor)
    +        output = self.read_channel()
    +        if output:
    +            if "Username:" in output:
    +                assert self.username is not None
    +                self.write_channel(self.username + self.RETURN)
    +            elif "Password:" in output:
    +                assert self.password is not None
    +                self.write_channel(self.password + self.RETURN)
    +                return
    +
    +
    +
    +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/flexvnf/flexvnf_ssh.html b/docs/netmiko/flexvnf/flexvnf_ssh.html index 3a0f83de0..d8a4f69c4 100644 --- a/docs/netmiko/flexvnf/flexvnf_ssh.html +++ b/docs/netmiko/flexvnf/flexvnf_ssh.html @@ -244,7 +244,7 @@

    Classes

    class FlexvnfSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -338,7 +338,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -351,11 +352,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/flexvnf/index.html b/docs/netmiko/flexvnf/index.html index 43963aa4c..02002254e 100644 --- a/docs/netmiko/flexvnf/index.html +++ b/docs/netmiko/flexvnf/index.html @@ -49,7 +49,7 @@

    Classes

    class FlexvnfSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -143,7 +143,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/fortinet/fortinet_ssh.html b/docs/netmiko/fortinet/fortinet_ssh.html index db4ba4a3e..86887c000 100644 --- a/docs/netmiko/fortinet/fortinet_ssh.html +++ b/docs/netmiko/fortinet/fortinet_ssh.html @@ -176,13 +176,7 @@

    Module netmiko.fortinet.fortinet_ssh

    if self._vdoms: self._config_global() - self._send_command_str( - "config system console", expect_string=self.prompt_pattern - ) - output = self._send_command_str( - "show full-configuration", expect_string=self.prompt_pattern - ) - self._send_command_str("end", expect_string=self.prompt_pattern) + output = self._send_command_str("show full-configuration system console") if self._vdoms: self._exit_config_global() @@ -265,7 +259,7 @@

    Classes

    class FortinetSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -357,7 +351,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -370,11 +365,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -534,13 +532,7 @@

    Classes

    if self._vdoms: self._config_global() - self._send_command_str( - "config system console", expect_string=self.prompt_pattern - ) - output = self._send_command_str( - "show full-configuration", expect_string=self.prompt_pattern - ) - self._send_command_str("end", expect_string=self.prompt_pattern) + output = self._send_command_str("show full-configuration system console") if self._vdoms: self._exit_config_global() diff --git a/docs/netmiko/fortinet/index.html b/docs/netmiko/fortinet/index.html index f8076a39f..1d2483790 100644 --- a/docs/netmiko/fortinet/index.html +++ b/docs/netmiko/fortinet/index.html @@ -49,7 +49,7 @@

    Classes

    class FortinetSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no config mode.

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -318,13 +322,7 @@

    Classes

    if self._vdoms: self._config_global() - self._send_command_str( - "config system console", expect_string=self.prompt_pattern - ) - output = self._send_command_str( - "show full-configuration", expect_string=self.prompt_pattern - ) - self._send_command_str("end", expect_string=self.prompt_pattern) + output = self._send_command_str("show full-configuration system console") if self._vdoms: self._exit_config_global() diff --git a/docs/netmiko/hillstone/hillstone.html b/docs/netmiko/hillstone/hillstone.html index 0880bf6b2..93ee281f3 100644 --- a/docs/netmiko/hillstone/hillstone.html +++ b/docs/netmiko/hillstone/hillstone.html @@ -82,7 +82,7 @@

    Classes

    class HillstoneStoneosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -176,7 +176,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -189,11 +190,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -364,7 +368,7 @@

    Inherited members

    class HillstoneStoneosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -458,7 +462,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -471,11 +476,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/hillstone/index.html b/docs/netmiko/hillstone/index.html index 66f095acb..13b632817 100644 --- a/docs/netmiko/hillstone/index.html +++ b/docs/netmiko/hillstone/index.html @@ -49,7 +49,7 @@

    Classes

    class HillstoneStoneosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -143,7 +143,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/hp/hp_comware.html b/docs/netmiko/hp/hp_comware.html index 43644fded..79af7d285 100644 --- a/docs/netmiko/hp/hp_comware.html +++ b/docs/netmiko/hp/hp_comware.html @@ -50,7 +50,7 @@

    Module netmiko.hp.hp_comware

    self._test_channel_read(pattern=r"[>\]]") self.set_base_prompt() - command = self.RETURN + "screen-length disable" + command = "screen-length disable" self.disable_paging(command=command) def config_mode( @@ -126,6 +126,9 @@

    Module netmiko.hp.hp_comware

    pattern=pattern, ) + # Strip off any leading RBM_. characters for firewall HA + prompt = re.sub(r"^RBM_.", "", prompt, flags=re.M) + # Strip off leading character prompt = prompt[1:] prompt = prompt.strip() @@ -272,7 +275,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -285,11 +289,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -326,7 +333,7 @@

    Classes

    self._test_channel_read(pattern=r"[>\]]") self.set_base_prompt() - command = self.RETURN + "screen-length disable" + command = "screen-length disable" self.disable_paging(command=command) def config_mode( @@ -402,6 +409,9 @@

    Classes

    pattern=pattern, ) + # Strip off any leading RBM_. characters for firewall HA + prompt = re.sub(r"^RBM_.", "", prompt, flags=re.M) + # Strip off leading character prompt = prompt[1:] prompt = prompt.strip() @@ -567,7 +577,7 @@

    Methods

    self._test_channel_read(pattern=r"[>\]]") self.set_base_prompt() - command = self.RETURN + "screen-length disable" + command = "screen-length disable" self.disable_paging(command=command)
  • @@ -608,6 +618,9 @@

    Methods

    pattern=pattern, ) + # Strip off any leading RBM_. characters for firewall HA + prompt = re.sub(r"^RBM_.", "", prompt, flags=re.M) + # Strip off leading character prompt = prompt[1:] prompt = prompt.strip() @@ -746,7 +759,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -759,11 +773,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -930,7 +947,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -943,11 +961,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/hp/hp_procurve.html b/docs/netmiko/hp/hp_procurve.html index d5bc6ffb7..da6dd438f 100644 --- a/docs/netmiko/hp/hp_procurve.html +++ b/docs/netmiko/hp/hp_procurve.html @@ -87,7 +87,7 @@

    Module netmiko.hp.hp_procurve

    # ProCurve requires elevated privileges to disable output paging :-( self.enable() self.set_terminal_width(command="terminal width 511", pattern="terminal") - command = self.RETURN + "no page" + command = "no page" self.disable_paging(command=command) def check_config_mode( @@ -355,7 +355,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -368,11 +369,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -439,7 +443,7 @@

    Classes

    # ProCurve requires elevated privileges to disable output paging :-( self.enable() self.set_terminal_width(command="terminal width 511", pattern="terminal") - command = self.RETURN + "no page" + command = "no page" self.disable_paging(command=command) def check_config_mode( @@ -733,7 +737,7 @@

    Methods

    # ProCurve requires elevated privileges to disable output paging :-( self.enable() self.set_terminal_width(command="terminal width 511", pattern="terminal") - command = self.RETURN + "no page" + command = "no page" self.disable_paging(command=command)
    @@ -872,7 +876,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -885,11 +890,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1074,7 +1082,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1087,11 +1096,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/hp/index.html b/docs/netmiko/hp/index.html index f8fcc116f..ad6751aee 100644 --- a/docs/netmiko/hp/index.html +++ b/docs/netmiko/hp/index.html @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -325,7 +329,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -338,11 +343,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -512,7 +520,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -525,11 +534,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -714,7 +726,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -727,11 +740,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/huawei/huawei.html b/docs/netmiko/huawei/huawei.html index e135c979e..5b75abc55 100644 --- a/docs/netmiko/huawei/huawei.html +++ b/docs/netmiko/huawei/huawei.html @@ -179,6 +179,16 @@

    Module netmiko.huawei.huawei

    self.write_channel("N" + self.RETURN) self.read_until_pattern(pattern=self.prompt_pattern) + # Huawei prompts for secure the configuration before displaying the initial base prompt. + if re.search( + r"security\srisks\sin\sthe\sconfiguration\sfile.*\[y\/n\]", data, flags=re.I + ): + self.send_command("Y", expect_string=r"(?i)continue.*\[y\/n\]") + self.send_command( + "Y", expect_string=r"saved\ssuccessfully", read_timeout=60 + ) + self.read_until_pattern(pattern=self.prompt_pattern) + class HuaweiTelnet(HuaweiBase): """Huawei Telnet driver.""" @@ -301,7 +311,7 @@

    Classes

    class HuaweiBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -395,7 +405,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -408,11 +419,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -821,7 +835,7 @@

    Inherited members

    class HuaweiSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei SSH driver.

    @@ -908,7 +922,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -921,11 +936,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -953,6 +971,16 @@

    Inherited members

    data = self.read_until_pattern(pattern=self.prompt_or_password_change) if re.search(self.password_change_prompt, data): self.write_channel("N" + self.RETURN) + self.read_until_pattern(pattern=self.prompt_pattern) + + # Huawei prompts for secure the configuration before displaying the initial base prompt. + if re.search( + r"security\srisks\sin\sthe\sconfiguration\sfile.*\[y\/n\]", data, flags=re.I + ): + self.send_command("Y", expect_string=r"(?i)continue.*\[y\/n\]") + self.send_command( + "Y", expect_string=r"saved\ssuccessfully", read_timeout=60 + ) self.read_until_pattern(pattern=self.prompt_pattern)

    Ancestors

    @@ -1017,7 +1045,7 @@

    Inherited members

    class HuaweiTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei Telnet driver.

    @@ -1104,7 +1132,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1117,11 +1146,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1305,7 +1337,7 @@

    Inherited members

    class HuaweiVrpv8SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei SSH driver.

    @@ -1392,7 +1424,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1405,11 +1438,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/huawei/huawei_smartax.html b/docs/netmiko/huawei/huawei_smartax.html index 068b4d6ae..9b7483416 100644 --- a/docs/netmiko/huawei/huawei_smartax.html +++ b/docs/netmiko/huawei/huawei_smartax.html @@ -172,7 +172,7 @@

    Classes

    class HuaweiSmartAXSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Supports Huawei SmartAX and OLT.

    @@ -259,7 +259,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -272,11 +273,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/huawei/index.html b/docs/netmiko/huawei/index.html index 67b4d7ca9..2ec6263a7 100644 --- a/docs/netmiko/huawei/index.html +++ b/docs/netmiko/huawei/index.html @@ -55,7 +55,7 @@

    Classes

    class HuaweiSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei SSH driver.

    @@ -142,7 +142,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -155,11 +156,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -187,6 +191,16 @@

    Classes

    data = self.read_until_pattern(pattern=self.prompt_or_password_change) if re.search(self.password_change_prompt, data): self.write_channel("N" + self.RETURN) + self.read_until_pattern(pattern=self.prompt_pattern) + + # Huawei prompts for secure the configuration before displaying the initial base prompt. + if re.search( + r"security\srisks\sin\sthe\sconfiguration\sfile.*\[y\/n\]", data, flags=re.I + ): + self.send_command("Y", expect_string=r"(?i)continue.*\[y\/n\]") + self.send_command( + "Y", expect_string=r"saved\ssuccessfully", read_timeout=60 + ) self.read_until_pattern(pattern=self.prompt_pattern)

    Ancestors

    @@ -251,7 +265,7 @@

    Inherited members

    class HuaweiSmartAXSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Supports Huawei SmartAX and OLT.

    @@ -338,7 +352,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -351,11 +366,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -633,7 +651,7 @@

    Inherited members

    class HuaweiTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei Telnet driver.

    @@ -720,7 +738,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -733,11 +752,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -921,7 +943,7 @@

    Inherited members

    class HuaweiVrpv8SSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Huawei SSH driver.

    @@ -1008,7 +1030,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1021,11 +1044,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/index.html b/docs/netmiko/index.html index 07e939858..155f5d9b7 100644 --- a/docs/netmiko/index.html +++ b/docs/netmiko/index.html @@ -28,10 +28,10 @@

    Package netmiko

    import sys
     
    -__version__ = "4.1.3"
    +__version__ = "4.3.0"
     PY_MAJ_VER = 3
    -PY_MIN_VER = 7
    -MIN_PYTHON_VER = "3.7"
    +PY_MIN_VER = 8
    +MIN_PYTHON_VER = "3.8"
     
     
     # Make sure user is using a valid Python version (for Netmiko)
    @@ -66,6 +66,7 @@ 

    Package netmiko

    from netmiko.ssh_dispatcher import ConnectHandler # noqa +from netmiko.ssh_dispatcher import TelnetFallback # noqa from netmiko.ssh_dispatcher import ConnLogOnly # noqa from netmiko.ssh_dispatcher import ConnUnify # noqa from netmiko.ssh_dispatcher import ssh_dispatcher # noqa @@ -94,6 +95,7 @@

    Package netmiko

    __all__ = ( "ConnectHandler", + "AgnosticHandler", "ConnLogOnly", "ConnUnify", "ssh_dispatcher", @@ -237,6 +239,10 @@

    Sub-modules

    +
    netmiko.digi
    +
    +
    +
    netmiko.dlink
    @@ -269,6 +275,10 @@

    Sub-modules

    +
    netmiko.fiberstore
    +
    +
    +
    netmiko.flexvnf
    @@ -305,6 +315,10 @@

    Sub-modules

    +
    netmiko.maipu
    +
    +
    +
    netmiko.mellanox
    @@ -419,6 +433,10 @@

    Sub-modules

    +
    netmiko.telnet_proxy
    +
    +
    +
    netmiko.terminal_server
    @@ -462,6 +480,31 @@

    Sub-modules

    Functions

    +
    +def AgnosticHandler(*args: Any, **kwargs: Any) ‑> BaseConnection +
    +
    +

    Factory function selects the proper class and creates object based on device_type.

    +
    + +Expand source code + +
    def ConnectHandler(*args: Any, **kwargs: Any) -> "BaseConnection":
    +    """Factory function selects the proper class and creates object based on device_type."""
    +    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(msg_str)
    +        )
    +    ConnectionClass = ssh_dispatcher(device_type)
    +    return ConnectionClass(*args, **kwargs)
    +
    +
    def ConnLogOnly(log_file: str = 'netmiko.log', log_level: Optional[int] = None, log_format: Optional[str] = None, **kwargs: Any) ‑> Optional[BaseConnection]
    @@ -842,7 +885,7 @@

    Classes

    class BaseConnection -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -930,7 +973,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -943,11 +987,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1022,6 +1069,7 @@

    Classes

    allow_auto_change: bool = False, encoding: str = "utf-8", sock: Optional[socket.socket] = None, + sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False, @@ -1108,7 +1156,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1121,11 +1170,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a `.Channel`) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :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. @@ -1192,6 +1244,7 @@

    Classes

    self.allow_auto_change = allow_auto_change self.encoding = encoding self.sock = sock + self.sock_telnet = sock_telnet self.fast_cli = fast_cli self._legacy_mode = _legacy_mode self.global_delay_factor = global_delay_factor @@ -1207,6 +1260,7 @@

    Classes

    no_log["password"] = self.password if self.secret: no_log["secret"] = self.secret + # Always sanitize username and password log.addFilter(SecretsFilter(no_log=no_log)) # Netmiko will close the session_log if we open the file @@ -1227,10 +1281,14 @@

    Classes

    no_log=no_log, record_writes=session_log_record_writes, ) + elif isinstance(session_log, SessionLog): + # SessionLog object + self.session_log = session_log + self.session_log.open() else: raise ValueError( "session_log must be a path to a file, a file handle, " - "or a BufferedIOBase subclass." + "SessionLog object, or a BufferedIOBase subclass." ) # Default values @@ -1508,7 +1566,6 @@

    Classes

    start_time = time.time() # if read_timeout == 0 or 0.0 keep reading indefinitely while (time.time() - start_time < read_timeout) or (not read_timeout): - output += self.read_channel() if re.search(pattern, output, flags=re_flags): @@ -1925,9 +1982,17 @@

    Classes

    """ self.channel: Channel if self.protocol == "telnet": - self.remote_conn = telnetlib.Telnet( - self.host, port=self.port, timeout=self.timeout - ) + if self.sock_telnet: + self.remote_conn = telnet_proxy.Telnet( + self.host, + port=self.port, + timeout=self.timeout, + proxy_dict=self.sock_telnet, + ) + else: + self.remote_conn = telnetlib.Telnet( + self.host, port=self.port, timeout=self.timeout + ) # Migrating communication to channel class self.channel = TelnetChannel(conn=self.remote_conn, encoding=self.encoding) self.telnet_login() @@ -2288,7 +2353,6 @@

    Classes

    return output def command_echo_read(self, cmd: str, read_timeout: float) -> str: - # Make sure you read until you detect the command echo (avoid getting out of sync) new_data = self.read_until_pattern( pattern=re.escape(cmd), read_timeout=read_timeout @@ -2305,6 +2369,7 @@

    Classes

    pass return new_data + @flush_session_log @select_cmd_verify def send_command_timing( self, @@ -2453,6 +2518,7 @@

    Classes

    prompt = self.base_prompt return re.escape(prompt.strip()) + @flush_session_log @select_cmd_verify def send_command( self, @@ -2976,6 +3042,7 @@

    Classes

    commands = cfg_file.readlines() return self.send_config_set(commands, **kwargs) + @flush_session_log def send_config_set( self, config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None, @@ -3513,7 +3580,6 @@

    Methods

    Expand source code
    def command_echo_read(self, cmd: str, read_timeout: float) -> str:
    -
         # Make sure you read until you detect the command echo (avoid getting out of sync)
         new_data = self.read_until_pattern(
             pattern=re.escape(cmd), read_timeout=read_timeout
    @@ -3783,9 +3849,17 @@ 

    Methods

    """ self.channel: Channel if self.protocol == "telnet": - self.remote_conn = telnetlib.Telnet( - self.host, port=self.port, timeout=self.timeout - ) + if self.sock_telnet: + self.remote_conn = telnet_proxy.Telnet( + self.host, + port=self.port, + timeout=self.timeout, + proxy_dict=self.sock_telnet, + ) + else: + self.remote_conn = telnetlib.Telnet( + self.host, port=self.port, timeout=self.timeout + ) # Migrating communication to channel class self.channel = TelnetChannel(conn=self.remote_conn, encoding=self.encoding) self.telnet_login() @@ -4321,7 +4395,6 @@

    Methods

    start_time = time.time() # if read_timeout == 0 or 0.0 keep reading indefinitely while (time.time() - start_time < read_timeout) or (not read_timeout): - output += self.read_channel() if re.search(pattern, output, flags=re_flags): @@ -4574,7 +4647,8 @@

    Methods

    Expand source code -
        @select_cmd_verify
    +
        @flush_session_log
    +    @select_cmd_verify
         def send_command(
             self,
             command_string: str,
    @@ -4816,7 +4890,8 @@ 

    Methods

    Expand source code -
    @select_cmd_verify
    +
    @flush_session_log
    +@select_cmd_verify
     def send_command_timing(
         self,
         command_string: str,
    @@ -4970,7 +5045,8 @@ 

    Methods

    Expand source code -
    def send_config_set(
    +
    @flush_session_log
    +def send_config_set(
         self,
         config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None,
         *,
    @@ -6759,6 +6835,7 @@ 

    Index

  • netmiko.cloudgenix
  • netmiko.coriant
  • netmiko.dell
  • +
  • netmiko.digi
  • netmiko.dlink
  • netmiko.eltex
  • netmiko.endace
  • @@ -6767,6 +6844,7 @@

    Index

  • netmiko.exceptions
  • netmiko.extreme
  • netmiko.f5
  • +
  • netmiko.fiberstore
  • netmiko.flexvnf
  • netmiko.fortinet
  • netmiko.hillstone
  • @@ -6776,6 +6854,7 @@

    Index

  • netmiko.juniper
  • netmiko.keymile
  • netmiko.linux
  • +
  • netmiko.maipu
  • netmiko.mellanox
  • netmiko.mikrotik
  • netmiko.mrv
  • @@ -6804,6 +6883,7 @@

    Index

  • netmiko.ssh_autodetect
  • netmiko.supermicro
  • netmiko.teldat
  • +
  • netmiko.telnet_proxy
  • netmiko.terminal_server
  • netmiko.tplink
  • netmiko.ubiquiti
  • @@ -6817,6 +6897,7 @@

    Index

  • Functions

      +
    • AgnosticHandler
    • ConnLogOnly
    • ConnUnify
    • ConnectHandler
    • diff --git a/docs/netmiko/ipinfusion/index.html b/docs/netmiko/ipinfusion/index.html index 5273b6ea3..cb1efb174 100644 --- a/docs/netmiko/ipinfusion/index.html +++ b/docs/netmiko/ipinfusion/index.html @@ -139,7 +139,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -152,11 +153,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -325,7 +329,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -338,11 +343,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ipinfusion/ipinfusion_ocnos.html b/docs/netmiko/ipinfusion/ipinfusion_ocnos.html index 89759b609..c3c190523 100644 --- a/docs/netmiko/ipinfusion/ipinfusion_ocnos.html +++ b/docs/netmiko/ipinfusion/ipinfusion_ocnos.html @@ -204,7 +204,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -217,11 +218,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -433,7 +437,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -446,11 +451,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -619,7 +627,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -632,11 +641,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/juniper/index.html b/docs/netmiko/juniper/index.html index 4b9852716..1f909fd2c 100644 --- a/docs/netmiko/juniper/index.html +++ b/docs/netmiko/juniper/index.html @@ -141,7 +141,7 @@

      Inherited members

  • class JuniperSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Juniper Networks devices.

    @@ -230,7 +230,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -243,11 +244,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -328,7 +332,7 @@

    Inherited members

    class JuniperScreenOsSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Juniper ScreenOS devices.

    @@ -415,7 +419,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -428,11 +433,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -669,7 +677,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -682,11 +691,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/juniper/juniper.html b/docs/netmiko/juniper/juniper.html index 4b010b01b..7389d315e 100644 --- a/docs/netmiko/juniper/juniper.html +++ b/docs/netmiko/juniper/juniper.html @@ -352,7 +352,7 @@

    Classes

    class JuniperBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Juniper Networks devices.

    @@ -441,7 +441,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -454,11 +455,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1196,7 +1200,7 @@

    Inherited members

    class JuniperSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Juniper Networks devices.

    @@ -1285,7 +1289,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1298,11 +1303,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1472,7 +1480,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1485,11 +1494,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/juniper/juniper_screenos.html b/docs/netmiko/juniper/juniper_screenos.html index 7382f8d6c..272198456 100644 --- a/docs/netmiko/juniper/juniper_screenos.html +++ b/docs/netmiko/juniper/juniper_screenos.html @@ -71,7 +71,7 @@

    Classes

    class JuniperScreenOsSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Juniper ScreenOS devices.

    @@ -158,7 +158,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -171,11 +172,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/keymile/index.html b/docs/netmiko/keymile/index.html index 818e4ed2a..6ffb10bfc 100644 --- a/docs/netmiko/keymile/index.html +++ b/docs/netmiko/keymile/index.html @@ -54,7 +54,7 @@

    Classes

    class KeymileNOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Common Methods for IOS (both SSH and telnet).

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/keymile/keymile_nos_ssh.html b/docs/netmiko/keymile/keymile_nos_ssh.html index 75685ddfb..f39dbb686 100644 --- a/docs/netmiko/keymile/keymile_nos_ssh.html +++ b/docs/netmiko/keymile/keymile_nos_ssh.html @@ -73,7 +73,7 @@

    Classes

    class KeymileNOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Common Methods for IOS (both SSH and telnet).

    @@ -160,7 +160,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -173,11 +174,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/linux/index.html b/docs/netmiko/linux/index.html index 562718373..242218658 100644 --- a/docs/netmiko/linux/index.html +++ b/docs/netmiko/linux/index.html @@ -156,7 +156,7 @@

    Inherited members

    class LinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -243,7 +243,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -256,11 +257,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/linux/linux_ssh.html b/docs/netmiko/linux/linux_ssh.html index 23dba4ed1..b063f5305 100644 --- a/docs/netmiko/linux/linux_ssh.html +++ b/docs/netmiko/linux/linux_ssh.html @@ -373,7 +373,7 @@

    Inherited members

    class LinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -460,7 +460,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -473,11 +474,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/maipu/index.html b/docs/netmiko/maipu/index.html new file mode 100644 index 000000000..5f5aee372 --- /dev/null +++ b/docs/netmiko/maipu/index.html @@ -0,0 +1,465 @@ + + + + + + +netmiko.maipu API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.maipu

    +
    +
    +
    + +Expand source code + +
    from netmiko.maipu.maipu import MaipuSSH
    +from netmiko.maipu.maipu import MaipuTelnet
    +
    +__all__ = ["MaipuSSH", "MaipuTelnet"]
    +
    +
    +
    +

    Sub-modules

    +
    +
    netmiko.maipu.maipu
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class MaipuSSH +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    MAIPU SSH driver

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class MaipuSSH(MaipuBase):
    +    """MAIPU SSH driver"""
    +
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +class MaipuTelnet +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    MAIPU telnet driver

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class MaipuTelnet(MaipuBase):
    +    """MAIPU telnet driver"""
    +
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/maipu/maipu.html b/docs/netmiko/maipu/maipu.html new file mode 100644 index 000000000..67d91d6ae --- /dev/null +++ b/docs/netmiko/maipu/maipu.html @@ -0,0 +1,737 @@ + + + + + + +netmiko.maipu.maipu API documentation + + + + + + + + + + + +
    +
    +
    +

    Module netmiko.maipu.maipu

    +
    +
    +
    + +Expand source code + +
    import time
    +
    +from netmiko.cisco_base_connection import CiscoBaseConnection
    +
    +
    +class MaipuBase(CiscoBaseConnection):
    +    def session_preparation(self) -> None:
    +        """Prepare the session after the connection has been established."""
    +        self._test_channel_read(pattern=r"[>#]")
    +        self.set_base_prompt()
    +        self.enable()
    +        self.disable_paging(command="more off")
    +        # Clear the read buffer
    +        time.sleep(0.3 * self.global_delay_factor)
    +        self.clear_buffer()
    +
    +    def save_config(
    +        self, cmd: str = "write", confirm: bool = False, confirm_response: str = ""
    +    ) -> str:
    +        """Saves Config Using Copy Run Start"""
    +        return super().save_config(
    +            cmd=cmd, confirm=confirm, confirm_response=confirm_response
    +        )
    +
    +
    +class MaipuSSH(MaipuBase):
    +    """MAIPU SSH driver"""
    +
    +    pass
    +
    +
    +class MaipuTelnet(MaipuBase):
    +    """MAIPU telnet driver"""
    +
    +    pass
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class MaipuBase +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    Base Class for cisco-like behavior.

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class MaipuBase(CiscoBaseConnection):
    +    def session_preparation(self) -> None:
    +        """Prepare the session after the connection has been established."""
    +        self._test_channel_read(pattern=r"[>#]")
    +        self.set_base_prompt()
    +        self.enable()
    +        self.disable_paging(command="more off")
    +        # Clear the read buffer
    +        time.sleep(0.3 * self.global_delay_factor)
    +        self.clear_buffer()
    +
    +    def save_config(
    +        self, cmd: str = "write", confirm: bool = False, confirm_response: str = ""
    +    ) -> str:
    +        """Saves Config Using Copy Run Start"""
    +        return super().save_config(
    +            cmd=cmd, confirm=confirm, confirm_response=confirm_response
    +        )
    +
    +

    Ancestors

    + +

    Subclasses

    + +

    Methods

    +
    +
    +def save_config(self, cmd: str = 'write', confirm: bool = False, confirm_response: str = '') ‑> str +
    +
    +

    Saves Config Using Copy Run Start

    +
    + +Expand source code + +
    def save_config(
    +    self, cmd: str = "write", confirm: bool = False, confirm_response: str = ""
    +) -> str:
    +    """Saves Config Using Copy Run Start"""
    +    return super().save_config(
    +        cmd=cmd, confirm=confirm, confirm_response=confirm_response
    +    )
    +
    +
    +
    +def session_preparation(self) ‑> None +
    +
    +

    Prepare the session after the connection has been established.

    +
    + +Expand source code + +
    def session_preparation(self) -> None:
    +    """Prepare the session after the connection has been established."""
    +    self._test_channel_read(pattern=r"[>#]")
    +    self.set_base_prompt()
    +    self.enable()
    +    self.disable_paging(command="more off")
    +    # Clear the read buffer
    +    time.sleep(0.3 * self.global_delay_factor)
    +    self.clear_buffer()
    +
    +
    +
    +

    Inherited members

    + +
    +
    +class MaipuSSH +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    MAIPU SSH driver

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class MaipuSSH(MaipuBase):
    +    """MAIPU SSH driver"""
    +
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +class MaipuTelnet +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +
    +
    +

    MAIPU telnet driver

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if <code>host</code> is
    +        provided.
    +
    +    :param host: Hostname of target device. Not required if <code>ip</code> is
    +            provided.
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +
    +    :param secret: The enable password if target device requires one.
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +
    +    :param device_type: Class selection based on device type.
    +
    +    :param verbose: Enable additional messages to standard output.
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +
    +    :param pkey: SSH key object to use.
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +
    +    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
    +            documentation for a description of the expected format.
    +
    +    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
    +        <https://github.com/paramiko/paramiko/issues/1961> (default: False)
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +
    +    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
    +            alt_key_file.
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +
    +    :param conn_timeout: TCP connection timeout.
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +
    +    :param read_timeout_override: Set a timeout that will override the default read_timeout
    +            of both send_command and send_command_timing. This is useful for 3rd party
    +            libraries where directly accessing method arguments might be impractical.
    +
    +    :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).
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ).

    +
        :param response_return: Character(s) to use in normalized return data to represent
    +            enter key (default:
    +
    +

    )

    +
        :param serial_settings: Dictionary of settings for use with serial port (pySerial).
    +
    +    :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: True)
    +
    +    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
    +            to write the session log to.
    +
    +    :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).
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: "utf-8")
    +
    +    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
    +            communication to the target host (default: None).
    +
    +    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
    +            telnet_proxy.py code for details.
    +
    +    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
    +            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
    +            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
    +
    +    :param auto_connect: Control whether Netmiko automatically establishes the connection as
    +            part of the object creation (default: True).
    +
    +    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
    +            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
    +            eliminated in Netmiko 5.x (default: False).
    +
    +    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
    +            (default: False)
    +
    +
    + +Expand source code + +
    class MaipuTelnet(MaipuBase):
    +    """MAIPU telnet driver"""
    +
    +    pass
    +
    +

    Ancestors

    + +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/docs/netmiko/mellanox/index.html b/docs/netmiko/mellanox/index.html index 2cbe74762..1165495e7 100644 --- a/docs/netmiko/mellanox/index.html +++ b/docs/netmiko/mellanox/index.html @@ -49,7 +49,7 @@

    Classes

    class MellanoxMlnxosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Mellanox MLNX-OS Switch support.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html index 21d5c31ce..44865fdca 100644 --- a/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html +++ b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html @@ -139,7 +139,7 @@

    Classes

    class MellanoxMlnxosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Mellanox MLNX-OS Switch support.

    @@ -226,7 +226,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -239,11 +240,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/mikrotik/mikrotik_ssh.html b/docs/netmiko/mikrotik/mikrotik_ssh.html index 836748c3b..a70f335ed 100644 --- a/docs/netmiko/mikrotik/mikrotik_ssh.html +++ b/docs/netmiko/mikrotik/mikrotik_ssh.html @@ -67,10 +67,10 @@

    Module netmiko.mikrotik.mikrotik_ssh

    c: disable console colors e: enable dumb terminal mode t: disable auto detect terminal capabilities - w511: set term width - h4098: set term height + 511w: set term width + 4098h: set term height """ - self.username += "+ctw511h4098" + self.username += "+ct511w4098h" def disable_paging(self, *args: Any, **kwargs: Any) -> str: """Mikrotik does not have paging by default.""" @@ -363,10 +363,10 @@

    Classes

    c: disable console colors e: enable dumb terminal mode t: disable auto detect terminal capabilities - w511: set term width - h4098: set term height + 511w: set term width + 4098h: set term height """ - self.username += "+ctw511h4098" + self.username += "+ct511w4098h" def disable_paging(self, *args: Any, **kwargs: Any) -> str: """Mikrotik does not have paging by default.""" diff --git a/docs/netmiko/mrv/index.html b/docs/netmiko/mrv/index.html index d6a4c9a27..a96361e0d 100644 --- a/docs/netmiko/mrv/index.html +++ b/docs/netmiko/mrv/index.html @@ -54,7 +54,7 @@

    Classes

    class MrvLxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    MRV Communications Driver (LX).

    @@ -141,7 +141,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -154,11 +155,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -334,7 +338,7 @@

    Inherited members

    class MrvOptiswitchSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    MRV Communications Driver (OptiSwitch).

    @@ -421,7 +425,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -434,11 +439,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/mrv/mrv_lx.html b/docs/netmiko/mrv/mrv_lx.html index 2c9ddbfe2..6b60ac973 100644 --- a/docs/netmiko/mrv/mrv_lx.html +++ b/docs/netmiko/mrv/mrv_lx.html @@ -92,7 +92,7 @@

    Classes

    class MrvLxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    MRV Communications Driver (LX).

    @@ -179,7 +179,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -192,11 +193,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/mrv/mrv_ssh.html b/docs/netmiko/mrv/mrv_ssh.html index 1c97e4799..7c585473f 100644 --- a/docs/netmiko/mrv/mrv_ssh.html +++ b/docs/netmiko/mrv/mrv_ssh.html @@ -97,7 +97,7 @@

    Classes

    class MrvOptiswitchSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    MRV Communications Driver (OptiSwitch).

    @@ -184,7 +184,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -197,11 +198,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/netapp/index.html b/docs/netmiko/netapp/index.html index 3d6c6d49b..f814a179f 100644 --- a/docs/netmiko/netapp/index.html +++ b/docs/netmiko/netapp/index.html @@ -49,7 +49,7 @@

    Classes

    class NetAppcDotSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -143,7 +143,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/netapp/netapp_cdot_ssh.html b/docs/netmiko/netapp/netapp_cdot_ssh.html index 1778af4ab..1d9b1f40b 100644 --- a/docs/netmiko/netapp/netapp_cdot_ssh.html +++ b/docs/netmiko/netapp/netapp_cdot_ssh.html @@ -81,7 +81,7 @@

    Classes

    class NetAppcDotSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -175,7 +175,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -188,11 +189,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/netgear/index.html b/docs/netmiko/netgear/index.html index 387a3790b..2585bd6f4 100644 --- a/docs/netmiko/netgear/index.html +++ b/docs/netmiko/netgear/index.html @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/netgear/netgear_prosafe_ssh.html b/docs/netmiko/netgear/netgear_prosafe_ssh.html index 96c37cf5d..1ea2f8965 100644 --- a/docs/netmiko/netgear/netgear_prosafe_ssh.html +++ b/docs/netmiko/netgear/netgear_prosafe_ssh.html @@ -188,7 +188,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -201,11 +202,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/no_config.html b/docs/netmiko/no_config.html index 2a115bbd7..25ec8b43c 100644 --- a/docs/netmiko/no_config.html +++ b/docs/netmiko/no_config.html @@ -113,6 +113,7 @@

    Subclasses

  • NetscalerSSH
  • CloudGenixIonSSH
  • CoriantSSH
  • +
  • DigiTransportBase
  • DlinkDSBase
  • ExtremeExosBase
  • F5TmshSSH
  • diff --git a/docs/netmiko/no_enable.html b/docs/netmiko/no_enable.html index 7cfef5fb1..2a4f64cd0 100644 --- a/docs/netmiko/no_enable.html +++ b/docs/netmiko/no_enable.html @@ -132,11 +132,13 @@

    Subclasses

  • CiscoFtdSSH
  • CoriantSSH
  • DellSonicSSH
  • +
  • DigiTransportBase
  • DlinkDSBase
  • EricssonMinilinkBase
  • ExtremeNosSSH
  • ExtremeSlxSSH
  • ExtremeTierraSSH
  • +
  • FiberstoreFsosSSH
  • FlexvnfSSH
  • FortinetSSH
  • HillstoneStoneosBase
  • diff --git a/docs/netmiko/nokia/index.html b/docs/netmiko/nokia/index.html index df39eccc3..98237fa4c 100644 --- a/docs/netmiko/nokia/index.html +++ b/docs/netmiko/nokia/index.html @@ -59,7 +59,7 @@

    Classes

    class NokiaSrlSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Nokia SRL devices for SSH.

    @@ -162,7 +162,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -175,11 +176,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -710,7 +714,7 @@

    Inherited members

    class NokiaSrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Nokia SR OS SSH driver.

    @@ -797,7 +801,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -810,11 +815,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -894,7 +902,7 @@

    Inherited members

    class NokiaSrosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Nokia SR OS Telnet driver.

    @@ -981,7 +989,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -994,11 +1003,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/nokia/nokia_srl.html b/docs/netmiko/nokia/nokia_srl.html index c1dd963b3..ff31ca545 100644 --- a/docs/netmiko/nokia/nokia_srl.html +++ b/docs/netmiko/nokia/nokia_srl.html @@ -204,7 +204,7 @@

    Classes

    class NokiaSrlSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Nokia SRL devices for SSH.

    @@ -307,7 +307,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -320,11 +321,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/nokia/nokia_sros.html b/docs/netmiko/nokia/nokia_sros.html index 09cb627f5..e315ad11b 100644 --- a/docs/netmiko/nokia/nokia_sros.html +++ b/docs/netmiko/nokia/nokia_sros.html @@ -76,7 +76,6 @@

    Module netmiko.nokia.nokia_sros

    command="environment console width 512", pattern="environment" ) self.disable_paging(command="environment more false") - # To perform file operations we need to disable paging in classical-CLI also self.disable_paging(command="//environment no more") else: # Classical CLI has no method to set the terminal width nor to disable command @@ -84,6 +83,8 @@

    Module netmiko.nokia.nokia_sros

    # Only disabled if not set under the ConnectHandler. if self.global_cmd_verify is None: self.global_cmd_verify = False + # Disable paging in both modes, file operations require no paging in classic + self.disable_paging(command="//environment more false") self.disable_paging(command="environment no more", pattern="environment") # Clear the read buffer @@ -442,7 +443,7 @@

    Classes

    class NokiaSros -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with Nokia SR OS devices @@ -543,7 +544,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -556,11 +558,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -610,7 +615,6 @@

    Classes

    command="environment console width 512", pattern="environment" ) self.disable_paging(command="environment more false") - # To perform file operations we need to disable paging in classical-CLI also self.disable_paging(command="//environment no more") else: # Classical CLI has no method to set the terminal width nor to disable command @@ -618,6 +622,8 @@

    Classes

    # Only disabled if not set under the ConnectHandler. if self.global_cmd_verify is None: self.global_cmd_verify = False + # Disable paging in both modes, file operations require no paging in classic + self.disable_paging(command="//environment more false") self.disable_paging(command="environment no more", pattern="environment") # Clear the read buffer @@ -1375,7 +1381,7 @@

    Inherited members

    class NokiaSrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Nokia SR OS SSH driver.

    @@ -1462,7 +1468,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1475,11 +1482,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1559,7 +1569,7 @@

    Inherited members

    class NokiaSrosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Nokia SR OS Telnet driver.

    @@ -1646,7 +1656,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1659,11 +1670,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ovs/index.html b/docs/netmiko/ovs/index.html index af0f85b51..c1a2edf93 100644 --- a/docs/netmiko/ovs/index.html +++ b/docs/netmiko/ovs/index.html @@ -49,7 +49,7 @@

    Classes

    class OvsLinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ovs/ovs_linux_ssh.html b/docs/netmiko/ovs/ovs_linux_ssh.html index 9143e69c9..a677bc610 100644 --- a/docs/netmiko/ovs/ovs_linux_ssh.html +++ b/docs/netmiko/ovs/ovs_linux_ssh.html @@ -44,7 +44,7 @@

    Classes

    class OvsLinuxSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -131,7 +131,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -144,11 +145,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/paloalto/index.html b/docs/netmiko/paloalto/index.html index 5b2ee65a2..5bb898dc8 100644 --- a/docs/netmiko/paloalto/index.html +++ b/docs/netmiko/paloalto/index.html @@ -49,7 +49,7 @@

    Classes

    class PaloAltoPanosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with PaloAlto devices.

    @@ -139,7 +139,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -152,11 +153,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -254,7 +258,7 @@

    Inherited members

    class PaloAltoPanosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with PaloAlto devices.

    @@ -344,7 +348,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -357,11 +362,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/paloalto/paloalto_panos.html b/docs/netmiko/paloalto/paloalto_panos.html index a20d282fc..cf4b75074 100644 --- a/docs/netmiko/paloalto/paloalto_panos.html +++ b/docs/netmiko/paloalto/paloalto_panos.html @@ -295,7 +295,7 @@

    Classes

    class PaloAltoPanosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with PaloAlto devices.

    @@ -385,7 +385,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -398,11 +399,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -942,7 +946,7 @@

    Inherited members

    class PaloAltoPanosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with PaloAlto devices.

    @@ -1032,7 +1036,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1045,11 +1050,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1147,7 +1155,7 @@

    Inherited members

    class PaloAltoPanosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with PaloAlto devices.

    @@ -1237,7 +1245,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1250,11 +1259,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/quanta/index.html b/docs/netmiko/quanta/index.html index 05f98c0e8..9da1bd52b 100644 --- a/docs/netmiko/quanta/index.html +++ b/docs/netmiko/quanta/index.html @@ -49,7 +49,7 @@

    Classes

    class QuantaMeshSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/quanta/quanta_mesh_ssh.html b/docs/netmiko/quanta/quanta_mesh_ssh.html index 517b4a36a..0b352e2ce 100644 --- a/docs/netmiko/quanta/quanta_mesh_ssh.html +++ b/docs/netmiko/quanta/quanta_mesh_ssh.html @@ -66,7 +66,7 @@

    Classes

    class QuantaMeshSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -153,7 +153,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -166,11 +167,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/rad/index.html b/docs/netmiko/rad/index.html index 981d0e797..c028f279f 100644 --- a/docs/netmiko/rad/index.html +++ b/docs/netmiko/rad/index.html @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -238,7 +242,7 @@

    Inherited members

    class RadETXTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    RAD ETX Telnet Support.

    @@ -325,7 +329,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -338,11 +343,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/rad/rad_etx.html b/docs/netmiko/rad/rad_etx.html index 9726e2562..01d52864d 100644 --- a/docs/netmiko/rad/rad_etx.html +++ b/docs/netmiko/rad/rad_etx.html @@ -141,7 +141,7 @@

    Classes

    class RadETXBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    RAD ETX Support, Tested on RAD 203AX, 205A and 220A.

    @@ -228,7 +228,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -241,11 +242,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -555,7 +559,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -568,11 +573,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -656,7 +664,7 @@

    Inherited members

    class RadETXTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    RAD ETX Telnet Support.

    @@ -743,7 +751,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -756,11 +765,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/raisecom/index.html b/docs/netmiko/raisecom/index.html index 1261aad8d..16adedf4b 100644 --- a/docs/netmiko/raisecom/index.html +++ b/docs/netmiko/raisecom/index.html @@ -50,7 +50,7 @@

    Classes

    class RaisecomRoapSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -295,7 +299,7 @@

    Inherited members

    class RaisecomRoapTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -382,7 +386,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -395,11 +400,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/raisecom/raisecom_roap.html b/docs/netmiko/raisecom/raisecom_roap.html index dd077e21a..f7fd7a991 100644 --- a/docs/netmiko/raisecom/raisecom_roap.html +++ b/docs/netmiko/raisecom/raisecom_roap.html @@ -198,7 +198,7 @@

    Classes

    class RaisecomRoapBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -285,7 +285,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -298,11 +299,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -436,7 +440,7 @@

    Inherited members

    class RaisecomRoapSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -523,7 +527,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -536,11 +541,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -681,7 +689,7 @@

    Inherited members

    class RaisecomRoapTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -768,7 +776,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -781,11 +790,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ruckus/index.html b/docs/netmiko/ruckus/index.html index d5715f324..664450a8a 100644 --- a/docs/netmiko/ruckus/index.html +++ b/docs/netmiko/ruckus/index.html @@ -50,7 +50,7 @@

    Classes

    class RuckusFastironSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ruckus FastIron aka ICX support.

    @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -321,7 +325,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -334,11 +339,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ruckus/ruckus_fastiron.html b/docs/netmiko/ruckus/ruckus_fastiron.html index 9b97c621c..35f15145c 100644 --- a/docs/netmiko/ruckus/ruckus_fastiron.html +++ b/docs/netmiko/ruckus/ruckus_fastiron.html @@ -150,7 +150,7 @@

    Classes

    class RuckusFastironBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ruckus FastIron aka ICX support.

    @@ -237,7 +237,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -250,11 +251,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -513,7 +517,7 @@

    Inherited members

    class RuckusFastironSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Ruckus FastIron aka ICX support.

    @@ -600,7 +604,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -613,11 +618,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -784,7 +792,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -797,11 +806,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ruijie/index.html b/docs/netmiko/ruijie/index.html index 7babe842f..6f57f1a22 100644 --- a/docs/netmiko/ruijie/index.html +++ b/docs/netmiko/ruijie/index.html @@ -49,7 +49,7 @@

    Classes

    class RuijieOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -320,7 +324,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -333,11 +338,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ruijie/ruijie_os.html b/docs/netmiko/ruijie/ruijie_os.html index 33125cbf4..d82849d28 100644 --- a/docs/netmiko/ruijie/ruijie_os.html +++ b/docs/netmiko/ruijie/ruijie_os.html @@ -79,7 +79,7 @@

    Classes

    class RuijieOSBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -166,7 +166,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -179,11 +180,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -325,7 +329,7 @@

    Inherited members

    class RuijieOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -412,7 +416,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -425,11 +430,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -596,7 +604,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -609,11 +618,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/scp_handler.html b/docs/netmiko/scp_handler.html index df980421b..de0b9edd6 100644 --- a/docs/netmiko/scp_handler.html +++ b/docs/netmiko/scp_handler.html @@ -302,7 +302,8 @@

    Module netmiko.scp_handler

    remote_out = "".join(remote_out_lines) # Match line containing file name assert isinstance(remote_file, str) - escape_file_name = re.escape(remote_file) + remote_file_base = os.path.basename(remote_file) + escape_file_name = re.escape(remote_file_base) pattern = r".*({}).*".format(escape_file_name) match = re.search(pattern, remote_out) if match: @@ -682,7 +683,8 @@

    Classes

    remote_out = "".join(remote_out_lines) # Match line containing file name assert isinstance(remote_file, str) - escape_file_name = re.escape(remote_file) + remote_file_base = os.path.basename(remote_file) + escape_file_name = re.escape(remote_file_base) pattern = r".*({}).*".format(escape_file_name) match = re.search(pattern, remote_out) if match: @@ -1132,7 +1134,8 @@

    Args

    remote_out = "".join(remote_out_lines) # Match line containing file name assert isinstance(remote_file, str) - escape_file_name = re.escape(remote_file) + remote_file_base = os.path.basename(remote_file) + escape_file_name = re.escape(remote_file_base) pattern = r".*({}).*".format(escape_file_name) match = re.search(pattern, remote_out) if match: diff --git a/docs/netmiko/session_log.html b/docs/netmiko/session_log.html index dff277ab6..72b4023bb 100644 --- a/docs/netmiko/session_log.html +++ b/docs/netmiko/session_log.html @@ -40,6 +40,7 @@

    Module netmiko.session_log

    file_encoding: str = "utf-8", no_log: Optional[Dict[str, Any]] = None, record_writes: bool = False, + slog_buffer: Optional[io.StringIO] = None, ) -> None: if no_log is None: self.no_log = {} @@ -58,6 +59,13 @@

    Module netmiko.session_log

    else: self.session_log = None + # In order to ensure all the no_log entries get hidden properly, + # we must first store everying in memory and then write out to file. + # Otherwise, we might miss the data we are supposed to hide (since + # the no_log data potentially spans multiple reads). + if slog_buffer is None: + self.slog_buffer = io.StringIO() + # Ensures last write operations prior to disconnect are recorded. self.fin = False @@ -77,15 +85,30 @@

    Module netmiko.session_log

    def close(self) -> None: """Close the session_log file (if it is a file that we opened).""" + self.flush() if self.session_log and self._session_log_close: self.session_log.close() self.session_log = None - def write(self, data: str) -> None: - if self.session_log is not None and len(data) > 0: - # Hide the password and secret in the session_log - for hidden_data in self.no_log.values(): - data = data.replace(hidden_data, "********") + def no_log_filter(self, data: str) -> str: + """Filter content from the session_log.""" + for hidden_data in self.no_log.values(): + data = data.replace(hidden_data, "********") + return data + + def _read_buffer(self) -> str: + self.slog_buffer.seek(0) + data = self.slog_buffer.read() + # Once read, create a new buffer + self.slog_buffer = io.StringIO() + return data + + def flush(self) -> None: + """Force the slog_buffer to be written out to the actual file""" + + if self.session_log is not None: + data = self._read_buffer() + data = self.no_log_filter(data) if isinstance(self.session_log, io.BufferedIOBase): self.session_log.write(write_bytes(data, encoding=self.file_encoding)) @@ -95,7 +118,13 @@

    Module netmiko.session_log

    assert isinstance(self.session_log, io.BufferedIOBase) or isinstance( self.session_log, io.TextIOBase ) - self.session_log.flush()
    + + # Flush the underlying file + self.session_log.flush() + + def write(self, data: str) -> None: + if len(data) > 0: + self.slog_buffer.write(data)
    @@ -109,7 +138,7 @@

    Classes

    class SessionLog -(file_name: Optional[str] = None, buffered_io: Optional[io.BufferedIOBase] = None, file_mode: str = 'write', file_encoding: str = 'utf-8', no_log: Optional[Dict[str, Any]] = None, record_writes: bool = False) +(file_name: Optional[str] = None, buffered_io: Optional[io.BufferedIOBase] = None, file_mode: str = 'write', file_encoding: str = 'utf-8', no_log: Optional[Dict[str, Any]] = None, record_writes: bool = False, slog_buffer: Optional[_io.StringIO] = None)
    @@ -126,6 +155,7 @@

    Classes

    file_encoding: str = "utf-8", no_log: Optional[Dict[str, Any]] = None, record_writes: bool = False, + slog_buffer: Optional[io.StringIO] = None, ) -> None: if no_log is None: self.no_log = {} @@ -144,6 +174,13 @@

    Classes

    else: self.session_log = None + # In order to ensure all the no_log entries get hidden properly, + # we must first store everying in memory and then write out to file. + # Otherwise, we might miss the data we are supposed to hide (since + # the no_log data potentially spans multiple reads). + if slog_buffer is None: + self.slog_buffer = io.StringIO() + # Ensures last write operations prior to disconnect are recorded. self.fin = False @@ -163,15 +200,30 @@

    Classes

    def close(self) -> None: """Close the session_log file (if it is a file that we opened).""" + self.flush() if self.session_log and self._session_log_close: self.session_log.close() self.session_log = None - def write(self, data: str) -> None: - if self.session_log is not None and len(data) > 0: - # Hide the password and secret in the session_log - for hidden_data in self.no_log.values(): - data = data.replace(hidden_data, "********") + def no_log_filter(self, data: str) -> str: + """Filter content from the session_log.""" + for hidden_data in self.no_log.values(): + data = data.replace(hidden_data, "********") + return data + + def _read_buffer(self) -> str: + self.slog_buffer.seek(0) + data = self.slog_buffer.read() + # Once read, create a new buffer + self.slog_buffer = io.StringIO() + return data + + def flush(self) -> None: + """Force the slog_buffer to be written out to the actual file""" + + if self.session_log is not None: + data = self._read_buffer() + data = self.no_log_filter(data) if isinstance(self.session_log, io.BufferedIOBase): self.session_log.write(write_bytes(data, encoding=self.file_encoding)) @@ -181,7 +233,13 @@

    Classes

    assert isinstance(self.session_log, io.BufferedIOBase) or isinstance( self.session_log, io.TextIOBase ) - self.session_log.flush()
    + + # Flush the underlying file + self.session_log.flush() + + def write(self, data: str) -> None: + if len(data) > 0: + self.slog_buffer.write(data)

    Methods

    @@ -196,11 +254,57 @@

    Methods

    def close(self) -> None:
         """Close the session_log file (if it is a file that we opened)."""
    +    self.flush()
         if self.session_log and self._session_log_close:
             self.session_log.close()
             self.session_log = None
    +
    +def flush(self) ‑> None +
    +
    +

    Force the slog_buffer to be written out to the actual file

    +
    + +Expand source code + +
    def flush(self) -> None:
    +    """Force the slog_buffer to be written out to the actual file"""
    +
    +    if self.session_log is not None:
    +        data = self._read_buffer()
    +        data = self.no_log_filter(data)
    +
    +        if isinstance(self.session_log, io.BufferedIOBase):
    +            self.session_log.write(write_bytes(data, encoding=self.file_encoding))
    +        else:
    +            self.session_log.write(data)
    +
    +        assert isinstance(self.session_log, io.BufferedIOBase) or isinstance(
    +            self.session_log, io.TextIOBase
    +        )
    +
    +        # Flush the underlying file
    +        self.session_log.flush()
    +
    +
    +
    +def no_log_filter(self, data: str) ‑> str +
    +
    +

    Filter content from the session_log.

    +
    + +Expand source code + +
    def no_log_filter(self, data: str) -> str:
    +    """Filter content from the session_log."""
    +    for hidden_data in self.no_log.values():
    +        data = data.replace(hidden_data, "********")
    +    return data
    +
    +
    def open(self) ‑> None
    @@ -235,20 +339,8 @@

    Methods

    Expand source code
    def write(self, data: str) -> None:
    -    if self.session_log is not None and len(data) > 0:
    -        # Hide the password and secret in the session_log
    -        for hidden_data in self.no_log.values():
    -            data = data.replace(hidden_data, "********")
    -
    -        if isinstance(self.session_log, io.BufferedIOBase):
    -            self.session_log.write(write_bytes(data, encoding=self.file_encoding))
    -        else:
    -            self.session_log.write(data)
    -
    -        assert isinstance(self.session_log, io.BufferedIOBase) or isinstance(
    -            self.session_log, io.TextIOBase
    -        )
    -        self.session_log.flush()
    + if len(data) > 0: + self.slog_buffer.write(data)
    @@ -273,6 +365,8 @@

    Index

    SessionLog

    diff --git a/docs/netmiko/sixwind/index.html b/docs/netmiko/sixwind/index.html index 0bfcacca9..c9aa87822 100644 --- a/docs/netmiko/sixwind/index.html +++ b/docs/netmiko/sixwind/index.html @@ -49,7 +49,7 @@

    Classes

    class SixwindOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -143,7 +143,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/sixwind/sixwind_os.html b/docs/netmiko/sixwind/sixwind_os.html index 8a88b3693..21ac8c68f 100644 --- a/docs/netmiko/sixwind/sixwind_os.html +++ b/docs/netmiko/sixwind/sixwind_os.html @@ -151,7 +151,7 @@

    Classes

    class SixwindOSBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -245,7 +245,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -258,11 +259,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -602,7 +606,7 @@

    Inherited members

    class SixwindOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -696,7 +700,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -709,11 +714,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/snmp_autodetect.html b/docs/netmiko/snmp_autodetect.html index d386fc87d..7f89ec393 100644 --- a/docs/netmiko/snmp_autodetect.html +++ b/docs/netmiko/snmp_autodetect.html @@ -62,10 +62,10 @@

    Example:

    Note, pysnmp is a required dependency for SNMPDetect and is intentionally not included in netmiko requirements. So installation of pysnmp might be required. """ -import ipaddress -from typing import Optional, Dict +from typing import Optional, Dict, List from typing.re import Pattern import re +import socket try: from pysnmp.entity.rfc3413.oneliner import cmdgen @@ -82,6 +82,11 @@

    Example:

    "expr": re.compile(r".*Arista Networks EOS.*", re.IGNORECASE), "priority": 99, }, + "allied_telesis_awplus": { + "oid": ".1.3.6.1.2.1.1.1.0", + "expr": re.compile(r".*AlliedWare Plus.*", re.IGNORECASE), + "priority": 99, + }, "paloalto_panos": { "oid": ".1.3.6.1.2.1.1.1.0", "expr": re.compile(r".*Palo Alto Networks.*", re.IGNORECASE), @@ -172,6 +177,51 @@

    Example:

    SNMP_MAPPER[device_type] = SNMP_MAPPER_BASE[device_type] +def identify_address_type(entry: str) -> List[str]: + """ + Return a list containing all ip types found. An empty list means no valid ip were found + Parameters + ---------- + entry: str + Can be an ipv4, an ipv6 or an FQDN. + + Returns + ------- + list of string: list + A list of string 'IPv4' | 'IPv6' which indicates if entry is a valid ipv4 and/or ipv6. + """ + try: + socket.inet_pton(socket.AF_INET, entry) + return ["IPv4"] + except socket.error: + pass + + try: + socket.inet_pton(socket.AF_INET6, entry) + return ["IPv6"] + except socket.error: + pass + + ip_types = [] + try: + addrinfo = socket.getaddrinfo(entry, None) + for info in addrinfo: + ip = info[4][0] + try: + socket.inet_pton(socket.AF_INET, ip) + ip_types.append("IPv4") + except socket.error: + pass + try: + socket.inet_pton(socket.AF_INET6, ip) + ip_types.append("IPv6") + except socket.error: + pass + except socket.gaierror: + pass + return ip_types + + class SNMPDetect(object): """ The SNMPDetect class tries to automatically determine the device type. @@ -239,7 +289,6 @@

    Example:

    auth_proto: str = "sha", encrypt_proto: str = "aes128", ) -> None: - # Check that the SNMP version is matching predefined type or raise ValueError if snmp_version == "v1" or snmp_version == "v2c": if not community: @@ -287,7 +336,7 @@

    Example:

    self._response_cache: Dict[str, str] = {} self.snmp_target = (self.hostname, self.snmp_port) - if ipaddress.ip_address(self.hostname).version == 6: + if "IPv6" in identify_address_type(self.hostname): self.udp_transport_target = cmdgen.Udp6TransportTarget( self.snmp_target, timeout=1.5, retries=2 ) @@ -413,6 +462,74 @@

    Example:

    +

    Functions

    +
    +
    +def identify_address_type(entry: str) ‑> List[str] +
    +
    +

    Return a list containing all ip types found. An empty list means no valid ip were found +Parameters

    +
    +
    +
    entry : str
    +
    Can be an ipv4, an ipv6 or an FQDN.
    +
    +

    Returns

    +
    +
    list of string: list
    +
    A list of string 'IPv4' | 'IPv6' which indicates if entry is a valid ipv4 and/or ipv6.
    +
    +
    + +Expand source code + +
    def identify_address_type(entry: str) -> List[str]:
    +    """
    +    Return a list containing all ip types found. An empty list means no valid ip were found
    +    Parameters
    +    ----------
    +    entry: str
    +        Can be an ipv4, an ipv6 or an FQDN.
    +
    +    Returns
    +    -------
    +    list of string: list
    +        A list of string 'IPv4' | 'IPv6' which indicates if entry is a valid ipv4 and/or ipv6.
    +    """
    +    try:
    +        socket.inet_pton(socket.AF_INET, entry)
    +        return ["IPv4"]
    +    except socket.error:
    +        pass
    +
    +    try:
    +        socket.inet_pton(socket.AF_INET6, entry)
    +        return ["IPv6"]
    +    except socket.error:
    +        pass
    +
    +    ip_types = []
    +    try:
    +        addrinfo = socket.getaddrinfo(entry, None)
    +        for info in addrinfo:
    +            ip = info[4][0]
    +            try:
    +                socket.inet_pton(socket.AF_INET, ip)
    +                ip_types.append("IPv4")
    +            except socket.error:
    +                pass
    +            try:
    +                socket.inet_pton(socket.AF_INET6, ip)
    +                ip_types.append("IPv6")
    +            except socket.error:
    +                pass
    +    except socket.gaierror:
    +        pass
    +    return ip_types
    +
    +
    +

    Classes

    @@ -540,7 +657,6 @@

    Methods

    auth_proto: str = "sha", encrypt_proto: str = "aes128", ) -> None: - # Check that the SNMP version is matching predefined type or raise ValueError if snmp_version == "v1" or snmp_version == "v2c": if not community: @@ -588,7 +704,7 @@

    Methods

    self._response_cache: Dict[str, str] = {} self.snmp_target = (self.hostname, self.snmp_port) - if ipaddress.ip_address(self.hostname).version == 6: + if "IPv6" in identify_address_type(self.hostname): self.udp_transport_target = cmdgen.Udp6TransportTarget( self.snmp_target, timeout=1.5, retries=2 ) @@ -788,6 +904,11 @@

    Index

  • netmiko
  • +
  • Functions

    + +
  • Classes

    • diff --git a/docs/netmiko/sophos/index.html b/docs/netmiko/sophos/index.html index 51ff78183..ebf7262be 100644 --- a/docs/netmiko/sophos/index.html +++ b/docs/netmiko/sophos/index.html @@ -49,7 +49,7 @@

      Classes

      class SophosSfosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -143,7 +143,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/sophos/sophos_sfos_ssh.html b/docs/netmiko/sophos/sophos_sfos_ssh.html index 38bb8315a..7c3acb6f1 100644 --- a/docs/netmiko/sophos/sophos_sfos_ssh.html +++ b/docs/netmiko/sophos/sophos_sfos_ssh.html @@ -79,7 +79,7 @@

      Classes

      class SophosSfosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -173,7 +173,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -186,11 +187,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ssh_autodetect.html b/docs/netmiko/ssh_autodetect.html index bf791dfbc..4ebc4ee44 100644 --- a/docs/netmiko/ssh_autodetect.html +++ b/docs/netmiko/ssh_autodetect.html @@ -126,27 +126,21 @@

      Netmiko connection creation section "priority": 99, "dispatch": "_autodetect_std", }, - "apresia_aeos": { - "cmd": "show system", - "search_patterns": ["Apresia"], - "priority": 99, - "dispatch": "_autodetect_std", - }, - "arista_eos": { + "allied_telesis_awplus": { "cmd": "show version", - "search_patterns": [r"Arista"], + "search_patterns": ["AlliedWare Plus"], "priority": 99, "dispatch": "_autodetect_std", }, - "arris_cer": { - "cmd": "show version", - "search_patterns": [r"CER"], + "apresia_aeos": { + "cmd": "show system", + "search_patterns": ["Apresia"], "priority": 99, "dispatch": "_autodetect_std", }, - "casa_cmts": { + "arista_eos": { "cmd": "show version", - "search_patterns": [r"Casa"], + "search_patterns": [r"Arista", r"vEOS"], "priority": 99, "dispatch": "_autodetect_std", }, @@ -292,7 +286,9 @@

      Netmiko connection creation section }, "extreme_slx": { "cmd": "show version", - "search_patterns": [r"SLX-OS Operating System Software"], + "search_patterns": [ + r"SLX-OS Operating System", + ], "priority": 99, "dispatch": "_autodetect_std", }, diff --git a/docs/netmiko/supermicro/index.html b/docs/netmiko/supermicro/index.html index bab8d0077..8c0dfb3e8 100644 --- a/docs/netmiko/supermicro/index.html +++ b/docs/netmiko/supermicro/index.html @@ -49,7 +49,7 @@

      Classes

      class SmciSwitchSmisSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -143,7 +143,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -240,7 +244,7 @@

      Inherited members

      class SmciSwitchSmisTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -334,7 +338,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -347,11 +352,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/supermicro/smci_smis.html b/docs/netmiko/supermicro/smci_smis.html index d21ce98a9..5fc0ad40f 100644 --- a/docs/netmiko/supermicro/smci_smis.html +++ b/docs/netmiko/supermicro/smci_smis.html @@ -79,7 +79,7 @@

      Classes

      class SmciSwitchSmisBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -173,7 +173,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -186,11 +187,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -343,7 +347,7 @@

      Inherited members

      class SmciSwitchSmisSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -437,7 +441,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -450,11 +455,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -534,7 +542,7 @@

      Inherited members

      class SmciSwitchSmisTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -628,7 +636,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -641,11 +650,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/teldat/index.html b/docs/netmiko/teldat/index.html index df8a7ce41..8c4d55395 100644 --- a/docs/netmiko/teldat/index.html +++ b/docs/netmiko/teldat/index.html @@ -49,7 +49,7 @@

      Classes

      class TeldatCITSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -143,7 +143,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -156,11 +157,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -239,7 +243,7 @@

      Inherited members

      class TeldatCITTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -333,7 +337,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -346,11 +351,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/teldat/teldat_cit.html b/docs/netmiko/teldat/teldat_cit.html index eccb3bdf7..474450e56 100644 --- a/docs/netmiko/teldat/teldat_cit.html +++ b/docs/netmiko/teldat/teldat_cit.html @@ -229,7 +229,7 @@

      Classes

      class TeldatCITBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -323,7 +323,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -336,11 +337,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -678,7 +682,7 @@

      Inherited members

      class TeldatCITSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -772,7 +776,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -785,11 +790,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -868,7 +876,7 @@

      Inherited members

      class TeldatCITTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Class for platforms that have no enable mode.

      @@ -962,7 +970,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -975,11 +984,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/telnet_proxy.html b/docs/netmiko/telnet_proxy.html new file mode 100644 index 000000000..bf3ff3742 --- /dev/null +++ b/docs/netmiko/telnet_proxy.html @@ -0,0 +1,304 @@ + + + + + + +netmiko.telnet_proxy API documentation + + + + + + + + + + + +
      +
      +
      +

      Module netmiko.telnet_proxy

      +
      +
      +
      + +Expand source code + +
      from typing import Dict, Any, Optional
      +import socket
      +import telnetlib
      +
      +try:
      +    import socks
      +
      +    SOCKS_SUPPORTED = True
      +except ModuleNotFoundError:
      +    SOCKS_SUPPORTED = False
      +
      +
      +class Telnet(telnetlib.Telnet):
      +    def __init__(
      +        self,
      +        host: Optional[str] = None,
      +        port: int = 0,
      +        timeout: float = socket._GLOBAL_DEFAULT_TIMEOUT,  # type: ignore
      +        proxy_dict: Optional[Dict[str, Any]] = None,
      +    ) -> None:
      +        self.proxy_dict = proxy_dict
      +        super().__init__(host=host, port=port, timeout=timeout)
      +
      +    def open(
      +        self,
      +        host: str,
      +        port: int = 0,
      +        timeout: float = socket._GLOBAL_DEFAULT_TIMEOUT,  # type: ignore
      +    ) -> None:
      +        """
      +        Connect to a host.
      +        The optional second argument is the port number, which
      +        defaults to the standard telnet port (23).
      +
      +        Don't try to reopen an already connected instance.
      +
      +        proxy_dict = {
      +                'proxy_type': socks.SOCKS5,
      +                'proxy_addr': hostname,
      +                'proxy_port': port,
      +                'proxy_username': username,
      +                'proxy_password': password
      +            }
      +        """
      +        self.eof = 0
      +        if not port:
      +            port = telnetlib.TELNET_PORT
      +        self.host = host
      +        self.port = port
      +        self.timeout = timeout
      +
      +        if SOCKS_SUPPORTED:
      +            self.sock = socks.create_connection(
      +                (host, port), timeout, **self.proxy_dict
      +            )
      +        else:
      +            msg = """
      +In order to use the telnet socks proxy, you must 'pip install pysocks'. Note, pysocks is
      +unmaintained (so use at your own risk).
      +"""
      +            raise ModuleNotFoundError(msg)
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +

      Classes

      +
      +
      +class Telnet +(host: Optional[str] = None, port: int = 0, timeout: float = <object object>, proxy_dict: Optional[Dict[str, Any]] = None) +
      +
      +

      Telnet interface class.

      +

      An instance of this class represents a connection to a telnet +server. +The instance is initially not connected; the open() +method must be used to establish a connection. +Alternatively, the +host name and optional port number can be passed to the +constructor, too.

      +

      Don't try to reopen an already connected instance.

      +

      This class has many read_*() methods. +Note that some of them +raise EOFError when the end of the connection is read, because +they can return an empty string for other reasons. +See the +individual doc strings.

      +

      read_until(expected, [timeout]) +Read until the expected string has been seen, or a timeout is +hit (default is no timeout); may block.

      +

      read_all() +Read all data until EOF; may block.

      +

      read_some() +Read at least one byte or EOF; may block.

      +

      read_very_eager() +Read all data available already queued or on the socket, +without blocking.

      +

      read_eager() +Read either data already queued or some data available on the +socket, without blocking.

      +

      read_lazy() +Read all data in the raw queue (processing it first), without +doing any socket I/O.

      +

      read_very_lazy() +Reads all data in the cooked queue, without doing any socket +I/O.

      +

      read_sb_data() +Reads available data between SB … SE sequence. Don't block.

      +

      set_option_negotiation_callback(callback) +Each time a telnet option is read on the input flow, this callback +(if set) is called with the following parameters : +callback(telnet socket, command, option) +option will be chr(0) when there is no option. +No other action is done afterwards by telnetlib.

      +

      Constructor.

      +

      When called without arguments, create an unconnected instance. +With a hostname argument, it connects the instance; port number +and timeout are optional.

      +
      + +Expand source code + +
      class Telnet(telnetlib.Telnet):
      +    def __init__(
      +        self,
      +        host: Optional[str] = None,
      +        port: int = 0,
      +        timeout: float = socket._GLOBAL_DEFAULT_TIMEOUT,  # type: ignore
      +        proxy_dict: Optional[Dict[str, Any]] = None,
      +    ) -> None:
      +        self.proxy_dict = proxy_dict
      +        super().__init__(host=host, port=port, timeout=timeout)
      +
      +    def open(
      +        self,
      +        host: str,
      +        port: int = 0,
      +        timeout: float = socket._GLOBAL_DEFAULT_TIMEOUT,  # type: ignore
      +    ) -> None:
      +        """
      +        Connect to a host.
      +        The optional second argument is the port number, which
      +        defaults to the standard telnet port (23).
      +
      +        Don't try to reopen an already connected instance.
      +
      +        proxy_dict = {
      +                'proxy_type': socks.SOCKS5,
      +                'proxy_addr': hostname,
      +                'proxy_port': port,
      +                'proxy_username': username,
      +                'proxy_password': password
      +            }
      +        """
      +        self.eof = 0
      +        if not port:
      +            port = telnetlib.TELNET_PORT
      +        self.host = host
      +        self.port = port
      +        self.timeout = timeout
      +
      +        if SOCKS_SUPPORTED:
      +            self.sock = socks.create_connection(
      +                (host, port), timeout, **self.proxy_dict
      +            )
      +        else:
      +            msg = """
      +In order to use the telnet socks proxy, you must 'pip install pysocks'. Note, pysocks is
      +unmaintained (so use at your own risk).
      +"""
      +            raise ModuleNotFoundError(msg)
      +
      +

      Ancestors

      +
        +
      • telnetlib.Telnet
      • +
      +

      Methods

      +
      +
      +def open(self, host: str, port: int = 0, timeout: float = <object object>) ‑> None +
      +
      +

      Connect to a host. +The optional second argument is the port number, which +defaults to the standard telnet port (23).

      +

      Don't try to reopen an already connected instance.

      +

      proxy_dict = { +'proxy_type': socks.SOCKS5, +'proxy_addr': hostname, +'proxy_port': port, +'proxy_username': username, +'proxy_password': password +}

      +
      + +Expand source code + +
          def open(
      +        self,
      +        host: str,
      +        port: int = 0,
      +        timeout: float = socket._GLOBAL_DEFAULT_TIMEOUT,  # type: ignore
      +    ) -> None:
      +        """
      +        Connect to a host.
      +        The optional second argument is the port number, which
      +        defaults to the standard telnet port (23).
      +
      +        Don't try to reopen an already connected instance.
      +
      +        proxy_dict = {
      +                'proxy_type': socks.SOCKS5,
      +                'proxy_addr': hostname,
      +                'proxy_port': port,
      +                'proxy_username': username,
      +                'proxy_password': password
      +            }
      +        """
      +        self.eof = 0
      +        if not port:
      +            port = telnetlib.TELNET_PORT
      +        self.host = host
      +        self.port = port
      +        self.timeout = timeout
      +
      +        if SOCKS_SUPPORTED:
      +            self.sock = socks.create_connection(
      +                (host, port), timeout, **self.proxy_dict
      +            )
      +        else:
      +            msg = """
      +In order to use the telnet socks proxy, you must 'pip install pysocks'. Note, pysocks is
      +unmaintained (so use at your own risk).
      +"""
      +            raise ModuleNotFoundError(msg)
      +
      +
      +
      +
      +
      +
      +
      + +
      + + + \ No newline at end of file diff --git a/docs/netmiko/terminal_server/index.html b/docs/netmiko/terminal_server/index.html index 9819b6ccf..b1d6a039c 100644 --- a/docs/netmiko/terminal_server/index.html +++ b/docs/netmiko/terminal_server/index.html @@ -50,7 +50,7 @@

      Classes

      class TerminalServerSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Generic Terminal Server driver SSH.

      @@ -137,7 +137,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -234,7 +238,7 @@

      Inherited members

      class TerminalServerTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Generic Terminal Server driver telnet.

      @@ -321,7 +325,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -334,11 +339,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/terminal_server/terminal_server.html b/docs/netmiko/terminal_server/terminal_server.html index c61b6916b..8c2b2aaee 100644 --- a/docs/netmiko/terminal_server/terminal_server.html +++ b/docs/netmiko/terminal_server/terminal_server.html @@ -73,7 +73,7 @@

      Classes

      class TerminalServer -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Generic Terminal Server driver.

      @@ -162,7 +162,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -175,11 +176,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -285,7 +289,7 @@

      Inherited members

      class TerminalServerSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Generic Terminal Server driver SSH.

      @@ -372,7 +376,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -385,11 +390,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -469,7 +477,7 @@

      Inherited members

      class TerminalServerTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

      Generic Terminal Server driver telnet.

      @@ -556,7 +564,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -569,11 +578,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/tplink/index.html b/docs/netmiko/tplink/index.html index 03af3f0d0..8c988a57b 100644 --- a/docs/netmiko/tplink/index.html +++ b/docs/netmiko/tplink/index.html @@ -136,7 +136,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -243,7 +247,7 @@

      Inherited members

    • send_config_from_file
    • send_config_set
    • send_multiline
    • -
    • session_preparation
    • +
    • session_preparation
    • set_base_prompt
    • set_terminal_width
    • special_login_handler
    • @@ -346,7 +350,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -359,11 +364,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -476,7 +484,7 @@

      Inherited members

    • send_config_from_file
    • send_config_set
    • send_multiline
    • -
    • session_preparation
    • +
    • session_preparation
    • set_base_prompt
    • set_terminal_width
    • special_login_handler
    • diff --git a/docs/netmiko/tplink/tplink_jetstream.html b/docs/netmiko/tplink/tplink_jetstream.html index 0ab3f3b81..95b2fb642 100644 --- a/docs/netmiko/tplink/tplink_jetstream.html +++ b/docs/netmiko/tplink/tplink_jetstream.html @@ -49,15 +49,12 @@

      Module netmiko.tplink.tplink_jetstream

      return super().__init__(**kwargs) def session_preparation(self) -> None: - """ - Prepare the session after the connection has been established. - """ delay_factor = self.select_delay_factor(delay_factor=0) time.sleep(0.3 * delay_factor) - self.clear_buffer() self._test_channel_read(pattern=r"[>#]") self.set_base_prompt() self.enable() + self.set_base_prompt() self.disable_paging() # Clear the read buffer time.sleep(0.3 * self.global_delay_factor) @@ -331,7 +328,8 @@

      Classes

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -344,11 +342,14 @@

      Classes

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -378,15 +379,12 @@

      Classes

      return super().__init__(**kwargs) def session_preparation(self) -> None: - """ - Prepare the session after the connection has been established. - """ delay_factor = self.select_delay_factor(delay_factor=0) time.sleep(0.3 * delay_factor) - self.clear_buffer() self._test_channel_read(pattern=r"[>#]") self.set_base_prompt() self.enable() + self.set_base_prompt() self.disable_paging() # Clear the read buffer time.sleep(0.3 * self.global_delay_factor) @@ -645,31 +643,6 @@

      Methods

      return output
      - -
      -

      Prepare the session after the connection has been established.

      -
      - -Expand source code - -
      def session_preparation(self) -> None:
      -    """
      -    Prepare the session after the connection has been established.
      -    """
      -    delay_factor = self.select_delay_factor(delay_factor=0)
      -    time.sleep(0.3 * delay_factor)
      -    self.clear_buffer()
      -    self._test_channel_read(pattern=r"[>#]")
      -    self.set_base_prompt()
      -    self.enable()
      -    self.disable_paging()
      -    # Clear the read buffer
      -    time.sleep(0.3 * self.global_delay_factor)
      -    self.clear_buffer()
      -
      -
      @@ -743,6 +716,7 @@

      Inherited members

    • send_config_from_file
    • send_config_set
    • send_multiline
    • +
    • session_preparation
    • set_terminal_width
    • special_login_handler
    • strip_ansi_escape_codes
    • @@ -844,7 +818,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -857,11 +832,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -951,7 +929,7 @@

      Inherited members

    • send_config_from_file
    • send_config_set
    • send_multiline
    • -
    • session_preparation
    • +
    • session_preparation
    • set_base_prompt
    • set_terminal_width
    • special_login_handler
    • @@ -1054,7 +1032,8 @@

      Inherited members

      to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -1067,11 +1046,14 @@

      Inherited members

      (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -1184,7 +1166,7 @@

      Inherited members

    • send_config_from_file
    • send_config_set
    • send_multiline
    • -
    • session_preparation
    • +
    • session_preparation
    • set_base_prompt
    • set_terminal_width
    • special_login_handler
    • @@ -1219,7 +1201,6 @@

      check_config_mode

    • enable
    • exit_config_mode
    • -
    • session_preparation
    • set_base_prompt
  • diff --git a/docs/netmiko/ubiquiti/edge_ssh.html b/docs/netmiko/ubiquiti/edge_ssh.html index b883d8241..15a4da579 100644 --- a/docs/netmiko/ubiquiti/edge_ssh.html +++ b/docs/netmiko/ubiquiti/edge_ssh.html @@ -124,7 +124,7 @@

    Classes

    class UbiquitiEdgeSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Ubiquity EdgeSwitch devices.

    @@ -213,7 +213,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -226,11 +227,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ubiquiti/edgerouter_ssh.html b/docs/netmiko/ubiquiti/edgerouter_ssh.html index 3efb3916a..4d06bdabc 100644 --- a/docs/netmiko/ubiquiti/edgerouter_ssh.html +++ b/docs/netmiko/ubiquiti/edgerouter_ssh.html @@ -274,7 +274,7 @@

    Inherited members

    class UbiquitiEdgeRouterSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with EdgeOS EdgeRouter network devices.

    @@ -361,7 +361,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -374,11 +375,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ubiquiti/index.html b/docs/netmiko/ubiquiti/index.html index c27566d2f..604a1ae0e 100644 --- a/docs/netmiko/ubiquiti/index.html +++ b/docs/netmiko/ubiquiti/index.html @@ -210,7 +210,7 @@

    Inherited members

    class UbiquitiEdgeRouterSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with EdgeOS EdgeRouter network devices.

    @@ -297,7 +297,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -310,11 +311,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -424,7 +428,7 @@

    Inherited members

    class UbiquitiEdgeSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Ubiquity EdgeSwitch devices.

    @@ -513,7 +517,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -526,11 +531,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -789,7 +797,7 @@

    Inherited members

    class UbiquitiUnifiSwitchSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Ubiquity EdgeSwitch devices.

    @@ -878,7 +886,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -891,11 +900,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/ubiquiti/unifiswitch_ssh.html b/docs/netmiko/ubiquiti/unifiswitch_ssh.html index 543f92cf8..40f57a62a 100644 --- a/docs/netmiko/ubiquiti/unifiswitch_ssh.html +++ b/docs/netmiko/ubiquiti/unifiswitch_ssh.html @@ -79,7 +79,7 @@

    Classes

    class UbiquitiUnifiSwitchSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements support for Ubiquity EdgeSwitch devices.

    @@ -168,7 +168,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -181,11 +182,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/utilities.html b/docs/netmiko/utilities.html index 9aa2b7c93..e07c3514c 100644 --- a/docs/netmiko/utilities.html +++ b/docs/netmiko/utilities.html @@ -528,7 +528,7 @@

    Module netmiko.utilities

    ) raise ValueError(msg) - if "cisco" not in platform: + if "cisco" not in platform and "linux" not in platform: return raw_output genie_device_mapper = { @@ -537,6 +537,9 @@

    Module netmiko.utilities

    "cisco_xr": "iosxr", "cisco_nxos": "nxos", "cisco_asa": "asa", + "linux": "linux", + "f5_linux": "linux", + "ovs_linux": "linux", } os = None @@ -1015,7 +1018,7 @@

    Functions

    ) raise ValueError(msg) - if "cisco" not in platform: + if "cisco" not in platform and "linux" not in platform: return raw_output genie_device_mapper = { @@ -1024,6 +1027,9 @@

    Functions

    "cisco_xr": "iosxr", "cisco_nxos": "nxos", "cisco_asa": "asa", + "linux": "linux", + "f5_linux": "linux", + "ovs_linux": "linux", } os = None diff --git a/docs/netmiko/vyos/index.html b/docs/netmiko/vyos/index.html index bb82b5388..da17bb830 100644 --- a/docs/netmiko/vyos/index.html +++ b/docs/netmiko/vyos/index.html @@ -49,7 +49,7 @@

    Classes

    class VyOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with VyOS network devices.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -301,9 +305,11 @@

    Classes

    self, cmd: str = "save", confirm: bool = False, confirm_response: str = "" ) -> str: """Saves Config.""" - output = super().save_config( + output = self.config_mode() + output += super().save_config( cmd=cmd, confirm=confirm, confirm_response=confirm_response ) + output += self.exit_config_mode() if "Done" not in output: raise ValueError(f"Save failed with following errors:\n\n{output}") return output diff --git a/docs/netmiko/vyos/vyos_ssh.html b/docs/netmiko/vyos/vyos_ssh.html index 6facbe0c6..dda5e94a0 100644 --- a/docs/netmiko/vyos/vyos_ssh.html +++ b/docs/netmiko/vyos/vyos_ssh.html @@ -164,9 +164,11 @@

    Module netmiko.vyos.vyos_ssh

    self, cmd: str = "save", confirm: bool = False, confirm_response: str = "" ) -> str: """Saves Config.""" - output = super().save_config( + output = self.config_mode() + output += super().save_config( cmd=cmd, confirm=confirm, confirm_response=confirm_response ) + output += self.exit_config_mode() if "Done" not in output: raise ValueError(f"Save failed with following errors:\n\n{output}") return output @@ -183,7 +185,7 @@

    Classes

    class VyOSSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implement methods for interacting with VyOS network devices.

    @@ -270,7 +272,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -283,11 +286,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -435,9 +441,11 @@

    Classes

    self, cmd: str = "save", confirm: bool = False, confirm_response: str = "" ) -> str: """Saves Config.""" - output = super().save_config( + output = self.config_mode() + output += super().save_config( cmd=cmd, confirm=confirm, confirm_response=confirm_response ) + output += self.exit_config_mode() if "Done" not in output: raise ValueError(f"Save failed with following errors:\n\n{output}") return output diff --git a/docs/netmiko/watchguard/fireware_ssh.html b/docs/netmiko/watchguard/fireware_ssh.html index 91eff6a3d..602feca29 100644 --- a/docs/netmiko/watchguard/fireware_ssh.html +++ b/docs/netmiko/watchguard/fireware_ssh.html @@ -83,7 +83,7 @@

    Classes

    class WatchguardFirewareSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements methods for communicating with Watchguard Firebox firewalls.

    @@ -170,7 +170,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -183,11 +184,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/watchguard/index.html b/docs/netmiko/watchguard/index.html index a1e78495f..64b3a1243 100644 --- a/docs/netmiko/watchguard/index.html +++ b/docs/netmiko/watchguard/index.html @@ -49,7 +49,7 @@

    Classes

    class WatchguardFirewareSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Implements methods for communicating with Watchguard Firebox firewalls.

    @@ -136,7 +136,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -149,11 +150,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/yamaha/index.html b/docs/netmiko/yamaha/index.html index 733f7d1b2..41e3c5ef6 100644 --- a/docs/netmiko/yamaha/index.html +++ b/docs/netmiko/yamaha/index.html @@ -50,7 +50,7 @@

    Classes

    class YamahaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Yamaha SSH driver.

    @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -321,7 +325,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -334,11 +339,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/yamaha/yamaha.html b/docs/netmiko/yamaha/yamaha.html index 331d59177..36ce4b7ab 100644 --- a/docs/netmiko/yamaha/yamaha.html +++ b/docs/netmiko/yamaha/yamaha.html @@ -137,7 +137,7 @@

    Classes

    class YamahaBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Defines vendor independent methods.

    @@ -225,7 +225,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -238,11 +239,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -497,7 +501,7 @@

    Inherited members

    class YamahaSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Yamaha SSH driver.

    @@ -584,7 +588,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -597,11 +602,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -768,7 +776,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -781,11 +790,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/zte/index.html b/docs/netmiko/zte/index.html index a15087df6..5bda59ed5 100644 --- a/docs/netmiko/zte/index.html +++ b/docs/netmiko/zte/index.html @@ -50,7 +50,7 @@

    Classes

    class ZteZxrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -137,7 +137,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -150,11 +151,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -233,7 +237,7 @@

    Inherited members

    class ZteZxrosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -320,7 +324,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -333,11 +338,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/zte/zte_zxros.html b/docs/netmiko/zte/zte_zxros.html index 6986670f7..5f35d4e10 100644 --- a/docs/netmiko/zte/zte_zxros.html +++ b/docs/netmiko/zte/zte_zxros.html @@ -105,7 +105,7 @@

    Classes

    class ZteZxrosBase -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -192,7 +192,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -205,11 +206,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -353,7 +357,7 @@

    Inherited members

    class ZteZxrosSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -440,7 +444,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -453,11 +458,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. @@ -536,7 +544,7 @@

    Inherited members

    class ZteZxrosTelnet -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Base Class for cisco-like behavior.

    @@ -623,7 +631,8 @@

    Inherited members

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -636,11 +645,14 @@

    Inherited members

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/zyxel/index.html b/docs/netmiko/zyxel/index.html index 9ab8498bb..919a92586 100644 --- a/docs/netmiko/zyxel/index.html +++ b/docs/netmiko/zyxel/index.html @@ -50,7 +50,7 @@

    Classes

    class ZyxelSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -144,7 +144,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -157,11 +158,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument. diff --git a/docs/netmiko/zyxel/zyxel_ssh.html b/docs/netmiko/zyxel/zyxel_ssh.html index 961b18164..5f8c34fd1 100644 --- a/docs/netmiko/zyxel/zyxel_ssh.html +++ b/docs/netmiko/zyxel/zyxel_ssh.html @@ -69,7 +69,7 @@

    Classes

    class ZyxelSSH -(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False) +(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, disable_sha2_fix: bool = False, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

    Class for platforms that have no enable mode.

    @@ -163,7 +163,8 @@

    Classes

    to select smallest of global and specific. Sets default global_delay_factor to .1 (default: True) - :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :param session_log: File path, SessionLog object, or BufferedIOBase subclass object + to write the session log to. :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 @@ -176,11 +177,14 @@

    Classes

    (default: False) :param encoding: Encoding to be used when writing bytes to the output channel. - (default: ascii) + (default: "utf-8") :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for communication to the target host (default: None). + :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See + telnet_proxy.py code for details. + :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function <code>cmd\_verify</code> argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.