Add ISIS DTEP Check

Author: joelebla

aci-preupgrade-validation-script.py

@@ -5101,6 +5101,69 @@ def ave_eol_check(index, total_checks, tversion, **kwargs):
     return result
 
 
+def isis_database_byte_check(index, total_checks, tversion, **kwargs):
+    title = 'ISIS DTEPs Byte Check'
+    result = PASS
+    msg = ''
+    headers = ["ISIS DTEPs Byte Count", "Recommended Action"]
+    data = []
+    recommended_action = 'Upgrade to a version with the fix for CSCwp15375. Current target version is affected.'
+    doc_url = 'https://datacenter.github.io/ACI-Pre-Upgrade-Validation-Script/validations/#isis-dteps-byte-check'
+    print_title(title, index, total_checks)
+
+    if not tversion:
+        print_result(title, MANUAL, "Target version not supplied. Skipping.")
+        return MANUAL
+    
+    affected_versions = ["6.1(1f)", "6.1(2f)", "6.1(2g)", "6.1(3f)"]
+    is_affected = False
+    for version in affected_versions:
+        if tversion.same_as(version):
+            is_affected = True
+            break
+    
+    if not is_affected:
+        print_result(title, NA, "Target version not affected")
+        return NA
+
+    isisDTEp_api = 'isisDTEp.json'
+    isisDTEp_api += '?query-target-filter=eq(isisDTEp.role,"spine")'
+    
+    isisDTEps = icurl('class', isisDTEp_api)
+    
+    physical_ids = set()
+    proxy_acast_mac_ids = set()
+    proxy_acast_v4_ids = set()
+    proxy_acast_v6_ids = set()
+    
+    for entry in isisDTEps:
+        dtep_type = entry['isisDTEp']['attributes']['type']
+        dtep_id = entry['isisDTEp']['attributes']['id']
+        
+        if dtep_type == "physical":
+            physical_ids.add(dtep_id)
+        elif dtep_type == "physical,proxy-acast-mac":
+            proxy_acast_mac_ids.add(dtep_id)
+        elif dtep_type == "physical,proxy-acast-v4":
+            proxy_acast_v4_ids.add(dtep_id)
+        elif dtep_type == "physical,proxy-acast-v6":
+            proxy_acast_v6_ids.add(dtep_id)
+    
+    for physical_id in physical_ids:
+        proxy_mac_id = next(iter(proxy_acast_mac_ids)) if proxy_acast_mac_ids else ""
+        proxy_v4_id = next(iter(proxy_acast_v4_ids)) if proxy_acast_v4_ids else ""
+        proxy_v6_id = next(iter(proxy_acast_v6_ids)) if proxy_acast_v6_ids else ""
+        
+        total_bytes = len(physical_id) + len(proxy_mac_id) + len(proxy_v4_id) + len(proxy_v6_id)
+        
+        if total_bytes >= 58:
+            result = FAIL_O
+            data.append([str(total_bytes), recommended_action])
+            break    
+
+    print_result(title, result, msg, headers, data, doc_url=doc_url)
+    return result
+
 if __name__ == "__main__":
     prints('    ==== %s%s, Script Version %s  ====\n' % (ts, tz, SCRIPT_VERSION))
     prints('!!!! Check https://github.com/datacenter/ACI-Pre-Upgrade-Validation-Script for Latest Release !!!!\n')
@@ -5216,6 +5279,7 @@ def ave_eol_check(index, total_checks, tversion, **kwargs):
         pbr_high_scale_check,
         standby_sup_sync_check,
         observer_db_size_check,
+        isis_database_byte_check,
 
     ]
     summary = {PASS: 0, FAIL_O: 0, FAIL_UF: 0, ERROR: 0, MANUAL: 0, POST: 0, NA: 0, 'TOTAL': len(checks)}
@@ -5261,3 +5325,4 @@ def ave_eol_check(index, total_checks, tversion, **kwargs):
     prints('==== Script Version %s FIN ====' % (SCRIPT_VERSION))
 
     subprocess.check_output(['rm', '-rf', DIR])
+

docs/docs/validations.md

@@ -184,6 +184,8 @@ Items                                           | Defect       | This Script
 [PBR High Scale][d23]                           | CSCwi66348   | :white_check_mark: | :no_entry_sign:           |:no_entry_sign:
 [Standby Sup Image Sync][d24]                   | CSCwi66348   | :white_check_mark: | :no_entry_sign:           |:no_entry_sign:
 [Observer Database Size][d25]                   | CSCvw45531   | :white_check_mark: | :no_entry_sign:           |:no_entry_sign:
+[ISIS DTEPs Byte Check][d26]                    | CSCwp15375   | :white_check_mark: | :no_entry_sign:           |:no_entry_sign:
+
 
 [d1]: #ep-announce-compatibility
 [d2]: #eventmgr-db-size-defect-susceptibility
@@ -210,6 +212,7 @@ Items                                           | Defect       | This Script
 [d23]: #pbr-high-scale
 [d24]: #standby-sup-image-sync
 [d25]: #observer-database-size
+[d26]: #isis-dteps-byte-check
 
 
 ## General Check Details
@@ -2541,6 +2544,18 @@ This check logs in to each APIC, checks the contents of the `/data2/dbstats/` di
     Certain high churn logging configurations have been found to grow this DB exceptionally large while on a non-fixed version. 'Contract Permit Logging' is one such configuration.
 
 
+### ISIS DTEPs Byte Check
+
+Due to [CSCwp15375][57], tech support generation will result in a switch crash under the following conditions:
+- The `isisDTEp` address for a given spine + PROXY-ACAST-MAC address + PROXY-ACAST-V4 address + PROXY-ACAST-V6 address equals 58 bytes or more
+- The ACI software version is 6.1(1f), 6.1(2f), 6.1(2g), or 6.1(3f)
+
+Do not upgrade to any affected ACI software release if this check fails.
+
+!!! note
+    NDI integration can cause tech support generation to happen automatically, resulting in switch crash without user intervention.
+
+
 [0]: https://github.com/datacenter/ACI-Pre-Upgrade-Validation-Script
 [1]: https://www.cisco.com/c/dam/en/us/td/docs/Website/datacenter/apicmatrix/index.html
 [2]: https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-release-notes-list.html
@@ -2597,4 +2612,5 @@ This check logs in to each APIC, checks the contents of the `/data2/dbstats/` di
 [53]: https://bst.cloudapps.cisco.com/bugsearch/bug/CSCvw45531
 [54]: https://bst.cloudapps.cisco.com/bugsearch/bug/CSCvt47850
 [55]: https://www.cisco.com/c/en/us/products/collateral/cloud-systems-management/application-policy-infrastructure-controller-apic/eol-apic-virtual-edge-pod-pb.html
-[56]: https://www.cisco.com/c/en/us/td/docs/dcn/whitepapers/cisco-aci-virtual-edge-migration.html
+[56]: https://www.cisco.com/c/en/us/td/docs/dcn/whitepapers/cisco-aci-virtual-edge-migration.html
+[57]: https://bst.cloudapps.cisco.com/bugsearch/bug/CSCwp15375