Module netmiko.exceptions

Expand source code
from paramiko.ssh_exception import SSHException
from paramiko.ssh_exception import AuthenticationException


class NetmikoBaseException(Exception):
    """General base exception except for exceptions that inherit from Paramiko."""

    pass


class ConnectionException(NetmikoBaseException):
    """Generic exception indicating the connection failed."""

    pass


class NetmikoTimeoutException(SSHException):
    """SSH session timed trying to connect to the device."""

    pass


NetMikoTimeoutException = NetmikoTimeoutException


class NetmikoAuthenticationException(AuthenticationException):
    """SSH authentication exception based on Paramiko AuthenticationException."""

    pass


NetMikoAuthenticationException = NetmikoAuthenticationException


class ConfigInvalidException(NetmikoBaseException):
    """Exception raised for invalid configuration error."""

    pass


class WriteException(NetmikoBaseException):
    """General exception indicating an error occurred during a Netmiko write operation."""

    pass


class ReadException(NetmikoBaseException):
    """General exception indicating an error occurred during a Netmiko read operation."""

    pass


class ReadTimeout(ReadException):
    """General exception indicating an error occurred during a Netmiko read operation."""

    pass

Classes

class ConfigInvalidException (*args, **kwargs)

Exception raised for invalid configuration error.

Expand source code
class ConfigInvalidException(NetmikoBaseException):
    """Exception raised for invalid configuration error."""

    pass

Ancestors

class ConnectionException (*args, **kwargs)

Generic exception indicating the connection failed.

Expand source code
class ConnectionException(NetmikoBaseException):
    """Generic exception indicating the connection failed."""

    pass

Ancestors

class NetmikoAuthenticationException (*args, **kwargs)

SSH authentication exception based on Paramiko AuthenticationException.

Expand source code
class NetmikoAuthenticationException(AuthenticationException):
    """SSH authentication exception based on Paramiko AuthenticationException."""

    pass

Ancestors

  • paramiko.ssh_exception.AuthenticationException
  • paramiko.ssh_exception.SSHException
  • builtins.Exception
  • builtins.BaseException
class NetMikoAuthenticationException (*args, **kwargs)

SSH authentication exception based on Paramiko AuthenticationException.

Expand source code
class NetmikoAuthenticationException(AuthenticationException):
    """SSH authentication exception based on Paramiko AuthenticationException."""

    pass

Ancestors

  • paramiko.ssh_exception.AuthenticationException
  • paramiko.ssh_exception.SSHException
  • builtins.Exception
  • builtins.BaseException
class NetmikoBaseException (*args, **kwargs)

General base exception except for exceptions that inherit from Paramiko.

Expand source code
class NetmikoBaseException(Exception):
    """General base exception except for exceptions that inherit from Paramiko."""

    pass

Ancestors

  • builtins.Exception
  • builtins.BaseException

Subclasses

class NetmikoTimeoutException (*args, **kwargs)

SSH session timed trying to connect to the device.

Expand source code
class NetmikoTimeoutException(SSHException):
    """SSH session timed trying to connect to the device."""

    pass

Ancestors

  • paramiko.ssh_exception.SSHException
  • builtins.Exception
  • builtins.BaseException
class NetMikoTimeoutException (*args, **kwargs)

SSH session timed trying to connect to the device.

Expand source code
class NetmikoTimeoutException(SSHException):
    """SSH session timed trying to connect to the device."""

    pass

Ancestors

  • paramiko.ssh_exception.SSHException
  • builtins.Exception
  • builtins.BaseException
class ReadException (*args, **kwargs)

General exception indicating an error occurred during a Netmiko read operation.

Expand source code
class ReadException(NetmikoBaseException):
    """General exception indicating an error occurred during a Netmiko read operation."""

    pass

Ancestors

Subclasses

class ReadTimeout (*args, **kwargs)

General exception indicating an error occurred during a Netmiko read operation.

Expand source code
class ReadTimeout(ReadException):
    """General exception indicating an error occurred during a Netmiko read operation."""

    pass

Ancestors

class WriteException (*args, **kwargs)

General exception indicating an error occurred during a Netmiko write operation.

Expand source code
class WriteException(NetmikoBaseException):
    """General exception indicating an error occurred during a Netmiko write operation."""

    pass

Ancestors