Module netmiko.juniper.juniper

Classes

class JuniperBase (ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = 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: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Implement methods for interacting with Juniper Networks devices.

methods. Overrides several methods for Juniper-specific compatibility.

    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)

Expand source code

class JuniperBase(NoEnable, BaseConnection):
    """
    Implement methods for interacting with Juniper Networks devices.

    methods.  Overrides several methods for Juniper-specific compatibility.
    """

    def session_preparation(self) -> None:
        """Prepare the session after the connection has been established."""
        pattern = r"[%>$#]"
        self._test_channel_read(pattern=pattern)
        self.enter_cli_mode()

        cmd = "set cli screen-width 511"
        self.set_terminal_width(command=cmd, pattern=r"Screen width set to")
        # Overloading disable_paging which is confusing
        self.disable_paging(
            command="set cli complete-on-space off",
            pattern=r"Disabling complete-on-space",
        )
        self.disable_paging(
            command="set cli screen-length 0", pattern=r"Screen length set to"
        )
        self.set_base_prompt()

    def _enter_shell(self) -> str:
        """Enter the Bourne Shell."""
        return self._send_command_str("start shell sh", expect_string=r"[\$#]")

    def _return_cli(self) -> str:
        """Return to the Juniper CLI."""
        return self._send_command_str("exit", expect_string=r"[#>]")

    def _determine_mode(self, data: str = "") -> str:
        """Determine whether in shell or CLI."""
        pattern = r"[%>$#]"
        if not data:
            self.write_channel(self.RETURN)
            data = self.read_until_pattern(pattern=pattern, read_timeout=10)

        shell_pattern = r"(?:root@|%|\$)"
        if re.search(shell_pattern, data):
            return "shell"
        elif ">" in data or "#" in data:
            return "cli"
        else:
            raise ValueError(f"Unexpected data returned for prompt: {data}")

    def enter_cli_mode(self) -> None:
        """Check if at shell prompt root@ and go into CLI."""
        mode = self._determine_mode()
        if mode == "shell":
            shell_pattern = r"(?:root@|%|\$)"
            self.write_channel(self.RETURN)
            cur_prompt = self.read_until_pattern(pattern=shell_pattern, read_timeout=10)
            if re.search(r"root@", cur_prompt) or re.search(r"^%$", cur_prompt.strip()):
                cli_pattern = r"[>#]"
                self.write_channel("cli" + self.RETURN)
                self.read_until_pattern(pattern=cli_pattern, read_timeout=10)
        return

    def check_config_mode(
        self,
        check_string: str = "]",
        pattern: str = r"(?m:[>#] $)",
        force_regex: bool = False,
    ) -> bool:
        """
        Checks if the device is in configuration mode or not.

        ?m = Use multiline matching

        Juniper unfortunately will use # as a message indicator when not in config mode
        For example, with commit confirmed.

        """
        return super().check_config_mode(check_string=check_string, pattern=pattern)

    def config_mode(
        self,
        config_command: str = "configure",
        pattern: str = r"(?s:Entering configuration mode.*\].*#)",
        re_flags: int = 0,
    ) -> str:
        """
        Enter configuration mode.

        ?s = enables re.DOTALL in regex pattern.
        """
        return super().config_mode(
            config_command=config_command, pattern=pattern, re_flags=re_flags
        )

    def exit_config_mode(
        self, exit_config: str = "exit configuration-mode", pattern: str = ""
    ) -> str:
        """Exit configuration mode."""
        output = ""
        if self.check_config_mode():
            confirm_msg = "Exit with uncommitted changes"
            pattern = rf"(?:>|{confirm_msg})"
            output = self._send_command_str(
                exit_config,
                expect_string=pattern,
                strip_prompt=False,
                strip_command=False,
            )
            if confirm_msg in output:
                output += self._send_command_str(
                    "yes", expect_string=r">", strip_prompt=False, strip_command=False
                )
            if self.check_config_mode():
                raise ValueError("Failed to exit configuration mode")
        return output

    def commit(
        self,
        confirm: bool = False,
        confirm_delay: Optional[int] = None,
        check: bool = False,
        comment: str = "",
        and_quit: bool = False,
        read_timeout: float = 120.0,
        delay_factor: Optional[float] = None,
    ) -> str:
        """
        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: Deprecated in Netmiko 4.x. Will be eliminated in Netmiko 5.

        """

        if delay_factor is not None:
            warnings.warn(DELAY_FACTOR_DEPR_SIMPLE_MSG, DeprecationWarning)
        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 = "configuration check succeeds"
        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

        # hostname might change on commit, and-quit might result in exiting config mode.
        re_prompt = re.escape(self.base_prompt)
        expect_string = rf"(?:{re_prompt}|[>#])"
        output += self._send_command_str(
            command_string,
            expect_string=expect_string,
            strip_prompt=False,
            strip_command=False,
            read_timeout=read_timeout,
        )

        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: Any, **kwargs: Any) -> str:
        """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: str) -> str:
        """Strip Juniper-specific output.

        Juniper will also put a configuration context:
        [edit]

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

        This method removes those lines.
        """
        strings_to_strip = [
            r"\[edit.*\]",
            r"\{master:?.*\}",
            r"\{backup:?.*\}",
            r"\{line.*\}",
            r"\{primary.*\}",
            r"\{secondary.*\}",
        ]

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

    def cleanup(self, command: str = "exit") -> None:
        """Gracefully exit the SSH session."""
        try:
            if self.check_config_mode():
                self.exit_config_mode()
        except Exception:
            pass
        # Always try to send final 'exit' (command)
        self._session_log_fin = True
        self.write_channel(command + self.RETURN)

Ancestors

• NoEnable
• BaseConnection

Subclasses

• JuniperSSH
• JuniperTelnet

Methods

def check_config_mode(self, check_string: str = ']', pattern: str = '(?m:[>#] $)', force_regex: bool = False) ‑> bool

Checks if the device is in configuration mode or not.

?m = Use multiline matching

Juniper unfortunately will use # as a message indicator when not in config mode For example, with commit confirmed.

Expand source code

def check_config_mode(
    self,
    check_string: str = "]",
    pattern: str = r"(?m:[>#] $)",
    force_regex: bool = False,
) -> bool:
    """
    Checks if the device is in configuration mode or not.

    ?m = Use multiline matching

    Juniper unfortunately will use # as a message indicator when not in config mode
    For example, with commit confirmed.

    """
    return super().check_config_mode(check_string=check_string, pattern=pattern)

def cleanup(self, command: str = 'exit') ‑> None

Gracefully exit the SSH session.

Expand source code

def cleanup(self, command: str = "exit") -> None:
    """Gracefully exit the SSH session."""
    try:
        if self.check_config_mode():
            self.exit_config_mode()
    except Exception:
        pass
    # Always try to send final 'exit' (command)
    self._session_log_fin = True
    self.write_channel(command + self.RETURN)

def commit(self, confirm: bool = False, confirm_delay: Optional[int] = None, check: bool = False, comment: str = '', and_quit: bool = False, read_timeout: float = 120.0, delay_factor: Optional[float] = None) ‑> str

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

delay_factor: Deprecated in Netmiko 4.x. Will be eliminated in Netmiko 5.

Expand source code

def commit(
    self,
    confirm: bool = False,
    confirm_delay: Optional[int] = None,
    check: bool = False,
    comment: str = "",
    and_quit: bool = False,
    read_timeout: float = 120.0,
    delay_factor: Optional[float] = None,
) -> str:
    """
    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: Deprecated in Netmiko 4.x. Will be eliminated in Netmiko 5.

    """

    if delay_factor is not None:
        warnings.warn(DELAY_FACTOR_DEPR_SIMPLE_MSG, DeprecationWarning)
    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 = "configuration check succeeds"
    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

    # hostname might change on commit, and-quit might result in exiting config mode.
    re_prompt = re.escape(self.base_prompt)
    expect_string = rf"(?:{re_prompt}|[>#])"
    output += self._send_command_str(
        command_string,
        expect_string=expect_string,
        strip_prompt=False,
        strip_command=False,
        read_timeout=read_timeout,
    )

    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: str = 'configure', pattern: str = '(?s:Entering configuration mode.*\\].*#)', re_flags: int = 0) ‑> str

Enter configuration mode.

?s = enables re.DOTALL in regex pattern.

Expand source code

def config_mode(
    self,
    config_command: str = "configure",
    pattern: str = r"(?s:Entering configuration mode.*\].*#)",
    re_flags: int = 0,
) -> str:
    """
    Enter configuration mode.

    ?s = enables re.DOTALL in regex pattern.
    """
    return super().config_mode(
        config_command=config_command, pattern=pattern, re_flags=re_flags
    )

def enter_cli_mode(self) ‑> None

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

Expand source code

def enter_cli_mode(self) -> None:
    """Check if at shell prompt root@ and go into CLI."""
    mode = self._determine_mode()
    if mode == "shell":
        shell_pattern = r"(?:root@|%|\$)"
        self.write_channel(self.RETURN)
        cur_prompt = self.read_until_pattern(pattern=shell_pattern, read_timeout=10)
        if re.search(r"root@", cur_prompt) or re.search(r"^%$", cur_prompt.strip()):
            cli_pattern = r"[>#]"
            self.write_channel("cli" + self.RETURN)
            self.read_until_pattern(pattern=cli_pattern, read_timeout=10)
    return

def exit_config_mode(self, exit_config: str = 'exit configuration-mode', pattern: str = '') ‑> str

Exit configuration mode.

Expand source code

def exit_config_mode(
    self, exit_config: str = "exit configuration-mode", pattern: str = ""
) -> str:
    """Exit configuration mode."""
    output = ""
    if self.check_config_mode():
        confirm_msg = "Exit with uncommitted changes"
        pattern = rf"(?:>|{confirm_msg})"
        output = self._send_command_str(
            exit_config,
            expect_string=pattern,
            strip_prompt=False,
            strip_command=False,
        )
        if confirm_msg in output:
            output += self._send_command_str(
                "yes", expect_string=r">", strip_prompt=False, strip_command=False
            )
        if self.check_config_mode():
            raise ValueError("Failed to exit configuration mode")
    return output

def session_preparation(self) ‑> None

Prepare the session after the connection has been established.

Expand source code

def session_preparation(self) -> None:
    """Prepare the session after the connection has been established."""
    pattern = r"[%>$#]"
    self._test_channel_read(pattern=pattern)
    self.enter_cli_mode()

    cmd = "set cli screen-width 511"
    self.set_terminal_width(command=cmd, pattern=r"Screen width set to")
    # Overloading disable_paging which is confusing
    self.disable_paging(
        command="set cli complete-on-space off",
        pattern=r"Disabling complete-on-space",
    )
    self.disable_paging(
        command="set cli screen-length 0", pattern=r"Screen length set to"
    )
    self.set_base_prompt()

def strip_context_items(self, a_string: str) ‑> str

Strip Juniper-specific output.

Juniper will also put a configuration context: [edit]

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

This method removes those lines.

Expand source code

def strip_context_items(self, a_string: str) -> str:
    """Strip Juniper-specific output.

    Juniper will also put a configuration context:
    [edit]

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

    This method removes those lines.
    """
    strings_to_strip = [
        r"\[edit.*\]",
        r"\{master:?.*\}",
        r"\{backup:?.*\}",
        r"\{line.*\}",
        r"\{primary.*\}",
        r"\{secondary.*\}",
    ]

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

def strip_prompt(self, *args: Any, **kwargs: Any) ‑> str

Strip the trailing router prompt from the output.

Expand source code

def strip_prompt(self, *args: Any, **kwargs: Any) -> str:
    """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:
  • check_enable_mode
  • clear_buffer
  • disable_paging
  • disconnect
  • enable
  • establish_connection
  • exit_enable_mode
  • find_prompt
  • is_alive
  • normalize_cmd
  • normalize_linefeeds
  • paramiko_cleanup
  • read_channel
  • read_channel_timing
  • 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
  • send_multiline
  • set_base_prompt
  • set_terminal_width
  • special_login_handler
  • strip_ansi_escape_codes
  • strip_backspaces
  • strip_command
  • telnet_login
  • write_channel

