Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in vxlan interface #4749

laxmikantchintakindi · 2024-11-21T06:00:39Z

Change Summary

Add support to set vlan and vni ranges in vxlan interface

Related Issue(s)

Fixes #4664

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

Add support to set vlan and vni ranges in vxlan interface.

How to test

Checklist

User Checklist

N/A

Repository Checklist

My code has been rebased from devel before I start
I have read the CONTRIBUTING document.
My change requires a change to the documentation and documentation have been updated accordingly.
I have updated molecule CI testing accordingly. (check the box if not applicable)

github-actions · 2024-11-21T06:00:51Z

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4749
# Activate the virtual environment
source test-avd-pr-4749/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/laxmikantchintakindi/avd.git@refactor/eos_cli/vxlan_vni#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/laxmikantchintakindi/avd.git#/ansible_collections/arista/avd/,refactor/eos_cli/vxlan_vni --force
# Optional: Install AVD examples
cd test-avd-pr-4749
ansible-playbook arista.avd.install_examples

sonarqubecloud · 2024-11-21T07:43:08Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ansible_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs/host1.cfg

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/vxlan-interface.j2

laxmikantchintakindi · 2024-11-29T10:25:22Z

Shall I add ability to set multicast_group on vlan ranges?

vxlan_interface:
  vxlan1:
    description: DC1-LEAF2A_VTEP
    vxlan:
        - id: 113,115-118
          vni: 10113,10115-10118
          multicast_group: 239.1.1.1

This will result in below commands:

vxlan vlan 113,115-118 vni 10113,10115-10118
vxlan vlan 113 multicast group 239.1.1.1
vxlan vlan 115 multicast group 239.1.1.1
vxlan vlan 116 multicast group 239.1.1.1
vxlan vlan 117 multicast group 239.1.1.1
vxlan vlan 118 multicast group 239.1.1.1

@gmuloc @ClausHolbechArista

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/vxlan_interface.schema.yml

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/vxlan-interface.j2

alexeygorbunov · 2025-01-10T21:21:06Z

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/vxlan_interface.schema.yml

+                type: dict
+                description: |-
+                  Set VNI on range of vlans.
+                  If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.


vxlan_interface.vxlan1.vxlan.vlans is duplicated

Suggested change

If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.

If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.

alexeygorbunov · 2025-01-10T21:23:09Z

ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vxlan-interface.md

