Module netmiko.furukawa.furukawa_fitelnet

Classes

class FurukawaFitelnetBase (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 FurukawaFitelnetBase(CiscoBaseConnection):
    """Common methods for Furukawa FITELnet VPN routers.

    FITELnet prompts vary by model:
    - Bare prompts: ">" (user mode), "#" (enable mode)
    - Hostname prompts: "F220>", "F220#", "F220(config)#",
      "F220(config-GigaEthernet1/1)#", etc.
    """

    def session_preparation(self) -> None:
        """Prepare the session after the connection has been established."""
        self._test_channel_read(pattern=r"[>#]")
        self.set_base_prompt()
        self.enable()
        # Re-set base prompt after enable (prompt changes from ">" to "#")
        self.set_base_prompt()
        self.disable_paging(command="no more")

    def telnet_login(
        self,
        pri_prompt_terminator: str = r"\#\s*$",
        alt_prompt_terminator: str = r">\s*$",
        username_pattern: str = r"(?:user:|username|login|user name)",
        pwd_pattern: str = r"assword:\s*$",
        delay_factor: float = 1.0,
        max_loops: int = 20,
    ) -> str:
        """Telnet/Serial login for FITELnet.

        FITELnet emits ``<WARNING> weak login password: set the password``
        right after login.  The base class default ``pwd_pattern = r"assword"``
        matches the word 'password' inside that warning and incorrectly sends
        the password as a CLI command.  Anchoring to ``assword:\\s*$`` limits
        matches to a real ``password:`` prompt at end-of-line.
        """
        return super().telnet_login(
            pri_prompt_terminator=pri_prompt_terminator,
            alt_prompt_terminator=alt_prompt_terminator,
            username_pattern=username_pattern,
            pwd_pattern=pwd_pattern,
            delay_factor=delay_factor,
            max_loops=max_loops,
        )

    def check_enable_mode(self, check_string: str = "#") -> bool:
        """Check if in enable mode.

        FITELnet uses bare prompts (just ">" or "#"), so we match the
        prompt character at end-of-line to avoid false matches on
        ``<WARNING>`` / ``<ERROR>`` messages that contain ``>``.
        """
        self.write_channel(self.RETURN)
        output = self.read_until_pattern(pattern=r"[>#]\s*$")
        return check_string in output

    def enable(
        self,
        cmd: str = "enable",
        pattern: str = "ssword",
        enable_pattern: Optional[str] = None,
        check_state: bool = True,
        re_flags: int = re.IGNORECASE,
    ) -> str:
        """Enter enable mode on FITELnet.

        Overridden because:
        1. The bare prompt changes from ">" to "#" after enable, causing the
           default ``read_until_prompt()`` to fail.
        2. If the wrong enable password is supplied, the device responds with
           ``<ERROR> Authentication failed`` followed by another ``password:``
           prompt.  The base implementation would hang waiting for "#".
           This override detects the failure immediately.

        ``enable_pattern`` is accepted for API compatibility with the parent
        signature but is not used; this override hardcodes the success /
        failure detection patterns.
        """
        output = ""
        if check_state and self.check_enable_mode():
            return output

        self.write_channel(self.normalize_cmd(cmd))
        output += self.read_until_pattern(pattern=rf"(?:{pattern}|#)", re_flags=re_flags)

        if re.search(pattern, output, flags=re_flags):
            self.write_channel(self.normalize_cmd(self.secret))
            # Read until "#" (success) or "Authentication failed" (wrong pw).
            output += self.read_until_pattern(pattern=r"(?:#|Authentication failed)")
            if "Authentication failed" in output:
                raise ValueError(
                    "Failed to enter enable mode. The enable password "
                    "(secret) was rejected by the device."
                )

        if not self.check_enable_mode():
            raise ValueError(
                "Failed to enter enable mode. Please ensure you pass "
                "the 'secret' argument to ConnectHandler."
            )
        return output

    def exit_enable_mode(self, exit_command: str = "disable") -> str:
        """Exit enable mode on FITELnet.

        Overridden because the base implementation uses read_until_prompt()
        which waits for '#', but after 'disable' the prompt changes to '>'.
        """
        output = ""
        if self.check_enable_mode():
            self.write_channel(self.normalize_cmd(exit_command))
            output += self.read_until_pattern(pattern=r">\s*$")
            # Drain any remaining data (serial ports may have buffered echoes)
            time.sleep(0.5)
            self.clear_buffer()
            if self.check_enable_mode():
                raise ValueError("Failed to exit enable mode.")
        return output

    def commit(
        self,
        read_timeout: float = 120.0,
    ) -> str:
        """
        Commit the candidate configuration on the FITELnet device.

        Applies the working.cfg (candidate) to current.cfg (running).

        commit may prompt with '[y/n]' for confirmation.
        """
        output = ""
        confirmation = r"onfirm|\[y/[nN]\]"
        pattern = rf"(?:#|{confirmation})"
        new_data = self._send_command_str(
            "commit",
            expect_string=pattern,
            strip_prompt=False,
            strip_command=False,
            read_timeout=read_timeout,
        )

        if re.search(confirmation, new_data):
            output += new_data
            new_data = self._send_command_str(
                "y",
                expect_string=r"#",
                strip_prompt=False,
                strip_command=False,
                read_timeout=read_timeout,
                cmd_verify=False,
            )

        output += new_data

        # FITELnet refuses commit while another session/process is active with
        # "Another processing is executing. This command can not be executed."
        # The message contains neither "error" nor "failed", so it must be
        # detected separately before the generic error check below.
        if "Another processing is executing" in output:
            raise ValueError(
                "Commit failed: another process is executing on the device. "
                "Retry once the other operation completes."
            )

        # FITELnet emits <ERROR> in all caps; match case-insensitively.
        if re.search(r"error|failed", output, re.IGNORECASE):
            raise ValueError(f"Commit failed with the following errors:\n\n{output}")

        return output

    def save_config(
        self,
        cmd: str = "save",
        confirm: bool = True,
        confirm_response: str = "y",
    ) -> str:
        """Save working.cfg to boot.cfg (startup configuration).

        FITELnet prompts 'save ok?[y/N]:' by default.

        If another process is holding the config (e.g. a concurrent session
        in the middle of commit/save/refresh), FITELnet replies with
        "Another processing is executing. This command can not be executed."
        and never prints the ``[y/N]`` prompt — so the confirm_response would
        then be sent as a bare CLI command.  Detect this explicitly and raise.
        """
        output = super().save_config(cmd=cmd, confirm=confirm, confirm_response=confirm_response)
        if "Another processing is executing" in output:
            raise ValueError(
                "save_config failed: another process is executing on the device. "
                "Retry once the other operation completes."
            )
        return output

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

        The base implementation only removes a single trailing prompt line.
        FITELnet devices may echo the prompt multiple times (especially on
        serial/telnet), so this override uses a loop to strip all trailing
        empty lines and prompt lines.
        """
        a_string = a_string.rstrip()
        response_list = a_string.split(self.RESPONSE_RETURN)
        base = self.base_prompt.strip()
        valid_prompts = {"#", ">", f"{base}#", f"{base}>"}

        while True:
            if not response_list:
                break
            last_line = response_list[-1].strip()

            # Remove control characters (e.g. BEL \x07) before matching
            clean_line = re.sub(r"[\x00-\x1f\x7f]", "", last_line)

            if clean_line in valid_prompts:
                # Drop the last line
                response_list = response_list[:-1]
                # valid_prompts must now be what we just matched
                valid_prompts = {clean_line}
            else:
                break

        return self.RESPONSE_RETURN.join(response_list)

Common methods for Furukawa FITELnet VPN routers.

FITELnet prompts vary by model: - Bare prompts: ">" (user mode), "#" (enable mode) - Hostname prompts: "F220>", "F220#", "F220(config)#", "F220(config-GigaEthernet1/1)#", etc.

    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

• CiscoBaseConnection
• BaseConnection

Subclasses

• FurukawaFitelnetSSH
• FurukawaFitelnetSerial
• FurukawaFitelnetTelnet

Methods

def check_enable_mode(self, check_string: str = '#') ‑> bool

Expand source code

def check_enable_mode(self, check_string: str = "#") -> bool:
    """Check if in enable mode.

    FITELnet uses bare prompts (just ">" or "#"), so we match the
    prompt character at end-of-line to avoid false matches on
    ``<WARNING>`` / ``<ERROR>`` messages that contain ``>``.
    """
    self.write_channel(self.RETURN)
    output = self.read_until_pattern(pattern=r"[>#]\s*$")
    return check_string in output

Check if in enable mode.

FITELnet uses bare prompts (just ">" or "#"), so we match the prompt character at end-of-line to avoid false matches on <WARNING> / <ERROR> messages that contain >.

def commit(self, read_timeout: float = 120.0) ‑> str

Expand source code

def commit(
    self,
    read_timeout: float = 120.0,
) -> str:
    """
    Commit the candidate configuration on the FITELnet device.

    Applies the working.cfg (candidate) to current.cfg (running).

    commit may prompt with '[y/n]' for confirmation.
    """
    output = ""
    confirmation = r"onfirm|\[y/[nN]\]"
    pattern = rf"(?:#|{confirmation})"
    new_data = self._send_command_str(
        "commit",
        expect_string=pattern,
        strip_prompt=False,
        strip_command=False,
        read_timeout=read_timeout,
    )

    if re.search(confirmation, new_data):
        output += new_data
        new_data = self._send_command_str(
            "y",
            expect_string=r"#",
            strip_prompt=False,
            strip_command=False,
            read_timeout=read_timeout,
            cmd_verify=False,
        )

    output += new_data

    # FITELnet refuses commit while another session/process is active with
    # "Another processing is executing. This command can not be executed."
    # The message contains neither "error" nor "failed", so it must be
    # detected separately before the generic error check below.
    if "Another processing is executing" in output:
        raise ValueError(
            "Commit failed: another process is executing on the device. "
            "Retry once the other operation completes."
        )

    # FITELnet emits <ERROR> in all caps; match case-insensitively.
    if re.search(r"error|failed", output, re.IGNORECASE):
        raise ValueError(f"Commit failed with the following errors:\n\n{output}")

    return output

Commit the candidate configuration on the FITELnet device.

Applies the working.cfg (candidate) to current.cfg (running).

commit may prompt with '[y/n]' for confirmation.

def enable(self,
cmd: str = 'enable',
pattern: str = 'ssword',
enable_pattern: str | None = None,
check_state: bool = True,
re_flags: int = re.IGNORECASE) ‑> str

Expand source code

def enable(
    self,
    cmd: str = "enable",
    pattern: str = "ssword",
    enable_pattern: Optional[str] = None,
    check_state: bool = True,
    re_flags: int = re.IGNORECASE,
) -> str:
    """Enter enable mode on FITELnet.

    Overridden because:
    1. The bare prompt changes from ">" to "#" after enable, causing the
       default ``read_until_prompt()`` to fail.
    2. If the wrong enable password is supplied, the device responds with
       ``<ERROR> Authentication failed`` followed by another ``password:``
       prompt.  The base implementation would hang waiting for "#".
       This override detects the failure immediately.

    ``enable_pattern`` is accepted for API compatibility with the parent
    signature but is not used; this override hardcodes the success /
    failure detection patterns.
    """
    output = ""
    if check_state and self.check_enable_mode():
        return output

    self.write_channel(self.normalize_cmd(cmd))
    output += self.read_until_pattern(pattern=rf"(?:{pattern}|#)", re_flags=re_flags)

    if re.search(pattern, output, flags=re_flags):
        self.write_channel(self.normalize_cmd(self.secret))
        # Read until "#" (success) or "Authentication failed" (wrong pw).
        output += self.read_until_pattern(pattern=r"(?:#|Authentication failed)")
        if "Authentication failed" in output:
            raise ValueError(
                "Failed to enter enable mode. The enable password "
                "(secret) was rejected by the device."
            )

    if not self.check_enable_mode():
        raise ValueError(
            "Failed to enter enable mode. Please ensure you pass "
            "the 'secret' argument to ConnectHandler."
        )
    return output

Enter enable mode on FITELnet.

Overridden because: 1. The bare prompt changes from ">" to "#" after enable, causing the default read_until_prompt() to fail. 2. If the wrong enable password is supplied, the device responds with <ERROR> Authentication failed followed by another password: prompt. The base implementation would hang waiting for "#". This override detects the failure immediately.

enable_pattern is accepted for API compatibility with the parent signature but is not used; this override hardcodes the success / failure detection patterns.

def exit_enable_mode(self, exit_command: str = 'disable') ‑> str

Expand source code

def exit_enable_mode(self, exit_command: str = "disable") -> str:
    """Exit enable mode on FITELnet.

    Overridden because the base implementation uses read_until_prompt()
    which waits for '#', but after 'disable' the prompt changes to '>'.
    """
    output = ""
    if self.check_enable_mode():
        self.write_channel(self.normalize_cmd(exit_command))
        output += self.read_until_pattern(pattern=r">\s*$")
        # Drain any remaining data (serial ports may have buffered echoes)
        time.sleep(0.5)
        self.clear_buffer()
        if self.check_enable_mode():
            raise ValueError("Failed to exit enable mode.")
    return output

Exit enable mode on FITELnet.

Overridden because the base implementation uses read_until_prompt() which waits for '#', but after 'disable' the prompt changes to '>'.

def save_config(self, cmd: str = 'save', confirm: bool = True, confirm_response: str = 'y') ‑> str

Expand source code

def save_config(
    self,
    cmd: str = "save",
    confirm: bool = True,
    confirm_response: str = "y",
) -> str:
    """Save working.cfg to boot.cfg (startup configuration).

    FITELnet prompts 'save ok?[y/N]:' by default.

    If another process is holding the config (e.g. a concurrent session
    in the middle of commit/save/refresh), FITELnet replies with
    "Another processing is executing. This command can not be executed."
    and never prints the ``[y/N]`` prompt — so the confirm_response would
    then be sent as a bare CLI command.  Detect this explicitly and raise.
    """
    output = super().save_config(cmd=cmd, confirm=confirm, confirm_response=confirm_response)
    if "Another processing is executing" in output:
        raise ValueError(
            "save_config failed: another process is executing on the device. "
            "Retry once the other operation completes."
        )
    return output

Save working.cfg to boot.cfg (startup configuration).

FITELnet prompts 'save ok?[y/N]:' by default.

If another process is holding the config (e.g. a concurrent session in the middle of commit/save/refresh), FITELnet replies with "Another processing is executing. This command can not be executed." and never prints the [y/N] prompt — so the confirm_response would then be sent as a bare CLI command. Detect this explicitly and raise.

def session_preparation(self) ‑> None

Expand source code

def session_preparation(self) -> None:
    """Prepare the session after the connection has been established."""
    self._test_channel_read(pattern=r"[>#]")
    self.set_base_prompt()
    self.enable()
    # Re-set base prompt after enable (prompt changes from ">" to "#")
    self.set_base_prompt()
    self.disable_paging(command="no more")

Prepare the session after the connection has been established.

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

Expand source code

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

    The base implementation only removes a single trailing prompt line.
    FITELnet devices may echo the prompt multiple times (especially on
    serial/telnet), so this override uses a loop to strip all trailing
    empty lines and prompt lines.
    """
    a_string = a_string.rstrip()
    response_list = a_string.split(self.RESPONSE_RETURN)
    base = self.base_prompt.strip()
    valid_prompts = {"#", ">", f"{base}#", f"{base}>"}

    while True:
        if not response_list:
            break
        last_line = response_list[-1].strip()

        # Remove control characters (e.g. BEL \x07) before matching
        clean_line = re.sub(r"[\x00-\x1f\x7f]", "", last_line)

        if clean_line in valid_prompts:
            # Drop the last line
            response_list = response_list[:-1]
            # valid_prompts must now be what we just matched
            valid_prompts = {clean_line}
        else:
            break

    return self.RESPONSE_RETURN.join(response_list)

Strip the trailing router prompt from the output.

The base implementation only removes a single trailing prompt line. FITELnet devices may echo the prompt multiple times (especially on serial/telnet), so this override uses a loop to strip all trailing empty lines and prompt lines.

def telnet_login(self,
pri_prompt_terminator: str = '\\#\\s*$',
alt_prompt_terminator: str = '>\\s*$',
username_pattern: str = '(?:user:|username|login|user name)',
pwd_pattern: str = 'assword:\\s*$',
delay_factor: float = 1.0,
max_loops: int = 20) ‑> str

Expand source code

def telnet_login(
    self,
    pri_prompt_terminator: str = r"\#\s*$",
    alt_prompt_terminator: str = r">\s*$",
    username_pattern: str = r"(?:user:|username|login|user name)",
    pwd_pattern: str = r"assword:\s*$",
    delay_factor: float = 1.0,
    max_loops: int = 20,
) -> str:
    """Telnet/Serial login for FITELnet.

    FITELnet emits ``<WARNING> weak login password: set the password``
    right after login.  The base class default ``pwd_pattern = r"assword"``
    matches the word 'password' inside that warning and incorrectly sends
    the password as a CLI command.  Anchoring to ``assword:\\s*$`` limits
    matches to a real ``password:`` prompt at end-of-line.
    """
    return super().telnet_login(
        pri_prompt_terminator=pri_prompt_terminator,
        alt_prompt_terminator=alt_prompt_terminator,
        username_pattern=username_pattern,
        pwd_pattern=pwd_pattern,
        delay_factor=delay_factor,
        max_loops=max_loops,
    )

Telnet/Serial login for FITELnet.

FITELnet emits <WARNING> weak login password: set the password right after login. The base class default pwd_pattern = r"assword" matches the word 'password' inside that warning and incorrectly sends the password as a CLI command. Anchoring to assword:\s*$ limits matches to a real password: prompt at end-of-line.

Inherited members

• CiscoBaseConnection:
  • check_config_mode
  • cleanup
  • clear_buffer
  • config_mode
  • disable_paging
  • disconnect
  • enable_secret_handler
  • establish_connection
  • exit_config_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
  • 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
  • write_channel

class FurukawaFitelnetSSH (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 FurukawaFitelnetSSH(FurukawaFitelnetBase):
    """Furukawa FITELnet SSH driver."""

    pass

Furukawa FITELnet SSH driver.

    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

• FurukawaFitelnetBase
• CiscoBaseConnection
• BaseConnection

Inherited members

• FurukawaFitelnetBase:
  • check_config_mode
  • check_enable_mode
  • cleanup
  • clear_buffer
  • commit
  • config_mode
  • disable_paging
  • disconnect
  • enable
  • enable_secret_handler
  • 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_prompt
  • telnet_login
  • write_channel

class FurukawaFitelnetSerial (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 FurukawaFitelnetSerial(FurukawaFitelnetBase):
    """Furukawa FITELnet Serial driver.

    serial_login() ultimately calls telnet_login(), so the above telnet_login() code is shared
    between both telnet and serial driver.
    """

    pass

Furukawa FITELnet Serial driver.

serial_login() ultimately calls telnet_login(), so the above telnet_login() code is shared between both telnet and serial driver.

    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

• FurukawaFitelnetBase
• CiscoBaseConnection
• BaseConnection

Inherited members

• FurukawaFitelnetBase:
  • check_config_mode
  • check_enable_mode
  • cleanup
  • clear_buffer
  • commit
  • config_mode
  • disable_paging
  • disconnect
  • enable
  • enable_secret_handler
  • 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_prompt
  • telnet_login
  • write_channel

class FurukawaFitelnetTelnet (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 FurukawaFitelnetTelnet(FurukawaFitelnetBase):
    """Furukawa FITELnet Telnet driver."""

    pass

Furukawa FITELnet Telnet driver.

    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

• FurukawaFitelnetBase
• CiscoBaseConnection
• BaseConnection

Inherited members

• FurukawaFitelnetBase:
  • check_config_mode
  • check_enable_mode
  • cleanup
  • clear_buffer
  • commit
  • config_mode
  • disable_paging
  • disconnect
  • enable
  • enable_secret_handler
  • 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_prompt
  • telnet_login
  • write_channel