Add scripts and documentation for faulty device tagging

Co-authored-by: lextm <425130+lextm@users.noreply.github.com>

Author: Copilot

FAULTY_DEVICE_ISSUES.md

@@ -22,74 +22,38 @@ The following imported issues are related to faulty devices but currently **miss
 ### #62 - HP Server OctetString Issue
 - **Status**: Needs tag
 - **Device**: HP server (OID .1.3.6.1.4.1.232.11.2.10.7.0)
-- **Issue**: OctetString field returning faulty hex values
-- **Reason**: Device-specific data encoding issue
-
-### #83 - Dell iDRAC 8 SNMPv3 Trap Issue
-- **Status**: Needs tag
-- **Device**: Dell iDRAC 8
-- **Issue**: SNMPv3 trap receiving issue
-- **Reason**: Works in PowerSNMP Manager but not SharpSnmpLib (device-specific compatibility)
+- **Issue**: OctetString field returning different hex values than iReasoning Browser
+- **Reason**: Works correctly in iReasoning Browser but returns "completely different" values in SharpSnmpLib - device-specific data encoding issue
 
 ### #89 - MikroTik RouterOS Unsupported Data Type
 - **Status**: Needs tag
 - **Device**: MikroTik RouterOS
-- **Issue**: Unsupported data type 18 exception
-- **Reason**: Device uses non-standard SNMP data types
+- **Issue**: BulkWalk causes "unsupported data type: 18" exception (SNMPv2), but Walk with SNMPv1 works fine
+- **Reason**: Device uses non-standard SNMP data type 18 that is not part of standard SNMP data types
 
 ### #101 - Cisco ASA 5510 MsgFlags Issue
-- **Status**: Needs tag
+- **Status**: Needs tag (note: currently only has "bug" label, missing "imported" label too)
 - **Device**: Cisco ASA 5510 firewall
-- **Issue**: Returns MsgFlags=8, library only handles 0-7
-- **Reason**: Works in Net::SNMP, device returns out-of-spec value
-
-### #114 - Fortis Device Data Construction Exception
-- **Status**: Needs tag
-- **Device**: Fortis device
-- **Issue**: Data construction exception with mismatched communities
-- **Reason**: Device-specific behavior
+- **Issue**: Returns MsgFlags=8 during SNMPv3 discovery, library only handles 0-7
+- **Reason**: Works in Net::SNMP, device returns out-of-spec value; Cisco C2960 switch works correctly
 
 ### #370 - QNap NAS GetTable Truncation
 - **Status**: Needs tag
 - **Device**: QNap NAS (Firmware 3.2.3 Build 0209T)
-- **Issue**: GetTable returns truncated/misaligned table data
-- **Reason**: Works in iReasoning Browser but not SharpSnmpLib (device-specific compatibility)
-
-### #420 - HP v1910-24G Switch VLAN Query
-- **Status**: Needs tag
-- **Device**: HP v1910-24G switch
-- **Issue**: VLAN query issue
-- **Reason**: Device-specific behavior
+- **Issue**: GetTable on hrStorageTable returns only 6 columns instead of 7, with misaligned/shifted values
+- **Reason**: Works correctly in iReasoning Browser but fails in SharpSnmpLib (device-specific compatibility)
 
 ### #436 - Cisco Switch MAC Address per VLAN
 - **Status**: Needs tag
 - **Device**: Cisco switch
-- **Issue**: MAC address retrieval per VLAN in SNMPv3 returns empty data
-- **Reason**: Device-specific VLAN context handling required
-
-### #469 - HP OpenView Integration Issue
-- **Status**: Needs tag
-- **Device**: HP OpenView
-- **Issue**: Integration issue
-- **Reason**: Device/platform-specific compatibility
-
-### #471 - Dell Server MIBs RFC1212 Loading
-- **Status**: Needs tag
-- **Device**: Dell server
-- **Issue**: RFC1212 loading issue with Dell MIBs
-- **Reason**: Device-specific MIB format
+- **Issue**: MAC address retrieval per VLAN in SNMPv3 returns empty data (OID 1.3.6.1.2.1.17.4.3.1.1)
+- **Reason**: Requires VLAN context support (community@VLANnum in v2c) which may not be properly supported in v3
 
 ### #475 - Citrix Xen GetTable Timeout
 - **Status**: Needs tag
 - **Device**: Citrix Xen SNMP Agent
