Module netmiko.oneaccess.oneaccess_oneos

Netmiko driver for OneAccess ONEOS

Expand source code 
"""Netmiko driver for OneAccess ONEOS"""
from typing import Any

from netmiko.cisco_base_connection import CiscoBaseConnection


class OneaccessOneOSBase(CiscoBaseConnection):
    def __init__(self, *args: Any, **kwargs: Any) -> None:
        """Init connection - similar as Cisco"""
        default_enter = kwargs.get("default_enter")
        kwargs["default_enter"] = "\r\n" if default_enter is None else default_enter
        super().__init__(*args, **kwargs)

    def session_preparation(self) -> None:
        """Prepare connection - disable paging"""

        self._test_channel_read(pattern=r"[>#]")
        self.disable_paging(command="term len 0")

        # try ONEOS6 command first - fallback to ONEOS5 if it fails
        self.set_terminal_width(command="screen-width 512", cmd_verify=True)
        output = self._test_channel_read(pattern=r"[>#]")
        if "error" in output.lower():
            self.set_terminal_width(command="stty columns 255", cmd_verify=True)
        else:
            # ONEOS6 uses different enter
            self.RETURN = "\n"

        self._test_channel_read(pattern=r"[>#]")
        self.set_base_prompt()

    def save_config(
        self, cmd: str = "write mem", confirm: bool = False, confirm_response: str = ""
    ) -> str:
        """Save config: write mem"""
        return super().save_config(
            cmd=cmd, confirm=confirm, confirm_response=confirm_response
        )


class OneaccessOneOSSSH(OneaccessOneOSBase):
    pass


class OneaccessOneOSTelnet(OneaccessOneOSBase):
    pass

Classes

class OneaccessOneOSBase (*args: Any, **kwargs: Any)

Base Class for cisco-like behavior.

Init connection - similar as Cisco

Expand source code 
class OneaccessOneOSBase(CiscoBaseConnection):
    def __init__(self, *args: Any, **kwargs: Any) -> None:
        """Init connection - similar as Cisco"""
        default_enter = kwargs.get("default_enter")
        kwargs["default_enter"] = "\r\n" if default_enter is None else default_enter
        super().__init__(*args, **kwargs)

    def session_preparation(self) -> None:
        """Prepare connection - disable paging"""

        self._test_channel_read(pattern=r"[>#]")
        self.disable_paging(command="term len 0")

        # try ONEOS6 command first - fallback to ONEOS5 if it fails
        self.set_terminal_width(command="screen-width 512", cmd_verify=True)
        output = self._test_channel_read(pattern=r"[>#]")
        if "error" in output.lower():
            self.set_terminal_width(command="stty columns 255", cmd_verify=True)
        else:
            # ONEOS6 uses different enter
            self.RETURN = "\n"

        self._test_channel_read(pattern=r"[>#]")
        self.set_base_prompt()

    def save_config(
        self, cmd: str = "write mem", confirm: bool = False, confirm_response: str = ""
    ) -> str:
        """Save config: write mem"""
        return super().save_config(
            cmd=cmd, confirm=confirm, confirm_response=confirm_response
        )

Ancestors

Subclasses

Methods

def save_config(self, cmd: str = 'write mem', confirm: bool = False, confirm_response: str = '') ‑> str

Save config: write mem

Expand source code 
def save_config(
    self, cmd: str = "write mem", confirm: bool = False, confirm_response: str = ""
) -> str:
    """Save config: write mem"""
    return super().save_config(
        cmd=cmd, confirm=confirm, confirm_response=confirm_response
    )
def session_preparation(self) ‑> None

Prepare connection - disable paging

Expand source code 
def session_preparation(self) -> None:
    """Prepare connection - disable paging"""

    self._test_channel_read(pattern=r"[>#]")
    self.disable_paging(command="term len 0")

    # try ONEOS6 command first - fallback to ONEOS5 if it fails
    self.set_terminal_width(command="screen-width 512", cmd_verify=True)
    output = self._test_channel_read(pattern=r"[>#]")
    if "error" in output.lower():
        self.set_terminal_width(command="stty columns 255", cmd_verify=True)
    else:
        # ONEOS6 uses different enter
        self.RETURN = "\n"

    self._test_channel_read(pattern=r"[>#]")
    self.set_base_prompt()

Inherited members

class OneaccessOneOSSSH (*args: Any, **kwargs: Any)

Base Class for cisco-like behavior.

Init connection - similar as Cisco

Expand source code 
class OneaccessOneOSSSH(OneaccessOneOSBase):
    pass

Ancestors

Inherited members

class OneaccessOneOSTelnet (*args: Any, **kwargs: Any)

Base Class for cisco-like behavior.

Init connection - similar as Cisco

Expand source code 
class OneaccessOneOSTelnet(OneaccessOneOSBase):
    pass

Ancestors

Inherited members