Add Basic Ethernet State parsing for NXOS and EOS

docs/developers/writing_profiles.rst

@@ -57,6 +57,12 @@ In this case we are using the ``XMLParser`` parser. In order to get the data we
 device we have to call the method ``_rpc`` with the ``args`` and ``kwargs`` parameters. This is, 
 by the way, an RPC call for a junos device.
 
+**Note:** If a model is called by other models, like openconfig-if-ethernet is called by openconfig-interfaces,
+there is no need to specify the execute section in the metadata, if the commands will be the same.
+Since the first model executes the commands, the data from the commands will be shared with the 
+models that the first model calls. While it will work it to specify the same commands in the metadata
+section for the second model, it could cause the commands to be executed multiple times.
+
 * **vlan** - This is the part that follows the model specification. In this case is ``vlan`` but in
   others it might be ``interfaces``, ``addressess`` or something else, this will be model dependent
   but it's basically whatever it's not ``metadata``. This part will follow the model specification

napalm_yang/jinja_filters/__init__.py

@@ -1,11 +1,13 @@
 import ip_filters
 import json_filters
 import vlan_filters
+import mac_filters
 
 JINJA_FILTERS = [
     ip_filters,
     json_filters,
     vlan_filters,
+    mac_filters,
 ]
 
 

napalm_yang/jinja_filters/mac_filters.py

@@ -0,0 +1,23 @@
+from napalm_yang.jinja_filters.helpers import check_empty
+import netaddr
+
+
+def filters():
+    return {
+        "dotted_mac_to_colon": dotted_mac_to_colon,
+        "colon_mac_to_dotted": colon_mac_to_dotted,
+    }
+
+
+@check_empty()
+def dotted_mac_to_colon(value):
+    mac = netaddr.EUI(value)
+    mac.dialect = netaddr.mac_unix_expanded
+    return str(mac)
+
+
+@check_empty()
+def colon_mac_to_dotted(value):
+    mac = netaddr.EUI(value)
+    mac.dialect = netaddr.mac_cisco
+    return str(mac)

napalm_yang/mappings/eos/parsers/state/openconfig-if-ethernet/ethernet.yaml

@@ -0,0 +1,68 @@
+---
+metadata:
+    processor: JSONParser
+ethernet:
+    _process: unnecessary
+    config:
+        _process: unnecessary
+    state:
+        _process: unnecessary
+        auto-negotiate:
+            _process: not_implemented
+        counters:
+            _process:
+                - path: interfaceCounters
+            in-8021q-frames:
+                _process: not_implemented
+            in-crc-errors:
+                _process:
+                    - path: inputErrorsDetail.fcsErrors
+            in-fragment-frames:
+                _process:
+                    - path: inputErrorsDetail.runtFrames
+            in-jabber-frames:
+                _process: not_implemented
+            in-mac-control-frames:
+                _process: not_implemented
+            in-mac-pause-frames:
+                _process:
+                    - path: inputErrorsDetail.rxPause
+            in-oversize-frames:
+                _process:
+                    - path: inputErrorsDetail.giantFrames
+            out-8021q-frames:
+                _process: not_implemented
+            out-mac-control-frames:
+                _process: not_implemented
+            out-mac-pause-frames:
+                _process:
+                    - path: outputErrorsDetail.txPause
+        duplex-mode:
+            _process:
+                - path: duplex
+                  # Note the value string is .lower() after the regex is parsed
+                  # but before the map, hence the difference
+                  regexp: "(?P<value>duplexFull|duplexHalf)"
+                  map:
+                      duplexfull: FULL
+                      duplexhalf: HALF
+        effective-speed:
+            _process:
+                # OC effective-speed units are Mbps
+                - path: bandwidth
+                  regexp: "(?P<value>\\d+)"
+                  value: "{{ value / 1000 }}"
+        enable-flow-control:
+            _process: not_implemented
+        hw-mac-address:
+            _process:
+                - path: burnedInAddress
+        mac-address:
+            _process:
+                - path: physicalAddress
+        negotiated-duplex-mode:
+            _process: not_implemented
+        negotiated-port-speed:
+            _process: not_implemented
+        port-speed:
+            _process: not_implemented

napalm_yang/mappings/nxos/parsers/state/openconfig-if-ethernet/ethernet.yaml

