diff --git a/README.md b/README.md index 8429070d0..6545acfe6 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,6 @@ $ pip install netmiko Netmiko has the following requirements (which pip will install for you) - Paramiko >= 2.4.3 - scp >= 0.13.2 -- pyyaml - pyserial - textfsm @@ -74,6 +73,7 @@ See the following directory for [example scripts](https://github.com/ktbyers/net - [Sending Configuration Commands](https://github.com/ktbyers/netmiko/tree/develop/examples/use_cases/case6_config_change) - [Handling Additional Prompting](https://github.com/ktbyers/netmiko/blob/develop/examples/use_cases/case5_prompting/send_command_prompting.py) - [Connecting with SSH Keys](https://github.com/ktbyers/netmiko/blob/develop/examples/use_cases/case9_ssh_keys/conn_ssh_keys.py) +- [Cisco Genie Integration](https://github.com/ktbyers/netmiko/blob/develop/examples/use_cases/case18_structured_data_genie) ### Getting Started: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..9f2435dad --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,8 @@ +Netmiko Documentation has Moved! +================================ + +.. contents:: + +Netmiko documentation has moved to GitHub Pages! + +You can find the README for Netmiko `here `__, and the API documentation `here `__. diff --git a/docs/netmiko/a10/a10_ssh.html b/docs/netmiko/a10/a10_ssh.html index 9a37e8f97..d0fd10928 100644 --- a/docs/netmiko/a10/a10_ssh.html +++ b/docs/netmiko/a10/a10_ssh.html @@ -120,10 +120,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -149,14 +149,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -180,7 +180,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/a10/index.html b/docs/netmiko/a10/index.html index 5adae1df0..fd8e9d33b 100644 --- a/docs/netmiko/a10/index.html +++ b/docs/netmiko/a10/index.html @@ -104,10 +104,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -164,7 +164,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/accedian/accedian_ssh.html b/docs/netmiko/accedian/accedian_ssh.html index 63bc17251..90c10bc49 100644 --- a/docs/netmiko/accedian/accedian_ssh.html +++ b/docs/netmiko/accedian/accedian_ssh.html @@ -141,10 +141,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -170,14 +170,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -201,7 +201,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/accedian/index.html b/docs/netmiko/accedian/index.html index 805bdc50f..aea7b2150 100644 --- a/docs/netmiko/accedian/index.html +++ b/docs/netmiko/accedian/index.html @@ -103,10 +103,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -132,14 +132,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -163,7 +163,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/alcatel/alcatel_aos_ssh.html b/docs/netmiko/alcatel/alcatel_aos_ssh.html index 9c3921836..2097da0d7 100644 --- a/docs/netmiko/alcatel/alcatel_aos_ssh.html +++ b/docs/netmiko/alcatel/alcatel_aos_ssh.html @@ -143,10 +143,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -172,14 +172,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -203,7 +203,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/alcatel/alcatel_sros_ssh.html b/docs/netmiko/alcatel/alcatel_sros_ssh.html index 07d9cef97..fbfa3328a 100644 --- a/docs/netmiko/alcatel/alcatel_sros_ssh.html +++ b/docs/netmiko/alcatel/alcatel_sros_ssh.html @@ -174,10 +174,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -203,14 +203,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -234,7 +234,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/alcatel/index.html b/docs/netmiko/alcatel/index.html index 216c09b75..7515e9971 100644 --- a/docs/netmiko/alcatel/index.html +++ b/docs/netmiko/alcatel/index.html @@ -109,10 +109,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -138,14 +138,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -169,7 +169,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -415,10 +415,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -444,14 +444,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -475,7 +475,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/apresia/apresia_aeos.html b/docs/netmiko/apresia/apresia_aeos.html index 6b7b6fae3..2af2245af 100644 --- a/docs/netmiko/apresia/apresia_aeos.html +++ b/docs/netmiko/apresia/apresia_aeos.html @@ -132,10 +132,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -161,14 +161,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -192,7 +192,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -371,10 +371,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -400,14 +400,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -431,7 +431,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -554,10 +554,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -583,14 +583,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -614,7 +614,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/apresia/index.html b/docs/netmiko/apresia/index.html index 1de5db475..9f38ed5c8 100644 --- a/docs/netmiko/apresia/index.html +++ b/docs/netmiko/apresia/index.html @@ -104,10 +104,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -164,7 +164,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -287,10 +287,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -316,14 +316,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -347,7 +347,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/arista/arista.html b/docs/netmiko/arista/arista.html index 9ba2a90b6..1aa3705e7 100644 --- a/docs/netmiko/arista/arista.html +++ b/docs/netmiko/arista/arista.html @@ -200,10 +200,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -229,14 +229,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -260,7 +260,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -559,10 +559,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -588,14 +588,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -619,7 +619,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -742,10 +742,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -771,14 +771,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -802,7 +802,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/arista/index.html b/docs/netmiko/arista/index.html index 726657778..e3eee1c80 100644 --- a/docs/netmiko/arista/index.html +++ b/docs/netmiko/arista/index.html @@ -194,10 +194,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -223,14 +223,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -254,7 +254,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -377,10 +377,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -406,14 +406,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -437,7 +437,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/aruba/aruba_ssh.html b/docs/netmiko/aruba/aruba_ssh.html index 09b459912..7235f907d 100644 --- a/docs/netmiko/aruba/aruba_ssh.html +++ b/docs/netmiko/aruba/aruba_ssh.html @@ -132,10 +132,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -161,14 +161,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -192,7 +192,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/aruba/index.html b/docs/netmiko/aruba/index.html index 0632dfbac..bd29b0a1a 100644 --- a/docs/netmiko/aruba/index.html +++ b/docs/netmiko/aruba/index.html @@ -104,10 +104,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -164,7 +164,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/base_connection.html b/docs/netmiko/base_connection.html index 5b74e41eb..92c1a1a19 100644 --- a/docs/netmiko/base_connection.html +++ b/docs/netmiko/base_connection.html @@ -57,7 +57,12 @@

Module netmiko.base_connection

NetMikoTimeoutException, NetMikoAuthenticationException, ) -from netmiko.utilities import write_bytes, check_serial_port, get_structured_data +from netmiko.utilities import ( + write_bytes, + check_serial_port, + get_structured_data, + get_structured_data_genie, +) class BaseConnection(object): @@ -159,10 +164,10 @@

Module netmiko.base_connection

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -188,11 +193,11 @@

Module netmiko.base_connection

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: '\n'). + :param default_enter: Character(s) to send to correspond to enter key (default: \n). :type default_enter: str :param response_return: Character(s) to use in normalized return data to represent - enter key (default: '\n') + enter key (default: \n) :type response_return: str :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor @@ -217,7 +222,7 @@

Module netmiko.base_connection

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str """ self.remote_conn = None @@ -749,7 +754,7 @@

Module netmiko.base_connection

""" In case of an exception happening during `session_preparation()` Netmiko should gracefully clean-up after itself. This might be challenging for library users - to do since they don't have a reference to the object. This is possibly related + to do since they do not have a reference to the object. This is possibly related to threads used in Paramiko. """ try: @@ -782,7 +787,7 @@

Module netmiko.base_connection

self.clear_buffer() def _use_ssh_config(self, dict_arg): - """Update SSH connection parameters based on contents of SSH 'config' file. + """Update SSH connection parameters based on contents of SSH config file. :param dict_arg: Dictionary of SSH connection parameters :type dict_arg: dict @@ -1057,7 +1062,7 @@

Module netmiko.base_connection

Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. @@ -1130,6 +1135,7 @@

Module netmiko.base_connection

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -1155,6 +1161,9 @@

Module netmiko.base_connection

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -1172,10 +1181,18 @@

Module netmiko.base_connection

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def strip_prompt(self, a_string): @@ -1229,6 +1246,7 @@

Module netmiko.base_connection

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -1260,6 +1278,9 @@

Module netmiko.base_connection

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -1336,10 +1357,19 @@

Module netmiko.base_connection

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def send_command_expect(self, *args, **kwargs): @@ -1821,10 +1851,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1850,14 +1880,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1881,7 +1911,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1985,10 +2015,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -2014,11 +2044,11 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: '\n'). + :param default_enter: Character(s) to send to correspond to enter key (default: \n). :type default_enter: str :param response_return: Character(s) to use in normalized return data to represent - enter key (default: '\n') + enter key (default: \n) :type response_return: str :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor @@ -2043,7 +2073,7 @@

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str """ self.remote_conn = None @@ -2575,7 +2605,7 @@

Classes

""" In case of an exception happening during `session_preparation()` Netmiko should gracefully clean-up after itself. This might be challenging for library users - to do since they don't have a reference to the object. This is possibly related + to do since they do not have a reference to the object. This is possibly related to threads used in Paramiko. """ try: @@ -2608,7 +2638,7 @@

Classes

self.clear_buffer() def _use_ssh_config(self, dict_arg): - """Update SSH connection parameters based on contents of SSH 'config' file. + """Update SSH connection parameters based on contents of SSH config file. :param dict_arg: Dictionary of SSH connection parameters :type dict_arg: dict @@ -2883,7 +2913,7 @@

Classes

Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. @@ -2956,6 +2986,7 @@

Classes

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -2981,6 +3012,9 @@

Classes

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -2998,10 +3032,18 @@

Classes

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def strip_prompt(self, a_string): @@ -3055,6 +3097,7 @@

Classes

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -3086,6 +3129,9 @@

Classes

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -3162,10 +3208,19 @@

Classes

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def send_command_expect(self, *args, **kwargs): @@ -4268,7 +4323,7 @@

Methods

-def send_command(self, command_string, expect_string=None, delay_factor=1, max_loops=500, auto_find_prompt=True, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False) +def send_command(self, command_string, expect_string=None, delay_factor=1, max_loops=500, auto_find_prompt=True, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False, use_genie=False)

Execute command_string on the SSH channel using a pattern-based mechanism. Generally @@ -4292,6 +4347,8 @@

Methods

:param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool

:param use_textfsm: Process command output through TextFSM template (default: False). +:type normalize: bool

+

:param use_genie: Process command output through PyATS/Genie parser (default: False). :type normalize: bool

Source code @@ -4306,6 +4363,7 @@

Methods

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -4337,6 +4395,9 @@

Methods

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -4413,10 +4474,19 @@

Methods

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output
@@ -4444,7 +4514,7 @@

Methods

-def send_command_timing(self, command_string, delay_factor=1, max_loops=150, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False) +def send_command_timing(self, command_string, delay_factor=1, max_loops=150, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False, use_genie=False)

Execute command_string on the SSH channel using a delay-based mechanism. Generally @@ -4463,6 +4533,8 @@

Methods

:param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool

:param use_textfsm: Process command output through TextFSM template (default: False). +:type normalize: bool

+

:param use_genie: Process command output through PyATS/Genie parser (default: False). :type normalize: bool

Source code @@ -4475,6 +4547,7 @@

Methods

strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -4500,6 +4573,9 @@

Methods

:param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -4517,10 +4593,18 @@

Methods

command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output
@@ -4722,7 +4806,7 @@

Methods

Sets self.base_prompt

Used as delimiter for stripping of trailing prompt in output.

Should be set to something that is general and applies in multiple contexts. For Cisco -devices this will be set to router hostname (i.e. prompt without '>' or '#').

