Skip to content

VXLAN

ANTA catalog for VXLAN tests

Test functions related to VXLAN

VerifyVxlan1ConnSettings

Bases: AntaTest

Verifies the interface vxlan1 source interface and UDP port.

Expected Results
  • success: Passes if the interface vxlan1 source interface and UDP port are correct.
  • failure: Fails if the interface vxlan1 source interface or UDP port are incorrect.
  • skipped: Skips if the Vxlan1 interface is not configured.
Source code in anta/tests/vxlan.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class VerifyVxlan1ConnSettings(AntaTest):
    """
    Verifies the interface vxlan1 source interface and UDP port.

    Expected Results:
      * success: Passes if the interface vxlan1 source interface and UDP port are correct.
      * failure: Fails if the interface vxlan1 source interface or UDP port are incorrect.
      * skipped: Skips if the Vxlan1 interface is not configured.
    """

    name = "VerifyVxlan1ConnSettings"
    description = "Verifies the interface vxlan1 source interface and UDP port."
    categories = ["vxlan"]
    commands = [AntaCommand(command="show interfaces")]

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

        source_interface: VxlanSrcIntf
        """Source loopback interface of vxlan1 interface"""
        udp_port: int = Field(ge=1024, le=65335)
        """UDP port used for vxlan1 interface"""

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()
        command_output = self.instance_commands[0].json_output

        # Skip the test case if vxlan1 interface is not configured
        vxlan_output = get_value(command_output, "interfaces.Vxlan1")
        if not vxlan_output:
            self.result.is_skipped("Vxlan1 interface is not configured.")
            return

        src_intf = vxlan_output.get("srcIpIntf")
        port = vxlan_output.get("udpPort")

        # Check vxlan1 source interface and udp port
        if src_intf != self.inputs.source_interface:
            self.result.is_failure(f"Source interface is not correct. Expected `{self.inputs.source_interface}` as source interface but found `{src_intf}` instead.")
        if port != self.inputs.udp_port:
            self.result.is_failure(f"UDP port is not correct. Expected `{self.inputs.udp_port}` as UDP port but found `{port}` instead.")

Input

Bases: Input

Inputs for the VerifyVxlan1ConnSettings test.

Source code in anta/tests/vxlan.py 
193
194
195
196
197
198
199
class Input(AntaTest.Input):
    """Inputs for the VerifyVxlan1ConnSettings test."""

    source_interface: VxlanSrcIntf
    """Source loopback interface of vxlan1 interface"""
    udp_port: int = Field(ge=1024, le=65335)
    """UDP port used for vxlan1 interface"""

source_interface instance-attribute 

source_interface: VxlanSrcIntf

Source loopback interface of vxlan1 interface

udp_port class-attribute instance-attribute 

udp_port: int = Field(ge=1024, le=65335)

UDP port used for vxlan1 interface

VerifyVxlan1Interface

Bases: AntaTest

This test verifies if the Vxlan1 interface is configured and ‘up/up’.

Warning

The name of this test has been updated from ‘VerifyVxlan’ for better representation.

Expected Results
  • success: The test will pass if the Vxlan1 interface is configured with line protocol status and interface status ‘up’.
  • failure: The test will fail if the Vxlan1 interface line protocol status or interface status are not ‘up’.
  • skipped: The test will be skipped if the Vxlan1 interface is not configured.
Source code in anta/tests/vxlan.py 
22
23
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
52
53
54
class VerifyVxlan1Interface(AntaTest):
    """
    This test verifies if the Vxlan1 interface is configured and 'up/up'.

    !!! warning
        The name of this test has been updated from 'VerifyVxlan' for better representation.

    Expected Results:
      * success: The test will pass if the Vxlan1 interface is configured with line protocol status and interface status 'up'.
      * failure: The test will fail if the Vxlan1 interface line protocol status or interface status are not 'up'.
      * skipped: The test will be skipped if the Vxlan1 interface is not configured.
    """

    name = "VerifyVxlan1Interface"
    description = "Verifies the Vxlan1 interface status."
    categories = ["vxlan"]
    commands = [AntaCommand(command="show interfaces description", ofmt="json")]

    @AntaTest.anta_test
    def test(self) -> None:
        command_output = self.instance_commands[0].json_output
        if "Vxlan1" not in command_output["interfaceDescriptions"]:
            self.result.is_skipped("Vxlan1 interface is not configured")
        elif (
            command_output["interfaceDescriptions"]["Vxlan1"]["lineProtocolStatus"] == "up"
            and command_output["interfaceDescriptions"]["Vxlan1"]["interfaceStatus"] == "up"
        ):
            self.result.is_success()
        else:
            self.result.is_failure(
                f"Vxlan1 interface is {command_output['interfaceDescriptions']['Vxlan1']['lineProtocolStatus']}"
                f"/{command_output['interfaceDescriptions']['Vxlan1']['interfaceStatus']}"
            )

VerifyVxlanConfigSanity

Bases: AntaTest

This test verifies that no issues are detected with the VXLAN configuration.

Expected Results
  • success: The test will pass if no issues are detected with the VXLAN configuration.
  • failure: The test will fail if issues are detected with the VXLAN configuration.
  • skipped: The test will be skipped if VXLAN is not configured on the device.
