Module netmiko.alcatel.alcatel_sros_ssh

Alcatel-Lucent SROS support.

Source code 
"""Alcatel-Lucent SROS support."""
from __future__ import print_function
from __future__ import unicode_literals
import re
import time
from netmiko.cisco_base_connection import CiscoSSHConnection


class AlcatelSrosSSH(CiscoSSHConnection):
    """Alcatel-Lucent SROS support."""

    def session_preparation(self):
        self._test_channel_read()
        self.set_base_prompt()
        self.disable_paging(command="environment no more")
        # Clear the read buffer
        time.sleep(0.3 * self.global_delay_factor)
        self.clear_buffer()

    def set_base_prompt(self, *args, **kwargs):
        """Remove the > when navigating into the different config level."""
        cur_base_prompt = super(AlcatelSrosSSH, self).set_base_prompt(*args, **kwargs)
        match = re.search(r"(.*)(>.*)*#", cur_base_prompt)
        if match:
            # strip off >... from base_prompt
            self.base_prompt = match.group(1)
            return self.base_prompt

    def enable(self, cmd="enable-admin", pattern="ssword", re_flags=re.IGNORECASE):
        """Enter enable mode."""
        return super(AlcatelSrosSSH, self).enable(
            cmd=cmd, pattern=pattern, re_flags=re_flags
        )

    def check_enable_mode(self, check_string="CLI Already in admin mode"):
        """Check whether we are in enable-admin mode.
         SROS requires us to do this:
        *A:HOSTNAME# enable-admin
        MINOR: CLI Already in admin mode.
        *A:HOSTNAME#
        *A:HOSTNAME# enable-admin
        Password:
        MINOR: CLI Invalid password.
        *A:HOSTNAME#
        """
        output = self.send_command_timing("enable-admin")
        if re.search(r"ssword", output):
            # Just hit enter as we don't actually want to enter enable here
            self.write_channel(self.normalize_cmd(self.RETURN))
            self.read_until_prompt()
            return False
        elif check_string in output:
            return True
        raise ValueError("Unexpected response in check_enable_mode() method")

    def exit_enable_mode(self, exit_command=""):
        """No corresponding exit of enable mode on SROS."""
        pass

    def config_mode(self, config_command="configure", pattern="#"):
        """ Enter into configuration mode on SROS device."""
        return super(AlcatelSrosSSH, self).config_mode(
            config_command=config_command, pattern=pattern
        )

    def exit_config_mode(self, exit_config="exit all", pattern="#"):
        """ Exit from configuration mode."""
        return super(AlcatelSrosSSH, self).exit_config_mode(
            exit_config=exit_config, pattern=pattern
        )

    def check_config_mode(self, check_string="config", pattern="#"):
        """ Checks if the device is in configuration mode or not. """
        return super(AlcatelSrosSSH, self).check_config_mode(
            check_string=check_string, pattern=pattern
        )

    def save_config(self, *args, **kwargs):
        """Not Implemented"""
        raise NotImplementedError

Classes

class AlcatelSrosSSH (ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=8, banner_timeout=5, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii')

Alcatel-Lucent SROS support.

    Initialize attributes for establishing connection to target device.

    :param ip: IP address of target device. Not required if `host` is
        provided.
    :type ip: str

    :param host: Hostname of target device. Not required if `ip` is
            provided.
    :type host: str

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

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

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

    :param port: The destination port used to connect to the target
            device.
    :type port: int or None

    :param device_type: Class selection based on device type.
    :type device_type: str

    :param verbose: Enable additional messages to standard output.
    :type verbose: bool

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

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

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

    :param pkey: SSH key object to use.
    :type pkey: paramiko.PKey

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

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

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

    :param system_host_keys: Load host keys from the users known_hosts file.
    :type system_host_keys: bool
    :param alt_host_keys: If `True` host keys will be loaded from the file specified in
            alt_key_file.
    :type alt_host_keys: bool

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

    :param ssh_config_file: File name of OpenSSH configuration file.
    :type ssh_config_file: str

    :param timeout: Connection timeout.
    :type timeout: float

    :param session_timeout: Set a timeout for parallel requests.
    :type session_timeout: float

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

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

    :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).
    :type keepalive: int

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

). :type default_enter: str

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

) :type response_return: str

    :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: False)
    :type fast_cli: boolean

    :param session_log: File path or BufferedIOBase subclass object to write the session log to.
    :type session_log: str

    :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).
    :type session_log_record_writes: boolean

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

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

    :param encoding: Encoding to be used when writing bytes to the output channel.
            (default: ascii)
    :type encoding: str