+devices this will be set to router hostname (i.e. prompt without > or #).

This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode.

:param pri_prompt_terminator: Primary trailing delimiter for identifying a device prompt @@ -4741,7 +4825,7 @@

Methods

Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. @@ -5190,10 +5274,10 @@

Methods

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -5219,14 +5303,14 @@

Methods

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -5250,7 +5334,7 @@ 

Methods

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/calix/calix_b6.html b/docs/netmiko/calix/calix_b6.html index 315cf1830..0894e32f3 100644 --- a/docs/netmiko/calix/calix_b6.html +++ b/docs/netmiko/calix/calix_b6.html @@ -198,10 +198,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -227,14 +227,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -258,7 +258,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -503,10 +503,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -532,14 +532,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -563,7 +563,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -709,10 +709,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -738,14 +738,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -769,7 +769,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/calix/index.html b/docs/netmiko/calix/index.html index d0a5f8b59..a95f1b0cc 100644 --- a/docs/netmiko/calix/index.html +++ b/docs/netmiko/calix/index.html @@ -106,10 +106,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -135,14 +135,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -166,7 +166,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -312,10 +312,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -341,14 +341,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -372,7 +372,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html index f1e8a9d19..76b0c314c 100644 --- a/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html +++ b/docs/netmiko/checkpoint/checkpoint_gaia_ssh.html @@ -129,10 +129,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -158,14 +158,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -189,7 +189,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/checkpoint/index.html b/docs/netmiko/checkpoint/index.html index a2370c5f2..80a88842c 100644 --- a/docs/netmiko/checkpoint/index.html +++ b/docs/netmiko/checkpoint/index.html @@ -105,10 +105,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -165,7 +165,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/ciena/ciena_saos_ssh.html b/docs/netmiko/ciena/ciena_saos_ssh.html index 08607008e..fc7a70fac 100644 --- a/docs/netmiko/ciena/ciena_saos_ssh.html +++ b/docs/netmiko/ciena/ciena_saos_ssh.html @@ -118,10 +118,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -147,14 +147,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -178,7 +178,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/ciena/index.html b/docs/netmiko/ciena/index.html index 9aa9e8ff1..5e555ed29 100644 --- a/docs/netmiko/ciena/index.html +++ b/docs/netmiko/ciena/index.html @@ -104,10 +104,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -164,7 +164,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_asa_ssh.html b/docs/netmiko/cisco/cisco_asa_ssh.html index 85d338e8e..9235d1276 100644 --- a/docs/netmiko/cisco/cisco_asa_ssh.html +++ b/docs/netmiko/cisco/cisco_asa_ssh.html @@ -260,10 +260,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -289,14 +289,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -320,7 +320,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_ios.html b/docs/netmiko/cisco/cisco_ios.html index dcce94255..015081b8b 100644 --- a/docs/netmiko/cisco/cisco_ios.html +++ b/docs/netmiko/cisco/cisco_ios.html @@ -328,10 +328,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -357,14 +357,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -388,7 +388,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -621,10 +621,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -650,14 +650,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -681,7 +681,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -805,10 +805,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -834,14 +834,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -865,7 +865,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -989,10 +989,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1018,14 +1018,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1049,7 +1049,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_nxos_ssh.html b/docs/netmiko/cisco/cisco_nxos_ssh.html index 34b9d9e79..1a0573f22 100644 --- a/docs/netmiko/cisco/cisco_nxos_ssh.html +++ b/docs/netmiko/cisco/cisco_nxos_ssh.html @@ -364,10 +364,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -393,14 +393,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -424,7 +424,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_s300.html b/docs/netmiko/cisco/cisco_s300.html index df0a3d6c5..bad074fc0 100644 --- a/docs/netmiko/cisco/cisco_s300.html +++ b/docs/netmiko/cisco/cisco_s300.html @@ -125,10 +125,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -154,14 +154,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -185,7 +185,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_tp_tcce.html b/docs/netmiko/cisco/cisco_tp_tcce.html index 6e665b7ba..d79b3fd2f 100644 --- a/docs/netmiko/cisco/cisco_tp_tcce.html +++ b/docs/netmiko/cisco/cisco_tp_tcce.html @@ -190,10 +190,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -219,14 +219,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -250,7 +250,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_wlc_ssh.html b/docs/netmiko/cisco/cisco_wlc_ssh.html index 45b84b304..041812b98 100644 --- a/docs/netmiko/cisco/cisco_wlc_ssh.html +++ b/docs/netmiko/cisco/cisco_wlc_ssh.html @@ -285,10 +285,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -314,14 +314,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -345,7 +345,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/cisco_xr.html b/docs/netmiko/cisco/cisco_xr.html index 2ba692567..24746979b 100644 --- a/docs/netmiko/cisco/cisco_xr.html +++ b/docs/netmiko/cisco/cisco_xr.html @@ -296,10 +296,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -325,14 +325,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -356,7 +356,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -966,10 +966,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -995,14 +995,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1026,7 +1026,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1150,10 +1150,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1179,14 +1179,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1210,7 +1210,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco/index.html b/docs/netmiko/cisco/index.html index 2820dca56..b9883a6d6 100644 --- a/docs/netmiko/cisco/index.html +++ b/docs/netmiko/cisco/index.html @@ -203,10 +203,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -232,14 +232,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -263,7 +263,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -660,10 +660,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -689,14 +689,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -720,7 +720,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -953,10 +953,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -982,14 +982,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1013,7 +1013,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1137,10 +1137,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1166,14 +1166,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1197,7 +1197,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1321,10 +1321,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1350,14 +1350,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1381,7 +1381,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1651,10 +1651,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1680,14 +1680,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1711,7 +1711,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1906,10 +1906,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1935,14 +1935,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1966,7 +1966,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -2130,10 +2130,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -2159,14 +2159,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -2190,7 +2190,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -2527,10 +2527,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -2556,14 +2556,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -2587,7 +2587,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -3271,10 +3271,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -3300,14 +3300,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -3331,7 +3331,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -3455,10 +3455,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -3484,14 +3484,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -3515,7 +3515,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
diff --git a/docs/netmiko/cisco_base_connection.html b/docs/netmiko/cisco_base_connection.html index 3d358336d..38baba940 100644 --- a/docs/netmiko/cisco_base_connection.html +++ b/docs/netmiko/cisco_base_connection.html @@ -327,10 +327,10 @@

Classes

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -356,14 +356,14 @@

Classes

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -387,7 +387,7 @@ 

Classes

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1046,10 +1046,10 @@

Inherited members

means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1075,14 +1075,14 @@

Inherited members

to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

'). +

). :type default_enter: str

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

') +

) :type response_return: str

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
             to select smallest of global and specific. Sets default global_delay_factor to .1
@@ -1106,7 +1106,7 @@ 

Inherited members

:type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
@@ -1153,7 +1153,7 @@