-- **Issue**: GetTable operations timeout
-- **Reason**: Works in iReasoning Browser but not SharpSnmpLib, single OID reads work (device-specific compatibility)
-
-### #630 - HP Switch Firmware Download Status
-- **Status**: Needs tag
-- **Device**: HP switch
-- **Issue**: Firmware download status field issue
-- **Reason**: Device-specific behavior
+- **Issue**: GetTable operations timeout on sessionTable and procTable
+- **Reason**: Works in iReasoning Browser, single OID reads work fine with SharpSnmpLib (device-specific GetTable compatibility)
 
 ## Issues Already Properly Tagged
 
@@ -107,30 +71,38 @@ The following issues already have the `area:faulty-device` label:
 
 - **Total imported issues reviewed**: 490
 - **Issues already tagged with area:faulty-device**: 7
-- **Issues that need area:faulty-device tag**: 12
-- **Total device-related issues**: 19
+- **Issues that need area:faulty-device tag**: 6
+- **Total device-related issues**: 13
 
 ## Device Vendor Distribution
 
 - **Cisco**: 3 issues (#101, #318, #436)
-- **HP**: 4 issues (#62, #420, #469, #630)
-- **Dell**: 2 issues (#83, #471)
+- **HP**: 1 issue (#62)
+- **Dell**: 0 confirmed device issues
 - **QNap**: 1 issue (#370)
 - **Citrix**: 1 issue (#475)
 - **MikroTik**: 1 issue (#89)
-- **Fortis**: 1 issue (#114)
 - **Eaton**: 1 issue (#698)
 - **Unknown/Generic**: 5 issues (#291, #474, #608, #693, #700)
 
 ## Recommendations
 
-1. **Add the `area:faulty-device` label** to all 12 issues listed in the "Issues Requiring Label" section
+1. **Add the `area:faulty-device` label** to the 6 issues listed in the "Issues Requiring Label" section:
+   - #62 (HP server OctetString)
+   - #89 (MikroTik unsupported data type)
+   - #101 (Cisco ASA MsgFlags) - also needs "imported" label
+   - #370 (QNap GetTable)
+   - #436 (Cisco MAC address per VLAN)
+   - #475 (Citrix GetTable timeout)
+
 2. **Maintain this label** for device-specific compatibility issues to help:
    - Distinguish between library bugs and device non-compliance
    - Track which devices have known issues
    - Prioritize compatibility improvements
    - Document workarounds for specific devices
 
+3. **Consider creating** device-specific documentation or wiki pages for known compatibility issues with popular devices (Cisco, HP, Dell, etc.)
+
 ## Notes
 
 - Issues were reviewed based on their descriptions, comments, and whether they mention specific devices or work in other SNMP tools

FAULTY_DEVICE_TAGGING_README.md

@@ -0,0 +1,117 @@
+# Faulty Device Tagging Task - README
+
+## Task Overview
+
+This task involved reviewing all imported issues (490 total) in the lextudio/sharpsnmplib repository to identify which ones are related to faulty or non-standard devices, and tagging them with the `area:faulty-device` label.
+
+## What Was Done
+
+### 1. Comprehensive Review
+- Reviewed all 490 issues with the "imported" label
+- Applied systematic criteria to identify device-related issues
+- Verified each candidate issue by reading full descriptions and comments
+
+### 2. Identification Criteria
+
+Issues were identified as device-related if they met one or more of these criteria:
+
+1. **Specific device vendor/model** exhibiting non-standard SNMP behavior
+2. **Device returns malformed/truncated/incorrect** SNMP data  
+3. **Works in other SNMP tools** but not in SharpSnmpLib (indicates device-specific compatibility)
+4. **Explicitly mentions device bug** or firmware issue
+5. **Requires device-specific workaround** rather than a general fix
+
+### 3. Results
+
+**Found:**
+- 7 issues already properly tagged with `area:faulty-device`
+- 6 issues needing the `area:faulty-device` label
+
+**Issues requiring `area:faulty-device` label:**
+- #62: HP server - OctetString encoding mismatch (works in iReasoning)
+- #89: MikroTik RouterOS - unsupported data type 18
+- #101: Cisco ASA 5510 - MsgFlags=8 out of range (works in Net::SNMP)
+- #370: QNap NAS - GetTable truncation (works in iReasoning)
+- #436: Cisco switch - MAC address per VLAN (needs VLAN context)
+- #475: Citrix Xen - GetTable timeout (works in iReasoning)
+
+**Note:** Issue #101 also needs the "imported" label added.
+
+## Files Created
+
+### 1. `FAULTY_DEVICE_ISSUES.md`
+Comprehensive documentation of:
+- All device-related issues (both tagged and untagged)
+- Detailed analysis of each issue
+- Device vendor distribution
+- Recommendations for labeling
+
+### 2. `add-faulty-device-labels.sh`
+Automated script to add labels using GitHub CLI:
+```bash
+./add-faulty-device-labels.sh
+```
+
+This script will:
+- Add `area:faulty-device` label to the 6 identified issues
+- Add `imported` label to issue #101
+- Provide progress feedback
+
+## How to Apply the Labels
+
+### Option 1: Using the Script (Recommended)
+```bash
+# Ensure you have GitHub CLI installed and authenticated
+gh auth status
+
+# Run the script
+./add-faulty-device-labels.sh
+```
+
+### Option 2: Manual GitHub UI
+Navigate to each issue and add the `area:faulty-device` label:
+- Issue #62
+- Issue #89  
+- Issue #101 (also add "imported")
+- Issue #370
+- Issue #436
+- Issue #475
+
+### Option 3: Using GitHub CLI Manually
+```bash
+gh issue edit 62 --add-label "area:faulty-device"
+gh issue edit 89 --add-label "area:faulty-device"
+gh issue edit 101 --add-label "area:faulty-device,imported"
+gh issue edit 370 --add-label "area:faulty-device"
+gh issue edit 436 --add-label "area:faulty-device"
+gh issue edit 475 --add-label "area:faulty-device"
+```
+
+## Verification
+
+After applying labels, you can verify by running:
+```bash
+gh issue list --label "area:faulty-device" --label "imported" --state all
+```
+
+This should show 13 total issues (7 previously tagged + 6 newly tagged).
+
+## Notes
+
+- The `area:faulty-device` label (not just `faulty-device`) is used to match existing conventions in the repository
+- Some issues that mentioned devices were determined NOT to be device bugs (usage questions, documentation requests, etc.) and were excluded
+- The analysis focused on issues where the device behavior is non-standard or incompatible with SNMP specifications
+- Issues that work in other SNMP tools but not in SharpSnmpLib are strong indicators of device-specific compatibility issues
+
+## Device Breakdown
+
+After tagging, the repository will have device-related issues from:
+- **Cisco**: 3 issues (ASA, switches)
+- **HP**: 1 issue (server)
+- **QNap**: 1 issue (NAS)
+- **Citrix**: 1 issue (Xen)
+- **MikroTik**: 1 issue (RouterOS)
+- **Eaton**: 1 issue (PDU)
+- **Generic/Unknown devices**: 5 issues
+
+Total: 13 device-related issues identified and documented.

add-faulty-device-labels.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+# Script to add 'area:faulty-device' label to identified issues
+# Run this script in the repository root with GitHub CLI (gh) installed and authenticated
+
+echo "Adding 'area:faulty-device' label to identified imported issues..."
+echo ""
+
+# Array of issue numbers that need the label
+issues_to_tag=(62 89 101 370 436 475)
+
+for issue in "${issues_to_tag[@]}"; do
+    echo "Processing issue #$issue..."
+    gh issue edit $issue --add-label "area:faulty-device"
+    if [ $? -eq 0 ]; then
+        echo "✓ Successfully added label to issue #$issue"
+    else
+        echo "✗ Failed to add label to issue #$issue"
+    fi
+    echo ""
+done
+
+# Also add 'imported' label to #101 which is missing it
+echo "Adding 'imported' label to issue #101..."
+gh issue edit 101 --add-label "imported"
+if [ $? -eq 0 ]; then
+    echo "✓ Successfully added 'imported' label to issue #101"
+else
+    echo "✗ Failed to add 'imported' label to issue #101"
+fi
+
+echo ""
+echo "Done! All labels have been processed."
+echo ""
+echo "Summary:"
+echo "- Added 'area:faulty-device' label to 6 issues: #62, #89, #101, #370, #436, #475"
+echo "- Added 'imported' label to issue #101"