Module netmiko.aruba

Sub-modules

netmiko.aruba.aruba_aoscx

Aruba AOS CX support …

netmiko.aruba.aruba_os

Aruba OS support …

Classes

class ArubaCxSSH (**kwargs: Any)
Expand source code 
class ArubaCxSSH(CiscoSSHConnection):
    """Aruba AOS CX support"""

    def __init__(self, **kwargs: Any) -> None:
        if kwargs.get("default_enter") is None:
            kwargs["default_enter"] = "\r"
        return super().__init__(**kwargs)

    def session_preparation(self) -> None:
        self.ansi_escape_codes = True
        self._test_channel_read(pattern=r"[>#]")
        self.set_base_prompt()
        self.disable_paging(command="no page")

    def check_config_mode(
        self,
        check_string: str = "(config)#",
        pattern: str = r"[>#]",
        force_regex: bool = False,
    ) -> bool:
        return super().check_config_mode(check_string=check_string, pattern=pattern)

    def config_mode(
        self,
        config_command: str = "configure term",
        pattern: str = "",
        re_flags: int = 0,
    ) -> str:
        """Aruba auto completes on space so 'configure' needs fully spelled-out."""
        return super().config_mode(
            config_command=config_command, pattern=pattern, re_flags=re_flags
        )

Aruba AOS CX support

    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

Methods

def config_mode(self,
config_command: str = 'configure term',
pattern: str = '',
re_flags: int = 0) ‑> str
Expand source code 
def config_mode(
    self,
    config_command: str = "configure term",
    pattern: str = "",
    re_flags: int = 0,
) -> str:
    """Aruba auto completes on space so 'configure' needs fully spelled-out."""
    return super().config_mode(
        config_command=config_command, pattern=pattern, re_flags=re_flags
    )

Aruba auto completes on space so 'configure' needs fully spelled-out.

Inherited members

