Skip to content

Services

ANTA catalog for services tests

Test functions related to the EOS various services settings

VerifyDNSLookup

Bases: AntaTest

This class verifies the DNS (Domain name service) name to IP address resolution.

Expected Results
  • success: The test will pass if a domain name is resolved to an IP address.
  • failure: The test will fail if a domain name does not resolve to an IP address.
  • error: This test will error out if a domain name is invalid.
Source code in anta/tests/services.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class VerifyDNSLookup(AntaTest):
    """
    This class verifies the DNS (Domain name service) name to IP address resolution.

    Expected Results:
        * success: The test will pass if a domain name is resolved to an IP address.
        * failure: The test will fail if a domain name does not resolve to an IP address.
        * error: This test will error out if a domain name is invalid.
    """

    name = "VerifyDNSLookup"
    description = "Verifies the DNS name to IP address resolution."
    categories = ["services"]
    commands = [AntaTemplate(template="bash timeout 10 nslookup {domain}")]

    class Input(AntaTest.Input):
        """Inputs for the VerifyDNSLookup test."""

        domain_names: List[str]
        """List of domain names"""

    def render(self, template: AntaTemplate) -> list[AntaCommand]:
        return [template.render(domain=domain_name) for domain_name in self.inputs.domain_names]

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()
        failed_domains = []
        for command in self.instance_commands:
            domain = command.params["domain"]
            output = command.json_output["messages"][0]
            if f"Can't find {domain}: No answer" in output:
                failed_domains.append(domain)
        if failed_domains:
            self.result.is_failure(f"The following domain(s) are not resolved to an IP address: {', '.join(failed_domains)}")

Input

Bases: Input

Inputs for the VerifyDNSLookup test.

Source code in anta/tests/services.py 
69
70
71
72
73
class Input(AntaTest.Input):
    """Inputs for the VerifyDNSLookup test."""

    domain_names: List[str]
    """List of domain names"""

domain_names instance-attribute 

domain_names: List[str]

List of domain names

VerifyDNSServers

Bases: AntaTest

Verifies if the DNS (Domain Name Service) servers are correctly configured.

Expected Results
  • success: The test will pass if the DNS server specified in the input is configured with the correct VRF and priority.
  • failure: The test will fail if the DNS server is not configured or if the VRF and priority of the DNS server do not match the input.
Source code in anta/tests/services.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
class VerifyDNSServers(AntaTest):
    """
    Verifies if the DNS (Domain Name Service) servers are correctly configured.

    Expected Results:
        * success: The test will pass if the DNS server specified in the input is configured with the correct VRF and priority.
        * failure: The test will fail if the DNS server is not configured or if the VRF and priority of the DNS server do not match the input.
    """

    name = "VerifyDNSServers"
    description = "Verifies if the DNS servers are correctly configured."
    categories = ["services"]
    commands = [AntaCommand(command="show ip name-server")]

    class Input(AntaTest.Input):
        """Inputs for the VerifyDNSServers test."""

        dns_servers: List[DnsServers]
        """List of DNS servers to verify."""

        class DnsServers(BaseModel):
            """DNS server details"""

            server_address: Union[IPv4Address, IPv6Address]
            """The IPv4/IPv6 address of the DNS server."""
            vrf: str = "default"
            """The VRF for the DNS server. Defaults to 'default' if not provided."""
            priority: int = Field(ge=0, le=4)
            """The priority of the DNS server from 0 to 4, lower is first."""

    @AntaTest.anta_test
    def test(self) -> None:
        command_output = self.instance_commands[0].json_output["nameServerConfigs"]
        self.result.is_success()
        for server in self.inputs.dns_servers:
            address = str(server.server_address)
            vrf = server.vrf
            priority = server.priority
            input_dict = {"ipAddr": address, "vrf": vrf}

            if get_item(command_output, "ipAddr", address) is None:
                self.result.is_failure(f"DNS server `{address}` is not configured with any VRF.")
                continue

            if (output := get_dict_superset(command_output, input_dict)) is None:
                self.result.is_failure(f"DNS server `{address}` is not configured with VRF `{vrf}`.")
                continue

            if output["priority"] != priority:
                self.result.is_failure(f"For DNS server `{address}`, the expected priority is `{priority}`, but `{output['priority']}` was found instead.")

Input

Bases: Input

Inputs for the VerifyDNSServers test.

Source code in anta/tests/services.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class Input(AntaTest.Input):
    """Inputs for the VerifyDNSServers test."""

    dns_servers: List[DnsServers]
    """List of DNS servers to verify."""

    class DnsServers(BaseModel):
        """DNS server details"""

        server_address: Union[IPv4Address, IPv6Address]
        """The IPv4/IPv6 address of the DNS server."""
        vrf: str = "default"
        """The VRF for the DNS server. Defaults to 'default' if not provided."""
        priority: int = Field(ge=0, le=4)
        """The priority of the DNS server from 0 to 4, lower is first."""

dns_servers instance-attribute 

dns_servers: List[DnsServers]

List of DNS servers to verify.

DnsServers

Bases: BaseModel

DNS server details

Source code in anta/tests/services.py 
111
112
113
114
115
116
117
118
119
class DnsServers(BaseModel):
    """DNS server details"""

    server_address: Union[IPv4Address, IPv6Address]
    """The IPv4/IPv6 address of the DNS server."""
    vrf: str = "default"
    """The VRF for the DNS server. Defaults to 'default' if not provided."""
    priority: int = Field(ge=0, le=4)
    """The priority of the DNS server from 0 to 4, lower is first."""
