Module netmiko.zpe.zpe_nodegrid

Classes

class ZpeNodegridFileTransfer (ssh_conn: BaseConnection,
source_file: str,
dest_file: str,
file_system: str | None = '/var/tmp',
direction: str = 'put',
**kwargs: Any)
Expand source code 
class ZpeNodegridFileTransfer(BaseFileTransfer):
    """ZPE Nodegrid SCP File Transfer driver."""

    ssh_ctl_chan: "ZpeNodegridSSH"

    def __init__(
        self,
        ssh_conn: "BaseConnection",
        source_file: str,
        dest_file: str,
        file_system: Optional[str] = "/var/tmp",
        direction: str = "put",
        **kwargs: Any,
    ) -> None:
        super().__init__(
            ssh_conn=ssh_conn,
            source_file=source_file,
            dest_file=dest_file,
            file_system=file_system,
            direction=direction,
            **kwargs,
        )

    def remote_space_available(self, search_pattern: str = "") -> int:
        """Return space available on remote device."""
        search_pattern = self.ssh_ctl_chan.shell_prompt_pattern
        return self._remote_space_available_unix(search_pattern=search_pattern)

    def check_file_exists(self, remote_cmd: str = "") -> bool:
        """Check if the dest_file already exists on the file system."""
        return self._check_file_exists_unix(
            remote_cmd=remote_cmd, search_pattern=self.ssh_ctl_chan.shell_prompt_pattern
        )

    def remote_file_size(self, remote_cmd: str = "", remote_file: Optional[str] = None) -> int:
        """Get the file size of the remote file."""
        return self._remote_file_size_unix(
            remote_cmd=remote_cmd,
            remote_file=remote_file,
            search_pattern=self.ssh_ctl_chan.shell_prompt_pattern,
        )

    def remote_md5(self, base_cmd: str = "md5sum", remote_file: Optional[str] = None) -> str:
        """Calculate remote MD5 and returns the hash."""
        if remote_file is None:
            if self.direction == "put":
                remote_file = self.dest_file
            elif self.direction == "get":
                remote_file = self.source_file
        remote_cmd = f"{base_cmd} {self.file_system}/{remote_file}"
        self.ssh_ctl_chan._enter_shell()
        try:
            output = self.ssh_ctl_chan._send_command_str(
                remote_cmd,
                expect_string=self.ssh_ctl_chan.shell_prompt_pattern,
                read_timeout=300,
            )
        finally:
            self.ssh_ctl_chan._return_cli()
        return self.process_md5(output.strip())

    @staticmethod
    def process_md5(md5_output: str, pattern: str = r"(\S+)\s+") -> str:
        """Process the string to retrieve the MD5 hash."""
        match = re.search(pattern, md5_output)
        if match:
            return match.group(1)
        else:
            raise ValueError(f"Invalid output from MD5 command: {md5_output}")

    def enable_scp(self, cmd: str = "") -> None:
        raise NotImplementedError

    def disable_scp(self, cmd: str = "") -> None:
        raise NotImplementedError

ZPE Nodegrid SCP File Transfer driver.

Ancestors

Class variables

var ssh_ctl_chan : ZpeNodegridSSH

Static methods

def process_md5(md5_output: str, pattern: str = '(\\S+)\\s+') ‑> str
Expand source code 
@staticmethod
def process_md5(md5_output: str, pattern: str = r"(\S+)\s+") -> str:
    """Process the string to retrieve the MD5 hash."""
    match = re.search(pattern, md5_output)
    if match:
        return match.group(1)
    else:
        raise ValueError(f"Invalid output from MD5 command: {md5_output}")

Process the string to retrieve the MD5 hash.

Methods

def check_file_exists(self, remote_cmd: str = '') ‑> bool
Expand source code 
def check_file_exists(self, remote_cmd: str = "") -> bool:
    """Check if the dest_file already exists on the file system."""
    return self._check_file_exists_unix(
        remote_cmd=remote_cmd, search_pattern=self.ssh_ctl_chan.shell_prompt_pattern
    )

Check if the dest_file already exists on the file system.