class ArubaOsFileTransfer (file_system: str | None = '/mm/mynode',
hash_supported: bool = False,
**kwargs: Any)
Expand source code 
class ArubaOsFileTransfer(BaseFileTransfer):
    """Aruba OS SCP File Transfer driver"""

    def __init__(
        self,
        file_system: Optional[str] = "/mm/mynode",
        hash_supported: bool = False,
        **kwargs: Any,
    ) -> None:
        super().__init__(file_system=file_system, hash_supported=hash_supported, **kwargs)

    def file_md5(self, file_name: str, add_newline: bool = False) -> str:
        """Aruba OS does not support an MD5-hash operation."""
        raise NotImplementedError

    @staticmethod
    def process_md5(md5_output: str, pattern: str = "") -> str:
        """Aruba OS does not support an MD5-hash operation."""
        raise NotImplementedError

    def compare_md5(self) -> bool:
        """Aruba OS does not support an MD5-hash operation."""
        raise NotImplementedError

    def remote_md5(self, base_cmd: str = "", remote_file: Optional[str] = None) -> str:
        """Aruba OS does not support an MD5-hash operation."""
        raise NotImplementedError

    def check_file_exists(self, remote_cmd: str = "") -> bool:
        """Check if the dest_file already exists on the file system (return boolean)."""
        if self.direction == "put":
            if not remote_cmd:
                remote_cmd = f"dir search {self.dest_file.rpartition('/')[-1]}"
            remote_out = self.ssh_ctl_chan._send_command_str(remote_cmd)

            if "Cannot get directory information" in remote_out:
                return False

            # dir search default.cfg
            # -rw-r--r--    1 root     root 16283 Nov  9 12:25 default.cfg
            # -rw-r--r--    1 root     root 22927 May 25 12:21 default.cfg.2016-05-25_20-21-38
            # -rw-r--r--    2 root     root 19869 May  9 12:20 default.cfg.2016-05-09_12-20-22
            # Construct a list of the last column
            return self.dest_file in [
                fields[-1] for line in remote_out.splitlines() if (fields := line.split())
            ]

        elif self.direction == "get":
            return os.path.exists(self.dest_file)
        else:
            raise ValueError("Unexpected value for self.direction")

    def remote_file_size(self, remote_cmd: str = "", remote_file: Optional[str] = None) -> int:
        """Get the file size of the remote file."""
        if remote_file is None:
            if self.direction == "put":
                remote_file = self.dest_file
            elif self.direction == "get":
                remote_file = self.source_file

        assert isinstance(remote_file, str)
        remote_file_search = remote_file.rpartition("/")[-1]

        if not remote_cmd:
            remote_cmd = f"dir search {remote_file_search}"
        remote_out = self.ssh_ctl_chan._send_command_str(remote_cmd)

        if "Cannot get directory information" in remote_out:
            msg = "Unable to find file on remote system"
            raise IOError(msg)

        # dir search default.cfg
        # -rw-r--r--    1 root     root 16283 Nov  9 12:25 default.cfg
        # -rw-r--r--    1 root     root 22927 May 25 12:21 default.cfg.2016-05-25_20-21-38
        # -rw-r--r--    2 root     root 19869 May  9 12:20 default.cfg.2016-05-09_12-20-22
        for line in remote_out.splitlines():
            if line:
                fields = line.split()
                if len(fields) >= 5:
                    file_size = fields[4]
                    f_name = fields[-1]
                    if f_name == remote_file_search:
                        break
        else:
            msg = "Unable to find file on remote system"
            raise IOError(msg)

        try:
            return int(file_size)
        except ValueError as ve:
            msg = "Unable to parse remote file size, wrong field in use or malformed command output"
            raise IOError(msg) from ve

    def verify_file(self) -> bool:
        """Verify the file has been transferred correctly based on filesize."""
        if self.direction == "put":
            return os.stat(self.source_file).st_size == self.remote_file_size(
                remote_file=self.dest_file
            )
        elif self.direction == "get":
            return (
                self.remote_file_size(remote_file=self.source_file)
                == os.stat(self.dest_file).st_size
            )
        else:
            raise ValueError("Unexpected value of self.direction")

    def remote_space_available(self, search_pattern: str = "") -> int:
        """Return space available on remote device."""
        remote_cmd = "show storage"
        remote_output = self.ssh_ctl_chan._send_command_str(remote_cmd).strip()

        # show storage (df -h)
        # Filesystem                Size      Used Available Use% Mounted on
        # /dev/root                57.0M     54.6M      2.3M  96% /
        # /dev/usbdisk/1            3.9G    131.0M      3.8G   3% /mnt/usbdisk/1
        available_sizes = [
            fields[-3]
            for line in remote_output.splitlines()
            if (fields := line.split()) and fields[-1] == "/flash"
        ]

        if not available_sizes:
            msg = "Could not determine remote space available."
            raise ValueError(msg)

        space_available = 0
        # There is potentially more than one filesystem for /flash
        for available_size in available_sizes:
            size_names = ["B", "K", "M", "G", "T", "P", "E"]
            suffix = available_size[-1]
            size_str = available_size[:-1]

            if suffix not in size_names:
                msg = "Could not determine remote space available."
                raise ValueError(msg)

            try:
                size = float(size_str)
            except ValueError as ve:
                msg = "Could not determine remote space available."
                raise ValueError(msg) from ve

            space_available += size * (1024 ** size_names.index(suffix))

        return int(space_available)

    def enable_scp(self, cmd: str = "service scp") -> None:
        """Enable SCP on remote device."""
        super().enable_scp(cmd)

    def disable_scp(self, cmd: str = "no service scp") -> None:
        """Disable SCP on remote device."""
        super().disable_scp(cmd)

Aruba OS SCP File Transfer driver

Ancestors

Static methods

def process_md5(md5_output: str, pattern: str = '') ‑> str
Expand source code 
@staticmethod
def process_md5(md5_output: str, pattern: str = "") -> str:
    """Aruba OS does not support an MD5-hash operation."""
    raise NotImplementedError

Aruba OS does not support an MD5-hash operation.

Methods

def compare_md5(self) ‑> bool
Expand source code 
def compare_md5(self) -> bool:
    """Aruba OS does not support an MD5-hash operation."""
    raise NotImplementedError

Aruba OS does not support an MD5-hash operation.

def disable_scp(self, cmd: str = 'no service scp') ‑> None
Expand source code 
def disable_scp(self, cmd: str = "no service scp") -> None:
    """Disable SCP on remote device."""
    super().disable_scp(cmd)

Disable SCP on remote device.