class JuniperFileTransfer (ssh_conn: BaseConnection, source_file: str, dest_file: str, file_system: Optional[str] = '/var/tmp', direction: str = 'put', **kwargs: Any)

Juniper SCP File Transfer driver.

Expand source code

class JuniperFileTransfer(BaseFileTransfer):
    """Juniper SCP File Transfer driver."""

    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."""
        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 boolean)."""
        return self._check_file_exists_unix(remote_cmd=remote_cmd)

    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
        )

    def remote_md5(
        self, base_cmd: str = "file checksum md5", remote_file: Optional[str] = None
    ) -> str:
        return super().remote_md5(base_cmd=base_cmd, remote_file=remote_file)

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

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

Ancestors

• BaseFileTransfer

Inherited members

• BaseFileTransfer:
  • check_file_exists
  • close_scp_chan
  • compare_md5
  • disable_scp
  • enable_scp
  • establish_scp_conn
  • file_md5
  • get_file
  • local_space_available
  • process_md5
  • put_file
  • remote_file_size
  • remote_md5
  • remote_space_available
  • transfer_file
  • verify_file
  • verify_space_available

class JuniperSSH (ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = 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: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, sock_telnet: Optional[Dict[str, Any]] = None, auto_connect: bool = True, delay_factor_compat: bool = False, disable_lf_normalization: bool = False)

