scrapli 2.0.0a3__py3-none-musllinux_1_1_aarch64.whl → 2.0.0a5__py3-none-musllinux_1_1_aarch64.whl

scrapli/cli_parse.py

@@ -93,7 +93,7 @@ def textfsm_parse(
             originating textfsm.parser.TextFSMError exception.
 
     """
-    import textfsm
+    import textfsm  # noqa: PLC0415
 
     if isinstance(template, str):
         if template.startswith("http://") or template.startswith("https://"):

scrapli/cli_result.py

@@ -4,6 +4,7 @@ from typing import Any, TextIO
 
 from scrapli.cli_parse import genie_parse, textfsm_get_template, textfsm_parse
 from scrapli.exceptions import ParsingException
+from scrapli.helper import bulid_result_preview, unix_nano_timestmap_to_iso
 
 OPERATION_DELIMITER = "__libscrapli__"
 
@@ -48,6 +49,30 @@ class Result:
         self.textfsm_platform = textfsm_platform
         self.genie_platform = genie_platform
 
+    def __str__(self) -> str:
+        """
+        Magic str method for Result class
+
+        Args:
+            N/A
+
+        Returns:
+            str: str for class object
+
+        Raises:
+            N/A
+
+        """
+        return (
+            "<-----\n"
+            f"\tInput(s)         : {self.inputs}\n"
+            f"\tStart Time       : {unix_nano_timestmap_to_iso(timestamp=self.start_time)}\n"
+            f"\tEnd Time         : {unix_nano_timestmap_to_iso(timestamp=self.end_time)}\n"
+            f"\tElapsed Time (s) : {self.elapsed_time_seconds:.2f}s\n"
+            f"\tResult           : {bulid_result_preview(result=self.result)}\n"
+            "----->"
+        )
+
     def extend(self, result: "Result") -> None:
         """
         Extends this Result object with another Result object.
@@ -141,6 +166,23 @@ class Result:
         """
         return "\n".join(self.results)
 
+    @property
+    def result_raw(self) -> bytes:
+        """
+        Returns the results (raw) joined on newline chars. Note this does *not* include inputs sent.
+
+        Args:
+            N/A
+
+        Returns:
+            bytes: joined results
+
+        Raises:
+            N/A
+
+        """
+        return b"\n".join(self.results_raw)
+
     def textfsm_parse(
         self,
         index: int = 0,

scrapli/definitions/aethra_atosnt.yaml

@@ -0,0 +1,9 @@
+---
+prompt_pattern: '^[a-z0-9.\-_@]{1,64}>>'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-z0-9.\-_@]{1,64}>>'
+on_close_instructions:
+  - write:
+      input: '\x04'

scrapli/definitions/alcatel_aos.yaml

@@ -0,0 +1,9 @@
+---
+prompt_pattern: '^[a-zA-Z0-9.\-_@\/:]{1,63}[>|#]\s*'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-zA-Z0-9.\-_@\/:]{1,63}[>|#]\s*'
+on_close_instructions:
+  - write:
+      input: 'exit'

scrapli/definitions/arista_eos.yaml

@@ -62,3 +62,4 @@ on_close_instructions:
       requested_mode: 'privileged_exec'
   - write:
       input: 'exit'
+ntc_templates_platform: 'arista_eos'

scrapli/definitions/aruba_aoscx.yaml

@@ -0,0 +1,33 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'privileged_exec'
+    prompt_pattern: '^[\w.\-@/:]{1,63}#\s?$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w.\-@/:]{1,63}\(config[\w.\-@/:]{0,32}\)#\s?$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - '% Command incomplete.'
+  - 'Invalid input:'
+  - 'doesn''t exist'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'no page'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'
+ntc_templates_platform: 'aruba_aoscx'

scrapli/definitions/cisco_aireos.yaml

@@ -0,0 +1,31 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^\([\w. -]{1,31}\) >$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'config'
+  - name: 'configuration'
+    prompt_pattern: '^\([\w. -]{1,31}\) config>$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Incorrect Usage. Use the ''?'' or <TAB> key to list commands.'
+  - 'Incorrect input!'
+on_open_instructions:
+  - send_input:
+      input: 'config paging disable'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'logout'
+force_in_session_auth: true
+ntc_templates_platform: 'cisco_wlc_ssh'

scrapli/definitions/cisco_asa.yaml

@@ -0,0 +1,48 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w\./-]{1,63}>\s?$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_pattern: '^(P|p)assword:\s?$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[\w\./-]{1,63}#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w\./-]{1,63}\([\w-]{0,32}\)#\s?$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - '% Ambiguous command'
+  - '% Incomplete command'
+  - '% Invalid input detected'
+  - '% Unknown command'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'terminal pager 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'logout'
+ntc_templates_platform: 'cisco_asa'
+genie_platform: 'asa'

scrapli/definitions/cisco_cbs.yaml

@@ -0,0 +1,50 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-zA-Z0-9-.]{1,58}>$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_exact: '^(?:enable\s){0,1}Password:\s?$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-zA-Z0-9-.]{1,58}#$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[a-zA-Z0-9-.]{1,58}\([\w.\-@/:+]{1,32}\)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - '% Incomplete command'
+  - '% Unrecognized command'
+  - '% missing mandatory parameter'
+  - '% bad parameter value'
+  - '% Ambiguous command'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'terminal datadump'
+  - send_input:
+      input: 'terminal width 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'
+ntc_templates_platform: 'cisco_s300'

scrapli/definitions/cisco_ftd.yaml

@@ -0,0 +1,42 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^>\s*'
+    accessible_modes:
+      - name: 'expert'
+        instructions:
+          - send_input:
+              input: 'expert'
+  - name: 'expert'
+    prompt_pattern: '^[\w.-]{1,63}@[^$]+\$\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+      - name: 'root'
+        instructions:
+          - send_prompted_input:
+              input: 'sudo su -'
+              prompt_exact: '^Password:\s?$'
+              response: '__lookup::root'
+  - name: 'root'
+    prompt_pattern: '^root@[^#]+#\s*$'
+    accessible_modes:
+      - name: 'expert'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Syntax error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'logout'
+ntc_templates_platform: 'cisco_ftd'

scrapli/definitions/cisco_nxos.yaml

@@ -62,3 +62,5 @@ on_close_instructions:
       requested_mode: 'privileged_exec'
   - write:
       input: 'exit'
+ntc_templates_platform: 'cisco_nxos'
+genie_platform: 'nxos'

scrapli/definitions/cumulus_linux.yaml

@@ -0,0 +1,28 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^\S+@\S+:\S+:\S+[\$|#]\s*$'
+    accessible_modes:
+      - name: 'root'
+        instructions:
+          - send_prompted_input:
+              input: 'sudo su'
+              prompt_exact: ':'
+              response: '__lookup::enable'
+  - name: 'root'
+    prompt_pattern: '^\S+@\S+:\S+:\S+#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Permission denied'
+  - 'ERROR:'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'root'
+  - write:
+      input: 'exit'

scrapli/definitions/cumulus_vtysh.yaml

@@ -0,0 +1,42 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'linux'
+    prompt_pattern: '^\S+@\S+:\S+:\S+[\$|#]\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'vtysh'
+  - name: 'exec'
+    prompt_pattern: '^[\w\.\-]+#\s*$'
+    accessible_modes:
+      - name: 'linux'
+        instructions:
+          - send_input:
+              input: 'exit'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'conifgure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w\.\-]+\(config\)#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Permission denied'
+  - 'ERROR:'
+  - '% Unknown command.'
+  - '% Command incomplete.'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'

scrapli/definitions/datacom_dmos.yaml

@@ -0,0 +1,30 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w\.\-]+#\s*$$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w\.\-]+\(config\)#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'paginate false'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'

scrapli/definitions/datacom_dmswitch.yaml

@@ -0,0 +1,32 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w\.\-]+#\s*$$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+  - name: 'configuration'
+    prompt_pattern: '^[\w\.\-]+\(config\)#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'configuration'
+  - send_input:
+      input: 'no terminal paging'
+  - enter_mode:
+      requested_mode: 'exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'

scrapli/definitions/default.yaml

@@ -0,0 +1,9 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'cli'
+modes:
+  - name: 'cli'
+    prompt_pattern: '^.*[>#$]\s?+$'
+on_close_instructions:
+  - write:
+      input: 'exit'

scrapli/definitions/dell_emc.yaml

@@ -0,0 +1,46 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w.\-@/:]{1,63}>$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_pattern: '^(?:enable\s){0,1}password:\s?$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[\w.\-@/:]{1,63}#$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w.\-@/:]{1,63}\([\w.\-@/:+]{0,32}\)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - 'Command not found'
+  - 'Incomplete command'
+  - '% Invalid input detected at ''^'' marker.'
+  - 'An invalid interface has been used for this command.'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'term length 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'

scrapli/definitions/dell_enterprisesonic.yaml

@@ -0,0 +1,40 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'linux'
+    prompt_pattern: '^[\w.-]+@[\w.-]+:[\w\/~]+[#$]\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'sonic-cli'
+  - name: 'exec'
+    prompt_pattern: '^[\w.-]+#\s*$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'conifgure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[\w.-]+\(config(\S*)?\)#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'command not found'
+  - 'Permission denied'
+  - '% Error:'
+  - 'Warning: Idle timeout'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'term length 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'

scrapli/definitions/dlink_os.yaml

@@ -0,0 +1,46 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-z0-9.\-_@()/:]{1,63}:(user|oper|puser|3|4|6)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable admin'
+              prompt_pattern: '^[pP]ass[wW]ord:$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9.\-_@/:]{1,63}:(admin|5)#$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^[a-z0-9.\-_@/:]{1,63}:(admin|5)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - 'Next possible completions:'
+  - 'Available commands:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'enable clipaging'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'disable clipaging'
+  - write:
+      input: 'exit'

scrapli/definitions/edgecore_ecs.yaml

@@ -0,0 +1,35 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9.\-_@()/:]{1,48}#\s*$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'conf'
+  - name: 'configuration'
+    prompt_pattern: '^[a-z0-9.\-_@/:]{1,63}\(conf[a-z0-9.\-@/:\+]{0,32}\)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - '% Ambiguous command'
+  - '% Incomplete command'
+  - '% Invalid input detected'
+  - '% Unknown command'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'term width 300'
+  - send_input:
+      input: 'term len 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'

scrapli/definitions/eltex_esr.yaml

@@ -0,0 +1,43 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^(\\n)?[a-z0-9.\-_@/:]{1,63}>\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_pattern: '^\s*[pP]assword:\s*$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^(\\n)?[a-z0-9.\-_@/:]{1,63}#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'end'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - name: 'configuration'
+    prompt_pattern: '^(\\n)?[a-z0-9.\-_@/:]{1,63}\(conf[a-z0-9.\-@/:\+]{0,32}\)#\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - 'Syntax error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'terminal datadump'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'