Source code 
class AlcatelSrosSSH(CiscoSSHConnection):
    """Alcatel-Lucent SROS support."""

    def session_preparation(self):
        self._test_channel_read()
        self.set_base_prompt()
        self.disable_paging(command="environment no more")
        # Clear the read buffer
        time.sleep(0.3 * self.global_delay_factor)
        self.clear_buffer()

    def set_base_prompt(self, *args, **kwargs):
        """Remove the > when navigating into the different config level."""
        cur_base_prompt = super(AlcatelSrosSSH, self).set_base_prompt(*args, **kwargs)
        match = re.search(r"(.*)(>.*)*#", cur_base_prompt)
        if match:
            # strip off >... from base_prompt
            self.base_prompt = match.group(1)
            return self.base_prompt

    def enable(self, cmd="enable-admin", pattern="ssword", re_flags=re.IGNORECASE):
        """Enter enable mode."""
        return super(AlcatelSrosSSH, self).enable(
            cmd=cmd, pattern=pattern, re_flags=re_flags
        )

    def check_enable_mode(self, check_string="CLI Already in admin mode"):
        """Check whether we are in enable-admin mode.
         SROS requires us to do this:
        *A:HOSTNAME# enable-admin
        MINOR: CLI Already in admin mode.
        *A:HOSTNAME#
        *A:HOSTNAME# enable-admin
        Password:
        MINOR: CLI Invalid password.
        *A:HOSTNAME#
        """
        output = self.send_command_timing("enable-admin")
        if re.search(r"ssword", output):
            # Just hit enter as we don't actually want to enter enable here
            self.write_channel(self.normalize_cmd(self.RETURN))
            self.read_until_prompt()
            return False
        elif check_string in output:
            return True
        raise ValueError("Unexpected response in check_enable_mode() method")

    def exit_enable_mode(self, exit_command=""):
        """No corresponding exit of enable mode on SROS."""
        pass

    def config_mode(self, config_command="configure", pattern="#"):
        """ Enter into configuration mode on SROS device."""
        return super(AlcatelSrosSSH, self).config_mode(
            config_command=config_command, pattern=pattern
        )

    def exit_config_mode(self, exit_config="exit all", pattern="#"):
        """ Exit from configuration mode."""
        return super(AlcatelSrosSSH, self).exit_config_mode(
            exit_config=exit_config, pattern=pattern
        )

    def check_config_mode(self, check_string="config", pattern="#"):
        """ Checks if the device is in configuration mode or not. """
        return super(AlcatelSrosSSH, self).check_config_mode(
            check_string=check_string, pattern=pattern
        )

    def save_config(self, *args, **kwargs):
        """Not Implemented"""
        raise NotImplementedError

Ancestors

Methods

def check_config_mode(self, check_string='config', pattern='#')

Checks if the device is in configuration mode or not.

Source code 
def check_config_mode(self, check_string="config", pattern="#"):
    """ Checks if the device is in configuration mode or not. """
    return super(AlcatelSrosSSH, self).check_config_mode(
        check_string=check_string, pattern=pattern
    )
def check_enable_mode(self, check_string='CLI Already in admin mode')

Check whether we are in enable-admin mode. SROS requires us to do this: A:HOSTNAME# enable-admin MINOR: CLI Already in admin mode. A:HOSTNAME# A:HOSTNAME# enable-admin Password: MINOR: CLI Invalid password. A:HOSTNAME#

Source code 
def check_enable_mode(self, check_string="CLI Already in admin mode"):
    """Check whether we are in enable-admin mode.
     SROS requires us to do this:
    *A:HOSTNAME# enable-admin
    MINOR: CLI Already in admin mode.
    *A:HOSTNAME#
    *A:HOSTNAME# enable-admin
    Password:
    MINOR: CLI Invalid password.
    *A:HOSTNAME#
    """
    output = self.send_command_timing("enable-admin")
    if re.search(r"ssword", output):
        # Just hit enter as we don't actually want to enter enable here
        self.write_channel(self.normalize_cmd(self.RETURN))
        self.read_until_prompt()
        return False
    elif check_string in output:
        return True
    raise ValueError("Unexpected response in check_enable_mode() method")
def config_mode(self, config_command='configure', pattern='#')

Enter into configuration mode on SROS device.

Source code 
def config_mode(self, config_command="configure", pattern="#"):
    """ Enter into configuration mode on SROS device."""
    return super(AlcatelSrosSSH, self).config_mode(
        config_command=config_command, pattern=pattern
    )
def exit_enable_mode(self, exit_command='')

No corresponding exit of enable mode on SROS.

Source code 
def exit_enable_mode(self, exit_command=""):
    """No corresponding exit of enable mode on SROS."""
    pass
def save_config(self, *args, **kwargs)

Not Implemented

Source code 
def save_config(self, *args, **kwargs):
    """Not Implemented"""
    raise NotImplementedError
def set_base_prompt(self, *args, **kwargs)

Remove the > when navigating into the different config level.

Source code 
def set_base_prompt(self, *args, **kwargs):
    """Remove the > when navigating into the different config level."""
    cur_base_prompt = super(AlcatelSrosSSH, self).set_base_prompt(*args, **kwargs)
    match = re.search(r"(.*)(>.*)*#", cur_base_prompt)
    if match:
        # strip off >... from base_prompt
        self.base_prompt = match.group(1)
        return self.base_prompt

Inherited members