def enable_scp(self, cmd: str = 'service scp') ‑> None
Expand source code 
def enable_scp(self, cmd: str = "service scp") -> None:
    """Enable SCP on remote device."""
    super().enable_scp(cmd)

Enable SCP on remote device.

def file_md5(self, file_name: str, add_newline: bool = False) ‑> str
Expand source code 
def file_md5(self, file_name: str, add_newline: bool = False) -> str:
    """Aruba OS does not support an MD5-hash operation."""
    raise NotImplementedError

Aruba OS does not support an MD5-hash operation.

def remote_md5(self, base_cmd: str = '', remote_file: str | None = None) ‑> str
Expand source code 
def remote_md5(self, base_cmd: str = "", remote_file: Optional[str] = None) -> str:
    """Aruba OS does not support an MD5-hash operation."""
    raise NotImplementedError

Aruba OS does not support an MD5-hash operation.

def verify_file(self) ‑> bool
Expand source code 
def verify_file(self) -> bool:
    """Verify the file has been transferred correctly based on filesize."""
    if self.direction == "put":
        return os.stat(self.source_file).st_size == self.remote_file_size(
            remote_file=self.dest_file
        )
    elif self.direction == "get":
        return (
            self.remote_file_size(remote_file=self.source_file)
            == os.stat(self.dest_file).st_size
        )
    else:
        raise ValueError("Unexpected value of self.direction")

Verify the file has been transferred correctly based on filesize.

Inherited members

class ArubaOsSSH (**kwargs: Any)
Expand source code 
class ArubaOsSSH(CiscoSSHConnection):
    """Aruba OS support"""

    def __init__(self, **kwargs: Any) -> None:
        if kwargs.get("default_enter") is None:
            kwargs["default_enter"] = "\r"
        # Aruba has an auto-complete on space behavior that is problematic
        if kwargs.get("global_cmd_verify") is None:
            kwargs["global_cmd_verify"] = False
        return super().__init__(**kwargs)

    def session_preparation(self) -> None:
        """Aruba OS requires enable mode to disable paging."""
        # Aruba switches output ansi codes
        self.ansi_escape_codes = True
        self._test_channel_read(pattern=r"[>#]")
        self.set_base_prompt()
        self.enable()
        self.disable_paging(command="no paging")

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

        Aruba uses "(<controller name>) (config) #" as config prompt
        """
        return super().check_config_mode(check_string=check_string, pattern=pattern)

    def config_mode(
        self,
        config_command: str = "configure term",
        pattern: str = "",
        re_flags: int = 0,
    ) -> str:
        """Aruba auto completes on space so 'configure' needs fully spelled-out."""
        return super().config_mode(
            config_command=config_command, pattern=pattern, re_flags=re_flags
        )

Aruba OS support

    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

Methods

def check_config_mode(self,
check_string: str = '(config) #',
pattern: str = '[>#]',
force_regex: bool = False) ‑> bool
Expand source code 
def check_config_mode(
    self,
    check_string: str = "(config) #",
    pattern: str = r"[>#]",
    force_regex: bool = False,
) -> bool:
    """
    Checks if the device is in configuration mode or not.

    Aruba uses "(<controller name>) (config) #" as config prompt
    """
    return super().check_config_mode(check_string=check_string, pattern=pattern)

Checks if the device is in configuration mode or not.

Aruba uses "() (config) #" as config prompt

def config_mode(self,
config_command: str = 'configure term',
pattern: str = '',
re_flags: int = 0) ‑> str
Expand source code 
def config_mode(
    self,
    config_command: str = "configure term",
    pattern: str = "",
    re_flags: int = 0,
) -> str:
    """Aruba auto completes on space so 'configure' needs fully spelled-out."""
    return super().config_mode(
        config_command=config_command, pattern=pattern, re_flags=re_flags
    )

Aruba auto completes on space so 'configure' needs fully spelled-out.

def session_preparation(self) ‑> None
Expand source code 
def session_preparation(self) -> None:
    """Aruba OS requires enable mode to disable paging."""
    # Aruba switches output ansi codes
    self.ansi_escape_codes = True
    self._test_channel_read(pattern=r"[>#]")
    self.set_base_prompt()
    self.enable()
    self.disable_paging(command="no paging")

Aruba OS requires enable mode to disable paging.

Inherited members