Skip to content

Commit

Permalink
YANG sonic-interface: add missing mac_addr leaf (PR sonic-net#20968)
Browse files Browse the repository at this point in the history 
mac_addr support was added in the INTERFACES table by
sonic-net/sonic-swss#814 in 2020
but the YANG models were never updated to reflect that change.

Signed-off-by: Brad House (@bradh352)
  • Loading branch information
@bradh352
bradh352 committed Dec 27, 2024
1 parent 1e3bb43 commit 06e0c4a
Show file tree
Hide file tree
Showing 11 changed files with 488 additions and 71 deletions.
158 changes: 91 additions & 67 deletions src/sonic-yang-models/doc/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
* [Console](#console)
* [CRM](#crm)
* [CRM DASH](#crm-dash)
* [Data Plane L3 Interfaces](#data-plane-l3-interfaces)
* [DEFAULT_LOSSLESS_BUFFER_PARAMETER](#DEFAULT_LOSSLESS_BUFFER_PARAMETER)
* [Device Metadata](#device-metadata)
* [Device neighbor metada](#device-neighbor-metada)
Expand All @@ -40,10 +39,10 @@
* [FLEX_COUNTER_TABLE](#flex_counter_table)
* [GRPCCLIENT](#grpcclient)
* [Hash](#hash)
* [IPv6 Link-local] (#ipv6-link-local)
* [KDUMP](#kdump)
* [Kubernetes Master](#kubernetes-master)
* [L2 Neighbors](#l2-neighbors)
* [L3 Interfaces](#l3-interfaces)
* [Loopback Interface](#loopback-interface)
* [LOSSLESS_TRAFFIC_PATTERN](#LOSSLESS_TRAFFIC_PATTERN)
* [Memory Statistics](#memory-statistics)
Expand Down Expand Up @@ -925,47 +924,6 @@ It currently allows user to administratively bring down a line-card or fabric-ca
}
```

### Data Plane L3 Interfaces

IP configuration for data plane are defined in **INTERFACE**, **VLAN_SUB_INTERFACE**,
**PORTCHANNEL_INTERFACE** and **VLAN_INTERFACE** table. The objects
in all four tables have the interface (could be physical port, port
channel, vlan or vlan sub interface) that IP address is attached to as first-level key, and
IP prefix as second-level key. IP interface address objects don't have any attributes.
IP interface attributes, resides in those tables as well, key is the interface name
and value is a list of field-values representing the interface attributes, e.g. loopback action.

```
{
"INTERFACE": {
"Ethernet0|10.0.0.0/31": {},
"Ethernet4|10.0.0.2/31": {},
"Ethernet8|10.0.0.4/31": {}
"Ethernet8": {
"loopback_action": "drop"
}
},

"PORTCHANNEL_INTERFACE": {
"PortChannel01|10.0.0.56/31": {},
"PortChannel01|FC00::71/126": {},
"PortChannel02|10.0.0.58/31": {},
"PortChannel02|FC00::75/126": {}
},

"VLAN_INTERFACE": {
"Vlan1000|192.168.0.1/27": {}
},

"VLAN_SUB_INTERFACE": {
"Ethernet4.1|10.0.0.2/31": {},
"Ethernet4.1": {
"loopback_action": "drop"
}
}
}
```


### DEFAULT_LOSSLESS_BUFFER_PARAMETER

Expand Down Expand Up @@ -1336,30 +1294,6 @@ The configuration is applied globally for each ECMP and LAG on a switch.
}
```

### IPv6 Link-local
```
{
"INTERFACE": {
"Ethernet8": {
"ipv6_use_link_local_only": "disable"
}
},

"PORTCHANNEL_INTERFACE": {
"PortChannel01": {
"ipv6_use_link_local_only": "enable"
}
},

"VLAN_INTERFACE": {
"Vlan1000": {
"ipv6_use_link_local_only": "enable"
}
}
}

```

### KDUMP

```
Expand Down Expand Up @@ -1444,6 +1378,96 @@ loopback address can also be defined.
}
```

### L3 Interfaces

Configuration for L3 data plane interfaces are defined in the `INTERFACE`,
`VLAN_INTERFACE`, `VLAN_SUB_INTERFACE` and `PORTCHANNEL_INTERFACE` tables,
respectively.

The objects in all four tables have the interface as the key with the following
required patterns:
- `INTERFACE`: Any valid port name from the `PORT` table. Typically `Ethernet{0-999}`.
- `VLAN_INTERFACE`: `Vlan{1-4095}`
- `PORTCHANNEL_INTERFACE`: `PortChannel{0-9999}`
- `VLAN_SUB_INTERFACE`: Any valid `INTERFACE` or `PORTCHANNEL_INTERFACE` name followed by a `.` and a number between 1 and 4094. E.g. `Ethernet1.4`


These tables have a number of shared attributes as described below:
* `vrf_name`: Valid VRF name from the `VRF` table. Default: `default`
* `nat_zone`: NAT Zone for this interface. `0..3`
* `mpls`: Enable/disable MPLS routing for the interface. `enable` or `disable`. Default `disable`.
* `ipv6_use_link_local_only`: Enable/Disable IPv6 link local address on interface. `enable` or `disable`. Default `disable`.
* `mac_addr`: Assign administrator-provided MAC address to Interface. If not specified will use the system MAC (same for all interfaces). Not applicable to `VLAN_SUB_INTERFACE` as it will use the parent interface's mac address.
* `loopback_action`: Packet action when a packet ingress and gets routed on the same IP interface. `drop` or `forward`.


```json

{
"INTERFACE": {
"Ethernet0": {
"ipv6_use_link_local_only": "enable",
"mac_addr": "12:34:56:78:90:ab"
},
"Ethernet1": {
"loopback_action": "drop"
}
},
"VLAN_INTERFACE": {
"Vlan201": {
"vrf_name": "red",
"mac_addr": "AB:CD:EF:12:34:56"
}
},
"PORTCHANNEL_INTERFACE": {
"PortChannel101": {
"mac_addr": "1c:23:a8:56:de:2f"
}
},
"VLAN_SUB_INTERFACE": {
"Ethernet0.555": {
"vrf_name": "Blue",
"vlan": "555"
}
}
}
```

#### Assigning IP addresses to L3 Interfaces

The interface name and IP prefix act as multi-level key for the interface
objects. The IP prefixes are stored in the same tables as the interface
attributes: `INTERFACE`, `VLAN_INTERFACE`, `VLAN_SUB_INTERFACE` and `PORTCHANNEL_INTERFACE`.

In the example below we will show one interface with attributes for clarity,
but otherwise this is simply an example of how IP addresses may be configured.

```json
{
"INTERFACE": {
"Ethernet0": {
"ipv6_use_link_local_only": "enable",
"mac_addr": "12:34:56:78:90:ab"
},
"Ethernet0|10.0.0.0/31": {},
"Ethernet4|10.0.0.2/31": {},
"Ethernet8|10.0.0.4/31": {},
},
"PORTCHANNEL_INTERFACE": {
"PortChannel01|10.0.0.56/31": {},
"PortChannel01|FC00::71/126": {},
"PortChannel02|10.0.0.58/31": {},
"PortChannel02|FC00::75/126": {}
},
"VLAN_INTERFACE": {
"Vlan1000|192.168.0.1/27": {}
},
"VLAN_SUB_INTERFACE": {
"Ethernet4.1|10.0.0.2/31": {}
}
}
```

### Loopback Interface

Loopback interface configuration lies in **LOOPBACK_INTERFACE** table
Expand Down
9 changes: 6 additions & 3 deletions src/sonic-yang-models/tests/files/sample_config_db.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@
"PortChannel0003": {
"nat_zone": "1",
"loopback_action": "drop",
"ipv6_use_link_local_only": "enable"
"ipv6_use_link_local_only": "enable",
"mac_addr": "02:26:9b:73:c1:1a"
},
"PortChannel0004": {"vrf_name": "Vrf_blue"},
"PortChannel42|10.1.0.1/31": {},
Expand All @@ -151,7 +152,8 @@
"Vlan111": {
"nat_zone": "0",
"loopback_action": "forward",
"ipv6_use_link_local_only": "disable"
"ipv6_use_link_local_only": "disable",
"mac_addr": "02:ab:cd:ef:12:34"
},
"Vlan777": {},
"Vlan111|2a04:5555:45:6709::1/64": {
Expand Down Expand Up @@ -1201,7 +1203,8 @@
"Ethernet18": {
"nat_zone": "1",
"loopback_action": "forward",
"ipv6_use_link_local_only": "enable"
"ipv6_use_link_local_only": "enable",
"mac_addr": "12:34:56:78:90:ab"
},
"Ethernet112|2a04:5555:40:a709::2/126": {
"scope": "global",
Expand Down
10 changes: 10 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/interface.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,15 @@
"INTERFACE_INVALID_ENABLE_IPV6_LINK_LOCAL": {
"desc": "Enable the ipv6 link-local as true.",
"eStr": "Invalid value \"true\" in \"ipv6_use_link_local_only\" element."
},
"INTERFACE_MAC_ADDR": {
"desc": "Set administrator-provided interface mac address."
},
"INTERFACE_UPPER_MAC_ADDR": {
"desc": "Set UPPERCASE administrator-provided interface mac address."
},
"INTERFACE_INVALID_MAC_ADDR": {
"desc": "Set invalid interface mac address.",
"eStr": "Value \"badaddr\" does not satisfy the constraint \"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}\" (range, length, or pattern)."
}
}
10 changes: 10 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/portchannel.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,15 @@
"PORTCHANNEL_INTERFACE_INVALID_ENABLE_IPV6_LINK_LOCAL": {
"desc": "Enable the ipv6 link-local as true.",
"eStr": "Invalid value \"true\" in \"ipv6_use_link_local_only\" element."
},
"PORTCHANNEL_INTERFACE_MAC_ADDR": {
"desc": "Set administrator-provided interface mac address."
},
"PORTCHANNEL_INTERFACE_UPPER_MAC_ADDR": {
"desc": "Set UPPERCASE administrator-provided interface mac address."
},
"PORTCHANNEL_INTERFACE_INVALID_MAC_ADDR": {
"desc": "Set invalid interface mac address.",
"eStr": "Value \"badaddr\" does not satisfy the constraint \"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}\" (range, length, or pattern)."
}
}
10 changes: 10 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/vlan.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,16 @@
"desc": "Enable the ipv6 link-local as true.",
"eStr": "Invalid value \"true\" in \"ipv6_use_link_local_only\" element."
},
"VLAN_INTERFACE_MAC_ADDR": {
"desc": "Set administrator-provided interface mac address."
},
"VLAN_INTERFACE_UPPER_MAC_ADDR": {
"desc": "Set UPPERCASE administrator-provided interface mac address."
},
"VLAN_INTERFACE_INVALID_MAC_ADDR": {
"desc": "Set invalid interface mac address.",
"eStr": "Value \"badaddr\" does not satisfy the constraint \"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}\" (range, length, or pattern)."
},
"VLAN_MEMBERS_WITHOUT_CREATING_VLAN":{
"desc": "Vlan members without Creating Vlan",
"eStrKey": "LeafRef"
Expand Down
87 changes: 87 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests_config/interface.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,5 +274,92 @@
]
}
}
},
"INTERFACE_MAC_ADDR": {
"sonic-interface:sonic-interface": {
"sonic-interface:INTERFACE": {
"INTERFACE_LIST": [
{
"name": "Ethernet8",
"mac_addr": "02:26:9b:73:c1:1a"
}
]
}
},
"sonic-port:sonic-port": {
"sonic-port:PORT": {
"PORT_LIST": [
{
"admin_status": "up",
"alias": "eth8",
"description": "Ethernet8",
"fec": "rs",
"lanes": "65",
"mtu": 9000,
"name": "Ethernet8",
"speed": 25000,
"mode":"trunk"
}
]
}
}
},
"INTERFACE_UPPER_MAC_ADDR": {
"sonic-interface:sonic-interface": {
"sonic-interface:INTERFACE": {
"INTERFACE_LIST": [
{
"name": "Ethernet8",
"mac_addr": "02:AB:CD:EF:12:34"
}
]
}
},
"sonic-port:sonic-port": {
"sonic-port:PORT": {
"PORT_LIST": [
{
"admin_status": "up",
"alias": "eth8",
"description": "Ethernet8",
"fec": "rs",
"lanes": "65",
"mtu": 9000,
"name": "Ethernet8",
"speed": 25000,
"mode":"trunk"
}
]
}
}
},
"INTERFACE_INVALID_MAC_ADDR": {
"sonic-interface:sonic-interface": {
"sonic-interface:INTERFACE": {
"INTERFACE_LIST": [
{
"name": "Ethernet8",
"mac_addr": "badaddr"
}
]
}
},
"sonic-port:sonic-port": {
"sonic-port:PORT": {
"PORT_LIST": [
{
"admin_status": "up",
"alias": "eth8",
"description": "Ethernet8",
"fec": "rs",
"lanes": "65",
"mtu": 9000,
"name": "Ethernet8",
"speed": 25000,
"mode":"trunk"
}
]
}
}
}
}
Loading

0 comments on commit 06e0c4a

Please sign in to comment.