Subclasses

  • HPProcurveBase
  • HPComwareBase
  • MikrotikBase
  • -
  • MellanoxSSH
  • +
  • MellanoxMlnxosSSH
  • MrvLxSSH
  • MrvOptiswitchSSH
  • QuantaMeshSSH
  • diff --git a/docs/netmiko/citrix/index.html b/docs/netmiko/citrix/index.html index a5663d54a..6a734d8d4 100644 --- a/docs/netmiko/citrix/index.html +++ b/docs/netmiko/citrix/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/citrix/netscaler_ssh.html b/docs/netmiko/citrix/netscaler_ssh.html index 81d45c434..a61024907 100644 --- a/docs/netmiko/citrix/netscaler_ssh.html +++ b/docs/netmiko/citrix/netscaler_ssh.html @@ -153,10 +153,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -182,14 +182,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -213,7 +213,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/cloudgenix/cloudgenix_ion.html b/docs/netmiko/cloudgenix/cloudgenix_ion.html index ca81fc6de..011c4ff0f 100644 --- a/docs/netmiko/cloudgenix/cloudgenix_ion.html +++ b/docs/netmiko/cloudgenix/cloudgenix_ion.html @@ -173,10 +173,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -202,14 +202,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -233,7 +233,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/cloudgenix/index.html b/docs/netmiko/cloudgenix/index.html index d7645f6c2..90e655072 100644 --- a/docs/netmiko/cloudgenix/index.html +++ b/docs/netmiko/cloudgenix/index.html @@ -103,10 +103,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -132,14 +132,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -163,7 +163,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/coriant/coriant_ssh.html b/docs/netmiko/coriant/coriant_ssh.html index 139cc2938..2e00b19e2 100644 --- a/docs/netmiko/coriant/coriant_ssh.html +++ b/docs/netmiko/coriant/coriant_ssh.html @@ -137,10 +137,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -166,14 +166,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -197,7 +197,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/coriant/index.html b/docs/netmiko/coriant/index.html index 38824e45e..347b9f6bc 100644 --- a/docs/netmiko/coriant/index.html +++ b/docs/netmiko/coriant/index.html @@ -103,10 +103,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -132,14 +132,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -163,7 +163,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/dell_dnos6.html b/docs/netmiko/dell/dell_dnos6.html index de5e0a50b..79e115c11 100644 --- a/docs/netmiko/dell/dell_dnos6.html +++ b/docs/netmiko/dell/dell_dnos6.html @@ -131,10 +131,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -160,14 +160,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -191,7 +191,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -360,10 +360,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -389,14 +389,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -420,7 +420,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -543,10 +543,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -572,14 +572,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -603,7 +603,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/dell_force10_ssh.html b/docs/netmiko/dell/dell_force10_ssh.html index b49ed0664..d32687ce9 100644 --- a/docs/netmiko/dell/dell_force10_ssh.html +++ b/docs/netmiko/dell/dell_force10_ssh.html @@ -112,10 +112,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -141,14 +141,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -172,7 +172,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/dell_isilon_ssh.html b/docs/netmiko/dell/dell_isilon_ssh.html index c5766a945..6f549b62c 100644 --- a/docs/netmiko/dell/dell_isilon_ssh.html +++ b/docs/netmiko/dell/dell_isilon_ssh.html @@ -182,10 +182,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -211,14 +211,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -242,7 +242,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/dell_os10_ssh.html b/docs/netmiko/dell/dell_os10_ssh.html index 4702b7810..13c79b0f1 100644 --- a/docs/netmiko/dell/dell_os10_ssh.html +++ b/docs/netmiko/dell/dell_os10_ssh.html @@ -345,10 +345,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -374,14 +374,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -405,7 +405,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/dell_powerconnect.html b/docs/netmiko/dell/dell_powerconnect.html index 407fb7d94..ebc2053ce 100644 --- a/docs/netmiko/dell/dell_powerconnect.html +++ b/docs/netmiko/dell/dell_powerconnect.html @@ -208,10 +208,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -237,14 +237,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -268,7 +268,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -500,10 +500,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -529,14 +529,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -560,7 +560,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -772,10 +772,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -801,14 +801,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -832,7 +832,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/dell/index.html b/docs/netmiko/dell/index.html index fd5111448..66d4ccf0f 100644 --- a/docs/netmiko/dell/index.html +++ b/docs/netmiko/dell/index.html @@ -135,10 +135,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -164,14 +164,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -195,7 +195,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -318,10 +318,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -347,14 +347,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -378,7 +378,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -501,10 +501,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -530,14 +530,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -561,7 +561,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -716,10 +716,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -745,14 +745,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -776,7 +776,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1277,10 +1277,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1306,14 +1306,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1337,7 +1337,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1493,10 +1493,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1522,14 +1522,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1553,7 +1553,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1765,10 +1765,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1794,14 +1794,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1825,7 +1825,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/eltex/eltex_ssh.html b/docs/netmiko/eltex/eltex_ssh.html index 1f0b0a4e9..3657c7168 100644 --- a/docs/netmiko/eltex/eltex_ssh.html +++ b/docs/netmiko/eltex/eltex_ssh.html @@ -114,10 +114,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -143,14 +143,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -174,7 +174,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/eltex/index.html b/docs/netmiko/eltex/index.html index 4e9a5659a..1aa293a27 100644 --- a/docs/netmiko/eltex/index.html +++ b/docs/netmiko/eltex/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/endace/endace_ssh.html b/docs/netmiko/endace/endace_ssh.html index b02981489..9df350e55 100644 --- a/docs/netmiko/endace/endace_ssh.html +++ b/docs/netmiko/endace/endace_ssh.html @@ -141,10 +141,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -170,14 +170,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -201,7 +201,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/endace/index.html b/docs/netmiko/endace/index.html index ba4803844..735fb9ccd 100644 --- a/docs/netmiko/endace/index.html +++ b/docs/netmiko/endace/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/enterasys/enterasys_ssh.html b/docs/netmiko/enterasys/enterasys_ssh.html index 80188d4bb..8746d5077 100644 --- a/docs/netmiko/enterasys/enterasys_ssh.html +++ b/docs/netmiko/enterasys/enterasys_ssh.html @@ -115,10 +115,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -144,14 +144,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -175,7 +175,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/enterasys/index.html b/docs/netmiko/enterasys/index.html index fd3cf5734..9cc07f3a4 100644 --- a/docs/netmiko/enterasys/index.html +++ b/docs/netmiko/enterasys/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_ers_ssh.html b/docs/netmiko/extreme/extreme_ers_ssh.html index bd1948029..f42154339 100644 --- a/docs/netmiko/extreme/extreme_ers_ssh.html +++ b/docs/netmiko/extreme/extreme_ers_ssh.html @@ -139,10 +139,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -168,14 +168,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -199,7 +199,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_exos.html b/docs/netmiko/extreme/extreme_exos.html index a24ff5676..f52920fc9 100644 --- a/docs/netmiko/extreme/extreme_exos.html +++ b/docs/netmiko/extreme/extreme_exos.html @@ -181,10 +181,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -210,14 +210,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -241,7 +241,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -544,10 +544,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -573,14 +573,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -604,7 +604,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -728,10 +728,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -757,14 +757,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -788,7 +788,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_netiron.html b/docs/netmiko/extreme/extreme_netiron.html index adb542afc..e45384b8c 100644 --- a/docs/netmiko/extreme/extreme_netiron.html +++ b/docs/netmiko/extreme/extreme_netiron.html @@ -114,10 +114,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -143,14 +143,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -174,7 +174,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -321,10 +321,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -350,14 +350,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -381,7 +381,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -504,10 +504,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -533,14 +533,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -564,7 +564,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_nos_ssh.html b/docs/netmiko/extreme/extreme_nos_ssh.html index 1c8b340be..16829e766 100644 --- a/docs/netmiko/extreme/extreme_nos_ssh.html +++ b/docs/netmiko/extreme/extreme_nos_ssh.html @@ -127,10 +127,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -156,14 +156,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -187,7 +187,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_slx_ssh.html b/docs/netmiko/extreme/extreme_slx_ssh.html index ffc2f5c30..536399fa7 100644 --- a/docs/netmiko/extreme/extreme_slx_ssh.html +++ b/docs/netmiko/extreme/extreme_slx_ssh.html @@ -127,10 +127,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -156,14 +156,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -187,7 +187,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_vsp_ssh.html b/docs/netmiko/extreme/extreme_vsp_ssh.html index 4c41f095a..9bd0fa2de 100644 --- a/docs/netmiko/extreme/extreme_vsp_ssh.html +++ b/docs/netmiko/extreme/extreme_vsp_ssh.html @@ -118,10 +118,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -147,14 +147,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -178,7 +178,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/extreme_wing_ssh.html b/docs/netmiko/extreme/extreme_wing_ssh.html index ea189cf46..8eb83fe86 100644 --- a/docs/netmiko/extreme/extreme_wing_ssh.html +++ b/docs/netmiko/extreme/extreme_wing_ssh.html @@ -109,10 +109,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -138,14 +138,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -169,7 +169,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/extreme/index.html b/docs/netmiko/extreme/index.html index 9f5fedccf..9a56cc881 100644 --- a/docs/netmiko/extreme/index.html +++ b/docs/netmiko/extreme/index.html @@ -146,10 +146,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -175,14 +175,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -206,7 +206,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -413,10 +413,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -442,14 +442,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -473,7 +473,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -597,10 +597,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -626,14 +626,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -657,7 +657,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -783,10 +783,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -812,14 +812,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -843,7 +843,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -966,10 +966,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -995,14 +995,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1026,7 +1026,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1152,10 +1152,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1181,14 +1181,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1212,7 +1212,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1415,10 +1415,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1444,14 +1444,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1475,7 +1475,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1678,10 +1678,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1707,14 +1707,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1738,7 +1738,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1907,10 +1907,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1936,14 +1936,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1967,7 +1967,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/f5/f5_linux_ssh.html b/docs/netmiko/f5/f5_linux_ssh.html index b6cdcc293..422c5bfa1 100644 --- a/docs/netmiko/f5/f5_linux_ssh.html +++ b/docs/netmiko/f5/f5_linux_ssh.html @@ -99,10 +99,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -128,14 +128,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -159,7 +159,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/f5/f5_tmsh_ssh.html b/docs/netmiko/f5/f5_tmsh_ssh.html index 691567b0b..d747fe4c2 100644 --- a/docs/netmiko/f5/f5_tmsh_ssh.html +++ b/docs/netmiko/f5/f5_tmsh_ssh.html @@ -122,10 +122,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -151,14 +151,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -182,7 +182,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/f5/index.html b/docs/netmiko/f5/index.html index 562b7a01f..5dcebd4dc 100644 --- a/docs/netmiko/f5/index.html +++ b/docs/netmiko/f5/index.html @@ -109,10 +109,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -138,14 +138,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -169,7 +169,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -293,10 +293,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -322,14 +322,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -353,7 +353,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/flexvnf/flexvnf_ssh.html b/docs/netmiko/flexvnf/flexvnf_ssh.html index 282fdfff3..3ad80511c 100644 --- a/docs/netmiko/flexvnf/flexvnf_ssh.html +++ b/docs/netmiko/flexvnf/flexvnf_ssh.html @@ -302,10 +302,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -331,14 +331,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -362,7 +362,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/flexvnf/index.html b/docs/netmiko/flexvnf/index.html index 894f3e218..885f07325 100644 --- a/docs/netmiko/flexvnf/index.html +++ b/docs/netmiko/flexvnf/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/fortinet/fortinet_ssh.html b/docs/netmiko/fortinet/fortinet_ssh.html index ed5eb3804..090ecaf7f 100644 --- a/docs/netmiko/fortinet/fortinet_ssh.html +++ b/docs/netmiko/fortinet/fortinet_ssh.html @@ -189,10 +189,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -218,14 +218,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -249,7 +249,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/fortinet/index.html b/docs/netmiko/fortinet/index.html index 947e04824..fc79cabe0 100644 --- a/docs/netmiko/fortinet/index.html +++ b/docs/netmiko/fortinet/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/hp/hp_comware.html b/docs/netmiko/hp/hp_comware.html index db48226e3..39acd068d 100644 --- a/docs/netmiko/hp/hp_comware.html +++ b/docs/netmiko/hp/hp_comware.html @@ -191,10 +191,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -220,14 +220,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -251,7 +251,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -609,10 +609,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -638,14 +638,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -669,7 +669,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -792,10 +792,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -821,14 +821,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -852,7 +852,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/hp/hp_procurve.html b/docs/netmiko/hp/hp_procurve.html index b6e74e641..082e0a37a 100644 --- a/docs/netmiko/hp/hp_procurve.html +++ b/docs/netmiko/hp/hp_procurve.html @@ -214,10 +214,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -243,14 +243,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -274,7 +274,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -535,10 +535,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -564,14 +564,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -595,7 +595,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -738,10 +738,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -767,14 +767,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -798,7 +798,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/hp/index.html b/docs/netmiko/hp/index.html index a43485985..348b7187a 100644 --- a/docs/netmiko/hp/index.html +++ b/docs/netmiko/hp/index.html @@ -109,10 +109,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -138,14 +138,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -169,7 +169,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -292,10 +292,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -321,14 +321,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -352,7 +352,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -478,10 +478,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -507,14 +507,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -538,7 +538,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -681,10 +681,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -710,14 +710,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -741,7 +741,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/huawei/huawei.html b/docs/netmiko/huawei/huawei.html index 7b2ebe8c2..60ee74db9 100644 --- a/docs/netmiko/huawei/huawei.html +++ b/docs/netmiko/huawei/huawei.html @@ -146,28 +146,43 @@

    Module netmiko.huawei.huawei

    i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) - return_msg += output - - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) @@ -299,10 +314,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -328,14 +343,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -359,7 +374,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -717,10 +732,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -746,14 +761,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -777,7 +792,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -905,10 +920,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -934,14 +949,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -965,7 +980,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -995,28 +1010,43 @@

    Inherited members

    i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) - return_msg += output - - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) @@ -1073,28 +1103,43 @@

    Methods

    i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) - return_msg += output - - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) @@ -1223,10 +1268,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1252,14 +1297,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1283,7 +1328,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/huawei/index.html b/docs/netmiko/huawei/index.html index 7027c3120..a48a3916b 100644 --- a/docs/netmiko/huawei/index.html +++ b/docs/netmiko/huawei/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -293,10 +293,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -322,14 +322,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -353,7 +353,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -383,28 +383,43 @@

    Inherited members

    i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) - return_msg += output - - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) @@ -461,28 +476,43 @@

    Methods

    i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) - return_msg += output - - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) @@ -611,10 +641,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -640,14 +670,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -671,7 +701,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/index.html b/docs/netmiko/index.html index dbdc1f653..11632176a 100644 --- a/docs/netmiko/index.html +++ b/docs/netmiko/index.html @@ -47,7 +47,7 @@

    Module netmiko

    NetmikoAuthError = NetMikoAuthenticationException Netmiko = ConnectHandler -__version__ = "2.3.3" +__version__ = "2.4.1" __all__ = ( "ConnectHandler", "ssh_dispatcher", @@ -544,10 +544,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -573,14 +573,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -604,7 +604,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -708,10 +708,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -737,11 +737,11 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: '\n'). + :param default_enter: Character(s) to send to correspond to enter key (default: \n). :type default_enter: str :param response_return: Character(s) to use in normalized return data to represent - enter key (default: '\n') + enter key (default: \n) :type response_return: str :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor @@ -766,7 +766,7 @@

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str """ self.remote_conn = None @@ -1298,7 +1298,7 @@

    Classes

    """ In case of an exception happening during `session_preparation()` Netmiko should gracefully clean-up after itself. This might be challenging for library users - to do since they don't have a reference to the object. This is possibly related + to do since they do not have a reference to the object. This is possibly related to threads used in Paramiko. """ try: @@ -1331,7 +1331,7 @@

    Classes

    self.clear_buffer() def _use_ssh_config(self, dict_arg): - """Update SSH connection parameters based on contents of SSH 'config' file. + """Update SSH connection parameters based on contents of SSH config file. :param dict_arg: Dictionary of SSH connection parameters :type dict_arg: dict @@ -1606,7 +1606,7 @@

    Classes

    Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. @@ -1679,6 +1679,7 @@

    Classes

    strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -1704,6 +1705,9 @@

    Classes

    :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -1721,10 +1725,18 @@

    Classes

    command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def strip_prompt(self, a_string): @@ -1778,6 +1790,7 @@

    Classes

    strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -1809,6 +1822,9 @@

    Classes

    :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -1885,10 +1901,19 @@

    Classes

    command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def send_command_expect(self, *args, **kwargs): @@ -2991,7 +3016,7 @@

    Methods

    -def send_command(self, command_string, expect_string=None, delay_factor=1, max_loops=500, auto_find_prompt=True, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False) +def send_command(self, command_string, expect_string=None, delay_factor=1, max_loops=500, auto_find_prompt=True, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False, use_genie=False)

    Execute command_string on the SSH channel using a pattern-based mechanism. Generally @@ -3015,6 +3040,8 @@

    Methods

    :param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool

    :param use_textfsm: Process command output through TextFSM template (default: False). +:type normalize: bool

    +

    :param use_genie: Process command output through PyATS/Genie parser (default: False). :type normalize: bool

    Source code @@ -3029,6 +3056,7 @@

    Methods

    strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -3060,6 +3088,9 @@

    Methods

    :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -3136,10 +3167,19 @@

    Methods

    command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output
    @@ -3167,7 +3207,7 @@

    Methods

    -def send_command_timing(self, command_string, delay_factor=1, max_loops=150, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False) +def send_command_timing(self, command_string, delay_factor=1, max_loops=150, strip_prompt=True, strip_command=True, normalize=True, use_textfsm=False, use_genie=False)

    Execute command_string on the SSH channel using a delay-based mechanism. Generally @@ -3186,6 +3226,8 @@

    Methods

    :param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool

    :param use_textfsm: Process command output through TextFSM template (default: False). +:type normalize: bool

    +

    :param use_genie: Process command output through PyATS/Genie parser (default: False). :type normalize: bool

    Source code @@ -3198,6 +3240,7 @@

    Methods

    strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -3223,6 +3266,9 @@

    Methods

    :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -3240,10 +3286,18 @@

    Methods

    command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output
    @@ -3445,7 +3499,7 @@

    Methods

    Sets self.base_prompt

    Used as delimiter for stripping of trailing prompt in output.

    Should be set to something that is general and applies in multiple contexts. For Cisco -devices this will be set to router hostname (i.e. prompt without '>' or '#').

    +devices this will be set to router hostname (i.e. prompt without > or #).

    This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode.

    :param pri_prompt_terminator: Primary trailing delimiter for identifying a device prompt @@ -3464,7 +3518,7 @@

    Methods

    Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. diff --git a/docs/netmiko/ipinfusion/index.html b/docs/netmiko/ipinfusion/index.html index 3340ae652..0adb12bf5 100644 --- a/docs/netmiko/ipinfusion/index.html +++ b/docs/netmiko/ipinfusion/index.html @@ -107,10 +107,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -136,14 +136,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -167,7 +167,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -292,10 +292,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -321,14 +321,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -352,7 +352,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ipinfusion/ipinfusion_ocnos.html b/docs/netmiko/ipinfusion/ipinfusion_ocnos.html index 1e24656d2..e23c2b417 100644 --- a/docs/netmiko/ipinfusion/ipinfusion_ocnos.html +++ b/docs/netmiko/ipinfusion/ipinfusion_ocnos.html @@ -165,10 +165,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -194,14 +194,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -225,7 +225,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -387,10 +387,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -416,14 +416,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -447,7 +447,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -572,10 +572,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -601,14 +601,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -632,7 +632,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/juniper/index.html b/docs/netmiko/juniper/index.html index 7c43cf331..80a9e9f92 100644 --- a/docs/netmiko/juniper/index.html +++ b/docs/netmiko/juniper/index.html @@ -183,10 +183,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -212,14 +212,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -243,7 +243,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -369,10 +369,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -398,14 +398,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -429,7 +429,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/juniper/juniper.html b/docs/netmiko/juniper/juniper.html index 21cd53ea3..70c683552 100644 --- a/docs/netmiko/juniper/juniper.html +++ b/docs/netmiko/juniper/juniper.html @@ -365,10 +365,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -394,14 +394,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -425,7 +425,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1132,10 +1132,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1161,14 +1161,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1192,7 +1192,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1318,10 +1318,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1347,14 +1347,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1378,7 +1378,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/linux/index.html b/docs/netmiko/linux/index.html index 8a0b44900..c95d15362 100644 --- a/docs/netmiko/linux/index.html +++ b/docs/netmiko/linux/index.html @@ -200,10 +200,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -229,14 +229,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -260,7 +260,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/linux/linux_ssh.html b/docs/netmiko/linux/linux_ssh.html index 86e8b07f8..50765121b 100644 --- a/docs/netmiko/linux/linux_ssh.html +++ b/docs/netmiko/linux/linux_ssh.html @@ -353,10 +353,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -382,14 +382,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -413,7 +413,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/mellanox/index.html b/docs/netmiko/mellanox/index.html index 4d2782757..ef4b3a2c0 100644 --- a/docs/netmiko/mellanox/index.html +++ b/docs/netmiko/mellanox/index.html @@ -23,17 +23,17 @@

    Module netmiko.mellanox

    Source code
    from __future__ import unicode_literals
    -from netmiko.mellanox.mellanox_ssh import MellanoxSSH
    +from netmiko.mellanox.mellanox_mlnxos_ssh import MellanoxMlnxosSSH
     
    -__all__ = ["MellanoxSSH"]
    +__all__ = ["MellanoxMlnxosSSH"]

    Sub-modules

    -
    netmiko.mellanox.mellanox_ssh
    +
    netmiko.mellanox.mellanox_mlnxos_ssh
    -
    +

    Mellanox MLNX-OS Switch support.

    @@ -44,12 +44,12 @@

    Sub-modules

    Classes

    -
    -class MellanoxSSH +
    +class MellanoxMlnxosSSH (ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=8, banner_timeout=5, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii')
    -

    Base Class for cisco-like behavior.

    +

    Mellanox MLNX-OS Switch support.

        Initialize attributes for establishing connection to target device.
     
         :param ip: IP address of target device. Not required if `host` is
    @@ -104,10 +104,10 @@ 

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
    -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,52 +164,61 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    Source code -
    class MellanoxSSH(CiscoSSHConnection):
    -    def config_mode(self, config_command="config term", pattern="#"):
    -        """Enter into config_mode."""
    +
    class MellanoxMlnxosSSH(CiscoSSHConnection):
    +    """Mellanox MLNX-OS Switch support."""
    +
    +    def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE):
    +        """Enter into enable mode."""
             output = ""
    -        if not self.check_config_mode():
    -            self.write_channel(self.normalize_cmd(config_command))
    -            output = self.read_until_pattern(pattern=pattern)
    -            if not self.check_config_mode():
    -                raise ValueError("Failed to enter configuration mode.")
    +        if not self.check_enable_mode():
    +            self.write_channel(self.normalize_cmd(cmd))
    +            output += self.read_until_prompt_or_pattern(
    +                pattern=pattern, re_flags=re_flags
    +            )
    +            if not self.check_enable_mode():
    +                raise ValueError("Failed to enter enable mode.")
             return output
     
    -    def check_config_mode(self, check_string="(config)", pattern=r"[>|#]"):
    -        return super(MellanoxSSH, self).check_config_mode(
    +    def config_mode(self, config_command="config term", pattern="#"):
    +        return super(MellanoxMlnxosSSH, self).config_mode(
    +            config_command=config_command, pattern=pattern
    +        )
    +
    +    def check_config_mode(self, check_string="(config", pattern=r"#"):
    +        return super(MellanoxMlnxosSSH, self).check_config_mode(
                 check_string=check_string, pattern=pattern
             )
     
    -    def disable_paging(self, command="terminal length 999", delay_factor=1):
    -        """Disable paging default to a Cisco CLI method."""
    -        delay_factor = self.select_delay_factor(delay_factor)
    -        time.sleep(delay_factor * 0.1)
    -        self.clear_buffer()
    -        command = self.normalize_cmd(command)
    -        log.debug("In disable_paging")
    -        log.debug("Command: {0}".format(command))
    -        self.write_channel(command)
    -        output = self.read_until_prompt()
    -        if self.ansi_escape_codes:
    -            output = self.strip_ansi_escape_codes(output)
    -        log.debug("{0}".format(output))
    -        log.debug("Exiting disable_paging")
    -        return output
    +    def disable_paging(self, command="no cli session paging enable", delay_factor=1):
    +        return super(MellanoxMlnxosSSH, self).disable_paging(
    +            command=command, delay_factor=delay_factor
    +        )
     
         def exit_config_mode(self, exit_config="exit", pattern="#"):
    -        """Exit from configuration mode."""
    +        """Mellanox does not support a single command to completely exit configuration mode.
    +
    +        Consequently, need to keep checking and sending "exit".
    +        """
             output = ""
    -        if self.check_config_mode():
    -            self.write_channel(self.normalize_cmd(exit_config))
    -            output = self.read_until_pattern(pattern=pattern)
    +        check_count = 12
    +        while check_count >= 0:
                 if self.check_config_mode():
    -                raise ValueError("Failed to exit configuration mode")
    -        log.debug("exit_config_mode: {0}".format(output))
    +                self.write_channel(self.normalize_cmd(exit_config))
    +                output += self.read_until_pattern(pattern=pattern)
    +            else:
    +                break
    +            check_count -= 1
    +
    +        # One last check for whether we successfully exited config mode
    +        if self.check_config_mode():
    +            raise ValueError("Failed to exit configuration mode")
    +
    +        log.debug("exit_config_mode: {}".format(output))
             return output
     
         def save_config(
    @@ -230,49 +239,58 @@ 

    Ancestors

    Methods

    -
    -def config_mode(self, config_command='config term', pattern='#') +
    +def enable(self, cmd='enable', pattern='#', re_flags=)
    -

    Enter into config_mode.

    +

    Enter into enable mode.

    Source code -
    def config_mode(self, config_command="config term", pattern="#"):
    -    """Enter into config_mode."""
    +
    def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE):
    +    """Enter into enable mode."""
         output = ""
    -    if not self.check_config_mode():
    -        self.write_channel(self.normalize_cmd(config_command))
    -        output = self.read_until_pattern(pattern=pattern)
    -        if not self.check_config_mode():
    -            raise ValueError("Failed to enter configuration mode.")
    +    if not self.check_enable_mode():
    +        self.write_channel(self.normalize_cmd(cmd))
    +        output += self.read_until_prompt_or_pattern(
    +            pattern=pattern, re_flags=re_flags
    +        )
    +        if not self.check_enable_mode():
    +            raise ValueError("Failed to enter enable mode.")
         return output
    -
    -def disable_paging(self, command='terminal length 999', delay_factor=1) +
    +def exit_config_mode(self, exit_config='exit', pattern='#')
    -

    Disable paging default to a Cisco CLI method.

    +

    Mellanox does not support a single command to completely exit configuration mode.

    +

    Consequently, need to keep checking and sending "exit".

    Source code -
    def disable_paging(self, command="terminal length 999", delay_factor=1):
    -    """Disable paging default to a Cisco CLI method."""
    -    delay_factor = self.select_delay_factor(delay_factor)
    -    time.sleep(delay_factor * 0.1)
    -    self.clear_buffer()
    -    command = self.normalize_cmd(command)
    -    log.debug("In disable_paging")
    -    log.debug("Command: {0}".format(command))
    -    self.write_channel(command)
    -    output = self.read_until_prompt()
    -    if self.ansi_escape_codes:
    -        output = self.strip_ansi_escape_codes(output)
    -    log.debug("{0}".format(output))
    -    log.debug("Exiting disable_paging")
    +
    def exit_config_mode(self, exit_config="exit", pattern="#"):
    +    """Mellanox does not support a single command to completely exit configuration mode.
    +
    +    Consequently, need to keep checking and sending "exit".
    +    """
    +    output = ""
    +    check_count = 12
    +    while check_count >= 0:
    +        if self.check_config_mode():
    +            self.write_channel(self.normalize_cmd(exit_config))
    +            output += self.read_until_pattern(pattern=pattern)
    +        else:
    +            break
    +        check_count -= 1
    +
    +    # One last check for whether we successfully exited config mode
    +    if self.check_config_mode():
    +        raise ValueError("Failed to exit configuration mode")
    +
    +    log.debug("exit_config_mode: {}".format(output))
         return output
    -
    +
    def save_config(self, cmd='configuration write', confirm=False, confirm_response='')
    @@ -301,10 +319,10 @@

    Inherited members

  • clear_buffer
  • close_session_log
  • commit
  • +
  • config_mode
  • +
  • disable_paging
  • disconnect
  • -
  • enable
  • establish_connection
  • -
  • exit_config_mode
  • exit_enable_mode
  • find_prompt
  • is_alive
  • @@ -352,17 +370,17 @@

    Index

  • Sub-modules

  • Classes

    diff --git a/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html new file mode 100644 index 000000000..38eee1379 --- /dev/null +++ b/docs/netmiko/mellanox/mellanox_mlnxos_ssh.html @@ -0,0 +1,450 @@ + + + + + + +netmiko.mellanox.mellanox_mlnxos_ssh API documentation + + + + + + + + + +
    +
    +
    +

    Module netmiko.mellanox.mellanox_mlnxos_ssh

    +
    +
    +

    Mellanox MLNX-OS Switch support.

    +
    +Source code +
    """Mellanox MLNX-OS Switch support."""
    +from __future__ import unicode_literals
    +import re
    +from netmiko.cisco_base_connection import CiscoSSHConnection
    +from netmiko import log
    +
    +
    +class MellanoxMlnxosSSH(CiscoSSHConnection):
    +    """Mellanox MLNX-OS Switch support."""
    +
    +    def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE):
    +        """Enter into enable mode."""
    +        output = ""
    +        if not self.check_enable_mode():
    +            self.write_channel(self.normalize_cmd(cmd))
    +            output += self.read_until_prompt_or_pattern(
    +                pattern=pattern, re_flags=re_flags
    +            )
    +            if not self.check_enable_mode():
    +                raise ValueError("Failed to enter enable mode.")
    +        return output
    +
    +    def config_mode(self, config_command="config term", pattern="#"):
    +        return super(MellanoxMlnxosSSH, self).config_mode(
    +            config_command=config_command, pattern=pattern
    +        )
    +
    +    def check_config_mode(self, check_string="(config", pattern=r"#"):
    +        return super(MellanoxMlnxosSSH, self).check_config_mode(
    +            check_string=check_string, pattern=pattern
    +        )
    +
    +    def disable_paging(self, command="no cli session paging enable", delay_factor=1):
    +        return super(MellanoxMlnxosSSH, self).disable_paging(
    +            command=command, delay_factor=delay_factor
    +        )
    +
    +    def exit_config_mode(self, exit_config="exit", pattern="#"):
    +        """Mellanox does not support a single command to completely exit configuration mode.
    +
    +        Consequently, need to keep checking and sending "exit".
    +        """
    +        output = ""
    +        check_count = 12
    +        while check_count >= 0:
    +            if self.check_config_mode():
    +                self.write_channel(self.normalize_cmd(exit_config))
    +                output += self.read_until_pattern(pattern=pattern)
    +            else:
    +                break
    +            check_count -= 1
    +
    +        # One last check for whether we successfully exited config mode
    +        if self.check_config_mode():
    +            raise ValueError("Failed to exit configuration mode")
    +
    +        log.debug("exit_config_mode: {}".format(output))
    +        return output
    +
    +    def save_config(
    +        self, cmd="configuration write", confirm=False, confirm_response=""
    +    ):
    +        """Save Config on Mellanox devices Enters and Leaves Config Mode"""
    +        output = self.enable()
    +        output += self.config_mode()
    +        output += self.send_command(cmd)
    +        output += self.exit_config_mode()
    +        return output
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Classes

    +
    +
    +class MellanoxMlnxosSSH +(ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=8, banner_timeout=5, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii') +
    +
    +

    Mellanox MLNX-OS Switch support.

    +
        Initialize attributes for establishing connection to target device.
    +
    +    :param ip: IP address of target device. Not required if `host` is
    +        provided.
    +    :type ip: str
    +
    +    :param host: Hostname of target device. Not required if `ip` is
    +            provided.
    +    :type host: str
    +
    +    :param username: Username to authenticate against target device if
    +            required.
    +    :type username: str
    +
    +    :param password: Password to authenticate against target device if
    +            required.
    +    :type password: str
    +
    +    :param secret: The enable password if target device requires one.
    +    :type secret: str
    +
    +    :param port: The destination port used to connect to the target
    +            device.
    +    :type port: int or None
    +
    +    :param device_type: Class selection based on device type.
    +    :type device_type: str
    +
    +    :param verbose: Enable additional messages to standard output.
    +    :type verbose: bool
    +
    +    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).
    +    :type global_delay_factor: int
    +
    +    :param use_keys: Connect to target device using SSH keys.
    +    :type use_keys: bool
    +
    +    :param key_file: Filename path of the SSH key file to use.
    +    :type key_file: str
    +
    +    :param pkey: SSH key object to use.
    +    :type pkey: paramiko.PKey
    +
    +    :param passphrase: Passphrase to use for encrypted key; password will be used for key
    +            decryption if not specified.
    +    :type passphrase: str
    +
    +    :param allow_agent: Enable use of SSH key-agent.
    +    :type allow_agent: bool
    +
    +    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
    +            means unknown SSH host keys will be accepted).
    +    :type ssh_strict: bool
    +
    +    :param system_host_keys: Load host keys from the users known_hosts file.
    +    :type system_host_keys: bool
    +    :param alt_host_keys: If `True` host keys will be loaded from the file specified in
    +            alt_key_file.
    +    :type alt_host_keys: bool
    +
    +    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).
    +    :type alt_key_file: str
    +
    +    :param ssh_config_file: File name of OpenSSH configuration file.
    +    :type ssh_config_file: str
    +
    +    :param timeout: Connection timeout.
    +    :type timeout: float
    +
    +    :param session_timeout: Set a timeout for parallel requests.
    +    :type session_timeout: float
    +
    +    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.
    +    :type auth_timeout: float
    +
    +    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).
    +    :type banner_timeout: float
    +
    +    :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
    +            Currently defaults to 0, for backwards compatibility (it will not attempt
    +            to keep the connection alive).
    +    :type keepalive: int
    +
    +    :param default_enter: Character(s) to send to correspond to enter key (default:
    +
    +

    ). +:type default_enter: str

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

    ) +:type response_return: str

    +
        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
    +            to select smallest of global and specific. Sets default global_delay_factor to .1
    +            (default: False)
    +    :type fast_cli: boolean
    +
    +    :param session_log: File path or BufferedIOBase subclass object to write the session log to.
    +    :type session_log: str
    +
    +    :param session_log_record_writes: The session log generally only records channel reads due
    +            to eliminate command duplication due to command echo. You can enable this if you
    +            want to record both channel reads and channel writes in the log (default: False).
    +    :type session_log_record_writes: boolean
    +
    +    :param session_log_file_mode: "write" or "append" for session_log file mode
    +            (default: "write")
    +    :type session_log_file_mode: str
    +
    +    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
    +            (default: False)
    +    :type allow_auto_change: bool
    +
    +    :param encoding: Encoding to be used when writing bytes to the output channel.
    +            (default: ascii)
    +    :type encoding: str
    +
    +
    +Source code +
    class MellanoxMlnxosSSH(CiscoSSHConnection):
    +    """Mellanox MLNX-OS Switch support."""
    +
    +    def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE):
    +        """Enter into enable mode."""
    +        output = ""
    +        if not self.check_enable_mode():
    +            self.write_channel(self.normalize_cmd(cmd))
    +            output += self.read_until_prompt_or_pattern(
    +                pattern=pattern, re_flags=re_flags
    +            )
    +            if not self.check_enable_mode():
    +                raise ValueError("Failed to enter enable mode.")
    +        return output
    +
    +    def config_mode(self, config_command="config term", pattern="#"):
    +        return super(MellanoxMlnxosSSH, self).config_mode(
    +            config_command=config_command, pattern=pattern
    +        )
    +
    +    def check_config_mode(self, check_string="(config", pattern=r"#"):
    +        return super(MellanoxMlnxosSSH, self).check_config_mode(
    +            check_string=check_string, pattern=pattern
    +        )
    +
    +    def disable_paging(self, command="no cli session paging enable", delay_factor=1):
    +        return super(MellanoxMlnxosSSH, self).disable_paging(
    +            command=command, delay_factor=delay_factor
    +        )
    +
    +    def exit_config_mode(self, exit_config="exit", pattern="#"):
    +        """Mellanox does not support a single command to completely exit configuration mode.
    +
    +        Consequently, need to keep checking and sending "exit".
    +        """
    +        output = ""
    +        check_count = 12
    +        while check_count >= 0:
    +            if self.check_config_mode():
    +                self.write_channel(self.normalize_cmd(exit_config))
    +                output += self.read_until_pattern(pattern=pattern)
    +            else:
    +                break
    +            check_count -= 1
    +
    +        # One last check for whether we successfully exited config mode
    +        if self.check_config_mode():
    +            raise ValueError("Failed to exit configuration mode")
    +
    +        log.debug("exit_config_mode: {}".format(output))
    +        return output
    +
    +    def save_config(
    +        self, cmd="configuration write", confirm=False, confirm_response=""
    +    ):
    +        """Save Config on Mellanox devices Enters and Leaves Config Mode"""
    +        output = self.enable()
    +        output += self.config_mode()
    +        output += self.send_command(cmd)
    +        output += self.exit_config_mode()
    +        return output
    +
    +

    Ancestors

    + +

    Methods

    +
    +
    +def enable(self, cmd='enable', pattern='#', re_flags=) +
    +
    +

    Enter into enable mode.

    +
    +Source code +
    def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE):
    +    """Enter into enable mode."""
    +    output = ""
    +    if not self.check_enable_mode():
    +        self.write_channel(self.normalize_cmd(cmd))
    +        output += self.read_until_prompt_or_pattern(
    +            pattern=pattern, re_flags=re_flags
    +        )
    +        if not self.check_enable_mode():
    +            raise ValueError("Failed to enter enable mode.")
    +    return output
    +
    +
    +
    +def exit_config_mode(self, exit_config='exit', pattern='#') +
    +
    +

    Mellanox does not support a single command to completely exit configuration mode.

    +

    Consequently, need to keep checking and sending "exit".

    +
    +Source code +
    def exit_config_mode(self, exit_config="exit", pattern="#"):
    +    """Mellanox does not support a single command to completely exit configuration mode.
    +
    +    Consequently, need to keep checking and sending "exit".
    +    """
    +    output = ""
    +    check_count = 12
    +    while check_count >= 0:
    +        if self.check_config_mode():
    +            self.write_channel(self.normalize_cmd(exit_config))
    +            output += self.read_until_pattern(pattern=pattern)
    +        else:
    +            break
    +        check_count -= 1
    +
    +    # One last check for whether we successfully exited config mode
    +    if self.check_config_mode():
    +        raise ValueError("Failed to exit configuration mode")
    +
    +    log.debug("exit_config_mode: {}".format(output))
    +    return output
    +
    +
    +
    +def save_config(self, cmd='configuration write', confirm=False, confirm_response='') +
    +
    +

    Save Config on Mellanox devices Enters and Leaves Config Mode

    +
    +Source code +
    def save_config(
    +    self, cmd="configuration write", confirm=False, confirm_response=""
    +):
    +    """Save Config on Mellanox devices Enters and Leaves Config Mode"""
    +    output = self.enable()
    +    output += self.config_mode()
    +    output += self.send_command(cmd)
    +    output += self.exit_config_mode()
    +    return output
    +
    +
    +
    +

    Inherited members

    + +
    +
    +
    +
    + +
    + + + + + \ No newline at end of file diff --git a/docs/netmiko/mikrotik/index.html b/docs/netmiko/mikrotik/index.html index 5895525df..29874c5b7 100644 --- a/docs/netmiko/mikrotik/index.html +++ b/docs/netmiko/mikrotik/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
  • -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -289,10 +289,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -318,14 +318,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
    -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -349,7 +349,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/mikrotik/mikrotik_ssh.html b/docs/netmiko/mikrotik/mikrotik_ssh.html index 7ba0a948a..041fead1a 100644 --- a/docs/netmiko/mikrotik/mikrotik_ssh.html +++ b/docs/netmiko/mikrotik/mikrotik_ssh.html @@ -201,10 +201,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -230,14 +230,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
    -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -261,7 +261,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -647,10 +647,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -676,14 +676,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
    -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -707,7 +707,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -832,10 +832,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -861,14 +861,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default:
    -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -892,7 +892,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/mrv/index.html b/docs/netmiko/mrv/index.html index d5ad687aa..1bee9fcb7 100644 --- a/docs/netmiko/mrv/index.html +++ b/docs/netmiko/mrv/index.html @@ -109,10 +109,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -138,14 +138,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -169,7 +169,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -359,10 +359,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -388,14 +388,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -419,7 +419,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/mrv/mrv_lx.html b/docs/netmiko/mrv/mrv_lx.html index 00e3932f7..ccf3a6f44 100644 --- a/docs/netmiko/mrv/mrv_lx.html +++ b/docs/netmiko/mrv/mrv_lx.html @@ -128,10 +128,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -157,14 +157,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -188,7 +188,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/mrv/mrv_ssh.html b/docs/netmiko/mrv/mrv_ssh.html index 2e1d783c5..d6833cce1 100644 --- a/docs/netmiko/mrv/mrv_ssh.html +++ b/docs/netmiko/mrv/mrv_ssh.html @@ -137,10 +137,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -166,14 +166,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -197,7 +197,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/netapp/index.html b/docs/netmiko/netapp/index.html index 38eca5c68..c131b7539 100644 --- a/docs/netmiko/netapp/index.html +++ b/docs/netmiko/netapp/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/netapp/netapp_cdot_ssh.html b/docs/netmiko/netapp/netapp_cdot_ssh.html index 122e5f62f..06e1de1d0 100644 --- a/docs/netmiko/netapp/netapp_cdot_ssh.html +++ b/docs/netmiko/netapp/netapp_cdot_ssh.html @@ -134,10 +134,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -163,14 +163,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -194,7 +194,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ovs/index.html b/docs/netmiko/ovs/index.html index 7e99559e6..32f6042a2 100644 --- a/docs/netmiko/ovs/index.html +++ b/docs/netmiko/ovs/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ovs/ovs_linux_ssh.html b/docs/netmiko/ovs/ovs_linux_ssh.html index 1404221fa..317f6fdfd 100644 --- a/docs/netmiko/ovs/ovs_linux_ssh.html +++ b/docs/netmiko/ovs/ovs_linux_ssh.html @@ -99,10 +99,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -128,14 +128,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -159,7 +159,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/paloalto/index.html b/docs/netmiko/paloalto/index.html index 813688463..a6996bc11 100644 --- a/docs/netmiko/paloalto/index.html +++ b/docs/netmiko/paloalto/index.html @@ -107,10 +107,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -136,14 +136,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -167,7 +167,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -292,10 +292,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -321,14 +321,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -352,7 +352,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/paloalto/paloalto_panos.html b/docs/netmiko/paloalto/paloalto_panos.html index 45d70bf78..52f96242a 100644 --- a/docs/netmiko/paloalto/paloalto_panos.html +++ b/docs/netmiko/paloalto/paloalto_panos.html @@ -281,10 +281,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -310,14 +310,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -341,7 +341,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -917,10 +917,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -946,14 +946,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -977,7 +977,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -1102,10 +1102,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -1131,14 +1131,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -1162,7 +1162,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/pluribus/index.html b/docs/netmiko/pluribus/index.html index 3ff4fd752..2f98596a5 100644 --- a/docs/netmiko/pluribus/index.html +++ b/docs/netmiko/pluribus/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/pluribus/pluribus_ssh.html b/docs/netmiko/pluribus/pluribus_ssh.html index 6e978d9a4..73175778e 100644 --- a/docs/netmiko/pluribus/pluribus_ssh.html +++ b/docs/netmiko/pluribus/pluribus_ssh.html @@ -136,10 +136,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -165,14 +165,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -196,7 +196,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/quanta/index.html b/docs/netmiko/quanta/index.html index 0f4eba11e..6ad10e214 100644 --- a/docs/netmiko/quanta/index.html +++ b/docs/netmiko/quanta/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/quanta/quanta_mesh_ssh.html b/docs/netmiko/quanta/quanta_mesh_ssh.html index 595275f69..e9a7e9841 100644 --- a/docs/netmiko/quanta/quanta_mesh_ssh.html +++ b/docs/netmiko/quanta/quanta_mesh_ssh.html @@ -116,10 +116,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -145,14 +145,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -176,7 +176,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/rad/index.html b/docs/netmiko/rad/index.html index c4f4c3741..ebc3c6661 100644 --- a/docs/netmiko/rad/index.html +++ b/docs/netmiko/rad/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -291,10 +291,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -320,14 +320,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -351,7 +351,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/rad/rad_etx.html b/docs/netmiko/rad/rad_etx.html index e539c9677..0081dd7df 100644 --- a/docs/netmiko/rad/rad_etx.html +++ b/docs/netmiko/rad/rad_etx.html @@ -187,10 +187,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -216,14 +216,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -247,7 +247,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -529,10 +529,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -558,14 +558,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -589,7 +589,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -715,10 +715,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -744,14 +744,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -775,7 +775,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ruckus/index.html b/docs/netmiko/ruckus/index.html index d98b901d6..f5f2741eb 100644 --- a/docs/netmiko/ruckus/index.html +++ b/docs/netmiko/ruckus/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -288,10 +288,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -317,14 +317,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -348,7 +348,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ruckus/ruckus_fastiron.html b/docs/netmiko/ruckus/ruckus_fastiron.html index b8f687cda..8318adc37 100644 --- a/docs/netmiko/ruckus/ruckus_fastiron.html +++ b/docs/netmiko/ruckus/ruckus_fastiron.html @@ -187,10 +187,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -216,14 +216,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -247,7 +247,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -515,10 +515,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -544,14 +544,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -575,7 +575,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -698,10 +698,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -727,14 +727,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -758,7 +758,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/terminal_server/index.html b/docs/netmiko/terminal_server/index.html index 3bdb8ae49..a278e3ceb 100644 --- a/docs/netmiko/terminal_server/index.html +++ b/docs/netmiko/terminal_server/index.html @@ -105,10 +105,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -134,14 +134,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -165,7 +165,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -288,10 +288,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -317,14 +317,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -348,7 +348,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/terminal_server/terminal_server.html b/docs/netmiko/terminal_server/terminal_server.html index edbd5f561..bbbaaf50e 100644 --- a/docs/netmiko/terminal_server/terminal_server.html +++ b/docs/netmiko/terminal_server/terminal_server.html @@ -128,10 +128,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -157,14 +157,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -188,7 +188,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -335,10 +335,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -364,14 +364,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -395,7 +395,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    @@ -518,10 +518,10 @@

    Inherited members

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -547,14 +547,14 @@

    Inherited members

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -578,7 +578,7 @@ 

    Inherited members

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ubiquiti/edge_ssh.html b/docs/netmiko/ubiquiti/edge_ssh.html index 55922d863..30d91d73e 100644 --- a/docs/netmiko/ubiquiti/edge_ssh.html +++ b/docs/netmiko/ubiquiti/edge_ssh.html @@ -142,10 +142,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -171,14 +171,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -202,7 +202,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/ubiquiti/index.html b/docs/netmiko/ubiquiti/index.html index 55cdf2c52..7278abaa5 100644 --- a/docs/netmiko/ubiquiti/index.html +++ b/docs/netmiko/ubiquiti/index.html @@ -106,10 +106,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -135,14 +135,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -166,7 +166,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/utilities.html b/docs/netmiko/utilities.html index 37ecdda55..304f8d97f 100644 --- a/docs/netmiko/utilities.html +++ b/docs/netmiko/utilities.html @@ -32,10 +32,18 @@

    Module netmiko.utilities

    import io import os import serial.tools.list_ports +from netmiko.py23_compat import text_type from netmiko._textfsm import _clitable as clitable from netmiko._textfsm._clitable import CliTableError -from netmiko.py23_compat import text_type +try: + from genie.conf.base import Device + from genie.libs.parser.utils import get_parser + from pyats.datastructures import AttrDict + + GENIE_INSTALLED = True +except ImportError: + GENIE_INSTALLED = False # Dictionary mapping 'show run' for vendors with different command SHOW_RUN_MAPPER = { @@ -287,6 +295,54 @@

    Module netmiko.utilities

    output = raw_output if structured_data == [] else structured_data return output except CliTableError: + return raw_output + + +def get_structured_data_genie(raw_output, platform, command): + if not sys.version_info >= (3, 4): + raise ValueError("Genie requires Python >= 3.4") + + if not GENIE_INSTALLED: + msg = ( + "\nGenie and PyATS are not installed. Please PIP install both Genie and PyATS:\n" + "pip install genie\npip install pyats\n" + ) + raise ValueError(msg) + + if "cisco" not in platform: + return raw_output + + genie_device_mapper = { + "cisco_ios": "ios", + "cisco_xe": "iosxe", + "cisco_xr": "iosxr", + "cisco_nxos": "nxos", + "cisco_asa": "asa", + } + + os = None + # platform might be _ssh, _telnet, _serial strip that off + if platform.count("_") > 1: + base_platform = platform.split("_")[:-1] + base_platform = "_".join(base_platform) + else: + base_platform = platform + + os = genie_device_mapper.get(base_platform) + if os is None: + return raw_output + + # Genie specific construct for doing parsing (based on Genie in Ansible) + device = Device("new_device", os=os) + device.custom.setdefault("abstraction", {}) + device.custom["abstraction"]["order"] = ["os"] + device.cli = AttrDict({"execute": None}) + try: + # Test of whether their is a parser for the given command (will return Exception if fails) + get_parser(command, device) + parsed_output = device.parse(command, output=raw_output) + return parsed_output + except Exception: return raw_output
    @@ -474,6 +530,61 @@

    Functions

    return raw_output
    +
    +def get_structured_data_genie(raw_output, platform, command) +
    +
    +
    +
    +Source code +
    def get_structured_data_genie(raw_output, platform, command):
    +    if not sys.version_info >= (3, 4):
    +        raise ValueError("Genie requires Python >= 3.4")
    +
    +    if not GENIE_INSTALLED:
    +        msg = (
    +            "\nGenie and PyATS are not installed. Please PIP install both Genie and PyATS:\n"
    +            "pip install genie\npip install pyats\n"
    +        )
    +        raise ValueError(msg)
    +
    +    if "cisco" not in platform:
    +        return raw_output
    +
    +    genie_device_mapper = {
    +        "cisco_ios": "ios",
    +        "cisco_xe": "iosxe",
    +        "cisco_xr": "iosxr",
    +        "cisco_nxos": "nxos",
    +        "cisco_asa": "asa",
    +    }
    +
    +    os = None
    +    # platform might be _ssh, _telnet, _serial strip that off
    +    if platform.count("_") > 1:
    +        base_platform = platform.split("_")[:-1]
    +        base_platform = "_".join(base_platform)
    +    else:
    +        base_platform = platform
    +
    +    os = genie_device_mapper.get(base_platform)
    +    if os is None:
    +        return raw_output
    +
    +    # Genie specific construct for doing parsing (based on Genie in Ansible)
    +    device = Device("new_device", os=os)
    +    device.custom.setdefault("abstraction", {})
    +    device.custom["abstraction"]["order"] = ["os"]
    +    device.cli = AttrDict({"execute": None})
    +    try:
    +        # Test of whether their is a parser for the given command (will return Exception if fails)
    +        get_parser(command, device)
    +        parsed_output = device.parse(command, output=raw_output)
    +        return parsed_output
    +    except Exception:
    +        return raw_output
    +
    +
    def get_template_dir()
    @@ -637,6 +748,7 @@

    Index

  • find_cfg_file
  • find_netmiko_dir
  • get_structured_data
  • +
  • get_structured_data_genie
  • get_template_dir
  • load_devices
  • load_yaml_file
  • diff --git a/docs/netmiko/vyos/index.html b/docs/netmiko/vyos/index.html index c9e9d8680..5afe84cdd 100644 --- a/docs/netmiko/vyos/index.html +++ b/docs/netmiko/vyos/index.html @@ -104,10 +104,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -133,14 +133,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -164,7 +164,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/docs/netmiko/vyos/vyos_ssh.html b/docs/netmiko/vyos/vyos_ssh.html index 01720233e..27c8c46ae 100644 --- a/docs/netmiko/vyos/vyos_ssh.html +++ b/docs/netmiko/vyos/vyos_ssh.html @@ -219,10 +219,10 @@

    Classes

    means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -248,14 +248,14 @@

    Classes

    to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: ' + :param default_enter: Character(s) to send to correspond to enter key (default: -

    '). +

    ). :type default_enter: str

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

    ') +

    ) :type response_return: str

        :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
                 to select smallest of global and specific. Sets default global_delay_factor to .1
    @@ -279,7 +279,7 @@ 

    Classes

    :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str
    diff --git a/examples/use_cases/case18_structured_data_genie/genie_show_ip_route_ios.py b/examples/use_cases/case18_structured_data_genie/genie_show_ip_route_ios.py new file mode 100644 index 000000000..fcdd22210 --- /dev/null +++ b/examples/use_cases/case18_structured_data_genie/genie_show_ip_route_ios.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +from getpass import getpass +from pprint import pprint +from netmiko import ConnectHandler + +PASSWORD = getpass() + + +def main(): + conn = ConnectHandler( + host="cisco1.lasthop.io", + device_type="cisco_xe", + username="username", + password=PASSWORD, + ) + output = conn.send_command("show ip route", use_genie=True) + pprint(output) + + +if __name__ == "__main__": + main() diff --git a/examples/use_cases/case18_structured_data_genie/genie_show_mac_nxos.py b/examples/use_cases/case18_structured_data_genie/genie_show_mac_nxos.py new file mode 100644 index 000000000..1cabd45c0 --- /dev/null +++ b/examples/use_cases/case18_structured_data_genie/genie_show_mac_nxos.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +from getpass import getpass +from pprint import pprint +from netmiko import ConnectHandler + +PASSWORD = getpass() + + +def main(): + conn = ConnectHandler( + host="nxos1.lasthop.io", + device_type="cisco_nxos", + username="username", + password=PASSWORD, + ) + output = conn.send_command("show mac address-table", use_genie=True) + pprint(output) + + +if __name__ == "__main__": + main() diff --git a/examples/use_cases/case18_structured_data_genie/genie_show_platform_iosxr.py b/examples/use_cases/case18_structured_data_genie/genie_show_platform_iosxr.py new file mode 100644 index 000000000..446a36ad9 --- /dev/null +++ b/examples/use_cases/case18_structured_data_genie/genie_show_platform_iosxr.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +from getpass import getpass +from pprint import pprint +from netmiko import ConnectHandler + +PASSWORD = getpass() + + +def main(): + conn = ConnectHandler( + host="iosxr1.lasthop.io", + device_type="cisco_xr", + username="username", + password=PASSWORD, + ) + output = conn.send_command("show platform", use_genie=True) + pprint(output) + + +if __name__ == "__main__": + main() diff --git a/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex1.py b/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex1.py new file mode 100644 index 000000000..527ddd4d3 --- /dev/null +++ b/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex1.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python +from getpass import getpass +from pprint import pprint +from netmiko import ConnectHandler + +PASSWORD = getpass() + + +def main(): + conn = ConnectHandler( + host="cisco1.lasthop.io", + # "cisco_xe" device type will cause textfsm to not return structured data + device_type="cisco_xe", + username="username", + password=PASSWORD, + ) + # Setting both `use_textfsm` and `use_genie` to True will try textfsm first + # if structured data is returned genie will be ignored. If textfsm does not + # return structured data netmiko will try to parse with genie + output = conn.send_command("show version", use_textfsm=True, use_genie=True) + # genie structured data returned + pprint(output) + + +if __name__ == "__main__": + main() diff --git a/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex2.py b/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex2.py new file mode 100644 index 000000000..0135553fc --- /dev/null +++ b/examples/use_cases/case18_structured_data_genie/genie_textfsm_combined_ex2.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python +from getpass import getpass +from pprint import pprint +from netmiko import ConnectHandler + +PASSWORD = getpass() + + +def main(): + conn = ConnectHandler( + host="cisco1.lasthop.io", + device_type="cisco_ios", + username="username", + password=PASSWORD, + ) + # Setting both `use_textfsm` and `use_genie` to True will try textfsm first + # if structured data is returned genie will be ignored. If textfsm does not + # return structured data netmiko will try to parse with genie + output = conn.send_command("show version", use_textfsm=True, use_genie=True) + # textfsm structured data returned + pprint(output) + + +if __name__ == "__main__": + main() diff --git a/netmiko/__init__.py b/netmiko/__init__.py index be2e8628f..1ea80ff25 100644 --- a/netmiko/__init__.py +++ b/netmiko/__init__.py @@ -23,7 +23,7 @@ NetmikoAuthError = NetMikoAuthenticationException Netmiko = ConnectHandler -__version__ = "2.4.0" +__version__ = "2.4.1" __all__ = ( "ConnectHandler", "ssh_dispatcher", diff --git a/netmiko/_textfsm/_clitable.py b/netmiko/_textfsm/_clitable.py index 44347a59e..acb8cf6c6 100644 --- a/netmiko/_textfsm/_clitable.py +++ b/netmiko/_textfsm/_clitable.py @@ -31,7 +31,13 @@ import os import re import threading -import copyable_regex_object + +try: + # TextFSM >= 1.0 (new package structure) + from textfsm import copyable_regex_object +except ImportError: + # TextFSM <= 0.4.1 + import copyable_regex_object import textfsm from netmiko._textfsm import _texttable as texttable diff --git a/netmiko/base_connection.py b/netmiko/base_connection.py index 2de93d968..d2353aecc 100644 --- a/netmiko/base_connection.py +++ b/netmiko/base_connection.py @@ -29,7 +29,12 @@ NetMikoTimeoutException, NetMikoAuthenticationException, ) -from netmiko.utilities import write_bytes, check_serial_port, get_structured_data +from netmiko.utilities import ( + write_bytes, + check_serial_port, + get_structured_data, + get_structured_data_genie, +) class BaseConnection(object): @@ -131,10 +136,10 @@ def __init__( means unknown SSH host keys will be accepted). :type ssh_strict: bool - :param system_host_keys: Load host keys from the user's 'known_hosts' file. + :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in - 'alt_key_file'. + alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). @@ -160,11 +165,11 @@ def __init__( to keep the connection alive). :type keepalive: int - :param default_enter: Character(s) to send to correspond to enter key (default: '\n'). + :param default_enter: Character(s) to send to correspond to enter key (default: \n). :type default_enter: str :param response_return: Character(s) to use in normalized return data to represent - enter key (default: '\n') + enter key (default: \n) :type response_return: str :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor @@ -189,7 +194,7 @@ def __init__( :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. - (default: 'ascii') + (default: ascii) :type encoding: str """ self.remote_conn = None @@ -721,7 +726,7 @@ def _try_session_preparation(self): """ In case of an exception happening during `session_preparation()` Netmiko should gracefully clean-up after itself. This might be challenging for library users - to do since they don't have a reference to the object. This is possibly related + to do since they do not have a reference to the object. This is possibly related to threads used in Paramiko. """ try: @@ -754,7 +759,7 @@ def session_preparation(self): self.clear_buffer() def _use_ssh_config(self, dict_arg): - """Update SSH connection parameters based on contents of SSH 'config' file. + """Update SSH connection parameters based on contents of SSH config file. :param dict_arg: Dictionary of SSH connection parameters :type dict_arg: dict @@ -1029,7 +1034,7 @@ def set_base_prompt( Used as delimiter for stripping of trailing prompt in output. Should be set to something that is general and applies in multiple contexts. For Cisco - devices this will be set to router hostname (i.e. prompt without '>' or '#'). + devices this will be set to router hostname (i.e. prompt without > or #). This will be set on entering user exec or privileged exec on Cisco, but not when entering/exiting config mode. @@ -1102,6 +1107,7 @@ def send_command_timing( strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. @@ -1127,6 +1133,9 @@ def send_command_timing( :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ output = "" delay_factor = self.select_delay_factor(delay_factor) @@ -1144,10 +1153,18 @@ def send_command_timing( command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def strip_prompt(self, a_string): @@ -1201,6 +1218,7 @@ def send_command( strip_command=True, normalize=True, use_textfsm=False, + use_genie=False, ): """Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. By default this method will keep waiting to receive data until the @@ -1232,6 +1250,9 @@ def send_command( :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool + + :param use_genie: Process command output through PyATS/Genie parser (default: False). + :type normalize: bool """ # Time to delay in each read loop loop_delay = 0.2 @@ -1308,10 +1329,19 @@ def send_command( command_string=command_string, strip_prompt=strip_prompt, ) - if use_textfsm: - output = get_structured_data( - output, platform=self.device_type, command=command_string.strip() - ) + + # If both TextFSM and Genie are set, try TextFSM then Genie + for parser_flag, parser_func in ( + (use_textfsm, get_structured_data), + (use_genie, get_structured_data_genie), + ): + if parser_flag: + structured_output = parser_func( + output, platform=self.device_type, command=command_string.strip() + ) + # If we have structured data; return it. + if not isinstance(structured_output, string_types): + return structured_output return output def send_command_expect(self, *args, **kwargs): diff --git a/netmiko/huawei/huawei.py b/netmiko/huawei/huawei.py index ac1ad1e71..de05886cf 100644 --- a/netmiko/huawei/huawei.py +++ b/netmiko/huawei/huawei.py @@ -122,28 +122,43 @@ def telnet_login( i = 1 while i <= max_loops: try: - # Search for username pattern / send username - output = self.read_until_pattern(pattern=username_pattern) + output = self.read_channel() return_msg += output - self.write_channel(self.username + self.TELNET_RETURN) - - # Search for password pattern, / send password - output = self.read_until_pattern(pattern=pwd_pattern) - return_msg += output - - self.write_channel(self.password + self.TELNET_RETURN) + # Search for username pattern / send username + if re.search(username_pattern, output, flags=re.I): + self.write_channel(self.username + self.TELNET_RETURN) + time.sleep(1 * delay_factor) + output = self.read_channel() + return_msg += output - # Search for router prompt, OR password_change prompt - output = self.read_until_pattern(pattern=combined_pattern) - return_msg += output + # Search for password pattern / send password + if re.search(pwd_pattern, output, flags=re.I): + self.write_channel(self.password + self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + output = self.read_channel() + return_msg += output + if re.search( + pri_prompt_terminator, output, flags=re.M + ) or re.search(alt_prompt_terminator, output, flags=re.M): + return return_msg + # Search for password change prompt, send "N" if re.search(password_change_prompt, output): self.write_channel("N" + self.TELNET_RETURN) output = self.read_until_pattern(pattern=combined_pattern) return_msg += output - return return_msg + # Check if proper data received + if re.search(pri_prompt_terminator, output, flags=re.M) or re.search( + alt_prompt_terminator, output, flags=re.M + ): + return return_msg + + self.write_channel(self.TELNET_RETURN) + time.sleep(0.5 * delay_factor) + i += 1 + except EOFError: self.remote_conn.close() msg = "Login failed: {}".format(self.host) diff --git a/netmiko/mellanox/__init__.py b/netmiko/mellanox/__init__.py index c26e522c3..1061750b6 100644 --- a/netmiko/mellanox/__init__.py +++ b/netmiko/mellanox/__init__.py @@ -1,4 +1,4 @@ from __future__ import unicode_literals -from netmiko.mellanox.mellanox_ssh import MellanoxSSH +from netmiko.mellanox.mellanox_mlnxos_ssh import MellanoxMlnxosSSH -__all__ = ["MellanoxSSH"] +__all__ = ["MellanoxMlnxosSSH"] diff --git a/netmiko/mellanox/mellanox_mlnxos_ssh.py b/netmiko/mellanox/mellanox_mlnxos_ssh.py new file mode 100644 index 000000000..2b7e9d918 --- /dev/null +++ b/netmiko/mellanox/mellanox_mlnxos_ssh.py @@ -0,0 +1,68 @@ +"""Mellanox MLNX-OS Switch support.""" +from __future__ import unicode_literals +import re +from netmiko.cisco_base_connection import CiscoSSHConnection +from netmiko import log + + +class MellanoxMlnxosSSH(CiscoSSHConnection): + """Mellanox MLNX-OS Switch support.""" + + def enable(self, cmd="enable", pattern="#", re_flags=re.IGNORECASE): + """Enter into enable mode.""" + output = "" + if not self.check_enable_mode(): + self.write_channel(self.normalize_cmd(cmd)) + output += self.read_until_prompt_or_pattern( + pattern=pattern, re_flags=re_flags + ) + if not self.check_enable_mode(): + raise ValueError("Failed to enter enable mode.") + return output + + def config_mode(self, config_command="config term", pattern="#"): + return super(MellanoxMlnxosSSH, self).config_mode( + config_command=config_command, pattern=pattern + ) + + def check_config_mode(self, check_string="(config", pattern=r"#"): + return super(MellanoxMlnxosSSH, self).check_config_mode( + check_string=check_string, pattern=pattern + ) + + def disable_paging(self, command="no cli session paging enable", delay_factor=1): + return super(MellanoxMlnxosSSH, self).disable_paging( + command=command, delay_factor=delay_factor + ) + + def exit_config_mode(self, exit_config="exit", pattern="#"): + """Mellanox does not support a single command to completely exit configuration mode. + + Consequently, need to keep checking and sending "exit". + """ + output = "" + check_count = 12 + while check_count >= 0: + if self.check_config_mode(): + self.write_channel(self.normalize_cmd(exit_config)) + output += self.read_until_pattern(pattern=pattern) + else: + break + check_count -= 1 + + # One last check for whether we successfully exited config mode + if self.check_config_mode(): + raise ValueError("Failed to exit configuration mode") + + log.debug("exit_config_mode: {}".format(output)) + return output + + def save_config( + self, cmd="configuration write", confirm=False, confirm_response="" + ): + """Save Config on Mellanox devices Enters and Leaves Config Mode""" + output = self.enable() + output += self.config_mode() + output += self.send_command(cmd) + output += self.exit_config_mode() + return output diff --git a/netmiko/mellanox/mellanox_ssh.py b/netmiko/mellanox/mellanox_ssh.py deleted file mode 100644 index f3ef6f10a..000000000 --- a/netmiko/mellanox/mellanox_ssh.py +++ /dev/null @@ -1,58 +0,0 @@ -from __future__ import unicode_literals -from netmiko.cisco_base_connection import CiscoSSHConnection -from netmiko import log -import time - - -class MellanoxSSH(CiscoSSHConnection): - def config_mode(self, config_command="config term", pattern="#"): - """Enter into config_mode.""" - output = "" - if not self.check_config_mode(): - self.write_channel(self.normalize_cmd(config_command)) - output = self.read_until_pattern(pattern=pattern) - if not self.check_config_mode(): - raise ValueError("Failed to enter configuration mode.") - return output - - def check_config_mode(self, check_string="(config)", pattern=r"[>|#]"): - return super(MellanoxSSH, self).check_config_mode( - check_string=check_string, pattern=pattern - ) - - def disable_paging(self, command="terminal length 999", delay_factor=1): - """Disable paging default to a Cisco CLI method.""" - delay_factor = self.select_delay_factor(delay_factor) - time.sleep(delay_factor * 0.1) - self.clear_buffer() - command = self.normalize_cmd(command) - log.debug("In disable_paging") - log.debug("Command: {0}".format(command)) - self.write_channel(command) - output = self.read_until_prompt() - if self.ansi_escape_codes: - output = self.strip_ansi_escape_codes(output) - log.debug("{0}".format(output)) - log.debug("Exiting disable_paging") - return output - - def exit_config_mode(self, exit_config="exit", pattern="#"): - """Exit from configuration mode.""" - output = "" - if self.check_config_mode(): - self.write_channel(self.normalize_cmd(exit_config)) - output = self.read_until_pattern(pattern=pattern) - if self.check_config_mode(): - raise ValueError("Failed to exit configuration mode") - log.debug("exit_config_mode: {0}".format(output)) - return output - - def save_config( - self, cmd="configuration write", confirm=False, confirm_response="" - ): - """Save Config on Mellanox devices Enters and Leaves Config Mode""" - output = self.enable() - output += self.config_mode() - output += self.send_command(cmd) - output += self.exit_config_mode() - return output diff --git a/netmiko/ssh_dispatcher.py b/netmiko/ssh_dispatcher.py index 0afb13b31..4e036035d 100644 --- a/netmiko/ssh_dispatcher.py +++ b/netmiko/ssh_dispatcher.py @@ -58,7 +58,7 @@ from netmiko.linux import LinuxSSH, LinuxFileTransfer from netmiko.mikrotik import MikrotikRouterOsSSH from netmiko.mikrotik import MikrotikSwitchOsSSH -from netmiko.mellanox import MellanoxSSH +from netmiko.mellanox import MellanoxMlnxosSSH from netmiko.mrv import MrvLxSSH from netmiko.mrv import MrvOptiswitchSSH from netmiko.netapp import NetAppcDotSSH @@ -142,7 +142,8 @@ "linux": LinuxSSH, "mikrotik_routeros": MikrotikRouterOsSSH, "mikrotik_switchos": MikrotikSwitchOsSSH, - "mellanox": MellanoxSSH, + "mellanox": MellanoxMlnxosSSH, + "mellanox_mlnxos": MellanoxMlnxosSSH, "mrv_lx": MrvLxSSH, "mrv_optiswitch": MrvOptiswitchSSH, "netapp_cdot": NetAppcDotSSH, diff --git a/netmiko/utilities.py b/netmiko/utilities.py index c1983961b..1961c714f 100644 --- a/netmiko/utilities.py +++ b/netmiko/utilities.py @@ -7,10 +7,18 @@ import io import os import serial.tools.list_ports +from netmiko.py23_compat import text_type from netmiko._textfsm import _clitable as clitable from netmiko._textfsm._clitable import CliTableError -from netmiko.py23_compat import text_type +try: + from genie.conf.base import Device + from genie.libs.parser.utils import get_parser + from pyats.datastructures import AttrDict + + GENIE_INSTALLED = True +except ImportError: + GENIE_INSTALLED = False # Dictionary mapping 'show run' for vendors with different command SHOW_RUN_MAPPER = { @@ -263,3 +271,51 @@ def get_structured_data(raw_output, platform, command): return output except CliTableError: return raw_output + + +def get_structured_data_genie(raw_output, platform, command): + if not sys.version_info >= (3, 4): + raise ValueError("Genie requires Python >= 3.4") + + if not GENIE_INSTALLED: + msg = ( + "\nGenie and PyATS are not installed. Please PIP install both Genie and PyATS:\n" + "pip install genie\npip install pyats\n" + ) + raise ValueError(msg) + + if "cisco" not in platform: + return raw_output + + genie_device_mapper = { + "cisco_ios": "ios", + "cisco_xe": "iosxe", + "cisco_xr": "iosxr", + "cisco_nxos": "nxos", + "cisco_asa": "asa", + } + + os = None + # platform might be _ssh, _telnet, _serial strip that off + if platform.count("_") > 1: + base_platform = platform.split("_")[:-1] + base_platform = "_".join(base_platform) + else: + base_platform = platform + + os = genie_device_mapper.get(base_platform) + if os is None: + return raw_output + + # Genie specific construct for doing parsing (based on Genie in Ansible) + device = Device("new_device", os=os) + device.custom.setdefault("abstraction", {}) + device.custom["abstraction"]["order"] = ["os"] + device.cli = AttrDict({"execute": None}) + try: + # Test of whether their is a parser for the given command (will return Exception if fails) + get_parser(command, device) + parsed_output = device.parse(command, output=raw_output) + return parsed_output + except Exception: + return raw_output diff --git a/requirements-dev.txt b/requirements-dev.txt index afcac7c9c..ac8f0e9e5 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,3 +1,4 @@ +PyYAML==5.1 pytest==4.6.3 pylama==7.7.1 tox==3.13.1 diff --git a/requirements-genie.txt b/requirements-genie.txt new file mode 100644 index 000000000..add4ef2e2 --- /dev/null +++ b/requirements-genie.txt @@ -0,0 +1,2 @@ +pyats; python_version>="3.4" +genie; python_version>="3.4" diff --git a/setup.py b/setup.py index 753d66c0e..84588a942 100644 --- a/setup.py +++ b/setup.py @@ -51,11 +51,10 @@ def find_version(*file_paths): "setuptools>=38.4.0", "paramiko>=2.4.3", "scp>=0.13.2", - "pyyaml", "pyserial", "textfsm", 'enum34; python_version == "2.7"', 'ipaddress; python_version == "2.7"', ], - extras_require={"test": ["pytest>=4.6.3"]}, + extras_require={"test": ["pyyaml==5.1", "pytest>=4.6.3"]}, ) diff --git a/tests/test_netmiko_show.py b/tests/test_netmiko_show.py index 585eee73e..96e587e47 100755 --- a/tests/test_netmiko_show.py +++ b/tests/test_netmiko_show.py @@ -5,7 +5,7 @@ test_disable_paging: disable paging test_ssh_connect: verify ssh connectivity test_send_command: send a command -test_send_command_expect: send a command +test_send_command_timing: send a command test_base_prompt: test the base prompt test_strip_prompt: test removing the prompt test_strip_command: test stripping extraneous info after sending a command @@ -17,6 +17,7 @@ from __future__ import print_function from __future__ import unicode_literals +import pytest import time @@ -24,19 +25,19 @@ def test_disable_paging(net_connect, commands, expected_responses): """Verify paging is disabled by looking for string after when paging would normally occur.""" if net_connect.device_type == "arista_eos": # Arista logging buffer gets enormous - net_connect.send_command_expect("clear logging") - multiple_line_output = net_connect.send_command_expect(commands["extended_output"]) + net_connect.send_command("clear logging") + multiple_line_output = net_connect.send_command(commands["extended_output"]) assert expected_responses["multiple_line_output"] in multiple_line_output if net_connect.device_type == "arista_eos": # Arista output is slow and has router-name in output time.sleep(5) net_connect.clear_buffer() - net_connect.send_command_expect("clear logging", expect_string="#") + net_connect.send_command("clear logging", expect_string="#") def test_ssh_connect(net_connect, commands, expected_responses): """Verify the connection was established successfully.""" - show_version = net_connect.send_command_expect(commands["version"]) + show_version = net_connect.send_command(commands["version"]) assert expected_responses["version_banner"] in show_version @@ -54,14 +55,69 @@ def test_send_command_timing(net_connect, commands, expected_responses): assert expected_responses["interface_ip"] in show_ip -def test_send_command_expect(net_connect, commands, expected_responses): - """Verify a command can be sent down the channel successfully using _expect method.""" +def test_send_command(net_connect, commands, expected_responses): + """Verify a command can be sent down the channel successfully using send_command method.""" time.sleep(1) net_connect.clear_buffer() - show_ip_alt = net_connect.send_command_expect(commands["basic"]) + show_ip_alt = net_connect.send_command(commands["basic"]) assert expected_responses["interface_ip"] in show_ip_alt +def test_send_command_textfsm(net_connect, commands, expected_responses): + """Verify a command can be sent down the channel successfully using send_command method.""" + + base_platform = net_connect.device_type + if base_platform.count("_") >= 2: + # Strip off the _ssh, _telnet, _serial + base_platform = base_platform.split("_")[:-1] + base_platform = "_".join(base_platform) + + if base_platform not in [ + "cisco_ios", + "cisco_xe", + "cisco_xr", + "cisco_nxos", + "arista_eos", + "cisco_asa", + "juniper_junos", + "hp_procurve", + ]: + assert pytest.skip("TextFSM/ntc-templates not supported on this platform") + else: + time.sleep(1) + net_connect.clear_buffer() + fallback_cmd = commands.get("basic") + command = commands.get("basic_textfsm", fallback_cmd) + show_ip_alt = net_connect.send_command(command, use_textfsm=True) + assert isinstance(show_ip_alt, list) + + +def test_send_command_genie(net_connect, commands, expected_responses): + """Verify a command can be sent down the channel successfully using send_command method.""" + + base_platform = net_connect.device_type + if base_platform.count("_") >= 2: + # Strip off the _ssh, _telnet, _serial + base_platform = base_platform.split("_")[:-1] + base_platform = "_".join(base_platform) + + if base_platform not in [ + "cisco_ios", + "cisco_xe", + "cisco_xr", + "cisco_nxos", + "cisco_asa", + ]: + assert pytest.skip("TextFSM/ntc-templates not supported on this platform") + else: + time.sleep(1) + net_connect.clear_buffer() + fallback_cmd = commands.get("basic") + command = commands.get("basic_textfsm", fallback_cmd) + show_ip_alt = net_connect.send_command(command, use_genie=True) + assert isinstance(show_ip_alt, dict) + + def test_base_prompt(net_connect, commands, expected_responses): """Verify the router prompt is detected correctly.""" assert net_connect.base_prompt == expected_responses["base_prompt"] @@ -73,7 +129,7 @@ def test_strip_prompt(net_connect, commands, expected_responses): if expected_responses["base_prompt"] == "": return show_ip = net_connect.send_command_timing(commands["basic"]) - show_ip_alt = net_connect.send_command_expect(commands["basic"]) + show_ip_alt = net_connect.send_command(commands["basic"]) assert expected_responses["base_prompt"] not in show_ip assert expected_responses["base_prompt"] not in show_ip_alt @@ -81,7 +137,7 @@ def test_strip_prompt(net_connect, commands, expected_responses): def test_strip_command(net_connect, commands, expected_responses): """Ensure that the command that was executed does not show up in the command output.""" show_ip = net_connect.send_command_timing(commands["basic"]) - show_ip_alt = net_connect.send_command_expect(commands["basic"]) + show_ip_alt = net_connect.send_command(commands["basic"]) assert commands["basic"] not in show_ip assert commands["basic"] not in show_ip_alt @@ -89,7 +145,7 @@ def test_strip_command(net_connect, commands, expected_responses): def test_normalize_linefeeds(net_connect, commands, expected_responses): """Ensure no '\r\n' sequences.""" show_version = net_connect.send_command_timing(commands["version"]) - show_version_alt = net_connect.send_command_expect(commands["version"]) + show_version_alt = net_connect.send_command(commands["version"]) assert not "\r\n" in show_version assert not "\r\n" in show_version_alt diff --git a/tests/unit/test_utilities.py b/tests/unit/test_utilities.py index f58f2c6ee..2f97b8c35 100755 --- a/tests/unit/test_utilities.py +++ b/tests/unit/test_utilities.py @@ -1,9 +1,8 @@ #!/usr/bin/env python import os -from os import environ -from os.path import dirname, join, isdir, relpath -from uuid import uuid4 as random_uuid +from os.path import dirname, join, relpath +import sys from netmiko import utilities from netmiko._textfsm import _clitable as clitable @@ -119,7 +118,7 @@ def test_obtain_all_devices(): def test_find_netmiko_dir(): """Try to get the netmiko_dir""" folder = dirname(__file__) - environ["NETMIKO_DIR"] = folder + os.environ["NETMIKO_DIR"] = folder result = utilities.find_netmiko_dir() assert result[0] == folder assert result[1].endswith("/tmp") @@ -127,7 +126,7 @@ def test_find_netmiko_dir(): def test_invalid_netmiko_dir(): """Try with an invalid netmiko_base_dir""" - environ["NETMIKO_DIR"] = "/" + os.environ["NETMIKO_DIR"] = "/" try: utilities.find_netmiko_dir() except ValueError as exc: @@ -190,7 +189,7 @@ def test_clitable_to_dict(): def test_get_structured_data(): """Convert raw CLI output to structured data using TextFSM template""" - environ["NET_TEXTFSM"] = RESOURCE_FOLDER + os.environ["NET_TEXTFSM"] = RESOURCE_FOLDER raw_output = "Cisco IOS Software, Catalyst 4500 L3 Switch Software" result = utilities.get_structured_data( raw_output, platform="cisco_ios", command="show version" @@ -200,9 +199,86 @@ def test_get_structured_data(): def test_get_structured_data_relative_path(): """Test relative path for textfsm ntc directory""" - environ["NET_TEXTFSM"] = RELATIVE_RESOURCE_FOLDER + os.environ["NET_TEXTFSM"] = RELATIVE_RESOURCE_FOLDER raw_output = "Cisco IOS Software, Catalyst 4500 L3 Switch Software" result = utilities.get_structured_data( raw_output, platform="cisco_ios", command="show version" ) assert result == [{"model": "4500"}] + + +def test_get_structured_data_genie(): + """Convert raw CLI output to structured data using Genie""" + if not sys.version_info >= (3, 4): + assert True + return + raw_output = """Cisco IOS Software, C3560CX Software (C3560CX-UNIVERSALK9-M), Version 15.2(4)E7, RELEASE SOFTWARE (fc2) +Technical Support: http://www.cisco.com/techsupport +Copyright (c) 1986-2018 by Cisco Systems, Inc. +Compiled Tue 18-Sep-18 13:20 by prod_rel_team + +ROM: Bootstrap program is C3560CX boot loader +BOOTLDR: C3560CX Boot Loader (C3560CX-HBOOT-M) Version 15.2(4r)E5, RELEASE SOFTWARE (fc4) + +3560CX uptime is 5 weeks, 1 day, 2 hours, 30 minutes +System returned to ROM by power-on +System restarted at 11:45:26 PDT Tue May 7 2019 +System image file is "flash:c3560cx-universalk9-mz.152-4.E7.bin" +Last reload reason: power-on + + + +This product contains cryptographic features and is subject to United +States and local country laws governing import, export, transfer and +use. Delivery of Cisco cryptographic products does not imply +third-party authority to import, export, distribute or use encryption. +Importers, exporters, distributors and users are responsible for +compliance with U.S. and local country laws. By using this product you +agree to comply with applicable laws and regulations. If you are unable +to comply with U.S. and local laws, return this product immediately. + +A summary of U.S. laws governing Cisco cryptographic products may be found at: +http://www.cisco.com/wwl/export/crypto/tool/stqrg.html + +If you require further assistance please contact us by sending email to +export@cisco.com. + +License Level: ipservices +License Type: Permanent Right-To-Use +Next reload license Level: ipservices + +cisco WS-C3560CX-8PC-S (APM86XXX) processor (revision A0) with 524288K bytes of memory. +Processor board ID FOCXXXXXXXX +Last reset from power-on +5 Virtual Ethernet interfaces +12 Gigabit Ethernet interfaces +The password-recovery mechanism is enabled. + +512K bytes of flash-simulated non-volatile configuration memory. +Base ethernet MAC Address : 12:34:56:78:9A:BC +Motherboard assembly number : 86-75309-01 +Power supply part number : 867-5309-01 +Motherboard serial number : FOCXXXXXXXX +Power supply serial number : FOCXXXXXXXX +Model revision number : A0 +Motherboard revision number : A0 +Model number : WS-C3560CX-8PC-S +System serial number : FOCXXXXXXXX +Top Assembly Part Number : 86-7530-91 +Top Assembly Revision Number : A0 +Version ID : V01 +CLEI Code Number : CMM1400DRA +Hardware Board Revision Number : 0x02 + + +Switch Ports Model SW Version SW Image +------ ----- ----- ---------- ---------- +* 1 12 WS-C3560CX-8PC-S 15.2(4)E7 C3560CX-UNIVERSALK9-M + + +Configuration register is 0xF +""" + result = utilities.get_structured_data_genie( + raw_output, platform="cisco_xe", command="show version" + ) + assert result["version"]["chassis"] == "WS-C3560CX-8PC-S" diff --git a/tox.ini b/tox.ini index 2c1eadae6..3a670c4e7 100644 --- a/tox.ini +++ b/tox.ini @@ -4,6 +4,7 @@ envlist = py27,py35,py36,py37 [testenv] deps = -rrequirements-dev.txt + -rrequirements-genie.txt passenv = * commands =