priority class-attribute instance-attribute 
priority: int = Field(ge=0, le=4)

The priority of the DNS server from 0 to 4, lower is first.

server_address instance-attribute 
server_address: Union[IPv4Address, IPv6Address]

The IPv4/IPv6 address of the DNS server.

vrf class-attribute instance-attribute 
vrf: str = 'default'

The VRF for the DNS server. Defaults to ‘default’ if not provided.

VerifyErrdisableRecovery

Bases: AntaTest

Verifies the errdisable recovery reason, status, and interval.

Expected Results
  • Success: The test will pass if the errdisable recovery reason status is enabled and the interval matches the input.
  • Failure: The test will fail if the errdisable recovery reason is not found, the status is not enabled, or the interval does not match the input.
Source code in anta/tests/services.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
class VerifyErrdisableRecovery(AntaTest):
    """
    Verifies the errdisable recovery reason, status, and interval.

    Expected Results:
        * Success: The test will pass if the errdisable recovery reason status is enabled and the interval matches the input.
        * Failure: The test will fail if the errdisable recovery reason is not found, the status is not enabled, or the interval does not match the input.
    """

    name = "VerifyErrdisableRecovery"
    description = "Verifies the errdisable recovery reason, status, and interval."
    categories = ["services"]
    commands = [AntaCommand(command="show errdisable recovery", ofmt="text")]  # Command does not support JSON output hence using text output

    class Input(AntaTest.Input):
        """Inputs for the VerifyErrdisableRecovery test."""

        reasons: List[ErrDisableReason]
        """List of errdisable reasons"""

        class ErrDisableReason(BaseModel):
            """Details of an errdisable reason"""

            reason: ErrDisableReasons
            """Type or name of the errdisable reason"""
            interval: ErrDisableInterval
            """Interval of the reason in seconds"""

    @AntaTest.anta_test
    def test(self) -> None:
        command_output = self.instance_commands[0].text_output
        self.result.is_success()
        for error_reason in self.inputs.reasons:
            input_reason = error_reason.reason
            input_interval = error_reason.interval
            reason_found = False

            # Skip header and last empty line
            lines = command_output.split("\n")[2:-1]
            for line in lines:
                # Skip empty lines
                if not line.strip():
                    continue
                # Split by first two whitespaces
                reason, status, interval = line.split(None, 2)
                if reason != input_reason:
                    continue
                reason_found = True
                actual_reason_data = {"interval": interval, "status": status}
                expected_reason_data = {"interval": str(input_interval), "status": "Enabled"}
                if actual_reason_data != expected_reason_data:
                    failed_log = get_failed_logs(expected_reason_data, actual_reason_data)
                    self.result.is_failure(f"`{input_reason}`:{failed_log}\n")
                break

            if not reason_found:
                self.result.is_failure(f"`{input_reason}`: Not found.\n")

Input

Bases: Input

Inputs for the VerifyErrdisableRecovery test.

Source code in anta/tests/services.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
class Input(AntaTest.Input):
    """Inputs for the VerifyErrdisableRecovery test."""

    reasons: List[ErrDisableReason]
    """List of errdisable reasons"""

    class ErrDisableReason(BaseModel):
        """Details of an errdisable reason"""

        reason: ErrDisableReasons
        """Type or name of the errdisable reason"""
        interval: ErrDisableInterval
        """Interval of the reason in seconds"""

reasons instance-attribute 

reasons: List[ErrDisableReason]

List of errdisable reasons

ErrDisableReason

Bases: BaseModel

Details of an errdisable reason

Source code in anta/tests/services.py 
163
164
165
166
167
168
169
class ErrDisableReason(BaseModel):
    """Details of an errdisable reason"""

    reason: ErrDisableReasons
    """Type or name of the errdisable reason"""
    interval: ErrDisableInterval
    """Interval of the reason in seconds"""
interval instance-attribute 
interval: ErrDisableInterval

Interval of the reason in seconds

reason instance-attribute 
reason: ErrDisableReasons

Type or name of the errdisable reason

VerifyHostname

Bases: AntaTest

Verifies the hostname of a device.

Expected results
  • success: The test will pass if the hostname matches the provided input.
  • failure: The test will fail if the hostname does not match the provided input.
Source code in anta/tests/services.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class VerifyHostname(AntaTest):
    """
    Verifies the hostname of a device.

    Expected results:
        * success: The test will pass if the hostname matches the provided input.
        * failure: The test will fail if the hostname does not match the provided input.
    """

    name = "VerifyHostname"
    description = "Verifies the hostname of a device."
    categories = ["services"]
    commands = [AntaCommand(command="show hostname")]

    class Input(AntaTest.Input):
        """Defines the input parameters for this test case."""

        hostname: str
        """Expected hostname of the device."""

    @AntaTest.anta_test
    def test(self) -> None:
        hostname = self.instance_commands[0].json_output["hostname"]

        if hostname != self.inputs.hostname:
            self.result.is_failure(f"Expected `{self.inputs.hostname}` as the hostname, but found `{hostname}` instead.")
        else:
            self.result.is_success()

Input

Bases: Input

Defines the input parameters for this test case.

Source code in anta/tests/services.py 
38
39
40
41
42
class Input(AntaTest.Input):
    """Defines the input parameters for this test case."""

    hostname: str
    """Expected hostname of the device."""

hostname instance-attribute 

hostname: str

Expected hostname of the device.