ANTA Device API

AntaDevice

AntaDevice(
    name: str,
    tags: set[str] | None = None,
    *,
    disable_cache: bool = False
)

Bases: ABC

Abstract class representing a device in ANTA.

An implementation of this class must override the abstract coroutines _collect() and refresh().

Attributes:

Name	Type	Description
name	str	Device name.
is_online	bool	True if the device IP is reachable and a port can be open.
established	bool	True if remote command execution succeeds.
hw_model	str	Hardware model of the device.
tags	set[str]	Tags for this device.
cache	AntaCache | None	In-memory cache for this device (None if cache is disabled).
cache_locks	dict	Dictionary mapping keys to asyncio locks to guarantee exclusive access to the cache if not disabled. Deprecated, will be removed in ANTA v2.0.0, use self.cache.locks instead.

Parameters:

Name	Type	Description	Default
name	str	Device name.	required
tags	set[str] | None	Tags for this device.	None
disable_cache	bool	Disable caching for all commands for this device.	False

cache_statistics property

cache_statistics: dict[str, Any] | None

Return the device cache statistics for logging purposes.

_collect abstractmethod async

_collect(
    command: AntaCommand,
    *,
    collection_id: str | None = None
) -> None

Collect device command output.

This abstract coroutine can be used to implement any command collection method for a device in ANTA.

The _collect() implementation needs to populate the output attribute of the AntaCommand object passed as argument.

If a failure occurs, the _collect() implementation is expected to catch the exception and implement proper logging, the output attribute of the AntaCommand object passed as argument would be None in this case.

Parameters:

Name	Type	Description	Default
command	AntaCommand	The command to collect.	required
collection_id	str | None	An identifier used to build the eAPI request ID.	None

Source code in anta/device.py

@abstractmethod
async def _collect(self, command: AntaCommand, *, collection_id: str | None = None) -> None:
    """Collect device command output.

    This abstract coroutine can be used to implement any command collection method
    for a device in ANTA.

    The `_collect()` implementation needs to populate the `output` attribute
    of the `AntaCommand` object passed as argument.

    If a failure occurs, the `_collect()` implementation is expected to catch the
    exception and implement proper logging, the `output` attribute of the
    `AntaCommand` object passed as argument would be `None` in this case.

    Parameters
    ----------
    command
        The command to collect.
    collection_id
        An identifier used to build the eAPI request ID.
    """

collect async

collect(
    command: AntaCommand,
    *,
    collection_id: str | None = None
) -> None

Collect the output for a specified command.

When caching is activated on both the device and the command, this method prioritizes retrieving the output from the cache. In cases where the output isn’t cached yet, it will be freshly collected and then stored in the cache for future access. The method employs asynchronous locks based on the command’s UID to guarantee exclusive access to the cache.

When caching is NOT enabled, either at the device or command level, the method directly collects the output via the private _collect method without interacting with the cache.

Parameters:

Name	Type	Description	Default
command	AntaCommand	The command to collect.	required
collection_id	str | None	An identifier used to build the eAPI request ID.	None

Source code in anta/device.py

async def collect(self, command: AntaCommand, *, collection_id: str | None = None) -> None:
    """Collect the output for a specified command.

    When caching is activated on both the device and the command,
    this method prioritizes retrieving the output from the cache. In cases where the output isn't cached yet,
    it will be freshly collected and then stored in the cache for future access.
    The method employs asynchronous locks based on the command's UID to guarantee exclusive access to the cache.

    When caching is NOT enabled, either at the device or command level, the method directly collects the output
    via the private `_collect` method without interacting with the cache.

    Parameters
    ----------
    command
        The command to collect.
    collection_id
        An identifier used to build the eAPI request ID.
    """
    if self.cache is not None and command.use_cache:
        async with self.cache.locks[command.uid]:
            cached_output = await self.cache.get(command.uid)

            if cached_output is not None:
                logger.debug("Cache hit for %s on %s", command.command, self.name)
                command.output = cached_output
            else:
                await self._collect(command=command, collection_id=collection_id)
                await self.cache.set(command.uid, command.output)
    else:
        await self._collect(command=command, collection_id=collection_id)

collect_commands async

collect_commands(
    commands: list[AntaCommand],
    *,
    collection_id: str | None = None
) -> None

Collect multiple commands.

Parameters:

Name	Type	Description	Default
commands	list[AntaCommand]	The commands to collect.	required
collection_id	str | None	An identifier used to build the eAPI request ID.	None

Source code in anta/device.py

async def collect_commands(self, commands: list[AntaCommand], *, collection_id: str | None = None) -> None:
    """Collect multiple commands.

    Parameters
    ----------
    commands
        The commands to collect.
    collection_id
        An identifier used to build the eAPI request ID.
    """
    await asyncio.gather(*(self.collect(command=command, collection_id=collection_id) for command in commands))

copy async

