Refactor(eos_designs)!: Change L2 uplink description (#4532)

Co-authored-by: Guillaume Mulocher <[email protected]> Co-authored-by: Carl Buchmann <[email protected]>
aristanetworks · Oct 1, 2024 · e287ff1 · e287ff1
1 parent 28051ac
commit e287ff1
Show file tree

Hide file tree

Showing 405 changed files with 1,744 additions and 1,586 deletions.
diff --git a/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md b/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md
@@ -425,6 +425,35 @@ The default descriptions can be reverted manually if needed:
 
 The description fields support templates. See the input variables documentation for available fields.
 
+#### Underlay L2 ethernet interfaces
+
+The interface description for the L2 uplink/downlink interfaces changes to `L2_<peer>_<peer_interface>`. Previously the description was `<peer | upper>_<peer_interface>`.
+
+The interfaces using this are the member interfaces of port-channel uplinks.
+
+The descriptions can be reverted manually if needed:
+
+```diff
++underlay_l2_ethernet_description: "{peer!u}_{peer_interface}"
+```
+
+The description field support templates. See the input variables documentation for available fields.
+
+#### Underlay L2 port-channel interfaces
+
+The interface description for the L2 uplink/downlink port-channels changes to `L2_<peer_node_group_or_peer>_<peer_interface>`. Previously the default description was `<peer_node_group_or_uppercase_peer>_Po<peer_port_channel_id>`.
+The field `peer_node_group_or_peer` will contain the peer's node group name for MLAG pairs or EVPN A/A nodes or the peer's hostname for a single switch.
+
+The port-channels using this are port-channel uplinks.
+
+The descriptions can be reverted manually if needed:
+
+```diff
++underlay_l2_port_channel_description: "{peer_node_group_or_uppercase_peer}_Po{peer_port_channel_id}"
+```
+
+The description field support templates. See the input variables documentation for available fields.
+
 #### Out-of-band management interface
 
 The default interface description for the management interface changes to `OOB_MANAGEMENT`.

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1A.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1A.md
@@ -329,7 +329,7 @@ vlan 4094
 | Ethernet46 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
 | Ethernet47 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
 | Ethernet48 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
-| Ethernet51 | SPINE1_Ethernet1 | *trunk | *10,110,120,130 | *- | *- | 51 |
+| Ethernet51 | L2_SPINE1_Ethernet1 | *trunk | *10,110,120,130 | *- | *- | 51 |
 | Ethernet53 | MLAG_LEAF1B_Ethernet53 | *trunk | *- | *- | *MLAG | 53 |
 | Ethernet54 | MLAG_LEAF1B_Ethernet54 | *trunk | *- | *- | *MLAG | 53 |
 
@@ -1353,7 +1353,7 @@ interface Ethernet48
    spanning-tree bpduguard enable
 !
 interface Ethernet51
-   description SPINE1_Ethernet1
+   description L2_SPINE1_Ethernet1
    no shutdown
    channel-group 51 mode active
 !
@@ -1376,15 +1376,15 @@ interface Ethernet54
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel51 | SPINES_Po1 | trunk | 10,110,120,130 | - | - | - | - | 51 | - |
+| Port-Channel51 | L2_SPINES_Port-Channel1 | trunk | 10,110,120,130 | - | - | - | - | 51 | - |
 | Port-Channel53 | MLAG_LEAF1B_Port-Channel53 | trunk | - | - | MLAG | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel51
-   description SPINES_Po1
+   description L2_SPINES_Port-Channel1
    no shutdown
    switchport trunk allowed vlan 10,110,120,130
    switchport mode trunk

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1B.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1B.md
@@ -329,7 +329,7 @@ vlan 4094
 | Ethernet46 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
 | Ethernet47 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
 | Ethernet48 | IDF1 Standard Port | trunk phone | - | 110 | - | - |
-| Ethernet51 | SPINE2_Ethernet1 | *trunk | *10,110,120,130 | *- | *- | 51 |
+| Ethernet51 | L2_SPINE2_Ethernet1 | *trunk | *10,110,120,130 | *- | *- | 51 |
 | Ethernet53 | MLAG_LEAF1A_Ethernet53 | *trunk | *- | *- | *MLAG | 53 |
 | Ethernet54 | MLAG_LEAF1A_Ethernet54 | *trunk | *- | *- | *MLAG | 53 |
 
@@ -1353,7 +1353,7 @@ interface Ethernet48
    spanning-tree bpduguard enable
 !
 interface Ethernet51
-   description SPINE2_Ethernet1
+   description L2_SPINE2_Ethernet1
    no shutdown
    channel-group 51 mode active
 !
@@ -1376,15 +1376,15 @@ interface Ethernet54
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel51 | SPINES_Po1 | trunk | 10,110,120,130 | - | - | - | - | 51 | - |
+| Port-Channel51 | L2_SPINES_Port-Channel1 | trunk | 10,110,120,130 | - | - | - | - | 51 | - |
 | Port-Channel53 | MLAG_LEAF1A_Port-Channel53 | trunk | - | - | MLAG | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel51
-   description SPINES_Po1
+   description L2_SPINES_Port-Channel1
    no shutdown
    switchport trunk allowed vlan 10,110,120,130
    switchport mode trunk

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF2A.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF2A.md
@@ -247,8 +247,8 @@ vlan 230
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | Channel-Group |
 | --------- | ----------- | ---- | ----- | ----------- | ----------- | ------------- |
-| Ethernet1/1 | SPINE1_Ethernet49/1 | *trunk | *10,210,220,230 | *- | *- | 11 |
-| Ethernet1/3 | SPINE2_Ethernet49/1 | *trunk | *10,210,220,230 | *- | *- | 11 |
+| Ethernet1/1 | L2_SPINE1_Ethernet49/1 | *trunk | *10,210,220,230 | *- | *- | 11 |
+| Ethernet1/3 | L2_SPINE2_Ethernet49/1 | *trunk | *10,210,220,230 | *- | *- | 11 |
 | Ethernet3/1 | IDF2 Standard Port | trunk phone | - | 210 | - | - |
 | Ethernet3/2 | IDF2 Standard Port | trunk phone | - | 210 | - | - |
 | Ethernet3/3 | IDF2 Standard Port | trunk phone | - | 210 | - | - |
@@ -742,12 +742,12 @@ vlan 230
 ```eos
 !
 interface Ethernet1/1
-   description SPINE1_Ethernet49/1
+   description L2_SPINE1_Ethernet49/1
    no shutdown
    channel-group 11 mode active
 !
 interface Ethernet1/3
-   description SPINE2_Ethernet49/1
+   description L2_SPINE2_Ethernet49/1
    no shutdown
    channel-group 11 mode active
 !
@@ -6760,14 +6760,14 @@ interface Ethernet7/48
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel11 | SPINES_Po491 | trunk | 10,210,220,230 | - | - | - | - | - | - |
+| Port-Channel11 | L2_SPINES_Port-Channel491 | trunk | 10,210,220,230 | - | - | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel11
-   description SPINES_Po491
+   description L2_SPINES_Port-Channel491
    no shutdown
    switchport trunk allowed vlan 10,210,220,230
    switchport mode trunk

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3A.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3A.md
@@ -377,11 +377,11 @@ vlan 4094
 | Ethernet94 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet95 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet96 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
-| Ethernet97/1 | SPINE1_Ethernet50/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
-| Ethernet97/2 | SPINE2_Ethernet50/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
-| Ethernet97/3 | LEAF3C_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 973 |
-| Ethernet97/4 | LEAF3D_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 974 |
-| Ethernet98/1 | LEAF3E_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 981 |
+| Ethernet97/1 | L2_SPINE1_Ethernet50/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/2 | L2_SPINE2_Ethernet50/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/3 | L2_LEAF3C_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 973 |
+| Ethernet97/4 | L2_LEAF3D_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 974 |
+| Ethernet98/1 | L2_LEAF3E_Ethernet97/1 | *trunk | *10,310,320,330 | *- | *- | 981 |
 | Ethernet98/3 | MLAG_LEAF3B_Ethernet98/3 | *trunk | *- | *- | *MLAG | 983 |
 | Ethernet98/4 | MLAG_LEAF3B_Ethernet98/4 | *trunk | *- | *- | *MLAG | 983 |
 
@@ -2413,27 +2413,27 @@ interface Ethernet96
    spanning-tree bpduguard enable
 !
 interface Ethernet97/1
-   description SPINE1_Ethernet50/1
+   description L2_SPINE1_Ethernet50/1
    no shutdown
    channel-group 971 mode active
 !
 interface Ethernet97/2
-   description SPINE2_Ethernet50/1
+   description L2_SPINE2_Ethernet50/1
    no shutdown
    channel-group 971 mode active
 !
 interface Ethernet97/3
-   description LEAF3C_Ethernet97/1
+   description L2_LEAF3C_Ethernet97/1
    no shutdown
    channel-group 973 mode active
 !
 interface Ethernet97/4
-   description LEAF3D_Ethernet97/1
+   description L2_LEAF3D_Ethernet97/1
    no shutdown
    channel-group 974 mode active
 !
 interface Ethernet98/1
-   description LEAF3E_Ethernet97/1
+   description L2_LEAF3E_Ethernet97/1
    no shutdown
    channel-group 981 mode active
 !
@@ -2456,42 +2456,42 @@ interface Ethernet98/4
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel971 | SPINES_Po501 | trunk | 10,310,320,330 | - | - | - | - | 971 | - |
-| Port-Channel973 | LEAF3C_Po971 | trunk | 10,310,320,330 | - | - | - | - | 973 | - |
-| Port-Channel974 | LEAF3D_Po971 | trunk | 10,310,320,330 | - | - | - | - | 974 | - |
-| Port-Channel981 | LEAF3E_Po971 | trunk | 10,310,320,330 | - | - | - | - | 981 | - |
+| Port-Channel971 | L2_SPINES_Port-Channel501 | trunk | 10,310,320,330 | - | - | - | - | 971 | - |
+| Port-Channel973 | L2_LEAF3C_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 973 | - |
+| Port-Channel974 | L2_LEAF3D_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 974 | - |
+| Port-Channel981 | L2_LEAF3E_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 981 | - |
 | Port-Channel983 | MLAG_LEAF3B_Port-Channel983 | trunk | - | - | MLAG | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel971
-   description SPINES_Po501
+   description L2_SPINES_Port-Channel501
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 971
 !
 interface Port-Channel973
-   description LEAF3C_Po971
+   description L2_LEAF3C_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 973
 !
 interface Port-Channel974
-   description LEAF3D_Po971
+   description L2_LEAF3D_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 974
 !
 interface Port-Channel981
-   description LEAF3E_Po971
+   description L2_LEAF3E_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3B.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3B.md
@@ -377,11 +377,11 @@ vlan 4094
 | Ethernet94 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet95 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet96 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
-| Ethernet97/1 | SPINE1_Ethernet51/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
-| Ethernet97/2 | SPINE2_Ethernet51/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
-| Ethernet97/3 | LEAF3C_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 973 |
-| Ethernet97/4 | LEAF3D_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 974 |
-| Ethernet98/1 | LEAF3E_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 981 |
+| Ethernet97/1 | L2_SPINE1_Ethernet51/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/2 | L2_SPINE2_Ethernet51/1 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/3 | L2_LEAF3C_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 973 |
+| Ethernet97/4 | L2_LEAF3D_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 974 |
+| Ethernet98/1 | L2_LEAF3E_Ethernet97/2 | *trunk | *10,310,320,330 | *- | *- | 981 |
 | Ethernet98/3 | MLAG_LEAF3A_Ethernet98/3 | *trunk | *- | *- | *MLAG | 983 |
 | Ethernet98/4 | MLAG_LEAF3A_Ethernet98/4 | *trunk | *- | *- | *MLAG | 983 |
 
@@ -2413,27 +2413,27 @@ interface Ethernet96
    spanning-tree bpduguard enable
 !
 interface Ethernet97/1
-   description SPINE1_Ethernet51/1
+   description L2_SPINE1_Ethernet51/1
    no shutdown
    channel-group 971 mode active
 !
 interface Ethernet97/2
-   description SPINE2_Ethernet51/1
+   description L2_SPINE2_Ethernet51/1
    no shutdown
    channel-group 971 mode active
 !
 interface Ethernet97/3
-   description LEAF3C_Ethernet97/2
+   description L2_LEAF3C_Ethernet97/2
    no shutdown
    channel-group 973 mode active
 !
 interface Ethernet97/4
-   description LEAF3D_Ethernet97/2
+   description L2_LEAF3D_Ethernet97/2
    no shutdown
    channel-group 974 mode active
 !
 interface Ethernet98/1
-   description LEAF3E_Ethernet97/2
+   description L2_LEAF3E_Ethernet97/2
    no shutdown
    channel-group 981 mode active
 !
@@ -2456,42 +2456,42 @@ interface Ethernet98/4
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel971 | SPINES_Po501 | trunk | 10,310,320,330 | - | - | - | - | 971 | - |
-| Port-Channel973 | LEAF3C_Po971 | trunk | 10,310,320,330 | - | - | - | - | 973 | - |
-| Port-Channel974 | LEAF3D_Po971 | trunk | 10,310,320,330 | - | - | - | - | 974 | - |
-| Port-Channel981 | LEAF3E_Po971 | trunk | 10,310,320,330 | - | - | - | - | 981 | - |
+| Port-Channel971 | L2_SPINES_Port-Channel501 | trunk | 10,310,320,330 | - | - | - | - | 971 | - |
+| Port-Channel973 | L2_LEAF3C_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 973 | - |
+| Port-Channel974 | L2_LEAF3D_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 974 | - |
+| Port-Channel981 | L2_LEAF3E_Port-Channel971 | trunk | 10,310,320,330 | - | - | - | - | 981 | - |
 | Port-Channel983 | MLAG_LEAF3A_Port-Channel983 | trunk | - | - | MLAG | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel971
-   description SPINES_Po501
+   description L2_SPINES_Port-Channel501
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 971
 !
 interface Port-Channel973
-   description LEAF3C_Po971
+   description L2_LEAF3C_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 973
 !
 interface Port-Channel974
-   description LEAF3D_Po971
+   description L2_LEAF3D_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk
    switchport
    mlag 974
 !
 interface Port-Channel981
-   description LEAF3E_Po971
+   description L2_LEAF3E_Port-Channel971
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3C.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3C.md
@@ -341,8 +341,8 @@ vlan 330
 | Ethernet94 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet95 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
 | Ethernet96 | IDF3 Standard Port | trunk phone | - | 310 | - | - |
-| Ethernet97/1 | LEAF3A_Ethernet97/3 | *trunk | *10,310,320,330 | *- | *- | 971 |
-| Ethernet97/2 | LEAF3B_Ethernet97/3 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/1 | L2_LEAF3A_Ethernet97/3 | *trunk | *10,310,320,330 | *- | *- | 971 |
+| Ethernet97/2 | L2_LEAF3B_Ethernet97/3 | *trunk | *10,310,320,330 | *- | *- | 971 |
 
 *Inherited from Port-Channel Interface
 
@@ -2372,12 +2372,12 @@ interface Ethernet96
    spanning-tree bpduguard enable
 !
 interface Ethernet97/1
-   description LEAF3A_Ethernet97/3
+   description L2_LEAF3A_Ethernet97/3
    no shutdown
    channel-group 971 mode active
 !
 interface Ethernet97/2
-   description LEAF3B_Ethernet97/3
+   description L2_LEAF3B_Ethernet97/3
    no shutdown
    channel-group 971 mode active
 ```
@@ -2390,14 +2390,14 @@ interface Ethernet97/2
 
 | Interface | Description | Mode | VLANs | Native VLAN | Trunk Group | LACP Fallback Timeout | LACP Fallback Mode | MLAG ID | EVPN ESI |
 | --------- | ----------- | ---- | ----- | ----------- | ------------| --------------------- | ------------------ | ------- | -------- |
-| Port-Channel971 | IDF3_AGG_Po973 | trunk | 10,310,320,330 | - | - | - | - | - | - |
+| Port-Channel971 | L2_IDF3_AGG_Port-Channel973 | trunk | 10,310,320,330 | - | - | - | - | - | - |
 
 #### Port-Channel Interfaces Device Configuration
 
 ```eos
 !
 interface Port-Channel971
-   description IDF3_AGG_Po973
+   description L2_IDF3_AGG_Port-Channel973
    no shutdown
    switchport trunk allowed vlan 10,310,320,330
    switchport mode trunk