scrapli 2.0.0a4__py3-none-manylinux2010_x86_64.whl → 2.0.0a5__py3-none-manylinux2010_x86_64.whl

scrapli/definitions/nokia_sros.yaml

@@ -0,0 +1,31 @@
+---
+prompt_pattern: '.*\[.*?\]\n.*#'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^\[.*?\]\n.*#'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'edit-config exclusive'
+  - name: 'configuration'
+    prompt_pattern: '.?\(.*?\)\[.*?\]\n.*#'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'quit-config'
+failure_indicators:
+  - 'MINOR:'
+  - 'MAJOR:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'environment no more'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'logout'

scrapli/definitions/nokia_sros_classic.yaml

@@ -0,0 +1,33 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^\*?[abcd]:[\w\s_.-]+#\s?$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+  - name: 'configuration'
+    prompt_pattern: '^\*?[abcd]:[\w\s_.-]+>config[\w>]*(#|\$)\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit all'
+failure_indicators:
+  - 'MINOR:'
+  - 'MAJOR:'
+  - 'Error:'
+  - 'Bad Command:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'environment no more'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'logout'

scrapli/definitions/nokia_sros_classic_aram.yaml

@@ -0,0 +1,25 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^(.*)[a-zA-Z0-9_\:\-\>]*[\#\$] ?$'
+failure_indicators:
+  - 'command is not complete'
+  - 'invalid token'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'environment mode batch'
+  - send_input:
+      input: 'environment inhibit-alarms'
+  - send_input:
+      input: 'environment print no-more'
+  - send_input:
+      input: 'exit all'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'logout'

scrapli/definitions/paloalto_panos.yaml

@@ -0,0 +1,36 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w\._-]+@[\w\.\(\)_-]+>\s?$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+  - name: 'configuration'
+    prompt_pattern: '^[\w\._-]+@[\w\.\(\)_-]+#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Unknown command:'
+  - 'Invalid syntax.'
+  - 'Server error'
+  - 'Validation Error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'set cli scripting-mode on'
+  - send_input:
+      input: 'set cli pager off'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'
+ntc_templates_platform: 'paloalto_panos'

scrapli/definitions/raisecom_ros.yaml

@@ -0,0 +1,45 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-z0-9.\-_@()/:]{1,63}>$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_exact: '[pP]assword:\s?$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9.\-_@/:]{1,63}#$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'config'
+  - name: 'configuration'
+    prompt_pattern: '^[\w.\-@/:]{1,63}\([\w.\-@/:+]{0,32}\)#$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+failure_indicators:
+  - 'Error input in the position marked by ''^''.'
+  - 'Ambiguous input in the position marked by ''^'''
+  - '%  Incomplete command.'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'terminal page-break disable'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'

scrapli/definitions/ruckus_fastiron.yaml

@@ -0,0 +1,45 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-z0-9 .\-_@()/:]{1,63}>$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_exact: '^[pP]assword:\s?$'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9 .\-_@/:]{1,63}#$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'quit'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+  - 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:
+  - 'Error -'
+  - 'Invalid input -'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'skip-page-display'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'
+ntc_templates_platform: 'ruckus_fastiron'

scrapli/definitions/ruckus_unleashed.yaml

@@ -0,0 +1,64 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[a-z0-9]{1,24}>\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'enable force'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9]{1,24}#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'config'
+      - name: 'debug'
+        instructions:
+          - send_input:
+              input: 'debug'
+      - name: 'ap_mode'
+        instructions:
+          - send_input:
+              input: 'ap-mode'
+  - name: 'configuration'
+    prompt_pattern: '^[a-z0-9]{1,24}\(conf[a-z0-9\-]{0,24}\)#\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+  - name: 'debug'
+    prompt_pattern: '^[a-z0-9]{1,24}\(debug\)#\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'quit'
+  - name: 'ap_mode'
+    prompt_pattern: '^[a-z0-9]{1,24}\(ap-mode\)#\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'quit'
+failure_indicators:
+  - 'The command is'
+  - 'is invalid'
+  - 'must consist'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'
+force_in_session_auth: true

scrapli/definitions/siemens_roxii.yaml

@@ -0,0 +1,28 @@
+---
+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: 'config'
+  - name: 'configuration'
+    prompt_pattern: '^[a-z0-9\-_]{1,63}\(conf[a-z0-9.\-@/:\+]{0,32}\)#\s*$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'top; exit'
+failure_indicators:
+  - 'syntax error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'q'

scrapli/definitions/versa_flexvnf.yaml

@@ -0,0 +1,45 @@
+---
+prompt_pattern: '^.*[>#$%]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'shell'
+    prompt_pattern: '^\[\w+\@\S+ \S+\] \$ ?$'
+    accessible_modes:
+      - name: 'cli'
+        instructions:
+          - send_input:
+              input: 'cli'
+  - name: 'cli'
+    prompt_pattern: '^\w+@\S+-cli> ?$'
+    accessible_modes:
+      - name: 'shell'
+        instructions:
+          - send_input:
+              input: 'exit'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+  - name: 'configuration'
+    prompt_pattern: '^\w+@\S+-cli\(\S+\)% ?$'
+    accessible_modes:
+      - name: 'cli'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - '[error]'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'cli'
+  - send_input:
+      input: 'set complete-on-space false'
+  - send_input:
+      input: 'set paginate false'
+  - send_input:
+      input: 'set screen width 512'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'cli'
+  - write:
+      input: 'logout'

scrapli/definitions/vyos_vyos.yaml