def remote_md5(self, base_cmd: str = 'md5sum', remote_file: str | None = None) ‑> str
Expand source code 
def remote_md5(self, base_cmd: str = "md5sum", remote_file: Optional[str] = None) -> str:
    """Calculate remote MD5 and returns the hash."""
    if remote_file is None:
        if self.direction == "put":
            remote_file = self.dest_file
        elif self.direction == "get":
            remote_file = self.source_file
    remote_cmd = f"{base_cmd} {self.file_system}/{remote_file}"
    self.ssh_ctl_chan._enter_shell()
    try:
        output = self.ssh_ctl_chan._send_command_str(
            remote_cmd,
            expect_string=self.ssh_ctl_chan.shell_prompt_pattern,
            read_timeout=300,
        )
    finally:
        self.ssh_ctl_chan._return_cli()
    return self.process_md5(output.strip())

Calculate remote MD5 and returns the hash.

Inherited members

class ZpeNodegridSSH (ip: str = '',
host: str = '',
username: str = '',
password: str | None = None,
secret: str = '',
port: int | None = None,
device_type: str = '',
verbose: bool = False,
global_delay_factor: float = 1.0,
global_cmd_verify: bool | None = None,
use_keys: bool = False,
key_file: str | None = None,
pkey: paramiko.pkey.PKey | None = None,
passphrase: str | None = None,
disabled_algorithms: Dict[str, Any] | None = None,
disable_sha2_fix: bool = False,
allow_agent: bool = False,
ssh_strict: bool = False,
system_host_keys: bool = False,
alt_host_keys: bool = False,
alt_key_file: str = '',
ssh_config_file: str | None = None,
conn_timeout: float = 10,
auth_timeout: float | None = None,
banner_timeout: float = 15,
blocking_timeout: float = 20,
timeout: int = 100,
session_timeout: float = 60,
read_timeout_override: float | None = None,
keepalive: float = 0,
default_enter: str | None = None,
response_return: str | None = None,
serial_settings: Dict[str, Any] | None = None,
fast_cli: bool = True,
session_log: str | io.BufferedIOBase | SessionLog | None = None,
session_log_record_writes: bool = False,
session_log_file_mode: str = 'write',
allow_auto_change: bool = False,
encoding: str = 'utf-8',
sock: socket.socket | None = None,
sock_telnet: Dict[str, Any] | None = None,
auto_connect: bool = True,
delay_factor_compat: bool = False,
disable_lf_normalization: bool = False)
Expand source code 
class ZpeNodegridSSH(NoEnable, NoConfig, LinuxSSH):
    """ZPE Systems Nodegrid SSH driver.

    The Nodegrid OS uses a directory-based virtual configuration tree.
    Navigation uses 'cd' and 'ls'; read operations use 'show'; configuration
    uses 'set param=value'. Changes are staged and indicated by a '+' prefix
    in the prompt until a 'commit' is issued. There is no traditional enable
    or config mode.

    Prompt examples::

        [admin@nodegrid /]#           Normal (no staged changes)
        [+admin@nodegrid ETH0]#       Staged changes pending commit

    The underlying Linux shell is accessible via 'shell'; 'exit' returns
    to the Nodegrid CLI.

    SSH login and CLI mode transitions example::

        [admin@nodegrid /]# cd /settings/network_connections/ETH0/
        [admin@nodegrid ETH0]# set ipv4_mode=static
        [+admin@nodegrid ETH0]# set ipv4_address=192.168.1.50
        [+admin@nodegrid ETH0]# commit
        [admin@nodegrid ETH0]#
    """

    # Matches: [admin@nodegrid /]# and [+admin@nodegrid ETH0]#
    prompt_pattern = r"\[\+?.*\]#"
    # Matches: root@nodegrid:/var/home# or admin@nodegrid:~$
    shell_prompt_pattern = r".+@.+:.+[\$#]"

    def session_preparation(self) -> None:
        """Prepare the session after the connection has been established."""
        self.ansi_escape_codes = True
        self._test_channel_read(pattern=self.prompt_pattern)
        self.set_base_prompt()
        self.disable_paging()

    def set_base_prompt(
        self,
        pri_prompt_terminator: str = "#",
        alt_prompt_terminator: str = "",
        delay_factor: float = 1.0,
        pattern: Optional[str] = None,
    ) -> str:
        """Set the base prompt using the Nodegrid prompt pattern."""
        if pattern is None:
            pattern = self.prompt_pattern
        return super().set_base_prompt(
            pri_prompt_terminator=pri_prompt_terminator,
            alt_prompt_terminator=alt_prompt_terminator,
            delay_factor=delay_factor,
            pattern=pattern,
        )

    def find_prompt(self, delay_factor: float = 1.0, pattern: Optional[str] = None) -> str:
        """Find the current prompt."""
        if pattern is None:
            pattern = self.prompt_pattern
        return super().find_prompt(delay_factor=delay_factor, pattern=pattern)

    def _prompt_handler(self, auto_find_prompt: bool) -> str:
        """Return the prompt regex used by send_command for output termination.

        Uses the broad prompt_pattern rather than the escaped base_prompt so
        that send_command works correctly after 'cd' changes the prompt.
        """
        return self.prompt_pattern

    def strip_prompt(self, a_string: str) -> str:
        """Strip the trailing Nodegrid prompt from command output.

        Uses regex rather than an exact base_prompt match to correctly handle
        prompt changes from directory navigation and the '+' staged-change
        indicator.
        """
        response_list = a_string.split(self.RESPONSE_RETURN)
        last_line = response_list[-1]
        if re.search(self.prompt_pattern, last_line):
            return self.RESPONSE_RETURN.join(response_list[:-1])
        return a_string

    def disable_paging(
        self,
        command: str = ".sessionpageout undefined=no",
        delay_factor: Optional[float] = None,
        cmd_verify: bool = True,
        pattern: Optional[str] = None,
    ) -> str:
        """Disable paging for the current CLI session.

        WARNING: Not officially documented by ZPE. Could negatively impact performance.
        """
        return self._send_command_str(command, expect_string=self.prompt_pattern)

    def commit(self) -> str:
        """Commit staged configuration changes."""
        return self._send_command_str("commit", expect_string=self.prompt_pattern, read_timeout=30)

    def _enter_shell(self) -> str:
        """Enter the Bash shell on ZPE Nodegrid."""
        return self._send_command_str("shell", expect_string=self.shell_prompt_pattern)

    def _return_cli(self) -> str:
        """Return to the ZPE Nodegrid CLI."""
        return self._send_command_str("exit", expect_string=self.prompt_pattern)