copy(
    sources: list[Path],
    destination: Path,
    direction: Literal["to", "from"] = "from",
) -> None

Copy files to and from the device, usually through SCP.

It is not mandatory to implement this for a valid AntaDevice subclass.

Parameters:

Name	Type	Description	Default
sources	list[Path]	List of files to copy to or from the device.	required
destination	Path	Local or remote destination when copying the files. Can be a folder.	required
direction	Literal['to', 'from']	Defines if this coroutine copies files to or from the device.	'from'

Source code in anta/device.py

async def copy(self, sources: list[Path], destination: Path, direction: Literal["to", "from"] = "from") -> None:
    """Copy files to and from the device, usually through SCP.

    It is not mandatory to implement this for a valid AntaDevice subclass.

    Parameters
    ----------
    sources
        List of files to copy to or from the device.
    destination
        Local or remote destination when copying the files. Can be a folder.
    direction
        Defines if this coroutine copies files to or from the device.

    """
    _ = (sources, destination, direction)
    msg = f"copy() method has not been implemented in {self.__class__.__name__} definition"
    raise NotImplementedError(msg)

refresh abstractmethod async

refresh() -> None

Update attributes of an AntaDevice instance.

This coroutine must update the following attributes of AntaDevice:

• is_online: When the device IP is reachable and a port can be open.

• established: When a command execution succeeds.

• hw_model: The hardware model of the device.

Source code in anta/device.py

@abstractmethod
async def refresh(self) -> None:
    """Update attributes of an AntaDevice instance.

    This coroutine must update the following attributes of AntaDevice:

    - `is_online`: When the device IP is reachable and a port can be open.

    - `established`: When a command execution succeeds.

    - `hw_model`: The hardware model of the device.
    """

AsyncEOSDevice

AsyncEOSDevice(
    host: str,
    username: str,
    password: str,
    name: str | None = None,
    enable_password: str | None = None,
    port: int | None = None,
    ssh_port: int | None = 22,
    tags: set[str] | None = None,
    timeout: float | None = None,
    proto: Literal["http", "https"] = "https",
    *,
    enable: bool = False,
    insecure: bool = False,
    disable_cache: bool = False
)

Bases: AntaDevice

Implementation of AntaDevice for EOS using aio-eapi.

Attributes:

Name	Type	Description
name	str	Device name.
is_online	bool	True if the device IP is reachable and a port can be open.
established	bool	True if remote command execution succeeds.
hw_model	str	Hardware model of the device.
tags	set[str]	Tags for this device.

Parameters:

Name	Type	Description	Default
host	str	Device FQDN or IP.	required
username	str	Username to connect to eAPI and SSH.	required
password	str	Password to connect to eAPI and SSH.	required
name	str | None	Device name.	None
enable	bool	Collect commands using privileged mode.	False
enable_password	str | None	Password used to gain privileged access on EOS.	None
port	int | None	eAPI port. Defaults to 80 is proto is ‘http’ or 443 if proto is ‘https’.	None
ssh_port	int | None	SSH port.	22
tags	set[str] | None	Tags for this device.	None
timeout	float | None	Timeout value in seconds for outgoing API calls.	None
insecure	bool	Disable SSH Host Key validation.	False
proto	Literal['http', 'https']	eAPI protocol. Value can be ‘http’ or ‘https’.	'https'
disable_cache	bool	Disable caching for all commands for this device.	False

_collect async

_collect(
    command: AntaCommand,
    *,
    collection_id: str | None = None
) -> None

Collect device command output from EOS using aio-eapi.

Supports outformat json and text as output structure. Gain privileged access using the enable_password attribute of the AntaDevice instance if populated.

Parameters:

Name	Type	Description	Default
command	AntaCommand	The command to collect.	required
collection_id	str | None	An identifier used to build the eAPI request ID.	None

Source code in anta/device.py

