Module netmiko.flexvnf.flexvnf_ssh

Classes

class FlexvnfSSH (ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, 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, conn_timeout=5, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, 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', sock=None, auto_connect=True)

Defines vendor independent methods.

Otherwise method left as a stub method.

    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

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

    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
            (default: None). Global attribute takes precedence over function `cmd_verify`
            argument. Value of `None` indicates to use function `cmd_verify` argument.
    :type global_cmd_verify: bool|None

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

Source code

class FlexvnfSSH(BaseConnection):
    def session_preparation(self):
        """
        Prepare the session after the connection has been established.

        Disable paging (the '--more--' prompts).
        Set the base prompt for interaction ('>').
        """
        self._test_channel_read()
        self.enter_cli_mode()
        self.set_base_prompt()
        self.set_terminal_width(command="set screen width 511", pattern="set")
        self.disable_paging(command="set screen length 0")
        # Clear the read buffer
        time.sleep(0.3 * self.global_delay_factor)
        self.clear_buffer()

    def enter_cli_mode(self):
        """Check if at shell prompt root@ and go into CLI."""
        delay_factor = self.select_delay_factor(delay_factor=0)
        count = 0
        cur_prompt = ""
        while count < 50:
            self.write_channel(self.RETURN)
            time.sleep(0.1 * delay_factor)
            cur_prompt = self.read_channel()
            if re.search(r"admin@", cur_prompt) or re.search(
                r"^\$$", cur_prompt.strip()
            ):
                self.write_channel("cli" + self.RETURN)
                time.sleep(0.3 * delay_factor)
                self.clear_buffer()
                break
            elif ">" in cur_prompt or "%" in cur_prompt:
                break
            count += 1

    def check_enable_mode(self, *args, **kwargs):
        """No enable mode on flexvnf."""
        pass

    def enable(self, *args, **kwargs):
        """No enable mode on flexvnf."""
        pass

    def exit_enable_mode(self, *args, **kwargs):
        """No enable mode on flexvnf."""
        pass

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

    def config_mode(self, config_command="configure"):
        """Enter configuration mode."""
        return super().config_mode(config_command=config_command)

    def exit_config_mode(self, exit_config="exit configuration-mode"):
        """Exit configuration mode."""
        output = ""
        if self.check_config_mode():
            output = self.send_command_timing(
                exit_config, strip_prompt=False, strip_command=False
            )
            # if 'Exit with uncommitted changes?' in output:
            if "uncommitted changes" in output:
                output += self.send_command_timing(
                    "yes", strip_prompt=False, strip_command=False
                )
            if self.check_config_mode():
                raise ValueError("Failed to exit configuration mode")
        return output

    def commit(
        self,
        confirm=False,
        confirm_delay=None,
        check=False,
        comment="",
        and_quit=False,
        delay_factor=1,
    ):
        """
        Commit the candidate configuration.

        Commit the entered configuration. Raise an error and return the failure
        if the commit fails.

        Automatically enters configuration mode

        default:
            command_string = commit
        check and (confirm or confirm_dely or comment):
            Exception
        confirm_delay and no confirm:
            Exception
        confirm:
            confirm_delay option
            comment option
            command_string = commit confirmed or commit confirmed <confirm_delay>
        check:
            command_string = commit check

        """
        delay_factor = self.select_delay_factor(delay_factor)

        if check and (confirm or confirm_delay or comment):
            raise ValueError("Invalid arguments supplied with commit check")

        if confirm_delay and not confirm:
            raise ValueError(
                "Invalid arguments supplied to commit method both confirm and check"
            )

        # Select proper command string based on arguments provided
        command_string = "commit"
        commit_marker = "Commit complete."
        if check:
            command_string = "commit check"
            commit_marker = "Validation complete"
        elif confirm:
            if confirm_delay:
                command_string = "commit confirmed " + str(confirm_delay)
            else:
                command_string = "commit confirmed"
            commit_marker = "commit confirmed will be automatically rolled back in"

        # wrap the comment in quotes
        if comment:
            if '"' in comment:
                raise ValueError("Invalid comment contains double quote")
            comment = f'"{comment}"'
            command_string += " comment " + comment

        if and_quit:
            command_string += " and-quit"

        # Enter config mode (if necessary)
        output = self.config_mode()
        # and_quit will get out of config mode on commit
        if and_quit:
            prompt = self.base_prompt
            output += self.send_command_expect(
                command_string,
                expect_string=prompt,
                strip_prompt=True,
                strip_command=True,
                delay_factor=delay_factor,
            )
        else:
            output += self.send_command_expect(
                command_string,
                strip_prompt=True,
                strip_command=True,
                delay_factor=delay_factor,
            )

        if commit_marker not in output:
            raise ValueError(f"Commit failed with the following errors:\n\n{output}")

        return output

    def strip_prompt(self, *args, **kwargs):
        """Strip the trailing router prompt from the output."""
        a_string = super().strip_prompt(*args, **kwargs)
        return self.strip_context_items(a_string)

    def strip_context_items(self, a_string):
        """Strip FLEXVNF-specific output.

        FLEXVNF will also put a configuration context:
        [edit]

        and various chassis contexts:
        {master:0}, {backup:1}

        This method removes those lines.
        """
        strings_to_strip = [
            r"admin@lab-pg-dev-cp02v.*",
            r"\[edit.*\]",
            r"\[edit\]",
            r"\[ok\]",
            r"\[.*\]",
            r"\{master:.*\}",
            r"\{backup:.*\}",
            r"\{line.*\}",
            r"\{primary.*\}",
            r"\{secondary.*\}",
        ]

        response_list = a_string.split(self.RESPONSE_RETURN)
        last_line = response_list[0]

        for pattern in strings_to_strip:
            if re.search(pattern, last_line):
                return self.RESPONSE_RETURN.join(response_list[:-1])
        return a_string

Ancestors

• BaseConnection

Methods

def check_config_mode(self, check_string=']')

Checks if the device is in configuration mode or not.

Source code

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

def check_enable_mode(self, *args, **kwargs)

No enable mode on flexvnf.

Source code

def check_enable_mode(self, *args, **kwargs):
    """No enable mode on flexvnf."""
    pass

def commit(self, confirm=False, confirm_delay=None, check=False, comment='', and_quit=False, delay_factor=1)

Commit the candidate configuration.

Commit the entered configuration. Raise an error and return the failure if the commit fails.

Automatically enters configuration mode

default: command_string = commit check and (confirm or confirm_dely or comment): Exception confirm_delay and no confirm: Exception confirm: confirm_delay option comment option command_string = commit confirmed or commit confirmed check: command_string = commit check

Source code

def commit(
    self,
    confirm=False,
    confirm_delay=None,
    check=False,
    comment="",
    and_quit=False,
    delay_factor=1,
):
    """
    Commit the candidate configuration.

    Commit the entered configuration. Raise an error and return the failure
    if the commit fails.

    Automatically enters configuration mode

    default:
        command_string = commit
    check and (confirm or confirm_dely or comment):
        Exception
    confirm_delay and no confirm:
        Exception
    confirm:
        confirm_delay option
        comment option
        command_string = commit confirmed or commit confirmed <confirm_delay>
    check:
        command_string = commit check

    """
    delay_factor = self.select_delay_factor(delay_factor)

    if check and (confirm or confirm_delay or comment):
        raise ValueError("Invalid arguments supplied with commit check")

    if confirm_delay and not confirm:
        raise ValueError(
            "Invalid arguments supplied to commit method both confirm and check"
        )

    # Select proper command string based on arguments provided
    command_string = "commit"
    commit_marker = "Commit complete."
    if check:
        command_string = "commit check"
        commit_marker = "Validation complete"
    elif confirm:
        if confirm_delay:
            command_string = "commit confirmed " + str(confirm_delay)
        else:
            command_string = "commit confirmed"
        commit_marker = "commit confirmed will be automatically rolled back in"

    # wrap the comment in quotes
    if comment:
        if '"' in comment:
            raise ValueError("Invalid comment contains double quote")
        comment = f'"{comment}"'
        command_string += " comment " + comment

    if and_quit:
        command_string += " and-quit"

    # Enter config mode (if necessary)
    output = self.config_mode()
    # and_quit will get out of config mode on commit
    if and_quit:
        prompt = self.base_prompt
        output += self.send_command_expect(
            command_string,
            expect_string=prompt,
            strip_prompt=True,
            strip_command=True,
            delay_factor=delay_factor,
        )
    else:
        output += self.send_command_expect(
            command_string,
            strip_prompt=True,
            strip_command=True,
            delay_factor=delay_factor,
        )

    if commit_marker not in output:
        raise ValueError(f"Commit failed with the following errors:\n\n{output}")

    return output

def config_mode(self, config_command='configure')

Enter configuration mode.

Source code

def config_mode(self, config_command="configure"):
    """Enter configuration mode."""
    return super().config_mode(config_command=config_command)

def enable(self, *args, **kwargs)

No enable mode on flexvnf.

Source code

def enable(self, *args, **kwargs):
    """No enable mode on flexvnf."""
    pass

def enter_cli_mode(self)

Check if at shell prompt root@ and go into CLI.

Source code

def enter_cli_mode(self):
    """Check if at shell prompt root@ and go into CLI."""
    delay_factor = self.select_delay_factor(delay_factor=0)
    count = 0
    cur_prompt = ""
    while count < 50:
        self.write_channel(self.RETURN)
        time.sleep(0.1 * delay_factor)
        cur_prompt = self.read_channel()
        if re.search(r"admin@", cur_prompt) or re.search(
            r"^\$$", cur_prompt.strip()
        ):
            self.write_channel("cli" + self.RETURN)
            time.sleep(0.3 * delay_factor)
            self.clear_buffer()
            break
        elif ">" in cur_prompt or "%" in cur_prompt:
            break
        count += 1

def exit_config_mode(self, exit_config='exit configuration-mode')

Exit configuration mode.

Source code

def exit_config_mode(self, exit_config="exit configuration-mode"):
    """Exit configuration mode."""
    output = ""
    if self.check_config_mode():
        output = self.send_command_timing(
            exit_config, strip_prompt=False, strip_command=False
        )
        # if 'Exit with uncommitted changes?' in output:
        if "uncommitted changes" in output:
            output += self.send_command_timing(
                "yes", strip_prompt=False, strip_command=False
            )
        if self.check_config_mode():
            raise ValueError("Failed to exit configuration mode")
    return output

def exit_enable_mode(self, *args, **kwargs)

No enable mode on flexvnf.

Source code

def exit_enable_mode(self, *args, **kwargs):
    """No enable mode on flexvnf."""
    pass

def session_preparation(self)

Prepare the session after the connection has been established.

Disable paging (the '–more–' prompts). Set the base prompt for interaction ('>').

Source code

def session_preparation(self):
    """
    Prepare the session after the connection has been established.

    Disable paging (the '--more--' prompts).
    Set the base prompt for interaction ('>').
    """
    self._test_channel_read()
    self.enter_cli_mode()
    self.set_base_prompt()
    self.set_terminal_width(command="set screen width 511", pattern="set")
    self.disable_paging(command="set screen length 0")
    # Clear the read buffer
    time.sleep(0.3 * self.global_delay_factor)
    self.clear_buffer()

def strip_context_items(self, a_string)

Strip FLEXVNF-specific output.

FLEXVNF will also put a configuration context: [edit]

and various chassis contexts: {master:0}, {backup:1}

This method removes those lines.

Source code

def strip_context_items(self, a_string):
    """Strip FLEXVNF-specific output.

    FLEXVNF will also put a configuration context:
    [edit]

    and various chassis contexts:
    {master:0}, {backup:1}

    This method removes those lines.
    """
    strings_to_strip = [
        r"admin@lab-pg-dev-cp02v.*",
        r"\[edit.*\]",
        r"\[edit\]",
        r"\[ok\]",
        r"\[.*\]",
        r"\{master:.*\}",
        r"\{backup:.*\}",
        r"\{line.*\}",
        r"\{primary.*\}",
        r"\{secondary.*\}",
    ]

    response_list = a_string.split(self.RESPONSE_RETURN)
    last_line = response_list[0]

    for pattern in strings_to_strip:
        if re.search(pattern, last_line):
            return self.RESPONSE_RETURN.join(response_list[:-1])
    return a_string

def strip_prompt(self, *args, **kwargs)

Strip the trailing router prompt from the output.

Source code

def strip_prompt(self, *args, **kwargs):
    """Strip the trailing router prompt from the output."""
    a_string = super().strip_prompt(*args, **kwargs)
    return self.strip_context_items(a_string)

Inherited members

• BaseConnection:
  • cleanup
  • clear_buffer
  • close_session_log
  • disable_paging
  • disconnect
  • establish_connection
  • find_prompt
  • is_alive
  • normalize_cmd
  • normalize_linefeeds
  • open_session_log
  • paramiko_cleanup
  • read_channel
  • read_until_pattern
  • read_until_prompt
  • read_until_prompt_or_pattern
  • run_ttp
  • save_config
  • select_delay_factor
  • send_command
  • send_command_expect
  • send_command_timing
  • send_config_from_file
  • send_config_set
  • set_base_prompt
  • set_terminal_width
  • special_login_handler
  • strip_ansi_escape_codes
  • strip_backspaces
  • strip_command
  • telnet_login
  • write_channel