Implement methods for interacting with Juniper Networks devices.

methods. Overrides several methods for Juniper-specific compatibility.

    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)

Expand source code

class JuniperSSH(JuniperBase):
    pass

Ancestors

• JuniperBase
• NoEnable
• BaseConnection

Inherited members

• JuniperBase:
  • check_config_mode
  • check_enable_mode
  • cleanup
  • clear_buffer
  • commit
  • config_mode
  • disable_paging
  • disconnect
  • enable
  • enter_cli_mode
  • establish_connection
  • exit_config_mode
  • exit_enable_mode
  • find_prompt
  • is_alive
  • normalize_cmd
  • normalize_linefeeds
  • paramiko_cleanup
  • read_channel
  • read_channel_timing
  • 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
  • send_multiline
  • session_preparation
  • set_base_prompt
  • set_terminal_width
  • special_login_handler
  • strip_ansi_escape_codes
  • strip_backspaces
  • strip_command
  • strip_context_items
  • strip_prompt
  • telnet_login
  • write_channel

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

Implement methods for interacting with Juniper Networks devices.

methods. Overrides several methods for Juniper-specific compatibility.

    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)

Expand source code

class JuniperTelnet(JuniperBase):
    def __init__(self, *args: Any, **kwargs: Any) -> None:
        default_enter = kwargs.get("default_enter")
        kwargs["default_enter"] = "\r\n" if default_enter is None else default_enter
        super().__init__(*args, **kwargs)

Ancestors

• JuniperBase
• NoEnable
• BaseConnection

Inherited members

• JuniperBase:
  • check_config_mode
  • check_enable_mode
  • cleanup
  • clear_buffer
  • commit
  • config_mode
  • disable_paging
  • disconnect
  • enable
  • enter_cli_mode
  • establish_connection
  • exit_config_mode
  • exit_enable_mode
  • find_prompt
  • is_alive
  • normalize_cmd
  • normalize_linefeeds
  • paramiko_cleanup
  • read_channel
  • read_channel_timing
  • 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
  • send_multiline
  • session_preparation
  • set_base_prompt
  • set_terminal_width
  • special_login_handler
  • strip_ansi_escape_codes
  • strip_backspaces
  • strip_command
  • strip_context_items
  • strip_prompt
  • telnet_login
  • write_channel