Module netmiko.vyos.vyos_ssh

Classes

class VyOSSSH (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)

Implement methods for interacting with VyOS network devices.

    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 VyOSSSH(CiscoSSHConnection):
    """Implement methods for interacting with VyOS network devices."""

    def session_preparation(self):
        """Prepare the session after the connection has been established."""
        self._test_channel_read()
        self.set_base_prompt()
        self.set_terminal_width(command="set terminal width 512", pattern="terminal")
        self.disable_paging(command="set terminal length 0")
        # Clear the read buffer
        time.sleep(0.3 * self.global_delay_factor)
        self.clear_buffer()

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

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

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

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

    def config_mode(self, config_command="configure", pattern=r"[edit]"):
        """Enter configuration mode."""
        return super().config_mode(config_command=config_command, pattern=pattern)

    def exit_config_mode(self, exit_config="exit", pattern=r"exit"):
        """Exit configuration mode"""
        output = ""
        if self.check_config_mode():
            output = self.send_command_timing(
                exit_config, strip_prompt=False, strip_command=False
            )
            if "Cannot exit: configuration modified" in output:
                output += self.send_command_timing(
                    "exit discard", strip_prompt=False, strip_command=False
                )
            if self.check_config_mode():
                raise ValueError("Failed to exit configuration mode")
        return output

    def commit(self, comment="", delay_factor=0.1):
        """
        Commit the candidate configuration.

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

        default:
           command_string = commit
        comment:
           command_string = commit comment <comment>

        """
        delay_factor = self.select_delay_factor(delay_factor)
        error_marker = ["Failed to generate committed config", "Commit failed"]
        command_string = "commit"

        if comment:
            command_string += f' comment "{comment}"'

        output = self.config_mode()
        output += self.send_command_expect(
            command_string,
            strip_prompt=False,
            strip_command=False,
            delay_factor=delay_factor,
        )

        if any(x in output for x in error_marker):
            raise ValueError(f"Commit failed with following errors:\n\n{output}")
        return output

    def set_base_prompt(
        self, pri_prompt_terminator="$", alt_prompt_terminator="#", delay_factor=1
    ):
        """Sets self.base_prompt: used as delimiter for stripping of trailing prompt in output."""
        prompt = super().set_base_prompt(
            pri_prompt_terminator=pri_prompt_terminator,
            alt_prompt_terminator=alt_prompt_terminator,
            delay_factor=delay_factor,
        )
        # Set prompt to user@hostname (remove two additional characters)
        self.base_prompt = prompt[:-2].strip()
        return self.base_prompt

    def send_config_set(self, config_commands=None, exit_config_mode=False, **kwargs):
        """Remain in configuration mode."""
        return super().send_config_set(
            config_commands=config_commands, exit_config_mode=exit_config_mode, **kwargs
        )

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

Ancestors

• CiscoSSHConnection
• CiscoBaseConnection
• BaseConnection

Subclasses

• UbiquitiEdgeRouterSSH

Methods

def check_config_mode(self, check_string='#')

Checks if the device is in configuration mode

Source code

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

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

No enable mode on VyOS.

Source code

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

def commit(self, comment='', delay_factor=0.1)

Commit the candidate configuration.

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

default: command_string = commit comment: command_string = commit comment

Source code

def commit(self, comment="", delay_factor=0.1):
    """
    Commit the candidate configuration.

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

    default:
       command_string = commit
    comment:
       command_string = commit comment <comment>

    """
    delay_factor = self.select_delay_factor(delay_factor)
    error_marker = ["Failed to generate committed config", "Commit failed"]
    command_string = "commit"

    if comment:
        command_string += f' comment "{comment}"'

    output = self.config_mode()
    output += self.send_command_expect(
        command_string,
        strip_prompt=False,
        strip_command=False,
        delay_factor=delay_factor,
    )

    if any(x in output for x in error_marker):
        raise ValueError(f"Commit failed with following errors:\n\n{output}")
    return output

def config_mode(self, config_command='configure', pattern='[edit]')

Enter configuration mode.

Source code

def config_mode(self, config_command="configure", pattern=r"[edit]"):
    """Enter configuration mode."""
    return super().config_mode(config_command=config_command, pattern=pattern)

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

No enable mode on VyOS.

Source code

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

def exit_config_mode(self, exit_config='exit', pattern='exit')

Exit configuration mode

Source code

def exit_config_mode(self, exit_config="exit", pattern=r"exit"):
    """Exit configuration mode"""
    output = ""
    if self.check_config_mode():
        output = self.send_command_timing(
            exit_config, strip_prompt=False, strip_command=False
        )
        if "Cannot exit: configuration modified" in output:
            output += self.send_command_timing(
                "exit discard", 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 VyOS.

Source code

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

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

Not Implemented

Source code

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

def send_config_set(self, config_commands=None, exit_config_mode=False, **kwargs)

Remain in configuration mode.

Source code

def send_config_set(self, config_commands=None, exit_config_mode=False, **kwargs):
    """Remain in configuration mode."""
    return super().send_config_set(
        config_commands=config_commands, exit_config_mode=exit_config_mode, **kwargs
    )

def session_preparation(self)

Prepare the session after the connection has been established.

Source code

def session_preparation(self):
    """Prepare the session after the connection has been established."""
    self._test_channel_read()
    self.set_base_prompt()
    self.set_terminal_width(command="set terminal width 512", pattern="terminal")
    self.disable_paging(command="set terminal length 0")
    # Clear the read buffer
    time.sleep(0.3 * self.global_delay_factor)
    self.clear_buffer()

def set_base_prompt(self, pri_prompt_terminator='$', alt_prompt_terminator='#', delay_factor=1)

Sets self.base_prompt: used as delimiter for stripping of trailing prompt in output.

Source code

def set_base_prompt(
    self, pri_prompt_terminator="$", alt_prompt_terminator="#", delay_factor=1
):
    """Sets self.base_prompt: used as delimiter for stripping of trailing prompt in output."""
    prompt = super().set_base_prompt(
        pri_prompt_terminator=pri_prompt_terminator,
        alt_prompt_terminator=alt_prompt_terminator,
        delay_factor=delay_factor,
    )
    # Set prompt to user@hostname (remove two additional characters)
    self.base_prompt = prompt[:-2].strip()
    return self.base_prompt

Inherited members

• CiscoSSHConnection:
  • 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
  • select_delay_factor
  • send_command
  • send_command_expect
  • send_command_timing
  • send_config_from_file
  • set_terminal_width
  • special_login_handler
  • strip_ansi_escape_codes
  • strip_backspaces
  • strip_command
  • strip_prompt
  • telnet_login
  • write_channel