Teldata CIT Driver (ktbyers#3168)

ktbyers · dysby · ktbyers · commit 3f647bc7f785 · 2023-05-05T09:29:22.000-07:00
Co-authored-by: disbymixtape &lt;&gt;
Co-authored-by: dysby &lt;helder-j-dias@telecom.pt&gt;
diff --git a/netmiko/ssh_dispatcher.py b/netmiko/ssh_dispatcher.py
@@ -110,6 +110,7 @@
 from netmiko.ruijie import RuijieOSSSH, RuijieOSTelnet
 from netmiko.sixwind import SixwindOSSSH
 from netmiko.sophos import SophosSfosSSH
+from netmiko.teldat import TeldatCITSSH, TeldatCITTelnet
 from netmiko.terminal_server import TerminalServerSSH
 from netmiko.terminal_server import TerminalServerTelnet
 from netmiko.tplink import TPLinkJetStreamSSH, TPLinkJetStreamTelnet
@@ -249,6 +250,7 @@
     "sixwind_os": SixwindOSSSH,
     "sophos_sfos": SophosSfosSSH,
     "supermicro_smis": SmciSwitchSmisSSH,
+    "teldat_cit": TeldatCITSSH,
     "tplink_jetstream": TPLinkJetStreamSSH,
     "ubiquiti_edge": UbiquitiEdgeSSH,
     "ubiquiti_edgerouter": UbiquitiEdgeRouterSSH,
@@ -332,6 +334,7 @@
 CLASS_MAPPER["ruckus_fastiron_telnet"] = RuckusFastironTelnet
 CLASS_MAPPER["ruijie_os_telnet"] = RuijieOSTelnet
 CLASS_MAPPER["supermicro_smis_telnet"] = SmciSwitchSmisTelnet
+CLASS_MAPPER["teldat_cit_telnet"] = TeldatCITTelnet
 CLASS_MAPPER["tplink_jetstream_telnet"] = TPLinkJetStreamTelnet
 CLASS_MAPPER["yamaha_telnet"] = YamahaTelnet
 CLASS_MAPPER["zte_zxros_telnet"] = ZteZxrosTelnet
diff --git a/netmiko/teldat/__init__.py b/netmiko/teldat/__init__.py
@@ -0,0 +1,3 @@
+from netmiko.teldat.teldat_cit import TeldatCITSSH, TeldatCITTelnet
+
+__all__ = ["TeldatCITSSH", "TeldatCITTelnet"]
diff --git a/netmiko/teldat/teldat_cit.py b/netmiko/teldat/teldat_cit.py
@@ -0,0 +1,190 @@
+from typing import Optional, Any, Union, Sequence, Iterator, TextIO
+from netmiko.base_connection import BaseConnection
+from netmiko.no_enable import NoEnable
+import time
+import re
+from netmiko import log
+
+
+class TeldatCITBase(NoEnable, BaseConnection):
+    def session_preparation(self) -> None:
+        # Prompt is "*"
+        self._test_channel_read(pattern=r"\*")
+        self.set_base_prompt()
+        # Clear the read buffer
+        time.sleep(0.3 * self.global_delay_factor)
+        self.clear_buffer()
+
+    def disable_paging(
+        self,
+        command: str = "",
+        delay_factor: Optional[float] = None,
+        cmd_verify: bool = True,
+        pattern: Optional[str] = None,
+    ) -> str:
+        """Teldat doesn't have pagging"""
+        return ""
+
+    def set_base_prompt(
+        self,
+        pri_prompt_terminator: str = "*",
+        alt_prompt_terminator: str = "*",
+        delay_factor: float = 1.0,
+        pattern: Optional[str] = None,
+    ) -> str:
+        """
+        Teldat base prompt is "hostname *"
+        """
+        return super().set_base_prompt(
+            pri_prompt_terminator=pri_prompt_terminator,
+            alt_prompt_terminator=alt_prompt_terminator,
+            delay_factor=delay_factor,
+            pattern=pattern,
+        )
+
+    def cleanup(self, command: str = "logout") -> None:
+        """Gracefully exit the SSH session."""
+        self._base_mode()
+
+        if self.session_log:
+            self.session_log.fin = True
+
+        # Always try to send final 'logout'
+        self.write_channel(command + self.RETURN)
+        output = ""
+        for _ in range(30):
+            time.sleep(0.1)
+            output += self.read_channel()
+            if "Do you wish to end" in output:
+                self.write_channel("yes" + self.RETURN)
+                break
+
+    def _check_monitor_mode(self, check_string: str = "+", pattern: str = "") -> bool:
+        return super().check_config_mode(check_string=check_string, pattern=pattern)
+
+    def check_config_mode(
+        self, check_string: str = ">", pattern: str = "", force_regex: bool = False
+    ) -> bool:
+        return super().check_config_mode(
+            check_string=check_string, pattern=pattern, force_regex=force_regex
+        )
+
+    def _check_running_config_mode(
+        self, check_string: str = "$", pattern: str = ""
+    ) -> bool:
+        return super().check_config_mode(check_string=check_string, pattern=pattern)
+
+    def _monitor_mode(
+        self, monitor_command: str = "p 3", pattern: str = r"\+", re_flags: int = 0
+    ) -> str:
+        """
+        Enter into monitor_mode.
+        On Teldat devices always go to base mode before entering other modes
+        Cannot reuse super.config_mode() because config mode check is called only with
+        defaults in BaseConnection
+        """
+        self._base_mode()  # Teldat does not allow mode switching, go to base mode first
+
+        output = ""
+        self.write_channel(self.normalize_cmd(monitor_command))
+        # Make sure you read until you detect the command echo (avoid getting out of sync)
+        if self.global_cmd_verify is not False:
+            output += self.read_until_pattern(
+                pattern=re.escape(monitor_command.strip())
+            )
+        if not re.search(pattern, output, flags=re_flags):
+            output += self.read_until_pattern(pattern=pattern, re_flags=re_flags)
+        if not self._check_monitor_mode():
+            raise ValueError("Failed to enter monitor mode.")
+        return output
+
+    def config_mode(
+        self, config_command: str = "p 4", pattern: str = "onfig>", re_flags: int = 0
+    ) -> str:
+        self._base_mode()
+        return super().config_mode(
+            config_command=config_command, pattern=pattern, re_flags=re_flags
+        )
+
+    def _running_config_mode(
+        self, config_command: str = "p 5", pattern: str = r"onfig\$", re_flags: int = 0
+    ) -> str:
+        """Enter running config mode."""
+        self._base_mode()
+
+        output = ""
+        self.write_channel(self.normalize_cmd(config_command))
+        # Make sure you read until you detect the command echo (avoid getting out of sync)
+        if self.global_cmd_verify is not False:
+            output += self.read_until_pattern(pattern=re.escape(config_command.strip()))
+        if not re.search(pattern, output, flags=re_flags):
+            output += self.read_until_pattern(pattern=pattern, re_flags=re_flags)
+        if not self._check_running_config_mode():
+            raise ValueError("Failed to enter running config mode.")
+        return output
+
+    def send_config_set(
+        self,
+        config_commands: Union[str, Sequence[str], Iterator[str], TextIO, None] = None,
+        *,
+        exit_config_mode: bool = False,
+        **kwargs: Any,
+    ) -> str:
+        """
+        For Teldat devices always enter config mode
+        """
+        return super().send_config_set(
+            config_commands=config_commands,
+            exit_config_mode=exit_config_mode,
+            **kwargs,
+        )
+
+    def save_config(
+        self, cmd: str = "save yes", confirm: bool = False, confirm_response: str = ""
+    ) -> str:
+        if not self.check_config_mode() or not self._check_running_config_mode():
+            raise ValueError("Cannot save if not in config or running config mode")
+        # Some devices are slow so match on trailing-prompt if you can
+        output = self._send_command_str(
+            command_string=cmd, strip_prompt=False, strip_command=False
+        )
+        return output
+
+    def exit_config_mode(self, exit_config: str = "", pattern: str = "") -> str:
+        return self._base_mode()
+
+    def _base_mode(self, exit_cmd: str = "\x10", pattern: str = r"\*") -> str:
+        """
+        Exit from other modes (monitor, config, running config).
+        Send CTRL+P to the device
+        """
+        output = ""
+        self.write_channel(self.normalize_cmd(exit_cmd))
+        # Teldat - exit_cmd not printable
+        output += self.read_until_pattern(pattern=pattern)
+        log.debug(f"_base_mode: {output}")
+        return output
+
+
+class TeldatCITSSH(TeldatCITBase):
+    pass
+
+
+class TeldatCITTelnet(TeldatCITBase):
+    def telnet_login(
+        self,
+        pri_prompt_terminator: str = r"\*",
+        alt_prompt_terminator: str = r"\*",
+        username_pattern: str = "Username:",
+        pwd_pattern: str = "Password:",
+        delay_factor: float = 1.0,
+        max_loops: int = 60,
+    ) -> str:
+        return super().telnet_login(
+            pri_prompt_terminator=pri_prompt_terminator,
+            alt_prompt_terminator=alt_prompt_terminator,
+            username_pattern=username_pattern,
+            pwd_pattern=pwd_pattern,
+            delay_factor=delay_factor,
+            max_loops=max_loops,
+        )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from netmiko.teldat.teldat_cit import TeldatCITSSH, TeldatCITTelnet`
	`2`	`+`
	`3`	`+__all__ = ["TeldatCITSSH", "TeldatCITTelnet"]`