@@ -0,0 +1,70 @@
+---
+
+metadata:
+    processor: JSONParser
+ethernet:
+    _process: unnecessary
+    config:
+        _process: not_implemented
+    state:
+        _process: unnecessary
+        auto-negotiate:
+            _process: not_implemented
+        counters:
+            _process: unnecessary
+            in-8021q-frames:
+                _process: not_implemented
+            in-crc-errors:
+                _process:
+                    - path: eth_crc
+            in-fragment-frames:
+                _process:
+                    - path: eth_runts
+            in-jabber-frames:
+                _process: not_implemented
+            in-mac-control-frames:
+                _process: not_implemented
+            in-mac-pause-frames:
+                _process:
+                    - path: eth_inpause
+            in-oversize-frames:
+                _process:
+                    - path: eth_jumbo_inpkts
+            out-8021q-frames:
+                _process: not_implemented
+            out-mac-control-frames:
+                _process: not_implemented
+            out-mac-pause-frames:
+                _process:
+                    - path: eth_outpause
+        duplex-mode:
+            _process: not_implemented
+        effective-speed:
+            _process:
+                - path: eth_bw
+                  regexp: "(?P<value>\\d+)"
+                  value: "{{ value / 1000 }}"
+        enable-flow-control:
+            _process:
+                - path: eth_in_flowctrl
+                  map:
+                      "off": false
+                      "on": true
+        hw-mac-address:
+            _process:
+                - path: eth_bia_addr
+                  regexp: "(?P<value>\\S+)"
+                  value: "{{ value | dotted_mac_to_colon }}"
+                  when: "{{ interface_key[0:4] not in ['loop'] }}"
+        mac-address:
+            _process:
+                - path: eth_hw_addr
+                  regexp: "(?P<value>\\S+)"
+                  value: "{{ value | dotted_mac_to_colon }}"
+                  when: "{{ interface_key[0:4] not in ['loop'] }}"
+        negotiated-duplex-mode:
+            _process: not_implemented
+        negotiated-port-speed:
+            _process: not_implemented
+        port-speed:
+            _process: not_implemented

test/integration/test_profiles.py

@@ -44,6 +44,7 @@ def pretty_json(dictionary):
     ["junos", "config", napalm_yang.models.openconfig_system, "default"],
     ["junos", "state", napalm_yang.models.openconfig_interfaces, "default"],
     ["nxos", "config", napalm_yang.models.openconfig_interfaces, "default"],
+    ["nxos", "state", napalm_yang.models.openconfig_interfaces, "default"],
 ]
 
 

test/integration/test_profiles/eos/openconfig-interfaces/state/default/expected.json

@@ -2,6 +2,21 @@
     "interfaces": {
         "interface": {
             "Ethernet1": {
+                "ethernet": {
+                    "state": {
+                        "counters": {
+                            "in-crc-errors": 0,
+                            "in-fragment-frames": 0,
+                            "in-mac-pause-frames": 0,
+                            "in-oversize-frames": 0,
+                            "out-mac-pause-frames": 0
+                        },
+                        "duplex-mode": "FULL",
+                        "effective-speed": 0,
+                        "hw-mac-address": "08:00:27:76:17:76",
+                        "mac-address": "08:00:27:76:17:76"
+                    }
+                },
                 "name": "Ethernet1",
                 "state": {
                     "admin-status": "UP",
@@ -28,6 +43,20 @@
                 }
             },
             "Ethernet2": {
+                "ethernet": {
+                    "state": {
+                        "counters": {
+                            "in-crc-errors": 0,
+                            "in-fragment-frames": 0,
+                            "in-mac-pause-frames": 0,
+                            "in-oversize-frames": 0,
+                            "out-mac-pause-frames": 0
+                        },
+                        "duplex-mode": "FULL",
+                        "effective-speed": 0,
+                        "mac-address": "08:00:27:78:47:29"
+                    }
+                },
                 "name": "Ethernet2",
                 "state": {
                     "admin-status": "DOWN",
@@ -78,6 +107,11 @@
                 }
             },
             "Loopback1": {
+                "ethernet": {
+                    "state": {
+                        "effective-speed": 0
+                    }
+                },
                 "name": "Loopback1",
                 "state": {
                     "admin-status": "UP",
@@ -90,6 +124,21 @@
                 }
             },
             "Management1": {
+                "ethernet": {
+                    "state": {
+                        "counters": {
+                            "in-crc-errors": 0,
+                            "in-fragment-frames": 0,
+                            "in-mac-pause-frames": 0,
+                            "in-oversize-frames": 0,
+                            "out-mac-pause-frames": 0
+                        },
+                        "duplex-mode": "FULL",
+                        "effective-speed": 1000000,
+                        "hw-mac-address": "08:00:27:7d:44:c1",
+                        "mac-address": "08:00:27:7d:44:c1"
+                    }
+                },
                 "name": "Management1",
                 "state": {
                     "admin-status": "UP",
@@ -116,6 +165,12 @@
                 }
             },
             "Port-Channel1": {
+                "ethernet": {
+                    "state": {
+                        "effective-speed": 0,
+                        "mac-address": "08:00:27:78:47:29"
+                    }
+                },
                 "name": "Port-Channel1",
                 "state": {
                     "admin-status": "UP",
@@ -158,4 +213,3 @@
         }
     }
 }
-