ZPE Systems Nodegrid SSH driver.

The Nodegrid OS uses a directory-based virtual configuration tree. Navigation uses 'cd' and 'ls'; read operations use 'show'; configuration uses 'set param=value'. Changes are staged and indicated by a '+' prefix in the prompt until a 'commit' is issued. There is no traditional enable or config mode.

Prompt examples::

[admin@nodegrid /]#           Normal (no staged changes)
[+admin@nodegrid ETH0]#       Staged changes pending commit

The underlying Linux shell is accessible via 'shell'; 'exit' returns to the Nodegrid CLI.

SSH login and CLI mode transitions example::

[admin@nodegrid /]# cd /settings/network_connections/ETH0/
[admin@nodegrid ETH0]# set ipv4_mode=static
[+admin@nodegrid ETH0]# set ipv4_address=192.168.1.50
[+admin@nodegrid ETH0]# commit
[admin@nodegrid ETH0]#

    Initialize attributes for establishing connection to target device.

    :param ip: IP address of target device. Not required if <code>host</code> is
        provided.

    :param host: Hostname of target device. Not required if <code>ip</code> is
            provided.

    :param username: Username to authenticate against target device if
            required.

    :param password: Password to authenticate against target device if
            required.

    :param secret: The enable password if target device requires one.

    :param port: The destination port used to connect to the target
            device.

    :param device_type: Class selection based on device type.

    :param verbose: Enable additional messages to standard output.

    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).

    :param use_keys: Connect to target device using SSH keys.

    :param key_file: Filename path of the SSH key file to use.

    :param pkey: SSH key object to use.

    :param passphrase: Passphrase to use for encrypted key; password will be used for key
            decryption if not specified.

    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
            documentation for a description of the expected format.

    :param disable_sha2_fix: Boolean that fixes Paramiko issue with missing server-sig-algs
        <https://github.com/paramiko/paramiko/issues/1961> (default: False)

    :param allow_agent: Enable use of SSH key-agent.

    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
            means unknown SSH host keys will be accepted).

    :param system_host_keys: Load host keys from the users known_hosts file.

    :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
            alt_key_file.

    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).

    :param ssh_config_file: File name of OpenSSH configuration file.

    :param conn_timeout: TCP connection timeout.

    :param session_timeout: Set a timeout for parallel requests.

    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.

    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).

    :param read_timeout_override: Set a timeout that will override the default read_timeout
            of both send_command and send_command_timing. This is useful for 3rd party
            libraries where directly accessing method arguments might be impractical.

    :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
            Currently defaults to 0, for backwards compatibility (it will not attempt
            to keep the connection alive).

    :param default_enter: Character(s) to send to correspond to enter key (default:

).

    :param response_return: Character(s) to use in normalized return data to represent
            enter key (default:

)

    :param serial_settings: Dictionary of settings for use with serial port (pySerial).

    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
            to select smallest of global and specific. Sets default global_delay_factor to .1
            (default: True)

    :param session_log: File path, SessionLog object, or BufferedIOBase subclass object
            to write the session log to.

    :param session_log_record_writes: The session log generally only records channel reads due
            to eliminate command duplication due to command echo. You can enable this if you
            want to record both channel reads and channel writes in the log (default: False).

    :param session_log_file_mode: "write" or "append" for session_log file mode
            (default: "write")

    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
            (default: False)

    :param encoding: Encoding to be used when writing bytes to the output channel.
            (default: "utf-8")

    :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
            communication to the target host (default: None).

    :param sock_telnet: A dictionary of telnet socket parameters (SOCKS proxy). See
            telnet_proxy.py code for details.

    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
            (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
            argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.

    :param auto_connect: Control whether Netmiko automatically establishes the connection as
            part of the object creation (default: True).

    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
            eliminated in Netmiko 5.x (default: False).

    :param disable_lf_normalization: Disable Netmiko's linefeed normalization behavior
            (default: False)

Ancestors

Class variables

var prompt_pattern
var shell_prompt_pattern

Methods

def commit(self) ‑> str
Expand source code 
def commit(self) -> str:
    """Commit staged configuration changes."""
    return self._send_command_str("commit", expect_string=self.prompt_pattern, read_timeout=30)

Commit staged configuration changes.

def disable_paging(self,
command: str = '.sessionpageout undefined=no',
delay_factor: float | None = None,
cmd_verify: bool = True,
pattern: str | None = None) ‑> str
Expand source code 
def disable_paging(
    self,
    command: str = ".sessionpageout undefined=no",
    delay_factor: Optional[float] = None,
    cmd_verify: bool = True,
    pattern: Optional[str] = None,
) -> str:
    """Disable paging for the current CLI session.

    WARNING: Not officially documented by ZPE. Could negatively impact performance.
    """
    return self._send_command_str(command, expect_string=self.prompt_pattern)

Disable paging for the current CLI session.

WARNING: Not officially documented by ZPE. Could negatively impact performance.

def find_prompt(self, delay_factor: float = 1.0, pattern: str | None = None) ‑> str
Expand source code 
def find_prompt(self, delay_factor: float = 1.0, pattern: Optional[str] = None) -> str:
    """Find the current prompt."""
    if pattern is None:
        pattern = self.prompt_pattern
    return super().find_prompt(delay_factor=delay_factor, pattern=pattern)

Find the current prompt.

def set_base_prompt(self,
pri_prompt_terminator: str = '#',
alt_prompt_terminator: str = '',
delay_factor: float = 1.0,
pattern: str | None = None) ‑> str
Expand source code 
def set_base_prompt(
    self,
    pri_prompt_terminator: str = "#",
    alt_prompt_terminator: str = "",
    delay_factor: float = 1.0,
    pattern: Optional[str] = None,
) -> str:
    """Set the base prompt using the Nodegrid prompt pattern."""
    if pattern is None:
        pattern = self.prompt_pattern
    return super().set_base_prompt(
        pri_prompt_terminator=pri_prompt_terminator,
        alt_prompt_terminator=alt_prompt_terminator,
        delay_factor=delay_factor,
        pattern=pattern,
    )

Set the base prompt using the Nodegrid prompt pattern.

def strip_prompt(self, a_string: str) ‑> str
Expand source code 
def strip_prompt(self, a_string: str) -> str:
    """Strip the trailing Nodegrid prompt from command output.

    Uses regex rather than an exact base_prompt match to correctly handle
    prompt changes from directory navigation and the '+' staged-change
    indicator.
    """
    response_list = a_string.split(self.RESPONSE_RETURN)
    last_line = response_list[-1]
    if re.search(self.prompt_pattern, last_line):
        return self.RESPONSE_RETURN.join(response_list[:-1])
    return a_string

Strip the trailing Nodegrid prompt from command output.

Uses regex rather than an exact base_prompt match to correctly handle prompt changes from directory navigation and the '+' staged-change indicator.

Inherited members