scrapli 2.0.0a0__py3-none-macosx_11_0_arm64.whl

scrapli/ffi_mapping_netconf.py

@@ -0,0 +1,1612 @@
+"""scrapli.ffi_mapping_cli"""
+
+from collections.abc import Callable
+from ctypes import (
+    CDLL,
+    c_bool,
+    c_char_p,
+    c_int,
+    c_uint8,
+    c_uint64,
+)
+
+from _ctypes import POINTER
+
+from scrapli.ffi_types import (
+    CancelPointer,
+    DriverPointer,
+    IntPointer,
+    LogFuncCallback,
+    OperationId,
+    OperationIdPointer,
+    U64Pointer,
+    ZigSlice,
+    ZigSlicePointer,
+)
+
+
+class LibScrapliNetconfMapping:
+    """
+    Mapping to libscrapli netconf object functions mapping.
+
+    Should not be used/called directly.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    def __init__(self, lib: CDLL) -> None:  # noqa: PLR0915
+        self._alloc: Callable[
+            [
+                LogFuncCallback,
+                c_char_p,
+                c_int,
+                c_char_p,
+            ],
+            DriverPointer,
+        ] = lib.ls_netconf_alloc
+        lib.ls_netconf_alloc.argtypes = [
+            LogFuncCallback,
+            c_char_p,
+            c_int,
+            c_char_p,
+        ]
+        lib.ls_netconf_alloc.restype = DriverPointer
+
+        self._open: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_open
+        lib.ls_netconf_open.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_netconf_open.restype = c_uint8
+
+        self._close: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_netconf_close
+        lib.ls_netconf_close.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_bool,
+        ]
+        lib.ls_netconf_close.restype = c_uint8
+
+        self._fetch_sizes: Callable[
+            [
+                DriverPointer,
+                OperationId,
+                IntPointer,
+                IntPointer,
+                IntPointer,
+                IntPointer,
+                IntPointer,
+                IntPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_fetch_operation_sizes
+        lib.ls_netconf_fetch_operation_sizes.argtypes = [
+            DriverPointer,
+            OperationId,
+            IntPointer,
+            IntPointer,
+            IntPointer,
+            IntPointer,
+            IntPointer,
+            IntPointer,
+        ]
+        lib.ls_netconf_fetch_operation_sizes.restype = c_uint8
+
+        self._fetch: Callable[
+            [
+                DriverPointer,
+                OperationId,
+                U64Pointer,
+                U64Pointer,
+                ZigSlicePointer,
+                ZigSlicePointer,
+                ZigSlicePointer,
+                ZigSlicePointer,
+                ZigSlicePointer,
+                ZigSlicePointer,
+            ],
+            int,
+        ] = lib.ls_netconf_fetch_operation
+        lib.ls_netconf_fetch_operation.argtypes = [
+            DriverPointer,
+            OperationId,
+            POINTER(c_uint64),
+            POINTER(c_uint64),
+            POINTER(ZigSlice),
+            POINTER(ZigSlice),
+            POINTER(ZigSlice),
+            POINTER(ZigSlice),
+            POINTER(ZigSlice),
+            POINTER(ZigSlice),
+        ]
+        lib.ls_netconf_fetch_operation.restype = c_uint8
+
+        self._get_session_id: Callable[
+            [
+                DriverPointer,
+                IntPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_get_session_id
+        lib.ls_netconf_get_session_id.argtypes = [
+            DriverPointer,
+            IntPointer,
+        ]
+        lib.ls_netconf_get_session_id.restype = c_uint8
+
+        self._get_subscription_id: Callable[
+            [
+                c_char_p,
+                U64Pointer,
+            ],
+            int,
+        ] = lib.ls_netconf_get_subscription_id
+        lib.ls_netconf_get_subscription_id.argtypes = [
+            c_char_p,
+            POINTER(c_uint64),
+        ]
+        lib.ls_netconf_get_subscription_id.restype = c_uint8
+
+        self._get_next_notification_size: Callable[
+            [
+                DriverPointer,
+                U64Pointer,
+            ],
+            int,
+        ] = lib.ls_netconf_next_notification_message_size
+        lib.ls_netconf_next_notification_message_size.argtypes = [
+            DriverPointer,
+            POINTER(c_uint64),
+        ]
+        lib.ls_netconf_next_notification_message_size.restype = c_uint8
+
+        self._get_next_notification: Callable[
+            [
+                DriverPointer,
+                ZigSlicePointer,
+            ],
+            int,
+        ] = lib.ls_netconf_next_notification_message
+        lib.ls_netconf_next_notification_message.argtypes = [
+            DriverPointer,
+            POINTER(ZigSlice),
+        ]
+        lib.ls_netconf_next_notification_message.restype = c_uint8
+
+        self._get_next_subscription_size: Callable[
+            [
+                DriverPointer,
+                c_uint64,
+                U64Pointer,
+            ],
+            int,
+        ] = lib.ls_netconf_next_subscription_message_size
+        lib.ls_netconf_next_subscription_message_size.argtypes = [
+            DriverPointer,
+            c_uint64,
+            POINTER(c_uint64),
+        ]
+        lib.ls_netconf_next_subscription_message_size.restype = c_uint8
+
+        self._get_next_subscription: Callable[
+            [
+                DriverPointer,
+                c_uint64,
+                ZigSlicePointer,
+            ],
+            int,
+        ] = lib.ls_netconf_next_subscription_message
+        lib.ls_netconf_next_subscription_message.argtypes = [
+            DriverPointer,
+            c_uint64,
+            POINTER(ZigSlice),
+        ]
+        lib.ls_netconf_next_subscription_message.restype = c_uint8
+
+        self._raw_rpc: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_raw_rpc
+        lib.ls_netconf_raw_rpc.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_raw_rpc.restype = c_uint8
+
+        self._get_config: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_get_config
+        lib.ls_netconf_get_config.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_get_config.restype = c_uint8
+
+        self._edit_config: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_edit_config
+        lib.ls_netconf_edit_config.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_edit_config.restype = c_uint8
+
+        self._copy_config: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_copy_config
+        lib.ls_netconf_copy_config.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_copy_config.restype = c_uint8
+
+        self._delete_config: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_delete_config
+        lib.ls_netconf_delete_config.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+        ]
+        lib.ls_netconf_delete_config.restype = c_uint8
+
+        self._lock: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_lock
+        lib.ls_netconf_lock.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+        ]
+        lib.ls_netconf_lock.restype = c_uint8
+
+        self._unlock: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_unlock
+        lib.ls_netconf_unlock.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+        ]
+        lib.ls_netconf_unlock.restype = c_uint8
+
+        self._get: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_get
+        lib.ls_netconf_get.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_get.restype = c_uint8
+
+        self._close_session: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_close_session
+        lib.ls_netconf_close_session.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_netconf_close_session.restype = c_uint8
+
+        self._kill_session: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_int,
+            ],
+            int,
+        ] = lib.ls_netconf_kill_session
+        lib.ls_netconf_kill_session.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_int,
+        ]
+        lib.ls_netconf_kill_session.restype = c_uint8
+
+        self._commit: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_commit
+        lib.ls_netconf_commit.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_netconf_commit.restype = c_uint8
+
+        self._discard: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_discard
+        lib.ls_netconf_discard.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_netconf_discard.restype = c_uint8
+
+        self._cancel_commit: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_netconf_cancel_commit
+        lib.ls_netconf_cancel_commit.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_netconf_cancel_commit.restype = c_uint8
+
+        self._validate: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_validate
+        lib.ls_netconf_validate.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+        ]
+        lib.ls_netconf_validate.restype = c_uint8
+
+        self._get_schema: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_get_schema
+        lib.ls_netconf_get_schema.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_get_schema.restype = c_uint8
+
+        self._get_data: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_int,
+                c_bool,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_get_data
+        lib.ls_netconf_get_data.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_int,
+            c_bool,
+            c_char_p,
+        ]
+        lib.ls_netconf_get_data.restype = c_uint8
+
+        self._edit_data: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_edit_data
+        lib.ls_netconf_edit_data.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+            c_char_p,
+        ]
+        lib.ls_netconf_edit_data.restype = c_uint8
+
+        self._action: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
+        ] = lib.ls_netconf_action
+        lib.ls_netconf_action.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+            c_char_p,
+        ]
+        lib.ls_netconf_action.restype = c_uint8
+
+    def alloc(
+        self,
+        *,
+        logger_callback: LogFuncCallback,
+        host: c_char_p,
+        port: c_int,
+        transport_kind: c_char_p,
+    ) -> DriverPointer:
+        """
+        Allocate a Netconf object.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            logger_callback: pointer to logger callback function
+            host: host to connect to
+            port: port at which to connect
+            transport_kind: transport kind to use
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._alloc(logger_callback, host, port, transport_kind)
+
+    def open(
+        self, ptr: DriverPointer, operation_id: OperationIdPointer, cancel: CancelPointer
+    ) -> int:
+        """
+        Open the driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli netconf object.
+            operation_id: c_int pointer that is filled with the operation id to poll for completion.
+            cancel: bool pointer that can be set to true to cancel the operation.
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._open(ptr, operation_id, cancel)
+
+    def close(
+        self,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        force: c_bool,
+    ) -> int:
+        """
+        Close the driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli netconf object.
+            operation_id: c_int pointer that is filled with the operation id to poll for completion.
+            cancel: bool pointer that can be set to true to cancel the operation.
+            force: bool indicating if the connection should skip sending close-session rpc or not
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._close(
+            ptr,
+            operation_id,
+            cancel,
+            force,
+        )
+
+    def fetch_sizes(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationId,
+        input_size: IntPointer,
+        result_raw_size: IntPointer,
+        result_size: IntPointer,
+        rpc_warnings_size: IntPointer,
+        rpc_errors_size: IntPointer,
+        err_size: IntPointer,
+    ) -> int:
+        """
+        Fetch the sizes of a netconf operation's results.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: operation id of which to poll
+            input_size: int pointer to fill with the operation's input size
+            result_raw_size: int pointer to fill with the operation's result raw size
+            result_size:  int pointer to fill with the operation's result size
+            rpc_warnings_size: int pointer to fill with the size of any rpc warning string
+            rpc_errors_size: int pointer to fill with the size of any rpc error string
+            err_size: int pointer to fill with the operation's error size
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._fetch_sizes(
+            ptr,
+            operation_id,
+            input_size,
+            result_raw_size,
+            result_size,
+            rpc_warnings_size,
+            rpc_errors_size,
+            err_size,
+        )
+
+    def fetch(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationId,
+        start_time: U64Pointer,
+        end_time: U64Pointer,
+        input_slice: ZigSlicePointer,
+        result_raw_slice: ZigSlicePointer,
+        result_slice: ZigSlicePointer,
+        rpc_warnings_slice: ZigSlicePointer,
+        rpc_errors_slice: ZigSlicePointer,
+        err_slice: ZigSlicePointer,
+    ) -> int:
+        """
+        Fetch the result of a cli operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: operation id of which to poll
+            start_time: int pointer to fill with the operation's start time
+            end_time: int pointer to fill with the operation's end time
+            input_slice: pre allocated slice to fill with the operations input
+            result_raw_slice: pre allocated slice to fill with the operations result raw
+            result_slice: pre allocated slice to fill with the operations result
+            rpc_warnings_slice: pre allocated slice to fill with the rpc warnings string
+            rpc_errors_slice: pre allocated slice to fill with the rpc errors string
+            err_slice: pre allocated slice to fill with the operations error
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._fetch(
+            ptr,
+            operation_id,
+            start_time,
+            end_time,
+            input_slice,
+            result_raw_slice,
+            result_slice,
+            rpc_warnings_slice,
+            rpc_errors_slice,
+            err_slice,
+        )
+
+    def get_session_id(
+        self,
+        *,
+        ptr: DriverPointer,
+        session_id: IntPointer,
+    ) -> int:
+        """
+        Get the session id of the Netconf object/session.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            session_id: int pointer to fill with the session id
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_session_id(
+            ptr,
+            session_id,
+        )
+
+    def get_subscription_id(
+        self,
+        *,
+        payload: c_char_p,
+        subscription_id: U64Pointer,
+    ) -> int:
+        """
+        Get the subscription id from the given subscription response payload.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            payload: payload to get the subscription id from
+            subscription_id: int pointer to fill with the subscription id
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_subscription_id(
+            payload,
+            subscription_id,
+        )
+
+    def get_next_notification_size(
+        self,
+        *,
+        ptr: DriverPointer,
+        notification_size: U64Pointer,
+    ) -> int:
+        """
+        Get the size of the next notification message.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            notification_size: int pointer to fill with the session id
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_next_notification_size(
+            ptr,
+            notification_size,
+        )
+
+    def get_next_notification(
+        self,
+        *,
+        ptr: DriverPointer,
+        notification_slice: ZigSlicePointer,
+    ) -> int:
+        """
+        Get the next notification message.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            notification_slice: pre populted slice to fill with the notification
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_next_notification(
+            ptr,
+            notification_slice,
+        )
+
+    def get_next_subscription_size(
+        self,
+        *,
+        ptr: DriverPointer,
+        subscription_id: c_uint64,
+        subscription_size: U64Pointer,
+    ) -> int:
+        """
+        Get the size of the next subscription message for the given id.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            subscription_id: subscription id to fetch a message for
+            subscription_size: int pointer to fill with the session id
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_next_subscription_size(
+            ptr,
+            subscription_id,
+            subscription_size,
+        )
+
+    def get_next_subscription(
+        self,
+        *,
+        ptr: DriverPointer,
+        subscription_id: c_uint64,
+        subscription_slice: ZigSlicePointer,
+    ) -> int:
+        """
+        Get the next subscription message for the given id.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            subscription_id: subscription id to fetch a message for
+            subscription_slice: pre populted slice to fill with the notification
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_next_subscription(
+            ptr,
+            subscription_id,
+            subscription_slice,
+        )
+
+    def raw_rpc(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        payload: c_char_p,
+        base_namespace_prefix: c_char_p,
+        extra_namespaces: c_char_p,
+    ) -> int:
+        """
+        Execute a "raw" / user defined rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            payload: the payload to write into the outer rpc element
+            base_namespace_prefix: prefix to use for hte base/default netconf base namespace
+            extra_namespaces: extra namespace::prefix pairs (using "::" as split there), and
+                split by "__libscrapli__" for additional pairs. this plus the base namespace
+                prefix can allow for weird cases like nxos where the base namespace must be
+                prefixed and then additional namespaces indicating desired targets must be added
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._raw_rpc(
+            ptr,
+            operation_id,
+            cancel,
+            payload,
+            base_namespace_prefix,
+            extra_namespaces,
+        )
+
+    def get_config(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        source: c_char_p,
+        filter_: c_char_p,
+        filter_type: c_char_p,
+        filter_namespace_prefix: c_char_p,
+        filter_namespace: c_char_p,
+        defaults_type: c_char_p,
+    ) -> int:
+        """
+        Execute a get-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            source: source data store to get config from
+            filter_: filter to apply
+            filter_type: filter type (subtree|xpath)
+            filter_namespace_prefix: optional prefix for filter namespace
+            filter_namespace: optional namespace for filter
+            defaults_type: defaults type setting
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_config(
+            ptr,
+            operation_id,
+            cancel,
+            source,
+            filter_,
+            filter_type,
+            filter_namespace_prefix,
+            filter_namespace,
+            defaults_type,
+        )
+
+    def edit_config(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        config: c_char_p,
+        target: c_char_p,
+    ) -> int:
+        """
+        Execute an edit-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            config: the config to send
+            target: the target datastore
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._edit_config(
+            ptr,
+            operation_id,
+            cancel,
+            config,
+            target,
+        )
+
+    def copy_config(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        target: c_char_p,
+        source: c_char_p,
+    ) -> int:
+        """
+        Execute a copy-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            target: the target/destination datastore to copy to
+            source: the source datastore to copy from
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._copy_config(
+            ptr,
+            operation_id,
+            cancel,
+            target,
+            source,
+        )
+
+    def delete_config(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        target: c_char_p,
+    ) -> int:
+        """
+        Execute a delete-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            target: the target/destination datastore to delete
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._delete_config(
+            ptr,
+            operation_id,
+            cancel,
+            target,
+        )
+
+    def lock(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        target: c_char_p,
+    ) -> int:
+        """
+        Execute a lock rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            target: the target/destination datastore to lock
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._lock(
+            ptr,
+            operation_id,
+            cancel,
+            target,
+        )
+
+    def unlock(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        target: c_char_p,
+    ) -> int:
+        """
+        Execute an unlock rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            target: the target/destination datastore to lock
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._unlock(
+            ptr,
+            operation_id,
+            cancel,
+            target,
+        )
+
+    def get(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        filter_: c_char_p,
+        filter_type: c_char_p,
+        filter_namespace_prefix: c_char_p,
+        filter_namespace: c_char_p,
+        defaults_type: c_char_p,
+    ) -> int:
+        """
+        Execute a get rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            filter_: filter to apply
+            filter_type: filter type (subtree|xpath)
+            filter_namespace_prefix: optional prefix for filter namespace
+            filter_namespace: optional namespace for filter
+            defaults_type: defaults type setting
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get(
+            ptr,
+            operation_id,
+            cancel,
+            filter_,
+            filter_type,
+            filter_namespace_prefix,
+            filter_namespace,
+            defaults_type,
+        )
+
+    def close_session(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+    ) -> int:
+        """
+        Execute a close-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._close_session(
+            ptr,
+            operation_id,
+            cancel,
+        )
+
+    def kill_session(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        session_id: c_int,
+    ) -> int:
+        """
+        Execute a close-config rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            session_id: the session id to kill
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._kill_session(
+            ptr,
+            operation_id,
+            cancel,
+            session_id,
+        )
+
+    def commit(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+    ) -> int:
+        """
+        Execute a commit rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._commit(
+            ptr,
+            operation_id,
+            cancel,
+        )
+
+    def discard(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+    ) -> int:
+        """
+        Execute a discard rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._discard(
+            ptr,
+            operation_id,
+            cancel,
+        )
+
+    def cancel_commit(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+    ) -> int:
+        """
+        Execute a cancel-commit rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._cancel_commit(
+            ptr,
+            operation_id,
+            cancel,
+        )
+
+    def validate(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        source: c_char_p,
+    ) -> int:
+        """
+        Execute a validate rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            source: datastore to validate
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._validate(
+            ptr,
+            operation_id,
+            cancel,
+            source,
+        )
+
+    def get_schema(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        identifier: c_char_p,
+        version: c_char_p,
+        format_: c_char_p,
+    ) -> int:
+        """
+        Execute a get-schema rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            identifier: schema identifier to get
+            version: optional schema version to request
+            format_: schema format to apply
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_schema(
+            ptr,
+            operation_id,
+            cancel,
+            identifier,
+            version,
+            format_,
+        )
+
+    def get_data(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        source: c_char_p,
+        filter_: c_char_p,
+        filter_type: c_char_p,
+        filter_namespace_prefix: c_char_p,
+        filter_namespace: c_char_p,
+        config_filter: c_char_p,
+        origin_filters: c_char_p,
+        max_depth: c_int,
+        with_origin: c_bool,
+        defaults_type: c_char_p,
+    ) -> int:
+        """
+        Execute a get-data rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            source: source datastore to get data from
+            filter_: filter to apply to the get-config (or not if empty string)
+            filter_type: type of filter to apply, subtree|xpath
+            filter_namespace_prefix: filter namespace prefix
+            filter_namespace: filter namespace
+            config_filter: config filter true/false, or unset to leave up to the server
+            origin_filters: fully formed origin filter xml payload to embed
+            max_depth: max depth of data requested
+            with_origin: include origin data
+            defaults_type: defaults type to apply to the get-config, "unset" means dont apply one
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_data(
+            ptr,
+            operation_id,
+            cancel,
+            source,
+            filter_,
+            filter_type,
+            filter_namespace_prefix,
+            filter_namespace,
+            config_filter,
+            origin_filters,
+            max_depth,
+            with_origin,
+            defaults_type,
+        )
+
+    def edit_data(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        target: c_char_p,
+        content: c_char_p,
+    ) -> int:
+        """
+        Execute a edit-data rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            target: datastore to target
+            content: full payload content to send
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._edit_data(
+            ptr,
+            operation_id,
+            cancel,
+            target,
+            content,
+        )
+
+    def action(
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
+        cancel: CancelPointer,
+        action: c_char_p,
+    ) -> int:
+        """
+        Execute an action rpc operation.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: ptr to the netconf object
+            operation_id: int pointer to fill with the id of the submitted operation
+            cancel: bool pointer that can be set to true to cancel the operation
+            action: the action to send
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._action(
+            ptr,
+            operation_id,
+            cancel,
+            action,
+        )