Source code in anta/tests/vxlan.py 
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
class VerifyVxlanConfigSanity(AntaTest):
    """
    This test verifies that no issues are detected with the VXLAN configuration.

    Expected Results:
      * success: The test will pass if no issues are detected with the VXLAN configuration.
      * failure: The test will fail if issues are detected with the VXLAN configuration.
      * skipped: The test will be skipped if VXLAN is not configured on the device.
    """

    name = "VerifyVxlanConfigSanity"
    description = "Verifies there are no VXLAN config-sanity inconsistencies."
    categories = ["vxlan"]
    commands = [AntaCommand(command="show vxlan config-sanity", ofmt="json")]

    @AntaTest.anta_test
    def test(self) -> None:
        command_output = self.instance_commands[0].json_output
        if "categories" not in command_output or len(command_output["categories"]) == 0:
            self.result.is_skipped("VXLAN is not configured")
            return
        failed_categories = {
            category: content
            for category, content in command_output["categories"].items()
            if category in ["localVtep", "mlag", "pd"] and content["allCheckPass"] is not True
        }
        if len(failed_categories) > 0:
            self.result.is_failure(f"VXLAN config sanity check is not passing: {failed_categories}")
        else:
            self.result.is_success()

VerifyVxlanVniBinding

Bases: AntaTest

This test verifies the VNI-VLAN bindings of the Vxlan1 interface.

Expected Results
  • success: The test will pass if the VNI-VLAN bindings provided are properly configured.
  • failure: The test will fail if any VNI lacks bindings or if any bindings are incorrect.
  • skipped: The test will be skipped if the Vxlan1 interface is not configured.
Source code in anta/tests/vxlan.py 
 89
 90
 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
class VerifyVxlanVniBinding(AntaTest):
    """
    This test verifies the VNI-VLAN bindings of the Vxlan1 interface.

    Expected Results:
      * success: The test will pass if the VNI-VLAN bindings provided are properly configured.
      * failure: The test will fail if any VNI lacks bindings or if any bindings are incorrect.
      * skipped: The test will be skipped if the Vxlan1 interface is not configured.
    """

    name = "VerifyVxlanVniBinding"
    description = "Verifies the VNI-VLAN bindings of the Vxlan1 interface."
    categories = ["vxlan"]
    commands = [AntaCommand(command="show vxlan vni", ofmt="json")]

    class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
        bindings: Dict[Vni, Vlan]
        """VNI to VLAN bindings to verify"""

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()

        no_binding = []
        wrong_binding = []

        if (vxlan1 := get_value(self.instance_commands[0].json_output, "vxlanIntfs.Vxlan1")) is None:
            self.result.is_skipped("Vxlan1 interface is not configured")
            return

        for vni, vlan in self.inputs.bindings.items():
            vni = str(vni)
            if vni in vxlan1["vniBindings"]:
                retrieved_vlan = vxlan1["vniBindings"][vni]["vlan"]
            elif vni in vxlan1["vniBindingsToVrf"]:
                retrieved_vlan = vxlan1["vniBindingsToVrf"][vni]["vlan"]
            else:
                no_binding.append(vni)
                retrieved_vlan = None

            if retrieved_vlan and vlan != retrieved_vlan:
                wrong_binding.append({vni: retrieved_vlan})

        if no_binding:
            self.result.is_failure(f"The following VNI(s) have no binding: {no_binding}")

        if wrong_binding:
            self.result.is_failure(f"The following VNI(s) have the wrong VLAN binding: {wrong_binding}")

Input

Bases: Input

Source code in anta/tests/vxlan.py 
104
105
106
class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
    bindings: Dict[Vni, Vlan]
    """VNI to VLAN bindings to verify"""

bindings instance-attribute 

bindings: Dict[Vni, Vlan]

VNI to VLAN bindings to verify

VerifyVxlanVtep

Bases: AntaTest

This test verifies the VTEP peers of the Vxlan1 interface.

Expected Results
  • success: The test will pass if all provided VTEP peers are identified and matching.
  • failure: The test will fail if any VTEP peer is missing or there are unexpected VTEP peers.
  • skipped: The test will be skipped if the Vxlan1 interface is not configured.
Source code in anta/tests/vxlan.py 
139
140
141
142
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
class VerifyVxlanVtep(AntaTest):
    """
    This test verifies the VTEP peers of the Vxlan1 interface.

    Expected Results:
      * success: The test will pass if all provided VTEP peers are identified and matching.
      * failure: The test will fail if any VTEP peer is missing or there are unexpected VTEP peers.
      * skipped: The test will be skipped if the Vxlan1 interface is not configured.
    """

    name = "VerifyVxlanVtep"
    description = "Verifies the VTEP peers of the Vxlan1 interface"
    categories = ["vxlan"]
    commands = [AntaCommand(command="show vxlan vtep", ofmt="json")]

    class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
        vteps: List[IPv4Address]
        """List of VTEP peers to verify"""

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()

        inputs_vteps = [str(input_vtep) for input_vtep in self.inputs.vteps]

        if (vxlan1 := get_value(self.instance_commands[0].json_output, "interfaces.Vxlan1")) is None:
            self.result.is_skipped("Vxlan1 interface is not configured")
            return

        difference1 = set(inputs_vteps).difference(set(vxlan1["vteps"]))
        difference2 = set(vxlan1["vteps"]).difference(set(inputs_vteps))

        if difference1:
            self.result.is_failure(f"The following VTEP peer(s) are missing from the Vxlan1 interface: {sorted(difference1)}")

        if difference2:
            self.result.is_failure(f"Unexpected VTEP peer(s) on Vxlan1 interface: {sorted(difference2)}")

Input

Bases: Input

Source code in anta/tests/vxlan.py 
154
155
156
class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
    vteps: List[IPv4Address]
    """List of VTEP peers to verify"""

vteps instance-attribute 

vteps: List[IPv4Address]

List of VTEP peers to verify