@@ -35,6 +35,9 @@
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;multicast_group</samp>](## "vxlan_interface.vxlan1.vxlan.vlans.[].multicast_group") | String |  |  |  | IP Multicast Group Address. |
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;flood_vteps</samp>](## "vxlan_interface.vxlan1.vxlan.vlans.[].flood_vteps") | List, items: String |  |  |  |  |
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&lt;str&gt;</samp>](## "vxlan_interface.vxlan1.vxlan.vlans.[].flood_vteps.[]") | String |  |  |  | Remote VTEP IP Address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;vlan_range</samp>](## "vxlan_interface.vxlan1.vxlan.vlan_range") | Dictionary |  |  |  | Set VNI on range of vlans.<br>If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.<br>Number of VLANs must equal number of VNIs. |


Suggested change

| [<samp>      vlan_range</samp>](## "vxlan_interface.vxlan1.vxlan.vlan_range") | Dictionary | | | | Set VNI on range of vlans. If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`. Number of VLANs must equal number of VNIs. |

| [<samp>      vlan_range</samp>](## "vxlan_interface.vxlan1.vxlan.vlan_range") | Dictionary | | | | Set VNI on range of vlans. If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`. Number of VLANs must equal number of VNIs. |

alexeygorbunov · 2025-01-10T21:23:53Z

ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vxlan-interface.md

@@ -70,6 +73,9 @@
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;multicast_group</samp>](## "vxlan_interface.Vxlan1.vxlan.vlans.[].multicast_group") | String |  |  |  | IP Multicast Group Address. |
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;flood_vteps</samp>](## "vxlan_interface.Vxlan1.vxlan.vlans.[].flood_vteps") | List, items: String |  |  |  |  |
    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&lt;str&gt;</samp>](## "vxlan_interface.Vxlan1.vxlan.vlans.[].flood_vteps.[]") | String |  |  |  | Remote VTEP IP Address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;vlan_range</samp>](## "vxlan_interface.Vxlan1.vxlan.vlan_range") | Dictionary |  |  |  | Set VNI on range of vlans.<br>If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.<br>Number of VLANs must equal number of VNIs. |


Suggested change

| [<samp>      vlan_range</samp>](## "vxlan_interface.Vxlan1.vxlan.vlan_range") | Dictionary | | | | Set VNI on range of vlans. If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`. Number of VLANs must equal number of VNIs. |

| [<samp>      vlan_range</samp>](## "vxlan_interface.Vxlan1.vxlan.vlan_range") | Dictionary | | | | Set VNI on range of vlans. If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`. Number of VLANs must equal number of VNIs. |

alexeygorbunov · 2025-01-10T21:24:33Z

ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vxlan-interface.md

@@ -129,6 +135,18 @@

                  # Remote VTEP IP Address.
                - <str>
+
+          # Set VNI on range of vlans.
+          # If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.


Suggested change

# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.

# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.

alexeygorbunov · 2025-01-10T21:24:46Z

ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vxlan-interface.md

@@ -194,6 +212,18 @@

                  # Remote VTEP IP Address.
                - <str>
+
+          # Set VNI on range of vlans.
+          # If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.


Suggested change

# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.

# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.

Can I change vxlan_interface.vxlan1.vxlan.vlan_range to vxlan_interface.vxlan1.vxlan.vlan_range.vlans?

Right, this is probably even better

gmuloc · 2025-01-13T09:13:51Z

ansible_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs/host1.cfg

@@ -3787,6 +3787,7 @@ interface Vxlan1
   vxlan flood vtep learned data-plane
   vxlan vlan 110 vni 10110
   vxlan vlan 111 vni 10111
+   vxlan vlan 113,115-118 vni 10113,10115-10118


discussion on PR review call: what happens with many tokens 1,3,5,7,9,11,... to see if EOS will wrap it.
We may need to be able to give multiple ranges if EOS wraps to make it possible to match the output.

s1-host1(config-if-Vx1)#sh active interface Vxlan1 vxlan udp-port 4789 vxlan vlan 10-13,17-20 vni 10010-10013,10017-10020 s1-host1(config-if-Vx1)#vxlan vlan add 25-30 vni 10025-10030 s1-host1(config-if-Vx1)#sh active interface Vxlan1 vxlan udp-port 4789 vxlan vlan 10-13,17-20,25-30 vni 10010-10013,10017-10020,10025-10030

Yes it is supporting multiple ranges and wraps all individual and ranges in a single line.

For long input of vlan/vnis the command doesnt change.

s1-leaf1(config-if-Vx1)#Vxlan vlan 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31 vni 10001,10003,10005,10007,10009,10011,10013,10015,10017,10019,10021,10023,10025,10027,10029,10031 s1-leaf1(config-if-Vx1)#sh active interface Vxlan1 vxlan udp-port 4789 vxlan vlan 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31 vni 10001,10003,10005,10007,10009,10011,10013,10015,10017,10019,10021,10023,10025,10027,10029,10031

…/vxlan-interface.j2 Co-authored-by: Shivani-gslab <[email protected]>

…xlan_interface.schema.yml Co-authored-by: Claus Holbech <[email protected]>

…xlan_interface.schema.yml Co-authored-by: Vibhu-gslab <[email protected]>

…/vxlan-interface.j2 Co-authored-by: Vibhu-gslab <[email protected]>

github-actions bot assigned laxmikantchintakindi Nov 21, 2024

github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated labels Nov 21, 2024

Shivani-gslab reviewed Nov 21, 2024

View reviewed changes

ansible_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs/host1.cfg Show resolved Hide resolved

laxmikantchintakindi force-pushed the refactor/eos_cli/vxlan_vni branch from 797398b to ce4705e Compare November 21, 2024 17:12

laxmikantchintakindi requested a review from Shivani-gslab November 22, 2024 08:12

Shivani-gslab marked this pull request as ready for review November 22, 2024 12:49

Shivani-gslab requested review from a team as code owners November 22, 2024 12:49

Shivani-gslab marked this pull request as draft November 22, 2024 12:56

Shivani-gslab reviewed Nov 22, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/vxlan-interface.j2 Outdated Show resolved Hide resolved

Shivani-gslab reviewed Nov 28, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/vxlan-interface.j2 Outdated Show resolved Hide resolved

laxmikantchintakindi force-pushed the refactor/eos_cli/vxlan_vni branch from fff30e2 to 1ae28e3 Compare November 28, 2024 13:58

laxmikantchintakindi force-pushed the refactor/eos_cli/vxlan_vni branch 6 times, most recently from 3b5ee1c to 01469f9 Compare December 2, 2024 15:10

Shivani-gslab marked this pull request as ready for review December 3, 2024 13:11

gmuloc reviewed Dec 4, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/vxlan_interface.schema.yml Outdated Show resolved Hide resolved

laxmikantchintakindi force-pushed the refactor/eos_cli/vxlan_vni branch from c7be07a to e323630 Compare December 4, 2024 12:43

MaheshGSLAB requested review from Shivani-gslab, ClausHolbechArista, gmuloc and Vibhu-gslab December 6, 2024 11:34

laxmikantchintakindi requested a review from alexeygorbunov January 9, 2025 07:15

Vibhu-gslab reviewed Jan 9, 2025

View reviewed changes

laxmikantchintakindi requested a review from Vibhu-gslab January 10, 2025 04:32

Vibhu-gslab approved these changes Jan 10, 2025

View reviewed changes

Vibhu-gslab marked this pull request as ready for review January 10, 2025 07:31

alexeygorbunov reviewed Jan 10, 2025

View reviewed changes

laxmikantchintakindi marked this pull request as draft January 13, 2025 05:06

laxmikantchintakindi marked this pull request as ready for review January 13, 2025 06:20

gmuloc reviewed Jan 13, 2025

View reviewed changes

Laxmikant Chintakindi and others added 20 commits January 13, 2025 20:10

Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in

faf2384

Run eos_validate_state molecule

f49c6a4

Update documentation template

56ea386

Update python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation…

76f0677

…/vxlan-interface.j2 Co-authored-by: Shivani-gslab <[email protected]>

Temp

67675e8

Ignore the wrong inputs

5bf548c

Small change in doc

66394f0

update logic in doc

41354fb

Update code

370b044

Adding new key for vlan ranges

d7bc3fc

Fix doc and descriptions in schema

1b914b2

update descriptions in schema

08273f9

Address comments on schemas

f507057

Update python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/v…

f3e70c5

…xlan_interface.schema.yml Co-authored-by: Claus Holbech <[email protected]>

Modify templates

3dcf6f5

Default vxlan.vlans to empty list in doc template

9f892de

Update python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/v…

a905fd7

…xlan_interface.schema.yml Co-authored-by: Vibhu-gslab <[email protected]>

Update python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/v…

5ea3d70

…xlan_interface.schema.yml Co-authored-by: Vibhu-gslab <[email protected]>

Update python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation…

57f0f20

…/vxlan-interface.j2 Co-authored-by: Vibhu-gslab <[email protected]>

Fixing defined check in template

33cffb1

laxmikantchintakindi force-pushed the refactor/eos_cli/vxlan_vni branch from 522a81f to 33cffb1 Compare January 13, 2025 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in vxlan interface #4749

Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in vxlan interface #4749

laxmikantchintakindi commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024

sonarqubecloud bot commented Nov 21, 2024

laxmikantchintakindi commented Nov 29, 2024 •

edited

Loading

alexeygorbunov Jan 10, 2025

alexeygorbunov Jan 10, 2025

alexeygorbunov Jan 10, 2025

alexeygorbunov Jan 10, 2025

alexeygorbunov Jan 10, 2025

laxmikantchintakindi Jan 13, 2025

alexeygorbunov Jan 13, 2025

gmuloc Jan 13, 2025

laxmikantchintakindi Jan 13, 2025

laxmikantchintakindi Jan 13, 2025

	If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.
	If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.

	\| [<samp>      vlan_range</samp>](## "vxlan_interface.vxlan1.vxlan.vlan_range") \| Dictionary \| \| \| \| Set VNI on range of vlans.<br>If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.<br>Number of VLANs must equal number of VNIs. \|
	\| [<samp>      vlan_range</samp>](## "vxlan_interface.vxlan1.vxlan.vlan_range") \| Dictionary \| \| \| \| Set VNI on range of vlans.<br>If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.<br>Number of VLANs must equal number of VNIs. \|

	# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlans`.
	# If vni is set on the vlan in `vxlan_interface.vxlan1.vxlan.vlans`, it should not overlap with `vxlan_interface.vxlan1.vxlan.vlan_range`.

Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in vxlan interface #4749

Are you sure you want to change the base?

Refactor(eos_cli_config_gen): Add support to set vlan and vni ranges in vxlan interface #4749

Conversation

laxmikantchintakindi commented Nov 21, 2024 • edited Loading

Change Summary

Related Issue(s)

Component(s) name

Proposed changes

How to test

Checklist

User Checklist

Repository Checklist

github-actions bot commented Nov 21, 2024

sonarqubecloud bot commented Nov 21, 2024

Quality Gate passed

laxmikantchintakindi commented Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laxmikantchintakindi commented Nov 21, 2024 •

edited

Loading

laxmikantchintakindi commented Nov 29, 2024 •

edited

Loading