@@ -0,0 +1,35 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'privileged_exec'
+    prompt_pattern: '^[a-z0-9\.\--_()/:~]{1,1000}@[a-z0-9\.\--_()/:~]{1,1000}\$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+  - name: 'configuration'
+    prompt_pattern: '^[a-z0-9\.\--_()/:~]{1,1000}@[a-z0-9\.\--_()/:~]{1,1000}#'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'Ambiguous command'
+  - 'Incomplete command'
+  - 'Invalid command'
+  - 'Invalid value'
+  - 'Need to specify the config node to set'
+  - 'Set failed'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'stty cols 100000'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'

scrapli/definitions/zyxel_dslam.yaml

@@ -0,0 +1,18 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^(.*)[a-zA-Z0-9_\-]*[\>#]\s*$'
+failure_indicators:
+  - 'invalid command'
+  - 'command authorization fail'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'
+ntc_templates_platform: 'zyxel_dslam'

scrapli/ffi.py

@@ -10,7 +10,7 @@ from scrapli.exceptions import LibScrapliException
 
 logger = getLogger(__name__)
 
-LIBSCRAPLI_VERSION = "0.0.1-alpha.13"
+LIBSCRAPLI_VERSION = "0.0.1-alpha.17"
 LIBSCRAPLI_PATH_OVERRIDE_ENV = "LIBSCRAPLI_PATH"
 LIBSCRAPLI_CACHE_PATH_OVERRIDE_ENV = "LIBSCRAPLI_CACHE_PATH"
 XDG_CACHE_HOME_ENV = "XDG_CACHE_HOME"

scrapli/ffi_mapping.py

@@ -60,36 +60,6 @@ class LibScrapliSharedMapping:
         ]
         lib.ls_shared_free.restype = None
 
-        self._read: Callable[
-            [
-                DriverPointer,
-                StringPointer,
-                IntPointer,
-            ],
-            int,
-        ] = lib.ls_shared_read_session
-        lib.ls_shared_read_session.argtypes = [
-            DriverPointer,
-            StringPointer,
-            IntPointer,
-        ]
-        lib.ls_shared_read_session.restype = c_int
-
-        self._write: Callable[
-            [
-                DriverPointer,
-                c_char_p,
-                c_bool,
-            ],
-            int,
-        ] = lib.ls_shared_write_session
-        lib.ls_shared_write_session.argtypes = [
-            DriverPointer,
-            c_char_p,
-            c_bool,
-        ]
-        lib.ls_shared_write_session.restype = c_uint8
-
     def get_poll_fd(self, ptr: DriverPointer) -> c_int:
         """
         Get the operation poll fd from the driver at ptr.
@@ -126,6 +96,70 @@ class LibScrapliSharedMapping:
         """
         return self._free(ptr)
 
+
+class LibScrapliSessionMapping:
+    """
+    Mapping to libscrapli shared (between cli/netconf) object functions mapping.
+
+    Should not be used/called directly.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    def __init__(self, lib: CDLL) -> None:
+        self._read: Callable[
+            [
+                DriverPointer,
+                StringPointer,
+                IntPointer,
+            ],
+            int,
+        ] = lib.ls_session_read
+        lib.ls_session_read.argtypes = [
+            DriverPointer,
+            StringPointer,
+            IntPointer,
+        ]
+        lib.ls_session_read.restype = c_int
+
+        self._write: Callable[
+            [
+                DriverPointer,
+                c_char_p,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_session_write
+        lib.ls_session_write.argtypes = [
+            DriverPointer,
+            c_char_p,
+            c_bool,
+        ]
+        lib.ls_session_write.restype = c_uint8
+
+        self._write_and_return: Callable[
+            [
+                DriverPointer,
+                c_char_p,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_session_write_and_return
+        lib.ls_session_write_and_return.argtypes = [
+            DriverPointer,
+            c_char_p,
+            c_bool,
+        ]
+        lib.ls_session_write_and_return.restype = c_uint8
+
     def read(self, ptr: DriverPointer, buf: StringPointer, read_size: IntPointer) -> int:
         """
         Read from the session of driver at ptr.
@@ -147,7 +181,7 @@ class LibScrapliSharedMapping:
         """
         return self._read(ptr, buf, read_size)
 
-    def write(self, ptr: DriverPointer, buf: c_char_p, redacted: c_bool) -> int:
+    def write(self, ptr: DriverPointer, input_: c_char_p, redacted: c_bool) -> int:
         """
         Write to the session of driver at ptr.
 
@@ -155,7 +189,28 @@ class LibScrapliSharedMapping:
 
         Args:
             ptr: the ptr to the libscrapli cli/netconf object.
-            buf: buffer contents to write during the write operation..
+            input_: buffer contents to write during the write operation..
+            redacted: bool indicated if the write contents should be redacted from logs.
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._write(ptr, input_, redacted)
+
+    def write_and_return(self, ptr: DriverPointer, input_: c_char_p, redacted: c_bool) -> int:
+        """
+        Write and then send a return to the session of driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+            input_: buffer contents to write during the write operation..
             redacted: bool indicated if the write contents should be redacted from logs.
 
         Returns:
@@ -166,7 +221,7 @@ class LibScrapliSharedMapping:
             N/A
 
         """
-        return self._write(ptr, buf, redacted)
+        return self._write_and_return(ptr, input_, redacted)
 
 
 class LibScrapliMapping:
@@ -196,6 +251,7 @@ class LibScrapliMapping:
     def __init__(self) -> None:
         self.lib = CDLL(get_libscrapli_path())
         self.shared_mapping = LibScrapliSharedMapping(self.lib)
+        self.session_mapping = LibScrapliSessionMapping(self.lib)
         self.cli_mapping = LibScrapliCliMapping(self.lib)
         self.netconf_mapping = LibScrapliNetconfMapping(self.lib)
         self.options_mapping = LibScrapliOptionsMapping(self.lib)