Merge branch 'develop' into fix-garderos-prompt

Author: ktbyers

.gitignore

@@ -26,6 +26,7 @@ bin/.netmiko.cfg
 
 # Virtual Environment files
 .venv/
+.venv_old/
 bin/
 lib/
 pyvenv.cfg

PLATFORMS.md

@@ -118,6 +118,7 @@
 - MRV LX
 - Nokia/Alcatel SR-OS
 - Nokia SR Linux
+- Perle IOLAN Console Server
 - Optilink EOLT 9702 (telnet only)
 - QuantaMesh
 - Rad ETX

netmiko/base_connection.py

@@ -193,7 +193,7 @@ def __init__(
         serial_settings: Optional[Dict[str, Any]] = None,
         fast_cli: bool = True,
         _legacy_mode: bool = False,
-        session_log: Optional[SessionLog] = None,
+        session_log: Optional[Union[str, io.BufferedIOBase, SessionLog]] = None,
         session_log_record_writes: bool = False,
         session_log_file_mode: str = "write",
         allow_auto_change: bool = False,

netmiko/mikrotik/mikrotik_ssh.py

@@ -222,8 +222,8 @@ def remote_space_available(self, search_pattern: str = "") -> int:
         sys_res = self.ssh_ctl_chan._send_command_timing_str(remote_cmd).splitlines()
         for res in sys_res:
             if "free-memory" in res:
-                spaceMib = res.strip().replace("free-memory: ", "").replace("MiB", "")
-                return int(float(spaceMib) * 1048576)
+                space_str = res.strip().replace("free-memory: ", "")
+                return self._format_to_bytes(space_str)
         raise ValueError("Unexpected output from remote_space_available")
 
     def remote_file_size(

netmiko/perle/__init__.py

@@ -0,0 +1,3 @@
+from netmiko.perle.perle_ssh import PerleIolanSSH
+
+__all__ = ("PerleIolanSSH",)

netmiko/perle/perle_ssh.py

@@ -0,0 +1,92 @@
+import re
+from typing import Any, Dict, List, Optional, Union
+
+from netmiko.cisco_base_connection import CiscoBaseConnection
+from netmiko.no_config import NoConfig
+from netmiko.utilities import structured_data_converter
+
+
+class PerleIolanSSH(NoConfig, CiscoBaseConnection):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.default_enter = kwargs.get("default_enter", "\r")
+
+    def session_preparation(self) -> None:
+        self._test_channel_read()
+        self.set_base_prompt(pri_prompt_terminator="$")
+
+    def enable(
+        self,
+        cmd: str = "admin",
+        pattern: str = "ssword:",
+        enable_pattern: Optional[str] = None,
+        check_state: bool = True,
+        re_flags: int = re.IGNORECASE,
+    ) -> str:
+        return super().enable(cmd, pattern, enable_pattern, check_state, re_flags)
+
+    def exit_enable_mode(self, *args: Any, **kwargs: Any) -> str:
+        # Perle does not have this concept
+        return ""
+
+    def save_config(
+        self, cmd: str = "save", confirm: bool = True, confirm_response: str = "y"
+    ) -> str:
+        return super().save_config(cmd, confirm, confirm_response)
+
+    def send_command_timing(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Union[str, List[Any], Dict[str, Any]]:
+        real_command_string = kwargs["command_string"]
+        real_strip_command = kwargs.get("strip_command", True)
+        real_strip_prompt = kwargs.get("strip_prompt", True)
+        command = kwargs["command_string"] + "\n"
+        more = r"< Hit any key >"
+        kwargs["strip_prompt"] = False
+        kwargs["strip_command"] = False
+
+        output = str(super().send_command_timing(*args, **kwargs))
+
+        kwargs["command_string"] = " "
+        kwargs["normalize"] = False
+        kwargs["strip_command"] = True
+        while more in output:
+            output = re.sub(r"\n" + more, "", output)
+            output += str(
+                super().send_command_timing(
+                    *args,
+                    **kwargs,
+                )
+            )
+
+        output = self._sanitize_output(
+            output,
+            strip_command=real_strip_command,
+            command_string=command,
+            strip_prompt=real_strip_prompt,
+        )
+        return_data = structured_data_converter(
+            command=real_command_string,
+            raw_data=output,
+            platform=self.device_type,
+            use_textfsm=kwargs.get("use_textfsm", False),
+            use_ttp=kwargs.get("use_ttp", False),
+            use_genie=kwargs.get("use_genie", False),
+            textfsm_template=kwargs.get("textfsm_template", None),
+            ttp_template=kwargs.get("ttp_template", None),
+            raise_parsing_error=kwargs.get("raise_parsing_error", False),
+        )
+
+        return return_data
+
+    def strip_prompt(self, a_string: str) -> str:
+        # Delete repeated prompts
+        old_string = a_string
+        while (a_string := super().strip_prompt(a_string)) != old_string:
+            old_string = a_string
+        return a_string
+
+    def cleanup(self, command: str = "logout") -> None:
+        return super().cleanup(command)

netmiko/ssh_dispatcher.py

@@ -140,6 +140,7 @@
 from netmiko.paloalto import PaloAltoPanosSSH
 from netmiko.paloalto import PaloAltoPanosTelnet
 from netmiko.pluribus import PluribusSSH
+from netmiko.perle import PerleIolanSSH
 from netmiko.quanta import QuantaMeshSSH
 from netmiko.rad import RadETXSSH
 from netmiko.rad import RadETXTelnet
@@ -309,6 +310,7 @@
     "ovs_linux": OvsLinuxSSH,
     "paloalto_panos": PaloAltoPanosSSH,
     "pluribus": PluribusSSH,
+    "perle_iolan": PerleIolanSSH,
     "quanta_mesh": QuantaMeshSSH,
     "rad_etx": RadETXSSH,
     "raisecom_roap": RaisecomRoapSSH,