async def _collect(self, command: AntaCommand, *, collection_id: str | None = None) -> None:
    """Collect device command output from EOS using aio-eapi.

    Supports outformat `json` and `text` as output structure.
    Gain privileged access using the `enable_password` attribute
    of the `AntaDevice` instance if populated.

    Parameters
    ----------
    command
        The command to collect.
    collection_id
        An identifier used to build the eAPI request ID.
    """
    semaphore = await self._get_semaphore()

    async with semaphore:
        commands: list[EapiComplexCommand | EapiSimpleCommand] = []
        if self.enable and self._enable_password is not None:
            commands.append(
                {
                    "cmd": "enable",
                    "input": str(self._enable_password),
                },
            )
        elif self.enable:
            # No password
            commands.append({"cmd": "enable"})
        commands += [{"cmd": command.command, "revision": command.revision}] if command.revision else [{"cmd": command.command}]
        try:
            response = await self._session.cli(
                commands=commands,
                ofmt=command.ofmt,
                version=command.version,
                req_id=f"ANTA-{collection_id}-{id(command)}" if collection_id else f"ANTA-{id(command)}",
            )
            # Do not keep response of 'enable' command
            command.output = response[-1]
        except asynceapi.EapiCommandError as e:
            # This block catches exceptions related to EOS issuing an error.
            self._log_eapi_command_error(command, e)
        except TimeoutException as e:
            # This block catches Timeout exceptions.
            command.errors = [exc_to_str(e)]
            timeouts = self._session.timeout.as_dict()
            logger.error(
                "%s occurred while sending a command to %s. Consider increasing the timeout.\nCurrent timeouts: Connect: %s | Read: %s | Write: %s | Pool: %s",
                exc_to_str(e),
                self.name,
                timeouts["connect"],
                timeouts["read"],
                timeouts["write"],
                timeouts["pool"],
            )
        except (ConnectError, OSError) as e:
            # This block catches OSError and socket issues related exceptions.
            command.errors = [exc_to_str(e)]
            # pylint: disable=no-member
            if (isinstance(exc := e.__cause__, httpcore.ConnectError) and isinstance(os_error := exc.__context__, OSError)) or isinstance(
                os_error := e, OSError
            ):
                if isinstance(os_error.__cause__, OSError):
                    os_error = os_error.__cause__
                logger.error("A local OS error occurred while connecting to %s: %s.", self.name, os_error)
            else:
                anta_log_exception(e, f"An error occurred while issuing an eAPI request to {self.name}", logger)
        except HTTPError as e:
            # This block catches most of the httpx Exceptions and logs a general message.
            command.errors = [exc_to_str(e)]
            anta_log_exception(e, f"An error occurred while issuing an eAPI request to {self.name}", logger)
        logger.debug("%s: %s", self.name, command)

copy async

copy(
    sources: list[Path],
    destination: Path,
    direction: Literal["to", "from"] = "from",
) -> None

Copy files to and from the device using asyncssh.scp().

Parameters:

Name	Type	Description	Default
sources	list[Path]	List of files to copy to or from the device.	required
destination	Path	Local or remote destination when copying the files. Can be a folder.	required
direction	Literal['to', 'from']	Defines if this coroutine copies files to or from the device.	'from'

Source code in anta/device.py

async def copy(self, sources: list[Path], destination: Path, direction: Literal["to", "from"] = "from") -> None:
    """Copy files to and from the device using asyncssh.scp().

    Parameters
    ----------
    sources
        List of files to copy to or from the device.
    destination
        Local or remote destination when copying the files. Can be a folder.
    direction
        Defines if this coroutine copies files to or from the device.

    """
    async with asyncssh.connect(
        host=self._ssh_opts.host,
        port=self._ssh_opts.port,
        tunnel=self._ssh_opts.tunnel,
        family=self._ssh_opts.family,
        local_addr=self._ssh_opts.local_addr,
        options=self._ssh_opts,
    ) as conn:
        src: list[tuple[SSHClientConnection, Path]] | list[Path]
        dst: tuple[SSHClientConnection, Path] | Path
        if direction == "from":
            src = [(conn, file) for file in sources]
            dst = destination
            for file in sources:
                message = f"Copying '{file}' from device {self.name} to '{destination}' locally"
                logger.info(message)

        elif direction == "to":
            src = sources
            dst = conn, destination
            for file in src:
                message = f"Copying '{file}' to device {self.name} to '{destination}' remotely"
                logger.info(message)

        else:
            logger.critical("'direction' argument to copy() function is invalid: %s", direction)

            return
        await asyncssh.scp(src, dst)

refresh async

refresh() -> None

Update attributes of an AsyncEOSDevice instance.

This coroutine must update the following attributes of AsyncEOSDevice: - is_online: When a device IP is reachable and a port can be open - established: When a command execution succeeds - hw_model: The hardware model of the device

Source code in anta/device.py

async def refresh(self) -> None:
    """Update attributes of an AsyncEOSDevice instance.

    This coroutine must update the following attributes of AsyncEOSDevice:
    - is_online: When a device IP is reachable and a port can be open
    - established: When a command execution succeeds
    - hw_model: The hardware model of the device
    """
    logger.debug("Refreshing device %s", self.name)
    self.is_online = await self._session.check_connection()
    if self.is_online:
        show_version = AntaCommand(command="show version")
        await self._collect(show_version)
        if not show_version.collected:
            logger.warning("Cannot get hardware information from device %s", self.name)
        else:
            self.hw_model = show_version.json_output.get("modelName", None)
            if self.hw_model is None:
                logger.critical("Cannot parse 'show version' returned by device %s", self.name)
            # in some cases it is possible that 'modelName' comes back empty
            # and it is nice to get a meaninfule error message
            elif self.hw_model == "":
                logger.critical("Got an empty 'modelName' in the 'show version' returned by device %s", self.name)
    else:
        logger.warning("Could not connect to device %s: cannot open eAPI port", self.name)

    self.established = bool(self.is_online and self.hw_model)