PLUGIN_DOC.md

# Plugin Documentation

# IB Plugins

| Plugin | Collection | Analyzer Args | Collection Args | DataModel | Collector | Analyzer |
| --- | --- | --- | --- | --- | --- | --- |
| GenericCollectionPlugin | Runs each command from collection_args.commands on the target (in-band host or BMC over OOB SSH).<br>Commands are user-configured; there are no fixed CMD_\* class fields. | **Analyzer Args:**<br>- `checks`: list[nodescraper.plugins.generic_collection.analyzer_args.CommandCheck] — Per-command validation rules keyed by collected command name. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `commands`: list[nodescraper.plugins.generic_collection.collector_args.CommandSpec] — Named commands to run. Each entry must include 'name' and 'command'. Prefer small textual stdout; see class docstring...<br>- `sudo`: bool — Default sudo setting for commands that do not specify sudo.<br>- `timeout`: int — Default per-command timeout in seconds.<br>- `include_stdout`: bool — Default: include each command's stdout in collected results for analysis. When false, stdout is omitted from stored r... | [GenericCollectionDataModel](#GenericCollectionDataModel-Model) | [GenericCollectionCollector](#Collector-Class-GenericCollectionCollector) | [GenericAnalyzer](#Data-Analyzer-Class-GenericAnalyzer) |
| AmdSmiPlugin | bad-pages<br>firmware --json<br>list --json<br>metric -g all<br>partition --json<br>process --json<br>ras --cper --folder={folder}<br>ras --afid --cper-file {cper_file}<br>static -g all --json<br>static -g {gpu_id} --json<br>topology<br>version --json<br>xgmi -l<br>xgmi -m | **Analyzer Args:**<br>- `check_static_data`: bool — If True, run static data checks (e.g. driver version, partition mode).<br>- `expected_gpu_processes`: Optional[int] — Expected number of GPU processes.<br>- `expected_max_power`: Optional[int] — Expected maximum power value (e.g. watts).<br>- `expected_power_management`: Optional[str] — Expected amd-smi metric power_management value per GPU (e.g. DISABLED for active/full power, ENABLED for power-manage...<br>- `expected_driver_version`: Optional[str] — Expected AMD driver version string.<br>- `expected_memory_partition_mode`: Optional[str] — Expected memory partition mode (e.g. sp3, dp).<br>- `expected_compute_partition_mode`: Optional[str] — Expected compute partition mode.<br>- `expected_firmware_versions`: Optional[dict[str, str]] — Expected firmware versions keyed by amd-smi fw_id (e.g. PLDM_BUNDLE).<br>- `l0_to_recovery_count_error_threshold`: Optional[int] — L0-to-recovery count above which an error is raised.<br>- `l0_to_recovery_count_warning_threshold`: Optional[int] — L0-to-recovery count above which a warning is raised.<br>- `vendorid_ep`: Optional[str] — Expected endpoint vendor ID (e.g. for PCIe).<br>- `vendorid_ep_vf`: Optional[str] — Expected endpoint VF vendor ID.<br>- `devid_ep`: Optional[str] — Expected endpoint device ID.<br>- `devid_ep_vf`: Optional[str] — Expected endpoint VF device ID.<br>- `sku_name`: Optional[str] — Expected SKU name string for GPU.<br>- `expected_xgmi_speed`: Optional[list[float]] — Expected xGMI speed value(s) (e.g. link rate).<br>- `analysis_range_start`: Optional[datetime.datetime] — Start of time range for time-windowed analysis.<br>- `analysis_range_end`: Optional[datetime.datetime] — End of time range for time-windowed analysis. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `analysis_firmware_ids`: Optional[list[str]] — amd-smi fw_id values to record in analysis_ref.firmware_versions<br>- `cper_file_path`: Optional[str] — Path to CPER folder or file for RAS AFID collection (ras --afid --cper-file). | [AmdSmiDataModel](#AmdSmiDataModel-Model) | [AmdSmiCollector](#Collector-Class-AmdSmiCollector) | [AmdSmiAnalyzer](#Data-Analyzer-Class-AmdSmiAnalyzer) |
| BiosPlugin | sh -c 'cat /sys/devices/virtual/dmi/id/bios_version'<br>wmic bios get SMBIOSBIOSVersion /Value | **Analyzer Args:**<br>- `exp_bios_version`: list[str] — Expected BIOS version(s) to match against collected value (str or list).<br>- `regex_match`: bool — If True, match exp_bios_version as regex; otherwise exact match. | - | [BiosDataModel](#BiosDataModel-Model) | [BiosCollector](#Collector-Class-BiosCollector) | [BiosAnalyzer](#Data-Analyzer-Class-BiosAnalyzer) |
| CmdlinePlugin | cat /proc/cmdline | **Analyzer Args:**<br>- `required_cmdline`: Union[str, List] — Command-line parameters that must be present (e.g. 'pci=bfsort').<br>- `banned_cmdline`: Union[str, List] — Command-line parameters that must not be present.<br>- `os_overrides`: Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig] — Per-OS overrides for required_cmdline and banned_cmdline (keyed by OS identifier).<br>- `platform_overrides`: Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig] — Per-platform overrides for required_cmdline and banned_cmdline (keyed by platform). | - | [CmdlineDataModel](#CmdlineDataModel-Model) | [CmdlineCollector](#Collector-Class-CmdlineCollector) | [CmdlineAnalyzer](#Data-Analyzer-Class-CmdlineAnalyzer) |
| DeviceEnumerationPlugin | powershell -Command "(Get-WmiObject -Class Win32_Processor &#124; Measure-Object).Count"<br>lspci -d {vendorid_ep}: &#124; grep -iE 'VGA&#124;Display&#124;3D&#124;Processing accelerators&#124;Co-processor&#124;Accelerator' &#124; grep -vi 'Virtual Function' &#124; wc -l<br>powershell -Command "(wmic path win32_VideoController get name &#124; findstr AMD &#124; Measure-Object).Count"<br>lscpu<br>lshw<br>lspci -d {vendorid_ep}: &#124; grep -i 'Virtual Function' &#124; wc -l<br>powershell -Command "(Get-VMHostPartitionableGpu &#124; Measure-Object).Count" | **Analyzer Args:**<br>- `cpu_count`: Optional[list[int]] — Expected CPU count(s); pass as int or list of ints. Analysis passes if actual is in list.<br>- `gpu_count`: Optional[list[int]] — Expected GPU count(s); pass as int or list of ints. Analysis passes if actual is in list.<br>- `vf_count`: Optional[list[int]] — Expected virtual function count(s); pass as int or list of ints. Analysis passes if actual is in list. | - | [DeviceEnumerationDataModel](#DeviceEnumerationDataModel-Model) | [DeviceEnumerationCollector](#Collector-Class-DeviceEnumerationCollector) | [DeviceEnumerationAnalyzer](#Data-Analyzer-Class-DeviceEnumerationAnalyzer) |
| DimmPlugin | sh -c 'dmidecode -t 17 &#124; tr -s " " &#124; grep -v "Volatile\&#124;None\&#124;Module" &#124; grep Size' 2>/dev/null<br>dmidecode<br>wmic memorychip get Capacity | - | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `skip_sudo`: bool — If True, do not use sudo when running dmidecode or wmic for memory info. | [DimmDataModel](#DimmDataModel-Model) | [DimmCollector](#Collector-Class-DimmCollector) | - |
| DkmsPlugin | dkms status<br>dkms --version | **Analyzer Args:**<br>- `dkms_status`: Union[str, list] — Expected dkms status string(s) to match (e.g. 'amd/1.0.0'). At least one of dkms_status or dkms_version required.<br>- `dkms_version`: Union[str, list] — Expected dkms version string(s) to match. At least one of dkms_status or dkms_version required.<br>- `regex_match`: bool — If True, match dkms_status and dkms_version as regex; otherwise exact match. | - | [DkmsDataModel](#DkmsDataModel-Model) | [DkmsCollector](#Collector-Class-DkmsCollector) | [DkmsAnalyzer](#Data-Analyzer-Class-DkmsAnalyzer) |
| DmesgPlugin | dmesg --time-format iso -x<br>ls -1 /var/log/dmesg\* 2>/dev/null &#124; grep -E '^/var/log/dmesg(\.[0-9]+(\.gz)?)?$' &#124;&#124; true | **Built-in Regexes:**<br>- Out of memory error: `(?:oom_kill_process.*)&#124;(?:Out of memory.*)`<br>- I/O Page Fault: `IO_PAGE_FAULT`<br>- Kernel Panic: `\bkernel panic\b.*`<br>- SQ Interrupt: `sq_intr`<br>- SRAM ECC: `sram_ecc.*`<br>- Failed to load driver. IP hardware init error.: `\[amdgpu\]\] \*ERROR\* hw_init of IP block.*`<br>- Failed to load driver. IP software init error.: `\[amdgpu\]\] \*ERROR\* sw_init of IP block.*`<br>- Real Time throttling activated: `sched: RT throttling activated.*`<br>- RCU preempt detected stalls: `rcu_preempt detected stalls.*`<br>- RCU preempt self-detected stall: `rcu_preempt self-detected stall.*`<br>- QCM fence timeout: `qcm fence wait loop timeout.*`<br>- General protection fault: `(?:[\w-]+(?:\[[0-9.]+\])?\s+)?general protectio...`<br>- Segmentation fault: `(?:segfault.*in .*\[)&#124;(?:[Ss]egmentation [Ff]au...`<br>- Failed to disallow cf state: `amdgpu: Failed to disallow cf state.*`<br>- Failed to terminate tmr: `\*ERROR\* Failed to terminate tmr.*`<br>- Suspend of IP block failed: `\*ERROR\* suspend of IP block <\w+> failed.*`<br>- amdgpu Page Fault: `(amdgpu \w{4}:\w{2}:\w{2}\.\w:\s+amdgpu:\s+\[\S...`<br>- Page Fault: `page fault for address.*`<br>- Fatal error during GPU init: `(?:amdgpu)(.*Fatal error during GPU init)&#124;(Fata...`<br>- PCIe AER Error Status: `(pcieport [\w:.]+: AER: aer_status:[^\n]*(?:\n[...`<br>- PCIe AER Correctable Error Status: `(.*aer_cor_status: 0x[0-9a-fA-F]+, aer_cor_mask...`<br>- PCIe AER Uncorrectable Error Status: `(.*aer_uncor_status: 0x[0-9a-fA-F]+, aer_uncor_...`<br>- PCIe AER Uncorrectable Error Severity with TLP Header: `(.*aer_uncor_severity: 0x[0-9a-fA-F]+.*)(\n.*TL...`<br>- Failed to read journal file: `Failed to read journal file.*`<br>- Journal file corrupted or uncleanly shut down: `journal corrupted or uncleanly shut down.*`<br>- ACPI BIOS Error: `ACPI BIOS Error`<br>- ACPI Error: `ACPI Error`<br>- Filesystem corrupted!: `EXT4-fs error \(device .*\):`<br>- Error in buffered IO, check filesystem integrity: `(Buffer I\/O error on dev)(?:ice)? (\w+)`<br>- PCIe card no longer present: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(Slot\(...`<br>- PCIe Link Down: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(Slot\(...`<br>- Mismatched clock configuration between PCIe device and host: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(curren...`<br>- RAS Correctable Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- RAS Uncorrectable Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- RAS Deferred Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- RAS Corrected PCIe Error: `((?:\[Hardware Error\]:\s+)?event severity: cor...`<br>- GPU Reset: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- GPU reset failed: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- ACA Error: `(Accelerator Check Architecture[^\n]*)(?:\n[^\n...`<br>- ACA Error: `(Accelerator Check Architecture[^\n]*)(?:\n[^\n...`<br>- MCE Corrected Error: `\[Hardware Error\]:[^\n]*MC\d+_STATUS\[[^\]]*\&#124;...`<br>- MCE Uncorrected Error: `\[Hardware Error\]:[^\n]*MC\d+_STATUS\[[^\]]*\&#124;...`<br>- Mode 2 Reset Failed: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)? (...`<br>- RAS Corrected Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`<br>- SGX Error: `x86/cpu: SGX disabled by BIOS`<br>- MMP Error: `Failed to load MMP firmware qat_4xxx_mmp.bin`<br>- GPU Throttled: `amdgpu \w{4}:\w{2}:\w{2}.\w: amdgpu: WARN: GPU ...`<br>- RAS Poison Consumed: `amdgpu[ 0-9a-fA-F:.]+:(?:\s*amdgpu:)?\s+(?:{\d+...`<br>- RAS Poison created: `amdgpu[ 0-9a-fA-F:.]+:(?:\s*amdgpu:)?\s+(?:{\d+...`<br>- Bad page threshold exceeded: `(amdgpu: Saved bad pages (\d+) reaches threshol...`<br>- RAS Hardware Error: `Hardware error from APEI Generic Hardware Error...`<br>- Error Address: `Error Address.*(?:\s.*)`<br>- RAS EDR Event: `EDR: EDR event received`<br>- DPC Event: `DPC: .*`<br>- LNet: ko2iblnd has no matching interfaces: `(?:\[[^\]]+\]\s*)?LNetError:.*ko2iblnd:\s*No ma...`<br>- LNet: Error starting up LNI: `(?:\[[^\]]+\]\s*)?LNetError:\s*.*Error\s*-?\d+\...`<br>- Lustre: network initialisation failed: `LustreError:.*ptlrpc_init_portals\(\).*network ...`<br>**Analyzer Args:**<br>- `analysis_range_start`: Optional[datetime.datetime] — Start of time range for analysis (ISO format). Only events on or after this time are analyzed.<br>- `analysis_range_end`: Optional[datetime.datetime] — End of time range for analysis (ISO format). Only events before this time are analyzed.<br>- `check_unknown_dmesg_errors`: Optional[bool] — If True, treat unknown/unmatched dmesg error lines as failures.<br>- `exclude_category`: Optional[set[str]] — Set of error categories to exclude from analysis.<br>- `interval_to_collapse_event`: int — Seconds within which repeated events are collapsed into one (for rate limiting).<br>- `num_timestamps`: int — Number of timestamps to include per event in output.<br>- `error_regex`: Union[list[nodescraper.base.regexanalyzer.ErrorRegex], list[dict], NoneType] — Custom error regex patterns; each item can be ErrorRegex or dict with category/pattern.<br>- `priority_override_rules`: Optional[list[dict]] — Rules to override the priority of matched ErrorRegex objects. Each rule is a dict where all keys except 'new_priority...<br>- `mce_threshold`: Optional[int] — When set, raise ERROR if correctable MCE/RAS error count for any component (CPU, GPU BDF/block, etc.) reaches or exce...<br>- `ignore_match_rules`: Optional[list[dict[str, object]]] — Rules that skip regex matches during analysis. Each rule may use line_regex, match_regex, message, and/or mce_banks.... | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `collect_rotated_logs`: bool — If True, also collect rotated dmesg log files from /var/log/dmesg\*.<br>- `skip_sudo`: bool — If True, do not use sudo when running dmesg or listing log files.<br>- `log_dmesg_data`: bool — If True, log the collected dmesg output in artifacts. | [DmesgData](#DmesgData-Model) | [DmesgCollector](#Collector-Class-DmesgCollector) | [DmesgAnalyzer](#Data-Analyzer-Class-DmesgAnalyzer) |
| FabricsPlugin | lspci &#124; grep -i cassini<br>lsmod &#124; grep cxi<br>cxi_stat<br>ibstat<br>ibv_devinfo<br>ls -l /sys/class/infiniband/\*/device/net<br>fi_info -p cxi<br>mst start<br>mst status -v<br>ip link show<br>ofed_info -s | - | - | [FabricsDataModel](#FabricsDataModel-Model) | [FabricsCollector](#Collector-Class-FabricsCollector) | - |
| JournalPlugin | journalctl --no-pager --system --output=short-iso<br>journalctl --no-pager --system --output=json | **Analyzer Args:**<br>- `analysis_range_start`: Optional[datetime.datetime] — Start of time range for analysis (ISO format). Only events on or after this time are analyzed.<br>- `analysis_range_end`: Optional[datetime.datetime] — End of time range for analysis (ISO format). Only events before this time are analyzed.<br>- `check_priority`: Optional[int] — Check against journal log priority (0=emergency..7=debug). If an entry has priority <= check_priority, an ERROR event...<br>- `group`: bool — If True, group entries that have the same priority and message. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `boot`: Optional[int] — Optional boot ID to limit journal collection to a specific boot. | [JournalData](#JournalData-Model) | [JournalCollector](#Collector-Class-JournalCollector) | [JournalAnalyzer](#Data-Analyzer-Class-JournalAnalyzer) |
| KernelPlugin | sh -c 'uname -a'<br>sh -c 'cat /proc/sys/kernel/numa_balancing'<br>wmic os get Version /Value | **Analyzer Args:**<br>- `exp_kernel`: Union[str, list] — Expected kernel version string(s) to match (e.g. from uname -a).<br>- `exp_numa`: Optional[int] — Expected value for kernel.numa_balancing (e.g. 0 or 1).<br>- `regex_match`: bool — If True, match exp_kernel as regex; otherwise exact match. | - | [KernelDataModel](#KernelDataModel-Model) | [KernelCollector](#Collector-Class-KernelCollector) | [KernelAnalyzer](#Data-Analyzer-Class-KernelAnalyzer) |
| KernelModulePlugin | cat /proc/modules<br>modinfo amdgpu<br>wmic os get Version /Value | **Analyzer Args:**<br>- `kernel_modules`: dict[str, dict] — Expected kernel module name -> {version, etc.}. Analyzer checks collected modules match.<br>- `regex_filter`: list[str] — List of regex patterns to filter which collected modules are checked (default: amd). | - | [KernelModuleDataModel](#KernelModuleDataModel-Model) | [KernelModuleCollector](#Collector-Class-KernelModuleCollector) | [KernelModuleAnalyzer](#Data-Analyzer-Class-KernelModuleAnalyzer) |
| MemoryPlugin | free -b<br>lsmem<br>numactl -H<br>wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value | **Analyzer Args:**<br>- `ratio`: float — Required free-memory ratio (0-1). Analysis fails if free/total < ratio.<br>- `memory_threshold`: str — Minimum free memory required (e.g. '30Gi', '1T'). Used when ratio is not sufficient. | - | [MemoryDataModel](#MemoryDataModel-Model) | [MemoryCollector](#Collector-Class-MemoryCollector) | [MemoryAnalyzer](#Data-Analyzer-Class-MemoryAnalyzer) |
| NetworkPlugin | ip addr show<br>curl<br>ethtool -i {interface}<br>ethtool -S {interface}<br>ethtool {interface}<br>lldpcli show neighbor<br>lldpctl<br>ip neighbor show<br>ping<br>ip route show<br>ip rule show<br>wget | - | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `url`: Optional[str] — Optional URL to probe for network connectivity (used with netprobe).<br>- `netprobe`: Optional[Literal['ping', 'wget', 'curl']] — Tool to use for network connectivity probe: ping, wget, or curl.<br>- `exclusion_regex`: Optional[list[str]] — Regex patterns matched (search) against netdev/interface names; any match is skipped (ethtool not run against it). | [NetworkDataModel](#NetworkDataModel-Model) | [NetworkCollector](#Collector-Class-NetworkCollector) | [NetworkAnalyzer](#Data-Analyzer-Class-NetworkAnalyzer) |
| NicPlugin | bcmcli_config query AN_PROTOCOL -d {device_id}<br>bcmcli_debug dscdump --lane 0 -d {device_id}<br>bcmcli_fwmanager show certificate -d {device_id}<br>bcmcli_fwmanager show fwpackage -d {device_id}<br>bcmcli_show version<br>bcmcli_show device_list<br>bcmcli_show health -d {device_id}<br>bcmcli_link show -d {device_id}<br>bcmcli_livepatch show -d {device_id}<br>bcmcli_debug loopback -d {device_id}<br>bcmcli_config msixmv query --pf all -d {device_id}<br>bcmcli_config show_confs -d {device_id}<br>bcmcli_nvm show -d {device_id}<br>bcmcli_debug pcie counters -d {device_id}<br>bcmcli_config query pcie_relaxed_ordering -d {device_id}<br>bcmcli_show pci -d {device_id}<br>bcmcli_config query performance_profile -d {device_id}<br>bcmcli_qos show qos -d {device_id}<br>bcmcli_qos show hw-maps -d {device_id}<br>bcmcli_qos show rx-port-ratelimit -d {device_id}<br>bcmcli_qos show tx-ep-ratelimit --port 0 -d {device_id}<br>bcmcli_qos show ingress --cosq -d {device_id}<br>bcmcli_qos show egress --cosq -d {device_id}<br>bcmcli_show status -d {device_id}<br>bcmcli_show temperature -d {device_id}<br>bcmcli_show phy -d {device_id}<br>bcmcli_show resource_counts -d {device_id}<br>bcmcli_hwdbg dump_tx_counters -d {device_id}<br>bcmcli_hwdbg dump_rx_counters -d {device_id}<br>bcmcli_debug verify -d {device_id}<br>bcmcli_debug serdes_tx --get --modtype NRZ --lane 0 -d {device_id}<br>bcmcli_tunnel show rss -d {device_id}<br>bcmcli_tunnel show vxlan --type ipv4 -d {device_id}<br>bcmcli_tunnel show vxlan --type ipv6 -d {device_id}<br>bcmcli_timesync show dll -d {device_id}<br>bcmcli_timesync show duty-cycle -d {device_id}<br>bcmcli_timesync show ts-pin -d {device_id}<br>bcmcli_dump snap_dump -d {device_id}<br>bcmcli_config query support_rdma -d {device_id}<br>bcmcli_timesync show ptp -d {device_id}<br>bcmcli_timesync show synce -d {device_id}<br>bcmcli_timesync show tsio -d {device_id}<br>niccli --dev {device_num} cable --module_info --show<br>niccli --dev {device_num} counters --pcie<br>niccli devid<br>niccli --listdev<br>niccli --list<br>niccli --list_devices<br>niccli --dev {device_num} fw --livepatch --show<br>niccli --dev {device_num} linkdiag --dscdump --lane 0<br>niccli --dev {device_num} linkdiag --loopback --show<br>niccli --dev {device_num} linkdiag --txfir --show --modulation_type NRZ --lane 0<br>niccli --dev {device_num} link --counters --show<br>niccli --dev {device_num} link --status<br>niccli --dev {device_num} msix --max_vectors --show --pf 0<br>niccli --dev {device_num} nvm --listoptions<br>niccli --dev {device_num} nvm --list<br>niccli --dev {device_num} nvm --verify<br>niccli --dev {device_num} nvm --view<br>niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering<br>niccli --dev {device_num} nvm --getoption pcie_relaxed_ordering<br>niccli -dev {device_num} nvm -getoption performance_profile<br>niccli --dev {device_num} nvm --getoption performance_profile<br>niccli -dev {device_num} nvm -getoption support_rdma -scope 0<br>niccli -dev {device_num} getqos<br>niccli --dev {device_num} nvm --getoption support_rdma --scope 0<br>niccli --dev {device_num} qos --ets --show<br>niccli --dev {device_num} show --all<br>niccli --dev {device_num} show --health<br>niccli --dev {device_num} show --certificate<br>niccli --dev {device_num} show --pkg_ver<br>niccli --dev {device_num} qos --egress --cosq --show<br>niccli --dev {device_num} qos --ingress --cosq --show<br>niccli --dev {device_num} qos --rx_rate_limit --show<br>niccli --dev {device_num} qos --listmap --pri2cos<br>niccli --dev {device_num} timesync --ptp --show<br>niccli --dev {device_num} timesync --tsio --show<br>niccli --dev {device_num} tunnel --cfg --rss --show<br>niccli --dev {device_num} tunnel --cfg --vxlan --type ipv4 --show<br>niccli --dev {device_num} resmgmt --all --profile --show<br>niccli --dev {device_num} qos --dscp2prio<br>niccli --dev {device_num} qos --tx_ep_rate_limit --port 0 --show<br>niccli --dev {device_num} show --device_info<br>niccli --dev {device_num} show --device_pci_ids<br>niccli --dev {device_num} show<br>niccli --dev {device_num} timesync --synce --show<br>niccli verify<br>niccli --version<br>nicctl show card<br>nicctl --version<br>nicctl show card flash partition --json<br>nicctl show card interrupts --json<br>nicctl show card logs --non-persistent<br>nicctl show card logs --boot-fault<br>nicctl show card logs --persistent<br>nicctl show card profile --json<br>nicctl show card time --json<br>nicctl show card statistics packet-buffer summary --json<br>nicctl show lif statistics --json<br>nicctl show lif internal queue-to-ud-pinning<br>nicctl show pipeline internal anomalies<br>nicctl show pipeline internal rsq-ring<br>nicctl show pipeline internal statistics memory<br>nicctl show port fsm<br>nicctl show port transceiver --json<br>nicctl show port statistics --json<br>nicctl show port internal mac<br>nicctl show qos headroom --json<br>nicctl show rdma queue --json<br>nicctl show rdma queue-pair --detail --json<br>nicctl show version firmware<br>nicctl show dcqcn<br>nicctl show environment<br>nicctl show lif<br>nicctl show pcie ats<br>nicctl show port<br>nicctl show qos<br>nicctl show rdma statistics<br>nicctl show version host-software<br>nicctl show dcqcn --card {card_id} --json<br>nicctl show card hardware-config --card {card_id} | **Analyzer Args:**<br>- `expected_values`: Optional[Dict[str, Dict[str, Any]]] — Per-command expected checks keyed by canonical key (see command_to_canonical_key).<br>- `performance_profile_expected`: str — Expected Broadcom performance_profile value (case-insensitive). Default RoCE.<br>- `support_rdma_disabled_values`: List[str] — Values that indicate RDMA is not supported (case-insensitive).<br>- `pcie_relaxed_ordering_expected`: str — Expected Broadcom pcie_relaxed_ordering value (e.g. 'Relaxed ordering = enabled'); checked case-insensitively. Defaul...<br>- `expected_qos_prio_map`: Optional[Dict[Any, Any]] — Expected priority-to-TC map (e.g. {0: 0, 1: 1}; keys may be int or str in config). Checked per device when set.<br>- `expected_qos_pfc_enabled`: Optional[int] — Expected PFC enabled value (0/1 or bitmask). Checked per device when set.<br>- `expected_qos_tsa_map`: Optional[Dict[Any, Any]] — Expected TSA map for ETS (e.g. {0: 'ets', 1: 'strict'}; keys may be int or str in config). Checked per device when set.<br>- `expected_qos_tc_bandwidth`: Optional[List[int]] — Expected TC bandwidth percentages. Checked per device when set.<br>- `require_qos_consistent_across_adapters`: bool — When True and no expected_qos_\* are set, require all adapters to have the same prio_map, pfc_enabled, and tsa_map.<br>- `nicctl_log_error_regex`: Optional[List[Dict[str, Any]]] — Optional list of error patterns for nicctl show card logs. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `commands`: Optional[List[str]] — Optional list of niccli/nicctl/bcmcli commands to run. When None, default command set is used.<br>- `use_sudo_niccli`: bool — If True, run niccli commands with sudo when required.<br>- `use_sudo_nicctl`: bool — If True, run nicctl commands with sudo when required.<br>- `use_sudo_bcmcli`: bool — If True, run bcmcli commands with sudo when required.<br>- `broadcom_cli_override`: Optional[str] — Force 'niccli' or 'bcmcli' instead of auto-detecting which Broadcom CLI is present. | [NicDataModel](#NicDataModel-Model) | [NicCollector](#Collector-Class-NicCollector) | [NicAnalyzer](#Data-Analyzer-Class-NicAnalyzer) |
| NvmePlugin | nvme smart-log {dev}<br>nvme error-log {dev} --log-entries=256<br>nvme id-ctrl {dev}<br>nvme id-ns {dev}{ns}<br>nvme fw-log {dev}<br>nvme self-test-log {dev}<br>nvme get-log {dev} --log-id=6 --log-len=512<br>nvme telemetry-log {dev} --output-file={dev}_{f_name}<br>nvme list -o json | - | - | [NvmeDataModel](#NvmeDataModel-Model) | [NvmeCollector](#Collector-Class-NvmeCollector) | - |
| OsPlugin | sh -c '( lsb_release -ds &#124;&#124; (cat /etc/\*release &#124; grep PRETTY_NAME) &#124;&#124; uname -om ) 2>/dev/null &#124; head -n1'<br>cat /etc/\*release &#124; grep VERSION_ID<br>wmic os get Version /value<br>wmic os get Caption /Value | **Analyzer Args:**<br>- `exp_os`: Union[str, list] — Expected OS name/version string(s) to match (e.g. from lsb_release or /etc/os-release).<br>- `exact_match`: bool — If True, require exact match for exp_os; otherwise substring match. | - | [OsDataModel](#OsDataModel-Model) | [OsCollector](#Collector-Class-OsCollector) | [OsAnalyzer](#Data-Analyzer-Class-OsAnalyzer) |
| PackagePlugin | dnf list --installed<br>dpkg-query -W<br>pacman -Q<br>cat /etc/\*release<br>wmic product get name,version | **Analyzer Args:**<br>- `exp_package_ver`: Dict[str, Optional[str]] — Map package name -> expected version (None = any version). Checked against installed packages.<br>- `regex_match`: bool — If True, match package versions with regex; otherwise exact or prefix match.<br>- `rocm_regex`: Optional[str] — Optional regex to identify ROCm package version (used when enable_rocm_regex is True).<br>- `enable_rocm_regex`: bool — If True, use rocm_regex (or default pattern) to extract ROCm version for checks. | - | [PackageDataModel](#PackageDataModel-Model) | [PackageCollector](#Collector-Class-PackageCollector) | [PackageAnalyzer](#Data-Analyzer-Class-PackageAnalyzer) |
| PciePlugin | lspci -d {vendor_id}: -nn<br>lspci -x<br>lspci -xxxx<br>lspci -PP<br>lspci -PP -d {vendor_id}:{dev_id}<br>lspci -PP -D -d {vendor_id}:{dev_id}<br>lspci -PP -D<br>lspci -vvv<br>lspci -vvvt | **Analyzer Args:**<br>- `exp_speed`: int — Expected PCIe link speed (generation 1–5).<br>- `exp_width`: int — Expected PCIe link width in lanes (1–16).<br>- `exp_sriov_count`: int — Expected SR-IOV virtual function count.<br>- `exp_gpu_count_override`: Optional[int] — Override expected GPU count for validation.<br>- `exp_max_payload_size`: Union[Dict[int, int], int, NoneType] — Expected max payload size: int for all devices, or dict keyed by device ID.<br>- `exp_max_rd_req_size`: Union[Dict[int, int], int, NoneType] — Expected max read request size: int for all devices, or dict keyed by device ID.<br>- `exp_ten_bit_tag_req_en`: Union[Dict[int, int], int, NoneType] — Expected 10-bit tag request enable: int for all devices, or dict keyed by device ID. | - | [PcieDataModel](#PcieDataModel-Model) | [PcieCollector](#Collector-Class-PcieCollector) | [PcieAnalyzer](#Data-Analyzer-Class-PcieAnalyzer) |
| ProcessPlugin | top -b -n 1<br>rocm-smi --showpids<br>top -b -n 1 -o %CPU  | **Analyzer Args:**<br>- `max_kfd_processes`: int — Maximum allowed number of KFD (Kernel Fusion Driver) processes; 0 disables the check.<br>- `max_cpu_usage`: float — Maximum allowed CPU usage (percent) for process checks. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `top_n_process`: int — Number of top processes by CPU usage to collect (e.g. for top -b -n 1 -o %%CPU). | [ProcessDataModel](#ProcessDataModel-Model) | [ProcessCollector](#Collector-Class-ProcessCollector) | [ProcessAnalyzer](#Data-Analyzer-Class-ProcessAnalyzer) |
| RdmaPlugin | rdma link -j<br>rdma dev<br>rdma link<br>rdma statistic -j | **Analyzer Args:**<br>- `exclusion_regex`: Optional[list[str]] — Regex patterns matched against an interface netdev; matching interfaces are skipped. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors... | [RdmaDataModel](#RdmaDataModel-Model) | [RdmaCollector](#Collector-Class-RdmaCollector) | [RdmaAnalyzer](#Data-Analyzer-Class-RdmaAnalyzer) |
| RegexSearchPlugin | No collector step: reads local text from the CLI --data path (file or directory).<br>Directory scans load each file's contents into RegexSearchData for analysis. | Runs RegexSearchAnalyzer: user-defined patterns via analysis_args.error_regex (same shape as Dmesg).<br>Emits regex match events with optional per-file source in the description when scanning directories.<br>**Analyzer Args:**<br>- `error_regex`: Optional[list[dict[str, Any]]] — Regex patterns to search for; each dict may include regex (str), message, event_category, event_priority (same as Dme...<br>- `interval_to_collapse_event`: int — Seconds within which repeated events are collapsed into one.<br>- `num_timestamps`: int — Number of timestamps to include per event in output. | - | [RegexSearchData](#RegexSearchData-Model) | - | [RegexSearchAnalyzer](#Data-Analyzer-Class-RegexSearchAnalyzer) |
| RocmPlugin | {rocm_path}/opencl/bin/\*/clinfo<br>env &#124; grep -Ei 'rocm&#124;hsa&#124;hip&#124;mpi&#124;openmp&#124;ucx&#124;miopen'<br>ls /sys/class/kfd/kfd/proc/<br>grep -i -E 'rocm' /etc/ld.so.conf.d/\*<br>{rocm_path}/bin/rocminfo<br>ls -v -d {rocm_path}\*<br>ls -v -d {rocm_path}-[3-7]\* &#124; tail -1<br>ldconfig -p &#124; grep -i -E 'rocm'<br>grep . -H -r -i {rocm_path}/.info/\* | **Analyzer Args:**<br>- `exp_rocm`: Union[str, list] — Expected ROCm version string(s) to match (e.g. from rocminfo).<br>- `exp_rocm_latest`: str — Expected 'latest' ROCm path or version string for versioned installs.<br>- `exp_rocm_sub_versions`: dict[str, Union[str, list]] — Map sub-version name (e.g. version_rocm) to expected string or list of allowed strings. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `rocm_path`: str — Base path to ROCm installation (e.g. /opt/rocm). Used for rocminfo, clinfo, and version discovery. | [RocmDataModel](#RocmDataModel-Model) | [RocmCollector](#Collector-Class-RocmCollector) | [RocmAnalyzer](#Data-Analyzer-Class-RocmAnalyzer) |
| StoragePlugin | sh -c 'df -lH -B1 &#124; grep -v 'boot''<br>wmic LogicalDisk Where DriveType="3" Get DeviceId,Size,FreeSpace | **Analyzer Args:**<br>- `min_required_free_space_abs`: Optional[str] — Minimum required free space per mount (e.g. '10G', '1T').<br>- `min_required_free_space_prct`: Optional[int] — Minimum required free space as percentage of total (0–100).<br>- `ignore_devices`: Optional[list[str]] — Mount points or devices to exclude from free-space checks.<br>- `check_devices`: Optional[list[str]] — If non-empty, only these mount points or devices are checked.<br>- `regex_match`: bool — If True, match device/mount names with regex; otherwise exact match. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `skip_sudo`: bool — If True, do not use sudo when running df and related storage commands. | [StorageDataModel](#StorageDataModel-Model) | [StorageCollector](#Collector-Class-StorageCollector) | [StorageAnalyzer](#Data-Analyzer-Class-StorageAnalyzer) |
| ScaleOutAristaPlugin | show interfaces counters bins &#124; json &#124; no-more<br>show interfaces counters queue &#124; no-more<br>show interfaces counters queue drop-precedence &#124; no-more<br>show qos interfaces ecn counters queue &#124; json &#124; no-more<br>show interfaces counters errors &#124; json &#124; no-more<br>show interfaces phy &#124; no-more<br>show interfaces phy detail &#124; no-more<br>show interfaces counters ip &#124; json &#124; no-more<br>show ip interface &#124; no-more<br>show lldp &#124; no-more<br>show lldp neighbors &#124; json &#124; no-more<br>show interfaces counters &#124; json &#124; no-more<br>show interfaces flow-control &#124; json &#124; no-more<br>show interfaces counters queue detail &#124; no-more<br>show priority-flow-control counters &#124; json &#124; no-more<br>show priority-flow-control status &#124; no-more<br>show interfaces status &#124; json &#124; no-more<br>show qos interfaces &#124; no-more<br>show qos interfaces ecn &#124; no-more<br>show qos interfaces trust &#124; no-more<br>show qos maps &#124; no-more<br>show qos profile &#124; no-more<br>show qos profile summary &#124; no-more<br>show interfaces counters rates &#124; json &#124; no-more<br>show running-config &#124; no-more<br>show startup-config &#124; no-more<br>show system environment cooling &#124; json &#124; no-more<br>show platform trident mmu queue status &#124; no-more<br>show version &#124; json &#124; no-more | **Analyzer Args:**<br>- `analysis_ports`: Optional[List[str]] — Restrict per-port analysis to the given ports. Ports are S/P/[SP] where subport is optional (e.g. ['1/1', '1/31', '1/...<br>- `expected_port_bandwidth`: int — Expected interface bandwidth (bps) from show interfaces status (AristaPortStatus.bandwidth). Ports with a different b... | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Re-runs successful... | [ScaleOutAristaDataModel](#ScaleOutAristaDataModel-Model) | [ScaleOutAristaCollector](#Collector-Class-ScaleOutAristaCollector) | [ScaleOutAristaAnalyzer](#Data-Analyzer-Class-ScaleOutAristaAnalyzer) |
| ScaleOutDellPlugin | show alarm &#124; no-more<br>show buffer pool &#124; no-more<br>show buffer profile &#124; no-more<br>show clock &#124; no-more<br>show interface counters {port} &#124; no-more<br>show event details &#124; no-more<br>show interface fec status &#124; no-more<br>show interface counters &#124; no-more<br>show interface counters rate &#124; no-more<br>show interface Eth &#124; no-more<br>show interface phy counters &#124; no-more<br>show interface status &#124; no-more<br>show interface transceiver &#124; no-more<br>show interface transceiver dom &#124; no-more<br>show interface transceiver summary &#124; no-more<br>show ip arp &#124; no-more<br>show ip interfaces &#124; no-more<br>show ip route &#124; no-more<br>show lldp neighbor &#124; no-more<br>show lldp table &#124; no-more<br>show qos interface Ethall priority-flow-control statistics &#124; no-more<br>show priority-flow-control watchdog &#124; no-more<br>show qos interface Ethall queue all priority-flow-control watchdog-statistics &#124; no-more<br>show platform environment &#124; no-more<br>show platform firmware detail &#124; no-more<br>show platform syseeprom &#124; no-more<br>show qos interface Eth all &#124; no-more<br>show qos interface Eth all queue all &#124; no-more<br>show qos map dot1p-tc &#124; no-more<br>show qos map dscp-tc &#124; no-more<br>show qos map pfc-priority-pg &#124; no-more<br>show qos map pfc-priority-queue &#124; no-more<br>show qos map tc-dot1p &#124; no-more<br>show qos map tc-dscp &#124; no-more<br>show qos map tc-pg &#124; no-more<br>show qos map tc-queue &#124; no-more<br>show qos scheduler-policy &#124; no-more<br>show qos wred-policy &#124; no-more<br>show queue counters &#124; no-more<br>show queue persistent-watermark multicast &#124; no-more<br>show queue persistent-watermark unicast &#124; no-more<br>show queue watermark multicast &#124; no-more<br>show queue watermark unicast &#124; no-more<br>show running-configuration &#124; no-more<br>show version &#124; no-more | **Analyzer Args:**<br>- `analysis_ports`: Optional[List[str]] — Restrict per-port analysis to the given ports. Accepts optional Eth prefix (e.g. ['1/1', '1/31', '1/1/1'] or ['Eth1/1...<br>- `expected_port_speed`: int — Expected interface speed (Mbps) from show interface status (DellInterfaceStatus.speed). Ports with a different speed... | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output.<br>- `collection_ports`: Optional[List[str]] — Restrict detail counter collection to these ports. Accepts the same tokens as analysis_ports (e.g. ['1/1', '1/1/2'] o... | [ScaleOutDellDataModel](#ScaleOutDellDataModel-Model) | [ScaleOutDellCollector](#Collector-Class-ScaleOutDellCollector) | [ScaleOutDellAnalyzer](#Data-Analyzer-Class-ScaleOutDellAnalyzer) |
| SysSettingsPlugin | cat /sys/{}<br>ls -1 /sys/{}<br>ls -l /sys/{} | **Analyzer Args:**<br>- `checks`: Optional[list[nodescraper.plugins.inband.sys_settings.analyzer_args.SysfsCheck]] — List of sysfs checks (path, expected values or pattern, display name). | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `paths`: list[str] — Sysfs paths to read (cat). Paths with '\*' are collected with ls -l (e.g. class/net/\*/device).<br>- `directory_paths`: list[str] — Sysfs paths to list (ls -1); used for checks that match entry names by regex. | [SysSettingsDataModel](#SysSettingsDataModel-Model) | [SysSettingsCollector](#Collector-Class-SysSettingsCollector) | [SysSettingsAnalyzer](#Data-Analyzer-Class-SysSettingsAnalyzer) |
| SysctlPlugin | sysctl -n | **Analyzer Args:**<br>- `exp_vm_swappiness`: Optional[int] — Expected vm.swappiness value.<br>- `exp_vm_numa_balancing`: Optional[int] — Expected vm.numa_balancing value.<br>- `exp_vm_oom_kill_allocating_task`: Optional[int] — Expected vm.oom_kill_allocating_task value.<br>- `exp_vm_compaction_proactiveness`: Optional[int] — Expected vm.compaction_proactiveness value.<br>- `exp_vm_compact_unevictable_allowed`: Optional[int] — Expected vm.compact_unevictable_allowed value.<br>- `exp_vm_extfrag_threshold`: Optional[int] — Expected vm.extfrag_threshold value.<br>- `exp_vm_zone_reclaim_mode`: Optional[int] — Expected vm.zone_reclaim_mode value.<br>- `exp_vm_dirty_background_ratio`: Optional[int] — Expected vm.dirty_background_ratio value.<br>- `exp_vm_dirty_ratio`: Optional[int] — Expected vm.dirty_ratio value.<br>- `exp_vm_dirty_writeback_centisecs`: Optional[int] — Expected vm.dirty_writeback_centisecs value.<br>- `exp_kernel_numa_balancing`: Optional[int] — Expected kernel.numa_balancing value. | - | [SysctlDataModel](#SysctlDataModel-Model) | [SysctlCollector](#Collector-Class-SysctlCollector) | [SysctlAnalyzer](#Data-Analyzer-Class-SysctlAnalyzer) |
| SyslogPlugin | ls -1 /var/log/syslog\* 2>/dev/null &#124; grep -E '^/var/log/syslog(\.[0-9]+(\.gz)?)?$' &#124;&#124; true<br>ls -1 /var/log/messages\* 2>/dev/null &#124; grep -E '^/var/log/messages(\.[0-9]+(\.gz)?)?$' &#124;&#124; true | - | - | [SyslogData](#SyslogData-Model) | [SyslogCollector](#Collector-Class-SyslogCollector) | - |
| UptimePlugin | uptime | - | - | [UptimeDataModel](#UptimeDataModel-Model) | [UptimeCollector](#Collector-Class-UptimeCollector) | - |

# OOB plugins

| Plugin | Collection | Analyzer Args | Collection Args | DataModel | Collector | Analyzer |
| --- | --- | --- | --- | --- | --- | --- |
| OobGenericCollectionPlugin | Runs each command from collection_args.commands on the target (in-band host or BMC over OOB SSH).<br>Commands are user-configured; there are no fixed CMD_\* class fields. | **Analyzer Args:**<br>- `checks`: list[nodescraper.plugins.generic_collection.analyzer_args.CommandCheck] — Per-command validation rules keyed by collected command name. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `commands`: list[nodescraper.plugins.generic_collection.collector_args.CommandSpec] — Named commands to run. Each entry must include 'name' and 'command'. Prefer small textual stdout; see class docstring...<br>- `sudo`: bool — Default sudo setting for commands that do not specify sudo.<br>- `timeout`: int — Default per-command timeout in seconds.<br>- `include_stdout`: bool — Default: include each command's stdout in collected results for analysis. When false, stdout is omitted from stored r... | [GenericCollectionDataModel](#GenericCollectionDataModel-Model) | [GenericCollectionCollector](#Collector-Class-GenericCollectionCollector) | [GenericAnalyzer](#Data-Analyzer-Class-GenericAnalyzer) |
| OobBmcArchivePlugin | SSH (BMC) shell: tar+gzip archives for each path in collection_args (see PathSpec entries).<br>Uses sudo on the BMC when collection_args paths require elevated access. | - | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `paths`: list[nodescraper.plugins.ooband.bmc_archive.collector_args.PathSpec] — Named BMC paths to archive with tar czf -. Configure in plugin config under plugins.OobBmcArchivePlugin.collection_ar...<br>- `sudo`: bool — Default sudo setting for paths that do not specify sudo.<br>- `timeout`: int — Default per-path tar timeout in seconds.<br>- `skip_if_missing`: bool — Skip paths that do not exist on the BMC instead of failing collection.<br>- `ignore_failed_read`: bool — When true, pass GNU tar's --ignore-failed-read when the remote tar supports it. | [BmcArchiveDataModel](#BmcArchiveDataModel-Model) | [BmcArchiveCollector](#Collector-Class-BmcArchiveCollector) | - |
| RedfishEndpointPlugin | Redfish GET: explicit paths from collection_args.uris (parallel when max_workers>1).<br>Optional paged GET following the Members collection OData nextLink field when follow_next_link is true.<br>Redfish GET tree: when discover_tree is true, walks from api_root using OData resource id links and Members navigation (depth and endpoint caps from collection_args). | For each entry in analysis_args.checks, reads JSON paths in collected responses and compares values to constraints (eq, min/max, anyOf, regex, etc.).<br>URI key `*` runs checks against every collected response body.<br>**Analyzer Args:**<br>- `checks`: dict[str, dict[str, Union[int, float, str, bool, dict[str, Any]]]] — Map: URI or `*` -> { property_path: constraint }. URI keys must match a key in the collected responses (exact match).... | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `uris`: list[str] — Redfish URIs to GET. Ignored when discover_tree is True.<br>- `discover_tree`: bool — If True, discover endpoints from the BMC Redfish tree (service root and links) instead of using uris.<br>- `tree_max_depth`: int — When discover_tree is True: max traversal depth (1=service root only, 2=root + collections, 3=+ members).<br>- `tree_max_endpoints`: int — When discover_tree is True: max endpoints to discover (0=no limit).<br>- `max_workers`: int — Max concurrent GETs (1=sequential). Use >1 for async endpoint fetches.<br>- `follow_next_link`: bool — If True, follow Redfish Members collection OData nextLink pagination for each URI and merge all pages into a single r...<br>- `max_pages`: int — When follow_next_link is True: safety cap on the number of pages to follow per URI (default 200). | [RedfishEndpointDataModel](#RedfishEndpointDataModel-Model) | [RedfishEndpointCollector](#Collector-Class-RedfishEndpointCollector) | [RedfishEndpointAnalyzer](#Data-Analyzer-Class-RedfishEndpointAnalyzer) |
| RedfishOemDiagPlugin | Redfish LogService.CollectDiagnosticData for each entry in collection_args.oem_diagnostic_types (collection_args.log_service_path selects the LogService).<br>Optional binary archives under the plugin log path when log_path is set. | Summarizes success/failure per OEM diagnostic type from collected results.<br>When analysis_args.require_all_success is true, fails the run if any type failed collection.<br>**Analyzer Args:**<br>- `require_all_success`: bool — If True, analysis fails when any OEM type collection failed. | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `log_service_path`: str — Redfish path to the LogService (e.g. DiagLogs).<br>- `oem_diagnostic_types_allowable`: Optional[list[str]] — Allowable OEM diagnostic types for this architecture/BMC. When set, used for validation and as default for oem_diagno...<br>- `oem_diagnostic_types`: list[str] — OEM diagnostic types to collect. When empty and oem_diagnostic_types_allowable is set, defaults to that list.<br>- `task_timeout_s`: int — Max seconds to wait for each BMC task. | [RedfishOemDiagDataModel](#RedfishOemDiagDataModel-Model) | [RedfishOemDiagCollector](#Collector-Class-RedfishOemDiagCollector) | [RedfishOemDiagAnalyzer](#Data-Analyzer-Class-RedfishOemDiagAnalyzer) |
| ServiceabilityPluginMI3XX | Redfish GET: BMC event log Entries (collection_args.rf_event_log_uri; optional uri alias).<br>Paginated Members collection and optional top, reference_time/time_operator filters.<br>Redfish GET: CPER AdditionalDataURI binaries for DiagnosticDataType=CPER events (base64 in data model).<br>Optional chassis Assembly GETs (rf_assembly_uri_template + rf_chassis_devices).<br>Optional firmware bundle inventory GET (rf_firmware_bundle_uri) for component details. | Builds AFID events from collected Redfish event log members (and optional assembly metadata).<br>Optionally decodes CPER attachments via analysis_args.cper_decode_module before hub analysis.<br>Runs the configured Python service hub (hub_python_module) to produce service recommendations.<br>When analysis_args.skip_hub is true, only builds AFID events without running the hub.<br>**Analyzer Args:**<br>- `hub_python_module`: Optional[str] — Import path for the hub module (class implements hub_analyze_method); hub_options forwards kwargs.<br>- `hub_display_name`: Optional[str] — Optional label for analyzer status messages.<br>- `afid_sag_path`: Optional[str] — Path to hub config (e.g. AFID_SAG.json); passed as hub_init_path_kwarg.<br>- `hub_init_path_kwarg`: str — Hub __init__ keyword that receives afid_sag_path.<br>- `hub_analyze_method`: str — Hub method called with rf_events first (default get_service_info).<br>- `skip_hub`: bool — If True, only build afid_events without running the service hub.<br>- `cper_decode_module`: Optional[str] — Module import path for CPER decoding when events include CPER attachments.<br>- `cper_decode_method`: str — Callable on cper_decode_module: file-like CPER in, (return_code, decode_dict) out.<br>- `hub_options`: Optional[dict[str, Any]] — Extra kwargs for hub __init__ and analyze; collected cper_data overrides cper_data key.<br>- `from_ac_cycle`: int — from_ac_cycle kwarg for the hub analyze call (merged after hub_options).<br>- `from_date`: Optional[str] — Optional from_date for the hub analyze call (merged after hub_options).<br>- `designation_serials`: Optional[dict[str, str]] — Optional designation_serials for the hub analyze call (merged after hub_options).<br>- `suppress_service_actions`: Optional[list[str]] — Optional suppress_service_actions for the hub analyze call (merged after hub_options). | **Collection Args:**<br>- `html_view`: bool — When true, include logged command artifacts in command_artifacts.html using human-readable output. Arista collectors...<br>- `uri`: Optional[str] — Optional alias for ``rf_event_log_uri``. When both ``uri`` and ``rf_event_log_uri`` are explicitly set to non-empty v...<br>- `rf_event_log_uri`: str — Redfish URI for the event log ``Entries`` collection.<br>- `rf_chassis_devices`: Optional[List[str]] — Chassis designations for Assembly GETs; required with ``rf_assembly_uri_template``.<br>- `rf_assembly_uri_template`: Optional[str] — Redfish URI template containing ``{device}`` for each chassis Assembly resource.<br>- `rf_firmware_bundle_uri`: Optional[str] — Redfish URI for firmware bundle inventory when subclasses extract component details.<br>- `follow_next_link`: bool — If True, follow Members&#64;odata.nextLink up to max_pages; else single GET.<br>- `max_pages`: int — Safety cap on the number of pages when following event log pagination.<br>- `top`: Optional[int] — Most recent N entries via $skip after count probe; None collects full window.<br>- `reference_time`: Optional[str] — Optional ISO-8601 date or date-time used with time_operator (e.g. 2026-05-17 or 2026-05-17T13:01:00).<br>- `time_operator`: Optional[Literal['>', '>=', '<', '<=', '==']] — Comparison operator applied when reference_time is set. | [ServiceabilityDataModel](#ServiceabilityDataModel-Model) | [MI3XXCollector](#Collector-Class-MI3XXCollector) | [MI3XXAnalyzer](#Data-Analyzer-Class-MI3XXAnalyzer) |

# Collectors

## Collector Class GenericCollectionCollector

### Description

Run user-configured shell commands and report per-command success.

**Bases**: ['InBandDataCollector']

**Link to code**: [generic_collection_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/generic_collection/generic_collection_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>, <OSFamily.UNKNOWN: 2>, <OSFamily.WINDOWS: 1>}`

### Provides Data

GenericCollectionDataModel

### Documented collection

- Runs each command from collection_args.commands on the target (in-band host or BMC over OOB SSH).
- Commands are user-configured; there are no fixed CMD_\* class fields.

## Collector Class AmdSmiCollector

### Description

Class for collection of inband tool amd-smi data.

**Bases**: ['InBandDataCollector']

**Link to code**: [amdsmi_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/amdsmi/amdsmi_collector.py)

### Class Variables

- **AMD_SMI_EXE**: `amd-smi`
- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_VERSION**: `version --json`
- **CMD_LIST**: `list --json`
- **CMD_PROCESS**: `process --json`
- **CMD_PARTITION**: `partition --json`
- **CMD_FIRMWARE**: `firmware --json`
- **CMD_STATIC**: `static -g all --json`
- **CMD_STATIC_GPU**: `static -g {gpu_id} --json`
- **CMD_TOPOLOGY**: `topology`
- **CMD_METRIC**: `metric -g all`
- **CMD_BAD_PAGES**: `bad-pages`
- **CMD_XGMI_METRIC**: `xgmi -m`
- **CMD_XGMI_LINK**: `xgmi -l`
- **CMD_RAS**: `ras --cper --folder={folder}`
- **CMD_RAS_AFID**: `ras --afid --cper-file {cper_file}`

### Provides Data

AmdSmiDataModel

### Commands

- bad-pages
- firmware --json
- list --json
- metric -g all
- partition --json
- process --json
- ras --cper --folder={folder}
- ras --afid --cper-file {cper_file}
- static -g all --json
- static -g {gpu_id} --json
- topology
- version --json
- xgmi -l
- xgmi -m

## Collector Class BiosCollector

### Description

Collect BIOS details

**Bases**: ['InBandDataCollector']

**Link to code**: [bios_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/bios/bios_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic bios get SMBIOSBIOSVersion /Value`
- **CMD**: `sh -c 'cat /sys/devices/virtual/dmi/id/bios_version'`

### Provides Data

BiosDataModel

### Commands

- sh -c 'cat /sys/devices/virtual/dmi/id/bios_version'
- wmic bios get SMBIOSBIOSVersion /Value

## Collector Class CmdlineCollector

### Description

Read linux cmdline data

**Bases**: ['InBandDataCollector']

**Link to code**: [cmdline_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/cmdline/cmdline_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `cat /proc/cmdline`

### Provides Data

CmdlineDataModel

### Commands

- cat /proc/cmdline

## Collector Class DeviceEnumerationCollector

### Description

Collect CPU and GPU count

**Bases**: ['InBandDataCollector']

**Link to code**: [device_enumeration_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/device_enumeration/device_enumeration_collector.py)

### Class Variables

- **CMD_GPU_COUNT_LINUX**: `lspci -d {vendorid_ep}: | grep -iE 'VGA|Display|3D|Processing accelerators|Co-processor|Accelerator' | grep -vi 'Virtual Function' | wc -l`
- **CMD_VF_COUNT_LINUX**: `lspci -d {vendorid_ep}: | grep -i 'Virtual Function' | wc -l`
- **CMD_LSCPU_LINUX**: `lscpu`
- **CMD_LSHW_LINUX**: `lshw`
- **CMD_CPU_COUNT_WINDOWS**: `powershell -Command "(Get-WmiObject -Class Win32_Processor | Measure-Object).Count"`
- **CMD_GPU_COUNT_WINDOWS**: `powershell -Command "(wmic path win32_VideoController get name | findstr AMD | Measure-Object).Count"`
- **CMD_VF_COUNT_WINDOWS**: `powershell -Command "(Get-VMHostPartitionableGpu | Measure-Object).Count"`

### Provides Data

DeviceEnumerationDataModel

### Commands

- powershell -Command "(Get-WmiObject -Class Win32_Processor | Measure-Object).Count"
- lspci -d {vendorid_ep}: | grep -iE 'VGA|Display|3D|Processing accelerators|Co-processor|Accelerator' | grep -vi 'Virtual Function' | wc -l
- powershell -Command "(wmic path win32_VideoController get name | findstr AMD | Measure-Object).Count"
- lscpu
- lshw
- lspci -d {vendorid_ep}: | grep -i 'Virtual Function' | wc -l
- powershell -Command "(Get-VMHostPartitionableGpu | Measure-Object).Count"

## Collector Class DimmCollector

### Description

Collect data on installed DIMMs

**Bases**: ['InBandDataCollector']

**Link to code**: [dimm_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dimm/dimm_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic memorychip get Capacity`
- **CMD**: `sh -c 'dmidecode -t 17 | tr -s " " | grep -v "Volatile\|None\|Module" | grep Size' 2>/dev/null`
- **CMD_DMIDECODE_FULL**: `dmidecode`

### Provides Data

DimmDataModel

### Commands

- sh -c 'dmidecode -t 17 | tr -s " " | grep -v "Volatile\|None\|Module" | grep Size' 2>/dev/null
- dmidecode
- wmic memorychip get Capacity

## Collector Class DkmsCollector

### Description

Collect DKMS status and version data

**Bases**: ['InBandDataCollector']

**Link to code**: [dkms_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dkms/dkms_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_STATUS**: `dkms status`
- **CMD_VERSION**: `dkms --version`

### Provides Data

DkmsDataModel

### Commands

- dkms status
- dkms --version

## Collector Class DmesgCollector

### Description

Read dmesg log

**Bases**: ['InBandDataCollector']

**Link to code**: [dmesg_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dmesg/dmesg_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `dmesg --time-format iso -x`
- **CMD_LOGS**: `ls -1 /var/log/dmesg* 2>/dev/null | grep -E '^/var/log/dmesg(\.[0-9]+(\.gz)?)?$' || true`

### Provides Data

DmesgData

### Commands

- dmesg --time-format iso -x
- ls -1 /var/log/dmesg\* 2>/dev/null | grep -E '^/var/log/dmesg(\.[0-9]+(\.gz)?)?$' || true

## Collector Class FabricsCollector

### Description

Collect InfiniBand/RDMA fabrics configuration details

**Bases**: ['InBandDataCollector']

**Link to code**: [fabrics_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/fabrics/fabrics_collector.py)

### Class Variables

- **CMD_IBSTAT**: `ibstat`
- **CMD_IBV_DEVINFO**: `ibv_devinfo`
- **CMD_IB_DEV_NETDEVS**: `ls -l /sys/class/infiniband/*/device/net`
- **CMD_OFED_INFO**: `ofed_info -s`
- **CMD_MST_START**: `mst start`
- **CMD_MST_STATUS**: `mst status -v`
- **CMD_CASSINI_PCI**: `lspci | grep -i cassini`
- **CMD_NET_LINK**: `ip link show`
- **CMD_LIBFABRIC_INFO**: `fi_info -p cxi`
- **CMD_CXI_STAT**: `cxi_stat`
- **CMD_CXI_MODULES**: `lsmod | grep cxi`

### Provides Data

FabricsDataModel

### Commands

- lspci | grep -i cassini
- lsmod | grep cxi
- cxi_stat
- ibstat
- ibv_devinfo
- ls -l /sys/class/infiniband/\*/device/net
- fi_info -p cxi
- mst start
- mst status -v
- ip link show
- ofed_info -s

## Collector Class JournalCollector

### Description

Read journal log via journalctl.

**Bases**: ['InBandDataCollector']

**Link to code**: [journal_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/journal/journal_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `journalctl --no-pager --system --output=short-iso`
- **CMD_JSON**: `journalctl --no-pager --system --output=json`

### Provides Data

JournalData

### Commands

- journalctl --no-pager --system --output=short-iso
- journalctl --no-pager --system --output=json

## Collector Class KernelCollector

### Description

Read kernel version

**Bases**: ['InBandDataCollector']

**Link to code**: [kernel_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel/kernel_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic os get Version /Value`
- **CMD**: `sh -c 'uname -a'`
- **CMD_NUMA_BALANCING**: `sh -c 'cat /proc/sys/kernel/numa_balancing'`

### Provides Data

KernelDataModel

### Commands

- sh -c 'uname -a'
- sh -c 'cat /proc/sys/kernel/numa_balancing'
- wmic os get Version /Value

## Collector Class KernelModuleCollector

### Description

Read kernel modules and associated parameters

**Bases**: ['InBandDataCollector']

**Link to code**: [kernel_module_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel_module/kernel_module_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic os get Version /Value`
- **CMD**: `cat /proc/modules`
- **CMD_MODINFO_AMDGPU**: `modinfo amdgpu`

### Provides Data

KernelModuleDataModel

### Commands

- cat /proc/modules
- modinfo amdgpu
- wmic os get Version /Value

## Collector Class MemoryCollector

### Description

Collect memory usage details

**Bases**: ['InBandDataCollector']

**Link to code**: [memory_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/memory/memory_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value`
- **CMD**: `free -b`
- **CMD_LSMEM**: `lsmem`
- **CMD_NUMACTL**: `numactl -H`

### Provides Data

MemoryDataModel

### Commands

- free -b
- lsmem
- numactl -H
- wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value

## Collector Class NetworkCollector

### Description

Collect network configuration details using ip command

**Bases**: ['InBandDataCollector']

**Link to code**: [network_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/network/network_collector.py)

### Class Variables

- **CMD_ADDR**: `ip addr show`
- **CMD_ROUTE**: `ip route show`
- **CMD_RULE**: `ip rule show`
- **CMD_NEIGHBOR**: `ip neighbor show`
- **CMD_ETHTOOL_TEMPLATE**: `ethtool {interface}`
- **CMD_ETHTOOL_S_TEMPLATE**: `ethtool -S {interface}`
- **CMD_ETHTOOL_I_TEMPLATE**: `ethtool -i {interface}`
- **CMD_PING**: `ping`
- **CMD_WGET**: `wget`
- **CMD_CURL**: `curl`
- **CMD_LLDPCLI_NEIGHBOR**: `lldpcli show neighbor`
- **CMD_LLDPCTL**: `lldpctl`

### Provides Data

NetworkDataModel

### Commands

- ip addr show
- curl
- ethtool -i {interface}
- ethtool -S {interface}
- ethtool {interface}
- lldpcli show neighbor
- lldpctl
- ip neighbor show
- ping
- ip route show
- ip rule show
- wget

## Collector Class NicCollector

### Description

Collect raw output from niccli (Broadcom) and nicctl (Pensando) commands.

**Bases**: ['InBandDataCollector']

**Link to code**: [nic_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nic/nic_collector.py)

### Class Variables

- **CMD_NICCLI_VERSION**: `niccli --version`
- **CMD_NICCLI_LIST**: `niccli --list`
- **CMD_NICCLI_LIST_DEVICES**: `niccli --list_devices`
- **CMD_NICCLI_LIST_DEVICES_LEGACY**: `niccli --listdev`
- **CMD_NICCLI_DEVID**: `niccli devid`
- **CMD_NICCLI_VERIFY**: `niccli verify`
- **CMD_NICCLI_GLOBAL**: `['niccli devid']`
- **CMD_NICCLI_DISCOVERY_LEGACY**: `['niccli --listdev', 'niccli --list']`
- **CMD_NICCLI_DISCOVERY_NEW**: `['niccli --list_devices', 'niccli --list']`
- **CMD_NICCLI_DISCOVERY**: `['niccli --listdev', 'niccli --list']`
- **CMD_NICCLI_DISCOVERY_ALL**: `frozenset({'niccli --list', 'niccli --list_devices', 'niccli --listdev'})`
- **CMD_NICCLI_SUPPORT_RDMA_TEMPLATE_LEGACY**: `niccli -dev {device_num} nvm -getoption support_rdma -scope 0`
- **CMD_NICCLI_PERFORMANCE_PROFILE_TEMPLATE_LEGACY**: `niccli -dev {device_num} nvm -getoption performance_profile`
- **CMD_NICCLI_PCIE_RELAXED_ORDERING_TEMPLATE_LEGACY**: `niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering`
- **CMD_NICCLI_QOS_TEMPLATE_LEGACY**: `niccli -dev {device_num} getqos`
- **CMD_NICCLI_PER_DEVICE_LEGACY**: `[
  niccli -dev {device_num} nvm -getoption support_rdma -scope 0,
  niccli -dev {device_num} nvm -getoption performance_profile,
  niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering,
  niccli -dev {device_num} getqos
]`
- **CMD_NICCLI_SUPPORT_RDMA_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --getoption support_rdma --scope 0`
- **CMD_NICCLI_PERFORMANCE_PROFILE_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --getoption performance_profile`
- **CMD_NICCLI_PCIE_RELAXED_ORDERING_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --getoption pcie_relaxed_ordering`
- **CMD_NICCLI_QOS_TEMPLATE_NEW**: `niccli --dev {device_num} qos --ets --show`
- **CMD_NICCLI_SHOW_TEMPLATE_NEW**: `niccli --dev {device_num} show`
- **CMD_NICCLI_SHOW_ALL_TEMPLATE_NEW**: `niccli --dev {device_num} show --all`
- **CMD_NICCLI_SHOW_HEALTH_TEMPLATE_NEW**: `niccli --dev {device_num} show --health`
- **CMD_NICCLI_SHOW_DEVICE_INFO_TEMPLATE_NEW**: `niccli --dev {device_num} show --device_info`
- **CMD_NICCLI_SHOW_DEVICE_PCI_IDS_TEMPLATE_NEW**: `niccli --dev {device_num} show --device_pci_ids`
- **CMD_NICCLI_SHOW_CERTIFICATE_TEMPLATE_NEW**: `niccli --dev {device_num} show --certificate`
- **CMD_NICCLI_SHOW_PKG_VER_TEMPLATE_NEW**: `niccli --dev {device_num} show --pkg_ver`
- **CMD_NICCLI_LINK_STATUS_TEMPLATE_NEW**: `niccli --dev {device_num} link --status`
- **CMD_NICCLI_LINK_COUNTERS_TEMPLATE_NEW**: `niccli --dev {device_num} link --counters --show`
- **CMD_NICCLI_LINKDIAG_LOOPBACK_SHOW_TEMPLATE_NEW**: `niccli --dev {device_num} linkdiag --loopback --show`
- **CMD_NICCLI_LINKDIAG_DSCDUMP_TEMPLATE_NEW**: `niccli --dev {device_num} linkdiag --dscdump --lane 0`
- **CMD_NICCLI_LINKDIAG_TXFIR_SHOW_TEMPLATE_NEW**: `niccli --dev {device_num} linkdiag --txfir --show --modulation_type NRZ --lane 0`
- **CMD_NICCLI_QOS_EGRESS_COSQ_TEMPLATE_NEW**: `niccli --dev {device_num} qos --egress --cosq --show`
- **CMD_NICCLI_QOS_INGRESS_COSQ_TEMPLATE_NEW**: `niccli --dev {device_num} qos --ingress --cosq --show`
- **CMD_NICCLI_QOS_RX_RATE_LIMIT_TEMPLATE_NEW**: `niccli --dev {device_num} qos --rx_rate_limit --show`
- **CMD_NICCLI_QOS_TX_EP_RATE_LIMIT_TEMPLATE_NEW**: `niccli --dev {device_num} qos --tx_ep_rate_limit --port 0 --show`
- **CMD_NICCLI_QOS_DSCP2PRIO_TEMPLATE_NEW**: `niccli --dev {device_num} qos --dscp2prio`
- **CMD_NICCLI_QOS_LISTMAP_TEMPLATE_NEW**: `niccli --dev {device_num} qos --listmap --pri2cos`
- **CMD_NICCLI_NVM_LIST_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --list`
- **CMD_NICCLI_NVM_LISTOPTIONS_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --listoptions`
- **CMD_NICCLI_NVM_VIEW_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --view`
- **CMD_NICCLI_NVM_VERIFY_TEMPLATE_NEW**: `niccli --dev {device_num} nvm --verify`
- **CMD_NICCLI_FW_LIVEPATCH_SHOW_TEMPLATE_NEW**: `niccli --dev {device_num} fw --livepatch --show`
- **CMD_NICCLI_MSIX_SHOW_TEMPLATE_NEW**: `niccli --dev {device_num} msix --max_vectors --show --pf 0`
- **CMD_NICCLI_TIMESYNC_PTP_TEMPLATE_NEW**: `niccli --dev {device_num} timesync --ptp --show`
- **CMD_NICCLI_TIMESYNC_SYNCE_TEMPLATE_NEW**: `niccli --dev {device_num} timesync --synce --show`
- **CMD_NICCLI_TIMESYNC_TSIO_TEMPLATE_NEW**: `niccli --dev {device_num} timesync --tsio --show`
- **CMD_NICCLI_TUNNEL_RSS_TEMPLATE_NEW**: `niccli --dev {device_num} tunnel --cfg --rss --show`
- **CMD_NICCLI_TUNNEL_VXLAN_IPV4_TEMPLATE_NEW**: `niccli --dev {device_num} tunnel --cfg --vxlan --type ipv4 --show`
- **CMD_NICCLI_COUNTERS_PCIE_TEMPLATE_NEW**: `niccli --dev {device_num} counters --pcie`
- **CMD_NICCLI_RESMGMT_PROFILE_TEMPLATE_NEW**: `niccli --dev {device_num} resmgmt --all --profile --show`
- **CMD_NICCLI_CABLE_MODULE_INFO_TEMPLATE_NEW**: `niccli --dev {device_num} cable --module_info --show`
- **CMD_NICCLI_PER_DEVICE_NEW**: `[
  niccli --dev {device_num} nvm --getoption support_rdma --scope 0,
  niccli --dev {device_num} nvm --getoption performance_profile,
  niccli --dev {device_num} nvm --getoption pcie_relaxed_ordering,
  niccli --dev {device_num} qos --ets --show,
  niccli --dev {device_num} show --all,
  niccli --dev {device_num} show --health,
  niccli --dev {device_num} show --certificate,
  niccli --dev {device_num} show --pkg_ver,
  niccli --dev {device_num} link --status,
  niccli --dev {device_num} linkdiag --loopback --show,
  niccli --dev {device_num} linkdiag --txfir --show --modulation_type NRZ --lane 0,
  niccli --dev {device_num} qos --egress --cosq --show,
  niccli --dev {device_num} qos --ingress --cosq --show,
  niccli --dev {device_num} qos --rx_rate_limit --show,
  niccli --dev {device_num} qos --listmap --pri2cos,
  niccli --dev {device_num} msix --max_vectors --show --pf 0,
  niccli --dev {device_num} timesync --ptp --show,
  niccli --dev {device_num} timesync --tsio --show,
  niccli --dev {device_num} tunnel --cfg --rss --show,
  niccli --dev {device_num} tunnel --cfg --vxlan --type ipv4 --show,
  niccli --dev {device_num} counters --pcie,
  niccli --dev {device_num} resmgmt --all --profile --show
]`
- **CMD_NICCLI_SUPPORT_RDMA_TEMPLATE**: `niccli -dev {device_num} nvm -getoption support_rdma -scope 0`
- **CMD_NICCLI_PERFORMANCE_PROFILE_TEMPLATE**: `niccli -dev {device_num} nvm -getoption performance_profile`
- **CMD_NICCLI_PCIE_RELAXED_ORDERING_TEMPLATE**: `niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering`
- **CMD_NICCLI_PER_DEVICE**: `[
  niccli -dev {device_num} nvm -getoption support_rdma -scope 0,
  niccli -dev {device_num} nvm -getoption performance_profile,
  niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering,
  niccli -dev {device_num} getqos
]`
- **CMD_NICCTL_CARD_TEXT**: `nicctl show card`
- **CMD_NICCTL_GLOBAL**: `[
  nicctl --version,
  nicctl show card flash partition --json,
  nicctl show card interrupts --json,
  nicctl show card logs --non-persistent,
  nicctl show card logs --boot-fault,
  nicctl show card logs --persistent,
  nicctl show card profile --json,
  nicctl show card time --json,
  nicctl show card statistics packet-buffer summary --json,
  nicctl show lif statistics --json,
  nicctl show lif internal queue-to-ud-pinning,
  nicctl show pipeline internal anomalies,
  nicctl show pipeline internal rsq-ring,
  nicctl show pipeline internal statistics memory,
  nicctl show port fsm,
  nicctl show port transceiver --json,
  nicctl show port statistics --json,
  nicctl show port internal mac,
  nicctl show qos headroom --json,
  nicctl show rdma queue --json,
  nicctl show rdma queue-pair --detail --json,
  nicctl show version firmware
]`
- **CMD_NICCTL_PER_CARD**: `['nicctl show dcqcn --card {card_id} --json', 'nicctl show card hardware-config --card {card_id}']`
- **CMD_NICCTL_LEGACY_TEXT**: `[
  nicctl show card,
  nicctl show dcqcn,
  nicctl show environment,
  nicctl show lif,
  nicctl show pcie ats,
  nicctl show port,
  nicctl show qos,
  nicctl show rdma statistics,
  nicctl show version host-software
]`
- **CMD_BCMCLI_VERSION**: `bcmcli_show version`
- **CMD_BCMCLI_LIST**: `bcmcli_show device_list`
- **CMD_BCMCLI_GLOBAL**: `['bcmcli_show version', 'bcmcli_show device_list']`
- **CMD_BCMCLI_SUPPORT_RDMA_TEMPLATE**: `bcmcli_config query support_rdma -d {device_id}`
- **CMD_BCMCLI_PERFORMANCE_PROFILE_TEMPLATE**: `bcmcli_config query performance_profile -d {device_id}`
- **CMD_BCMCLI_PCIE_RELAXED_ORDERING_TEMPLATE**: `bcmcli_config query pcie_relaxed_ordering -d {device_id}`
- **CMD_BCMCLI_AN_PROTOCOL_TEMPLATE**: `bcmcli_config query AN_PROTOCOL -d {device_id}`
- **CMD_BCMCLI_NVM_SHOW_CONFS_TEMPLATE**: `bcmcli_config show_confs -d {device_id}`
- **CMD_BCMCLI_NVM_SHOW_TEMPLATE**: `bcmcli_nvm show -d {device_id}`
- **CMD_BCMCLI_QOS_TEMPLATE**: `bcmcli_qos show qos -d {device_id}`
- **CMD_BCMCLI_QOS_HW_MAPS_TEMPLATE**: `bcmcli_qos show hw-maps -d {device_id}`
- **CMD_BCMCLI_QOS_RX_PORT_RATELIMIT_TEMPLATE**: `bcmcli_qos show rx-port-ratelimit -d {device_id}`
- **CMD_BCMCLI_QOS_TX_EP_RATELIMIT_TEMPLATE**: `bcmcli_qos show tx-ep-ratelimit --port 0 -d {device_id}`
- **CMD_BCMCLI_QOS_INGRESS_COSQ_TEMPLATE**: `bcmcli_qos show ingress --cosq -d {device_id}`
- **CMD_BCMCLI_QOS_EGRESS_COSQ_TEMPLATE**: `bcmcli_qos show egress --cosq -d {device_id}`
- **CMD_BCMCLI_HEALTH_TEMPLATE**: `bcmcli_show health -d {device_id}`
- **CMD_BCMCLI_STATUS_TEMPLATE**: `bcmcli_show status -d {device_id}`
- **CMD_BCMCLI_TEMPERATURE_TEMPLATE**: `bcmcli_show temperature -d {device_id}`
- **CMD_BCMCLI_PCI_TEMPLATE**: `bcmcli_show pci -d {device_id}`
- **CMD_BCMCLI_PHY_TEMPLATE**: `bcmcli_show phy -d {device_id}`
- **CMD_BCMCLI_RESOURCE_COUNTS_TEMPLATE**: `bcmcli_show resource_counts -d {device_id}`
- **CMD_BCMCLI_LINK_STATUS_TEMPLATE**: `bcmcli_link show -d {device_id}`
- **CMD_BCMCLI_TX_COUNTERS_TEMPLATE**: `bcmcli_hwdbg dump_tx_counters -d {device_id}`
- **CMD_BCMCLI_RX_COUNTERS_TEMPLATE**: `bcmcli_hwdbg dump_rx_counters -d {device_id}`
- **CMD_BCMCLI_PCIE_COUNTERS_TEMPLATE**: `bcmcli_debug pcie counters -d {device_id}`
- **CMD_BCMCLI_VERIFY_TEMPLATE**: `bcmcli_debug verify -d {device_id}`
- **CMD_BCMCLI_LOOPBACK_SHOW_TEMPLATE**: `bcmcli_debug loopback -d {device_id}`
- **CMD_BCMCLI_DSCDUMP_TEMPLATE**: `bcmcli_debug dscdump --lane 0 -d {device_id}`
- **CMD_BCMCLI_SERDES_TX_GET_TEMPLATE**: `bcmcli_debug serdes_tx --get --modtype NRZ --lane 0 -d {device_id}`
- **CMD_BCMCLI_FW_VERSION_TEMPLATE**: `bcmcli_fwmanager show fwpackage -d {device_id}`
- **CMD_BCMCLI_FW_CERTIFICATE_TEMPLATE**: `bcmcli_fwmanager show certificate -d {device_id}`
- **CMD_BCMCLI_LIVEPATCH_SHOW_TEMPLATE**: `bcmcli_livepatch show -d {device_id}`
- **CMD_BCMCLI_TUNNEL_RSS_TEMPLATE**: `bcmcli_tunnel show rss -d {device_id}`
- **CMD_BCMCLI_TUNNEL_VXLAN_IPV4_TEMPLATE**: `bcmcli_tunnel show vxlan --type ipv4 -d {device_id}`
- **CMD_BCMCLI_TUNNEL_VXLAN_IPV6_TEMPLATE**: `bcmcli_tunnel show vxlan --type ipv6 -d {device_id}`
- **CMD_BCMCLI_TUNNEL_VXLAN_TEMPLATE**: `bcmcli_tunnel show vxlan --type ipv4 -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_PTP_TEMPLATE**: `bcmcli_timesync show ptp -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_SYNCE_TEMPLATE**: `bcmcli_timesync show synce -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_TSIO_TEMPLATE**: `bcmcli_timesync show tsio -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_DLL_TEMPLATE**: `bcmcli_timesync show dll -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_DUTY_CYCLE_TEMPLATE**: `bcmcli_timesync show duty-cycle -d {device_id}`
- **CMD_BCMCLI_TIMESYNC_TS_PIN_TEMPLATE**: `bcmcli_timesync show ts-pin -d {device_id}`
- **CMD_BCMCLI_MSIX_TEMPLATE**: `bcmcli_config msixmv query --pf all -d {device_id}`
- **CMD_BCMCLI_SNAPDUMP_TEMPLATE**: `bcmcli_dump snap_dump -d {device_id}`
- **CMD_BCMCLI_PER_DEVICE**: `[
  bcmcli_config query AN_PROTOCOL -d {device_id},
  bcmcli_config show_confs -d {device_id},
  bcmcli_nvm show -d {device_id},
  bcmcli_qos show qos -d {device_id},
  bcmcli_qos show hw-maps -d {device_id},
  bcmcli_qos show rx-port-ratelimit -d {device_id},
  bcmcli_qos show tx-ep-ratelimit --port 0 -d {device_id},
  bcmcli_qos show ingress --cosq -d {device_id},
  bcmcli_qos show egress --cosq -d {device_id},
  bcmcli_show health -d {device_id},
  bcmcli_show status -d {device_id},
  bcmcli_show temperature -d {device_id},
  bcmcli_show pci -d {device_id},
  bcmcli_show phy -d {device_id},
  bcmcli_show resource_counts -d {device_id},
  bcmcli_link show -d {device_id},
  bcmcli_hwdbg dump_tx_counters -d {device_id},
  bcmcli_hwdbg dump_rx_counters -d {device_id},
  bcmcli_debug pcie counters -d {device_id},
  bcmcli_debug verify -d {device_id},
  bcmcli_debug loopback -d {device_id},
  bcmcli_debug dscdump --lane 0 -d {device_id},
  bcmcli_debug serdes_tx --get --modtype NRZ --lane 0 -d {device_id},
  bcmcli_fwmanager show fwpackage -d {device_id},
  bcmcli_fwmanager show certificate -d {device_id},
  bcmcli_livepatch show -d {device_id},
  bcmcli_tunnel show rss -d {device_id},
  bcmcli_tunnel show vxlan --type ipv4 -d {device_id},
  bcmcli_tunnel show vxlan --type ipv6 -d {device_id},
  bcmcli_timesync show dll -d {device_id},
  bcmcli_timesync show duty-cycle -d {device_id},
  bcmcli_timesync show ts-pin -d {device_id},
  bcmcli_config msixmv query --pf all -d {device_id},
  bcmcli_dump snap_dump -d {device_id}
]`

### Provides Data

NicDataModel

### Commands

- bcmcli_config query AN_PROTOCOL -d {device_id}
- bcmcli_debug dscdump --lane 0 -d {device_id}
- bcmcli_fwmanager show certificate -d {device_id}
- bcmcli_fwmanager show fwpackage -d {device_id}
- bcmcli_show version
- bcmcli_show device_list
- bcmcli_show health -d {device_id}
- bcmcli_link show -d {device_id}
- bcmcli_livepatch show -d {device_id}
- bcmcli_debug loopback -d {device_id}
- bcmcli_config msixmv query --pf all -d {device_id}
- bcmcli_config show_confs -d {device_id}
- bcmcli_nvm show -d {device_id}
- bcmcli_debug pcie counters -d {device_id}
- bcmcli_config query pcie_relaxed_ordering -d {device_id}
- bcmcli_show pci -d {device_id}
- bcmcli_config query performance_profile -d {device_id}
- bcmcli_qos show qos -d {device_id}
- bcmcli_qos show hw-maps -d {device_id}
- bcmcli_qos show rx-port-ratelimit -d {device_id}
- bcmcli_qos show tx-ep-ratelimit --port 0 -d {device_id}
- bcmcli_qos show ingress --cosq -d {device_id}
- bcmcli_qos show egress --cosq -d {device_id}
- bcmcli_show status -d {device_id}
- bcmcli_show temperature -d {device_id}
- bcmcli_show phy -d {device_id}
- bcmcli_show resource_counts -d {device_id}
- bcmcli_hwdbg dump_tx_counters -d {device_id}
- bcmcli_hwdbg dump_rx_counters -d {device_id}
- bcmcli_debug verify -d {device_id}
- bcmcli_debug serdes_tx --get --modtype NRZ --lane 0 -d {device_id}
- bcmcli_tunnel show rss -d {device_id}
- bcmcli_tunnel show vxlan --type ipv4 -d {device_id}
- bcmcli_tunnel show vxlan --type ipv6 -d {device_id}
- bcmcli_timesync show dll -d {device_id}
- bcmcli_timesync show duty-cycle -d {device_id}
- bcmcli_timesync show ts-pin -d {device_id}
- bcmcli_dump snap_dump -d {device_id}
- bcmcli_config query support_rdma -d {device_id}
- bcmcli_timesync show ptp -d {device_id}
- bcmcli_timesync show synce -d {device_id}
- bcmcli_timesync show tsio -d {device_id}
- niccli --dev {device_num} cable --module_info --show
- niccli --dev {device_num} counters --pcie
- niccli devid
- niccli --listdev
- niccli --list
- niccli --list_devices
- niccli --dev {device_num} fw --livepatch --show
- niccli --dev {device_num} linkdiag --dscdump --lane 0
- niccli --dev {device_num} linkdiag --loopback --show
- niccli --dev {device_num} linkdiag --txfir --show --modulation_type NRZ --lane 0
- niccli --dev {device_num} link --counters --show
- niccli --dev {device_num} link --status
- niccli --dev {device_num} msix --max_vectors --show --pf 0
- niccli --dev {device_num} nvm --listoptions
- niccli --dev {device_num} nvm --list
- niccli --dev {device_num} nvm --verify
- niccli --dev {device_num} nvm --view
- niccli -dev {device_num} nvm -getoption pcie_relaxed_ordering
- niccli --dev {device_num} nvm --getoption pcie_relaxed_ordering
- niccli -dev {device_num} nvm -getoption performance_profile
- niccli --dev {device_num} nvm --getoption performance_profile
- niccli -dev {device_num} nvm -getoption support_rdma -scope 0
- niccli -dev {device_num} getqos
- niccli --dev {device_num} nvm --getoption support_rdma --scope 0
- niccli --dev {device_num} qos --ets --show
- niccli --dev {device_num} show --all
- niccli --dev {device_num} show --health
- niccli --dev {device_num} show --certificate
- niccli --dev {device_num} show --pkg_ver
- niccli --dev {device_num} qos --egress --cosq --show
- niccli --dev {device_num} qos --ingress --cosq --show
- niccli --dev {device_num} qos --rx_rate_limit --show
- niccli --dev {device_num} qos --listmap --pri2cos
- niccli --dev {device_num} timesync --ptp --show
- niccli --dev {device_num} timesync --tsio --show
- niccli --dev {device_num} tunnel --cfg --rss --show
- niccli --dev {device_num} tunnel --cfg --vxlan --type ipv4 --show
- niccli --dev {device_num} resmgmt --all --profile --show
- niccli --dev {device_num} qos --dscp2prio
- niccli --dev {device_num} qos --tx_ep_rate_limit --port 0 --show
- niccli --dev {device_num} show --device_info
- niccli --dev {device_num} show --device_pci_ids
- niccli --dev {device_num} show
- niccli --dev {device_num} timesync --synce --show
- niccli verify
- niccli --version
- nicctl show card
- nicctl --version
- nicctl show card flash partition --json
- nicctl show card interrupts --json
- nicctl show card logs --non-persistent
- nicctl show card logs --boot-fault
- nicctl show card logs --persistent
- nicctl show card profile --json
- nicctl show card time --json
- nicctl show card statistics packet-buffer summary --json
- nicctl show lif statistics --json
- nicctl show lif internal queue-to-ud-pinning
- nicctl show pipeline internal anomalies
- nicctl show pipeline internal rsq-ring
- nicctl show pipeline internal statistics memory
- nicctl show port fsm
- nicctl show port transceiver --json
- nicctl show port statistics --json
- nicctl show port internal mac
- nicctl show qos headroom --json
- nicctl show rdma queue --json
- nicctl show rdma queue-pair --detail --json
- nicctl show version firmware
- nicctl show dcqcn
- nicctl show environment
- nicctl show lif
- nicctl show pcie ats
- nicctl show port
- nicctl show qos
- nicctl show rdma statistics
- nicctl show version host-software
- nicctl show dcqcn --card {card_id} --json
- nicctl show card hardware-config --card {card_id}

## Collector Class NvmeCollector

### Description

Collect NVMe details from the system.

**Bases**: ['InBandDataCollector']

**Link to code**: [nvme_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nvme/nvme_collector.py)

### Class Variables

- **CMD_LINUX_LIST_JSON**: `nvme list -o json`
- **CMD_LINUX**: `{'smart_log': 'nvme smart-log {dev}', 'error_log': 'nvme error-log {dev} --log-entries=256', 'id_ctrl': 'nvme id-ctrl {dev}', 'id_ns': 'nvme id-ns {dev}{ns}', 'fw_log': 'nvme fw-log {dev}', 'self_test_log': 'nvme self-test-log {dev}', 'get_log': 'nvme get-log {dev} --log-id=6 --log-len=512', 'telemetry_log': 'nvme telemetry-log {dev} --output-file={dev}_{f_name}'}`
- **CMD_TEMPLATES**: `[
  nvme smart-log {dev},
  nvme error-log {dev} --log-entries=256,
  nvme id-ctrl {dev},
  nvme id-ns {dev}{ns},
  nvme fw-log {dev},
  nvme self-test-log {dev},
  nvme get-log {dev} --log-id=6 --log-len=512,
  nvme telemetry-log {dev} --output-file={dev}_{f_name}
]`
- **TELEMETRY_FILENAME**: `telemetry_log.bin`

### Provides Data

NvmeDataModel

### Commands

- nvme smart-log {dev}
- nvme error-log {dev} --log-entries=256
- nvme id-ctrl {dev}
- nvme id-ns {dev}{ns}
- nvme fw-log {dev}
- nvme self-test-log {dev}
- nvme get-log {dev} --log-id=6 --log-len=512
- nvme telemetry-log {dev} --output-file={dev}_{f_name}
- nvme list -o json

## Collector Class OsCollector

### Description

Collect OS details

**Bases**: ['InBandDataCollector']

**Link to code**: [os_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/os/os_collector.py)

### Class Variables

- **CMD_VERSION_WINDOWS**: `wmic os get Version /value`
- **CMD_VERSION**: `cat /etc/*release | grep VERSION_ID`
- **CMD_WINDOWS**: `wmic os get Caption /Value`
- **PRETTY_STR**: `PRETTY_NAME`
- **CMD**: `sh -c '( lsb_release -ds || (cat /etc/*release | grep PRETTY_NAME) || uname -om ) 2>/dev/null | head -n1'`

### Provides Data

OsDataModel

### Commands

- sh -c '( lsb_release -ds || (cat /etc/\*release | grep PRETTY_NAME) || uname -om ) 2>/dev/null | head -n1'
- cat /etc/\*release | grep VERSION_ID
- wmic os get Version /value
- wmic os get Caption /Value

## Collector Class PackageCollector

### Description

Collecting Package information from the system

**Bases**: ['InBandDataCollector']

**Link to code**: [package_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/package/package_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic product get name,version`
- **CMD_RELEASE**: `cat /etc/*release`
- **CMD_DPKG**: `dpkg-query -W`
- **CMD_DNF**: `dnf list --installed`
- **CMD_PACMAN**: `pacman -Q`

### Provides Data

PackageDataModel

### Commands

- dnf list --installed
- dpkg-query -W
- pacman -Q
- cat /etc/\*release
- wmic product get name,version

## Collector Class PcieCollector

### Description

class for collection of PCIe data only supports Linux OS type.

    This class collects the PCIE config space using the lspci hex dump and then parses the hex dump to get the
    PCIe configuration space for the GPUs in the system. If the system interaction level is set to STANDARD or higher,
    then the entire pcie configuration space is collected for the GPUs in the system. If the system interaction level
    is set to SURFACE then, only the first 64 bytes of the pcie configuration space is collected for the GPUs in the system.

    This class will collect important PCIe data from the system running the commands
    - `lspci -vvv` : Verbose collection of PCIe data
    - `lspci -vvvt`: Verbose tree view of PCIe data
    - `lspci -PP`: Path view of PCIe data for the GPUs
    - `lspci -PP -D`: Path view of PCIe data for the GPUs (with domain prefix)
    - If system interaction level is set to STANDARD or higher, the following commands will be run with sudo:
        - `lspci -xxxx`: Hex view of PCIe data for the GPUs
    - otherwise the following commands will be run without sudo:
        - `lspci -x`: Hex view of PCIe data for the GPUs
    - `lspci -d <vendor_id>:` : Detect AMD GPU device IDs in the system
    - `lspci -PP -D -d <vendor_id>:<dev_id>` : Upstream BDF path for GPUs (with domain prefix)
    - If system interaction level is set to STANDARD or higher, the following commands will be run with sudo:
        - The sudo lspci -xxxx command is used to collect the PCIe configuration space for the GPUs in the system
    - otherwise the following commands will be run without sudo:
        - The lspci -x command is used to collect the PCIe configuration space for the GPUs in the system

**Bases**: ['InBandDataCollector']

**Link to code**: [pcie_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/pcie/pcie_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_LSPCI_VERBOSE**: `lspci -vvv`
- **CMD_LSPCI_VERBOSE_TREE**: `lspci -vvvt`
- **CMD_LSPCI_PATH**: `lspci -PP`
- **CMD_LSPCI_PATH_DOMAIN**: `lspci -PP -D`
- **CMD_LSPCI_HEX_SUDO**: `lspci -xxxx`
- **CMD_LSPCI_HEX**: `lspci -x`
- **CMD_LSPCI_AMD_DEVICES**: `lspci -d {vendor_id}: -nn`
- **CMD_LSPCI_PATH_DEVICE**: `lspci -PP -d {vendor_id}:{dev_id}`
- **CMD_LSPCI_PATH_DEVICE_DOMAIN**: `lspci -PP -D -d {vendor_id}:{dev_id}`

### Provides Data

PcieDataModel

### Commands

- lspci -d {vendor_id}: -nn
- lspci -x
- lspci -xxxx
- lspci -PP
- lspci -PP -d {vendor_id}:{dev_id}
- lspci -PP -D -d {vendor_id}:{dev_id}
- lspci -PP -D
- lspci -vvv
- lspci -vvvt

## Collector Class ProcessCollector

### Description

Collect Process details

**Bases**: ['InBandDataCollector']

**Link to code**: [process_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/process/process_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_KFD**: `rocm-smi --showpids`
- **CMD_CPU_USAGE**: `top -b -n 1`
- **CMD_PROCESS**: `top -b -n 1 -o %CPU `

### Provides Data

ProcessDataModel

### Commands

- top -b -n 1
- rocm-smi --showpids
- top -b -n 1 -o %CPU

## Collector Class RdmaCollector

### Description

Collect RDMA status and statistics via rdma link and rdma statistic commands.

**Bases**: ['InBandDataCollector']

**Link to code**: [rdma_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rdma/rdma_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_LINK**: `rdma link -j`
- **CMD_STATISTIC**: `rdma statistic -j`
- **CMD_RDMA_DEV**: `rdma dev`
- **CMD_RDMA_LINK**: `rdma link`

### Provides Data

RdmaDataModel

### Commands

- rdma link -j
- rdma dev
- rdma link
- rdma statistic -j

## Collector Class RocmCollector

### Description

Collect ROCm version data

**Bases**: ['InBandDataCollector']

**Link to code**: [rocm_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rocm/rocm_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD_ROCM_SUB_VERSIONS_TMPL**: `grep . -H -r -i {rocm_path}/.info/*`
- **CMD_ROCMINFO_TMPL**: `{rocm_path}/bin/rocminfo`
- **CMD_ROCM_LATEST_TMPL**: `ls -v -d {rocm_path}-[3-7]* | tail -1`
- **CMD_ROCM_DIRS_TMPL**: `ls -v -d {rocm_path}*`
- **CMD_LD_CONF**: `grep -i -E 'rocm' /etc/ld.so.conf.d/*`
- **CMD_ROCM_LIBS**: `ldconfig -p | grep -i -E 'rocm'`
- **CMD_ENV_VARS**: `env | grep -Ei 'rocm|hsa|hip|mpi|openmp|ucx|miopen'`
- **CMD_CLINFO_TMPL**: `{rocm_path}/opencl/bin/*/clinfo`
- **CMD_KFD_PROC**: `ls /sys/class/kfd/kfd/proc/`

### Provides Data

RocmDataModel

### Commands

- {rocm_path}/opencl/bin/\*/clinfo
- env | grep -Ei 'rocm|hsa|hip|mpi|openmp|ucx|miopen'
- ls /sys/class/kfd/kfd/proc/
- grep -i -E 'rocm' /etc/ld.so.conf.d/\*
- {rocm_path}/bin/rocminfo
- ls -v -d {rocm_path}\*
- ls -v -d {rocm_path}-[3-7]\* | tail -1
- ldconfig -p | grep -i -E 'rocm'
- grep . -H -r -i {rocm_path}/.info/\*

## Collector Class StorageCollector

### Description

Collect disk usage details

**Bases**: ['InBandDataCollector']

**Link to code**: [storage_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/storage/storage_collector.py)

### Class Variables

- **CMD_WINDOWS**: `wmic LogicalDisk Where DriveType="3" Get DeviceId,Size,FreeSpace`
- **CMD**: `sh -c 'df -lH -B1 | grep -v 'boot''`

### Provides Data

StorageDataModel

### Commands

- sh -c 'df -lH -B1 | grep -v 'boot''
- wmic LogicalDisk Where DriveType="3" Get DeviceId,Size,FreeSpace

## Collector Class ScaleOutAristaCollector

### Description

Collect Arista switch data.

    Runs Arista EOS ``show`` commands (JSON and text) and parses their
    output into a :class:`ScaleOutAristaDataModel`.

**Bases**: ['InBandDataCollector']

**Link to code**: [scale_out_arista_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_arista/scale_out_arista_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.EOS: 4>, <OSFamily.LINUX: 3>, <OSFamily.UNKNOWN: 2>}`
- **CMD_VERSION**: `show version | json | no-more`
- **CMD_LLDP_NEIGHBORS**: `show lldp neighbors | json | no-more`
- **CMD_SYSTEM_ENV**: `show system environment cooling | json | no-more`
- **CMD_PORT_STATUS**: `show interfaces status | json | no-more`
- **CMD_ERROR_COUNTERS**: `show interfaces counters errors | json | no-more`
- **CMD_PACKET_COUNTERS**: `show interfaces counters | json | no-more`
- **CMD_BINS_COUNTERS**: `show interfaces counters bins | json | no-more`
- **CMD_IP_COUNTERS**: `show interfaces counters ip | json | no-more`
- **CMD_RATES_COUNTERS**: `show interfaces counters rates | json | no-more`
- **CMD_PFC_COUNTERS**: `show priority-flow-control counters | json | no-more`
- **CMD_DROPPED_PACKET_COUNTERS**: `show interfaces counters queue | no-more`
- **CMD_DROP_PRECEDENCE_COUNTERS**: `show interfaces counters queue drop-precedence | no-more`
- **CMD_PER_QUEUE_COUNTERS**: `show interfaces counters queue detail | no-more`
- **CMD_PAUSE_FRAME_COUNTERS**: `show interfaces flow-control | json | no-more`
- **CMD_ECN_COUNTERS**: `show qos interfaces ecn counters queue | json | no-more`
- **CMD_RUNNING_CONFIG**: `show running-config | no-more`
- **CMD_STARTUP_CONFIG**: `show startup-config | no-more`
- **CMD_IP_INTERFACE**: `show ip interface | no-more`
- **CMD_INTERFACES_PHY**: `show interfaces phy | no-more`
- **CMD_INTERFACES_PHY_DETAIL**: `show interfaces phy detail | no-more`
- **CMD_QOS_PROFILE**: `show qos profile | no-more`
- **CMD_QOS_PROFILE_SUMMARY**: `show qos profile summary | no-more`
- **CMD_QOS_MAPS**: `show qos maps | no-more`
- **CMD_QOS_INTERFACES**: `show qos interfaces | no-more`
- **CMD_QOS_INTERFACES_TRUST**: `show qos interfaces trust | no-more`
- **CMD_PFC_STATUS**: `show priority-flow-control status | no-more`
- **CMD_QOS_INTERFACES_ECN**: `show qos interfaces ecn | no-more`
- **CMD_LLDP**: `show lldp | no-more`
- **CMD_TRIDENT_MMU_QUEUE_STATUS**: `show platform trident mmu queue status | no-more`
- **ARTIFACT_COMMANDS**: `[
  show running-config | no-more,
  show startup-config | no-more,
  show ip interface | no-more,
  show interfaces phy | no-more,
  show interfaces phy detail | no-more,
  show qos profile | no-more,
  show qos profile summary | no-more,
  show qos maps | no-more,
  show qos interfaces | no-more,
  show qos interfaces trust | no-more,
  show priority-flow-control status | no-more,
  show qos interfaces ecn | no-more,
  show lldp | no-more,
  show platform trident mmu queue status | no-more
]`

### Provides Data

ScaleOutAristaDataModel

### Commands

- show interfaces counters bins | json | no-more
- show interfaces counters queue | no-more
- show interfaces counters queue drop-precedence | no-more
- show qos interfaces ecn counters queue | json | no-more
- show interfaces counters errors | json | no-more
- show interfaces phy | no-more
- show interfaces phy detail | no-more
- show interfaces counters ip | json | no-more
- show ip interface | no-more
- show lldp | no-more
- show lldp neighbors | json | no-more
- show interfaces counters | json | no-more
- show interfaces flow-control | json | no-more
- show interfaces counters queue detail | no-more
- show priority-flow-control counters | json | no-more
- show priority-flow-control status | no-more
- show interfaces status | json | no-more
- show qos interfaces | no-more
- show qos interfaces ecn | no-more
- show qos interfaces trust | no-more
- show qos maps | no-more
- show qos profile | no-more
- show qos profile summary | no-more
- show interfaces counters rates | json | no-more
- show running-config | no-more
- show startup-config | no-more
- show system environment cooling | json | no-more
- show platform trident mmu queue status | no-more
- show version | json | no-more

## Collector Class ScaleOutDellCollector

### Description

Collect Dell SONiC switch data.

    Runs Dell SONiC CLI ``show`` commands over SSH and parses their text
    output into a :class:`ScaleOutDellDataModel`.

**Bases**: ['InBandDataCollector']

**Link to code**: [scale_out_dell_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_dell/scale_out_dell_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>, <OSFamily.SONIC: 5>, <OSFamily.UNKNOWN: 2>}`
- **CMD_VERSION**: `show version | no-more`
- **CMD_INTERFACE_STATUS**: `show interface status | no-more`
- **CMD_INTERFACE_COUNTERS**: `show interface counters | no-more`
- **CMD_DETAIL_COUNTERS**: `show interface counters {port} | no-more`
- **CMD_FEC_STATUS**: `show interface fec status | no-more`
- **CMD_IP_ARP**: `show ip arp | no-more`
- **CMD_IP_ROUTE**: `show ip route | no-more`
- **CMD_PFC_STATISTICS**: `show qos interface Ethall priority-flow-control statistics | no-more`
- **CMD_PFC_WATCHDOG_STATISTICS**: `show qos interface Ethall queue all priority-flow-control watchdog-statistics | no-more`
- **CMD_QUEUE_COUNTERS**: `show queue counters | no-more`
- **CMD_CLOCK**: `show clock | no-more`
- **CMD_PLATFORM_SYSEEPROM**: `show platform syseeprom | no-more`
- **CMD_PLATFORM_FIRMWARE_DETAIL**: `show platform firmware detail | no-more`
- **CMD_RUNNING_CONFIGURATION**: `show running-configuration | no-more`
- **CMD_INTERFACE_TRANSCEIVER**: `show interface transceiver | no-more`
- **CMD_INTERFACE_TRANSCEIVER_SUMMARY**: `show interface transceiver summary | no-more`
- **CMD_IP_INTERFACES**: `show ip interfaces | no-more`
- **CMD_QOS_MAP_DSCP_TC**: `show qos map dscp-tc | no-more`
- **CMD_QOS_MAP_TC_QUEUE**: `show qos map tc-queue | no-more`
- **CMD_QOS_MAP_TC_PG**: `show qos map tc-pg | no-more`
- **CMD_QOS_MAP_TC_DSCP**: `show qos map tc-dscp | no-more`
- **CMD_QOS_MAP_TC_DOT1P**: `show qos map tc-dot1p | no-more`
- **CMD_QOS_MAP_PFC_PRIORITY_QUEUE**: `show qos map pfc-priority-queue | no-more`
- **CMD_QOS_MAP_PFC_PRIORITY_PG**: `show qos map pfc-priority-pg | no-more`
- **CMD_QOS_MAP_DOT1P_TC**: `show qos map dot1p-tc | no-more`
- **CMD_QOS_SCHEDULER_POLICY**: `show qos scheduler-policy | no-more`
- **CMD_QOS_WRED_POLICY**: `show qos wred-policy | no-more`
- **CMD_QOS_INTERFACE_ETH_ALL**: `show qos interface Eth all | no-more`
- **CMD_QOS_INTERFACE_ETH_ALL_QUEUE_ALL**: `show qos interface Eth all queue all | no-more`
- **CMD_PFC_WATCHDOG**: `show priority-flow-control watchdog | no-more`
- **CMD_BUFFER_PROFILE**: `show buffer profile | no-more`
- **CMD_BUFFER_POOL**: `show buffer pool | no-more`
- **CMD_INTERFACE_TRANSCEIVER_DOM**: `show interface transceiver dom | no-more`
- **CMD_LLDP_TABLE**: `show lldp table | no-more`
- **CMD_LLDP_NEIGHBOR**: `show lldp neighbor | no-more`
- **CMD_INTERFACE_ETH**: `show interface Eth | no-more`
- **CMD_INTERFACE_PHY_COUNTERS**: `show interface phy counters | no-more`
- **CMD_INTERFACE_COUNTERS_RATE**: `show interface counters rate | no-more`
- **CMD_QUEUE_WATERMARK_UNICAST**: `show queue watermark unicast | no-more`
- **CMD_QUEUE_WATERMARK_MULTICAST**: `show queue watermark multicast | no-more`
- **CMD_QUEUE_PERSISTENT_WATERMARK_UNICAST**: `show queue persistent-watermark unicast | no-more`
- **CMD_QUEUE_PERSISTENT_WATERMARK_MULTICAST**: `show queue persistent-watermark multicast | no-more`
- **CMD_PLATFORM_ENVIRONMENT**: `show platform environment | no-more`
- **CMD_EVENT_DETAILS**: `show event details | no-more`
- **CMD_ALARM**: `show alarm | no-more`
- **_INTERFACE_STATUS_LINE_RE**: `re.compile('^(?P<name>Eth\\S+)\\s+(?P<description>.+)\\s+(?P<oper>up|down)\\s+(?P<reason>\\S+)\\s+(?P<auto_neg>\\S+)\\s+(?P<speed>\\d+)\\s+(?P<mtu>\\d+)\\s+(?P<alt>\\S+)\\s*$', re.IGNORECASE)`
- **ARTIFACT_COMMANDS**: `[
  show clock | no-more,
  show platform syseeprom | no-more,
  show platform firmware detail | no-more,
  show running-configuration | no-more,
  show interface transceiver | no-more,
  show interface transceiver summary | no-more,
  show ip interfaces | no-more,
  show qos map dscp-tc | no-more,
  show qos map tc-queue | no-more,
  show qos map tc-pg | no-more,
  show qos map tc-dscp | no-more,
  show qos map tc-dot1p | no-more,
  show qos map pfc-priority-queue | no-more,
  show qos map pfc-priority-pg | no-more,
  show qos map dot1p-tc | no-more,
  show qos scheduler-policy | no-more,
  show qos wred-policy | no-more,
  show qos interface Eth all | no-more,
  show qos interface Eth all queue all | no-more,
  show priority-flow-control watchdog | no-more,
  show buffer profile | no-more,
  show buffer pool | no-more,
  show interface transceiver dom | no-more,
  show lldp table | no-more,
  show lldp neighbor | no-more,
  show interface Eth | no-more,
  show interface phy counters | no-more,
  show interface counters rate | no-more,
  show queue watermark unicast | no-more,
  show queue watermark multicast | no-more,
  show queue persistent-watermark unicast | no-more,
  show queue persistent-watermark multicast | no-more,
  show platform environment | no-more,
  show event details | no-more,
  show alarm | no-more
]`

### Provides Data

ScaleOutDellDataModel

### Commands

- show alarm | no-more
- show buffer pool | no-more
- show buffer profile | no-more
- show clock | no-more
- show interface counters {port} | no-more
- show event details | no-more
- show interface fec status | no-more
- show interface counters | no-more
- show interface counters rate | no-more
- show interface Eth | no-more
- show interface phy counters | no-more
- show interface status | no-more
- show interface transceiver | no-more
- show interface transceiver dom | no-more
- show interface transceiver summary | no-more
- show ip arp | no-more
- show ip interfaces | no-more
- show ip route | no-more
- show lldp neighbor | no-more
- show lldp table | no-more
- show qos interface Ethall priority-flow-control statistics | no-more
- show priority-flow-control watchdog | no-more
- show qos interface Ethall queue all priority-flow-control watchdog-statistics | no-more
- show platform environment | no-more
- show platform firmware detail | no-more
- show platform syseeprom | no-more
- show qos interface Eth all | no-more
- show qos interface Eth all queue all | no-more
- show qos map dot1p-tc | no-more
- show qos map dscp-tc | no-more
- show qos map pfc-priority-pg | no-more
- show qos map pfc-priority-queue | no-more
- show qos map tc-dot1p | no-more
- show qos map tc-dscp | no-more
- show qos map tc-pg | no-more
- show qos map tc-queue | no-more
- show qos scheduler-policy | no-more
- show qos wred-policy | no-more
- show queue counters | no-more
- show queue persistent-watermark multicast | no-more
- show queue persistent-watermark unicast | no-more
- show queue watermark multicast | no-more
- show queue watermark unicast | no-more
- show running-configuration | no-more
- show version | no-more

## Collector Class SysSettingsCollector

### Description

Collect sysfs settings from user-specified paths.

**Bases**: ['InBandDataCollector']

**Link to code**: [sys_settings_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sys_settings/sys_settings_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `cat /sys/{}`
- **CMD_LS**: `ls -1 /sys/{}`
- **CMD_LS_LONG**: `ls -l /sys/{}`

### Provides Data

SysSettingsDataModel

### Commands

- cat /sys/{}
- ls -1 /sys/{}
- ls -l /sys/{}

## Collector Class SysctlCollector

### Description

Collect sysctl kernel VM settings.

**Bases**: ['InBandDataCollector']

**Link to code**: [sysctl_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sysctl/sysctl_collector.py)

### Class Variables

- **CMD**: `sysctl -n`

### Provides Data

SysctlDataModel

### Commands

- sysctl -n

## Collector Class SyslogCollector

### Description

Read syslog log

**Bases**: ['InBandDataCollector']

**Link to code**: [syslog_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/syslog/syslog_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `ls -1 /var/log/syslog* 2>/dev/null | grep -E '^/var/log/syslog(\.[0-9]+(\.gz)?)?$' || true`
- **CMD_MESSAGES**: `ls -1 /var/log/messages* 2>/dev/null | grep -E '^/var/log/messages(\.[0-9]+(\.gz)?)?$' || true`

### Provides Data

SyslogData

### Commands

- ls -1 /var/log/syslog\* 2>/dev/null | grep -E '^/var/log/syslog(\.[0-9]+(\.gz)?)?$' || true
- ls -1 /var/log/messages\* 2>/dev/null | grep -E '^/var/log/messages(\.[0-9]+(\.gz)?)?$' || true

## Collector Class UptimeCollector

### Description

Collect last boot time and uptime from uptime command

**Bases**: ['InBandDataCollector']

**Link to code**: [uptime_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/uptime/uptime_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
- **CMD**: `uptime`

### Provides Data

UptimeDataModel

### Commands

- uptime

## Collector Class BmcArchiveCollector

### Description

Archive BMC directories over SSH using tar czf - <path>.

**Bases**: ['InBandDataCollector']

**Link to code**: [bmc_archive_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/bmc_archive/bmc_archive_collector.py)

### Class Variables

- **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>, <OSFamily.UNKNOWN: 2>}`
- **REMOTE_ARCHIVE_TEMPLATE**: `/tmp/node_scraper_{name}.tar.gz`
- **_tar_ignore_failed_read_supported**: `None`

### Provides Data

BmcArchiveDataModel

### Documented collection

- SSH (BMC) shell: tar+gzip archives for each path in collection_args (see PathSpec entries).
- Uses sudo on the BMC when collection_args paths require elevated access.

## Collector Class RedfishEndpointCollector

### Description

Collects Redfish endpoint responses for URIs specified in config.

**Bases**: ['RedfishDataCollector']

**Link to code**: [endpoint_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_endpoint/endpoint_collector.py)

### Provides Data

RedfishEndpointDataModel

### Documented collection

- Redfish GET: explicit paths from collection_args.uris (parallel when max_workers>1).
- Optional paged GET following the Members collection OData nextLink field when follow_next_link is true.
- Redfish GET tree: when discover_tree is true, walks from api_root using OData resource id links and Members navigation (depth and endpoint caps from collection_args).

## Collector Class RedfishOemDiagCollector

### Description

Collects Redfish OEM diagnostic logs (e.g. JournalControl, AllLogs) via LogService.CollectDiagnosticData.

**Bases**: ['RedfishDataCollector']

**Link to code**: [oem_diag_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_oem_diag/oem_diag_collector.py)

### Provides Data

RedfishOemDiagDataModel

### Documented collection

- Redfish LogService.CollectDiagnosticData for each entry in collection_args.oem_diagnostic_types (collection_args.log_service_path selects the LogService).
- Optional binary archives under the plugin log path when log_path is set.

## Collector Class MI3XXCollector

### Description

Collect MI3XX BMC Redfish data: event log members (with pagination), firmware inventory,
    CPER attachment bytes for qualifying events, and optional assembly/chassis metadata.

**Bases**: ['ServiceabilityCollectorBase']

**Link to code**: [mi3xx_collector.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/serviceability/mi3xx/mi3xx_collector.py)

### Provides Data

ServiceabilityDataModel

### Documented collection

- Redfish GET: BMC event log Entries (collection_args.rf_event_log_uri; optional uri alias).
- Paginated Members collection and optional top, reference_time/time_operator filters.
- Redfish GET: CPER AdditionalDataURI binaries for DiagnosticDataType=CPER events (base64 in data model).
- Optional chassis Assembly GETs (rf_assembly_uri_template + rf_chassis_devices).
- Optional firmware bundle inventory GET (rf_firmware_bundle_uri) for component details.

# Data Models

## GenericCollectionDataModel Model

### Description

Results for each command configured in collection_args.

**Link to code**: [generic_collection_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/generic_collection/generic_collection_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **results**: `list[nodescraper.plugins.generic_collection.generic_collection_data.CommandCollectionResult]`

## AmdSmiDataModel Model

### Description

Data model for amd-smi data.

    Optionals are used to allow for the data to be missing,
    This makes the data class more flexible for the analyzer
    which consumes only the required data. If any more data is
    required for the analyzer then they should not be set to
    default.

**Link to code**: [amdsmidata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/amdsmi/amdsmidata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **version**: `Optional[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiVersion]`
- **gpu_list**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiListItem]]`
- **partition**: `Optional[nodescraper.plugins.inband.amdsmi.amdsmidata.Partition]`
- **process**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Processes]]`
- **topology**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Topo]]`
- **firmware**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Fw]]`
- **bad_pages**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.BadPages]]`
- **static**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiStatic]]`
- **metric**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiMetric]]`
- **xgmi_metric**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.XgmiMetrics]]`
- **xgmi_link**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.XgmiLinks]]`
- **cper_data**: `Optional[list[nodescraper.models.datamodel.FileModel]]`
- **cper_afids**: `dict[str, int]`
- **analysis_firmware_ids**: `Optional[list[str]]`
- **analysis_ref**: `Optional[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiAnalysisRef]`

## BiosDataModel Model

**Link to code**: [biosdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/bios/biosdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **bios_version**: `str`

## CmdlineDataModel Model

**Link to code**: [cmdlinedata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/cmdline/cmdlinedata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **cmdline**: `str`

## DeviceEnumerationDataModel Model

**Link to code**: [deviceenumdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/device_enumeration/deviceenumdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **cpu_count**: `Optional[int]`
- **gpu_count**: `Optional[int]`
- **vf_count**: `Optional[int]`
- **lscpu_output**: `Optional[str]`
- **lshw_output**: `Optional[str]`

## DimmDataModel Model

**Link to code**: [dimmdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dimm/dimmdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **dimms**: `str`

## DkmsDataModel Model

**Link to code**: [dkmsdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dkms/dkmsdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **status**: `Optional[str]`
- **version**: `Optional[str]`

## DmesgData Model

### Description

Data model for in band dmesg log

**Link to code**: [dmesgdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dmesg/dmesgdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **dmesg_content**: `str`
- **skip_log_file**: `bool`

## FabricsDataModel Model

### Description

Complete InfiniBand/RDMA fabrics configuration data

**Link to code**: [fabricsdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/fabrics/fabricsdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **ibstat_devices**: `List[nodescraper.plugins.inband.fabrics.fabricsdata.IbstatDevice]`
- **ibv_devices**: `List[nodescraper.plugins.inband.fabrics.fabricsdata.IbvDeviceInfo]`
- **ibdev_netdev_mappings**: `List[nodescraper.plugins.inband.fabrics.fabricsdata.IbdevNetdevMapping]`
- **ofed_info**: `Optional[nodescraper.plugins.inband.fabrics.fabricsdata.OfedInfo]`
- **mst_status**: `Optional[nodescraper.plugins.inband.fabrics.fabricsdata.MstStatus]`
- **slingshot_data**: `Optional[nodescraper.plugins.inband.fabrics.fabricsdata.SlingshotData]`

## JournalData Model

### Description

Data model for journal logs

**Link to code**: [journaldata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/journal/journaldata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **journal_log**: `str`
- **journal_content_json**: `list[nodescraper.plugins.inband.journal.journaldata.JournalJsonEntry]`

## KernelDataModel Model

**Link to code**: [kerneldata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel/kerneldata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **kernel_info**: `str`
- **kernel_version**: `str`
- **numa_balancing**: `Optional[int]`

## KernelModuleDataModel Model

**Link to code**: [kernel_module_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel_module/kernel_module_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **kernel_modules**: `dict`
- **amdgpu_modinfo**: `Optional[nodescraper.plugins.inband.kernel_module.kernel_module_data.ModuleInfo]`

## MemoryDataModel Model

### Description

Memory data model

**Link to code**: [memorydata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/memory/memorydata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **mem_free**: `str`
- **mem_total**: `str`
- **mem_available**: `Optional[str]`
- **lsmem_data**: `Optional[nodescraper.plugins.inband.memory.memorydata.LsmemData]`
- **numa_topology**: `Optional[nodescraper.plugins.inband.memory.memorydata.NumaTopology]`

## NetworkDataModel Model

### Description

Complete network configuration data

**Link to code**: [networkdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/network/networkdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **interfaces**: `List[nodescraper.plugins.inband.network.networkdata.NetworkInterface]`
- **routes**: `List[nodescraper.plugins.inband.network.networkdata.Route]`
- **rules**: `List[nodescraper.plugins.inband.network.networkdata.RoutingRule]`
- **neighbors**: `List[nodescraper.plugins.inband.network.networkdata.Neighbor]`
- **ethtool_info**: `Dict[str, nodescraper.plugins.inband.network.networkdata.EthtoolInfo]`
- **ethtool_netdevs**: `List[str]`
- **ethtool_statistics**: `List[nodescraper.plugins.inband.network.ethtool_vendor.EthtoolStatistics]`
- **accessible**: `Optional[bool]`

## NicDataModel Model

### Description

Collected output of niccli (Broadcom) and nicctl (Pensando) commands.

**Link to code**: [nic_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nic/nic_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **results**: `Dict[str, nodescraper.plugins.inband.nic.nic_data.NicCommandResult]`
- **card_show**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlCardShow]`
- **cards**: `List[nodescraper.plugins.inband.nic.nic_data.NicCtlCard]`
- **port**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlPort]`
- **lif**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlLif]`
- **qos**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlQos]`
- **rdma**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlRdma]`
- **dcqcn**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlDcqcn]`
- **environment**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlEnvironment]`
- **version**: `Optional[nodescraper.plugins.inband.nic.nic_data.NicCtlVersion]`
- **broadcom_nic_devices**: `List[nodescraper.plugins.inband.nic.nic_data.NicCliDevice]`
- **broadcom_nic_qos**: `Dict[int, nodescraper.plugins.inband.nic.nic_data.NicCliQos]`
- **broadcom_nic_support_rdma**: `Dict[int, str]`
- **broadcom_nic_performance_profile**: `Dict[int, str]`
- **broadcom_nic_pcie_relaxed_ordering**: `Dict[int, str]`
- **pensando_nic_cards**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicCard]`
- **pensando_nic_dcqcn**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicDcqcn]`
- **pensando_nic_environment**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicEnvironment]`
- **pensando_nic_lif**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicLif]`
- **pensando_nic_pcie_ats**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicPcieAts]`
- **pensando_nic_ports**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicPort]`
- **pensando_nic_qos**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicQos]`
- **pensando_nic_rdma_statistics**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicRdmaStatistics]`
- **pensando_nic_version_host_software**: `Optional[nodescraper.plugins.inband.nic.nic_data.PensandoNicVersionHostSoftware]`
- **pensando_nic_version_firmware**: `List[nodescraper.plugins.inband.nic.nic_data.PensandoNicVersionFirmware]`
- **broadcom_cli_type**: `Optional[str]`
- **nicctl_card_logs**: `Optional[Dict[str, str]]`

## NvmeDataModel Model

### Description

NVMe collection output: parsed 'nvme list' entries and per-device command outputs.

**Link to code**: [nvmedata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nvme/nvmedata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **nvme_list**: `Optional[list[nodescraper.plugins.inband.nvme.nvmedata.NvmeListEntry]]`
- **devices**: `dict[str, nodescraper.plugins.inband.nvme.nvmedata.DeviceNvmeData]`

## OsDataModel Model

**Link to code**: [osdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/os/osdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **os_name**: `str`
- **os_version**: `str`

## PackageDataModel Model

### Description

Pacakge data contains the package data for the system

**Link to code**: [packagedata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/package/packagedata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **version_info**: `dict[str, str]`
- **rocm_regex**: `str`
- **enable_rocm_regex**: `bool`

## PcieDataModel Model

### Description

class for collection of PCIe data.

    Optionals are used to allow for the data to be missing,
    This makes the data class more flexible for the analyzer
    which consumes only the required data. If any more data is
    required for the analyzer then they should not be set to
    default.

    - pcie_cfg_space: A dictionary of PCIe cfg space for the GPUs obtained with setpci command
    - lspci_verbose: Verbose collection of PCIe data
    - lspci_verbose_tree: Tree view of PCIe data
    - lspci_path: Path view of PCIe data for the GPUs
    - lspci_path_domain: Path view of PCIe data for the GPUs (with domain prefix)
    - lspci_hex: Hex view of PCIe data for the GPUs

**Link to code**: [pcie_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/pcie/pcie_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **pcie_cfg_space**: `Dict[Annotated[str, AfterValidator(func=validate_bdf)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]`
- **vf_pcie_cfg_space**: `Optional[Dict[Annotated[str, AfterValidator(func=validate_bdf)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]]`

## ProcessDataModel Model

**Link to code**: [processdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/process/processdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **kfd_process**: `Optional[int]`
- **cpu_usage**: `Optional[float]`
- **processes**: `Optional[list[tuple[str, str]]]`

## RdmaDataModel Model

### Description

Data model for RDMA (Remote Direct Memory Access) statistics and link information.

**Link to code**: [rdmadata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rdma/rdmadata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **link_list**: `list[nodescraper.plugins.inband.rdma.rdmadata.RdmaLink]`
- **statistic_list**: `list[nodescraper.plugins.inband.rdma.rdmadata.RdmaStatistics]`
- **dev_list**: `list[nodescraper.plugins.inband.rdma.rdmadata.RdmaDevice]`
- **link_list_text**: `list[nodescraper.plugins.inband.rdma.rdmadata.RdmaLinkText]`

## RegexSearchData Model

### Description

Loaded file or directory contents passed to the analyzer (via --data).

**Link to code**: [regex_search_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/regex_search/regex_search_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **content**: `str`
- **data_root**: `str`
- **files**: `dict[str, str]`

## RocmDataModel Model

**Link to code**: [rocmdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rocm/rocmdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **ROCM_VERSION_FILENAME**: `ClassVar[str]`
- **rocm_version**: `str`
- **rocm_sub_versions**: `dict[str, str]`
- **rocminfo**: `List[str]`
- **rocm_latest_versioned_path**: `str`
- **rocm_all_paths**: `List[str]`
- **ld_conf_rocm**: `List[str]`
- **rocm_libs**: `List[str]`
- **env_vars**: `List[str]`
- **clinfo**: `List[str]`
- **kfd_proc**: `List[str]`

## StorageDataModel Model

**Link to code**: [storagedata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/storage/storagedata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **storage_data**: `dict[str, nodescraper.plugins.inband.storage.storagedata.DeviceStorageData]`

## ScaleOutAristaDataModel Model

### Description

Collected output of Arista commands.

**Link to code**: [scaleoutaristadata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_arista/scaleoutaristadata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **version**: `Optional[nodescraper.plugins.inband.switch.scale_out_arista.scaleoutaristadata.AristaVersion]`
- **lldp_neighbors**: `Optional[nodescraper.plugins.inband.switch.scale_out_arista.scaleoutaristadata.AristaNeighbors]`
- **system_env**: `Optional[nodescraper.plugins.inband.switch.scale_out_arista.scaleoutaristadata.AristaSystemEnv]`
- **port_list**: `Optional[List[str]]`
- **port**: `Optional[Dict[str, nodescraper.plugins.inband.switch.scale_out_arista.scaleoutaristadata.PortData]]`

## ScaleOutDellDataModel Model

### Description

Collected output of Dell SONiC switch commands

**Link to code**: [scaleoutdelldata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_dell/scaleoutdelldata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **ip_arp**: `Optional[List[nodescraper.plugins.inband.switch.scale_out_dell.scaleoutdelldata.DellArpEntry]]`
- **ip_route**: `Optional[List[nodescraper.plugins.inband.switch.scale_out_dell.scaleoutdelldata.DellRouteEntry]]`
- **port_list**: `Optional[List[str]]`
- **port**: `Optional[Dict[str, nodescraper.plugins.inband.switch.scale_out_dell.scaleoutdelldata.DellPortData]]`

## SysSettingsDataModel Model

### Description

Data model for sysfs settings: path -> parsed value.

    Values are parsed from user-specified sysfs paths (bracketed value extracted
    when present, e.g. '[always] madvise never' -> 'always').

**Link to code**: [sys_settings_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sys_settings/sys_settings_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **readings**: `dict[str, str]`

## SysctlDataModel Model

**Link to code**: [sysctldata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sysctl/sysctldata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **vm_swappiness**: `Optional[int]`
- **vm_numa_balancing**: `Optional[int]`
- **vm_oom_kill_allocating_task**: `Optional[int]`
- **vm_compaction_proactiveness**: `Optional[int]`
- **vm_compact_unevictable_allowed**: `Optional[int]`
- **vm_extfrag_threshold**: `Optional[int]`
- **vm_zone_reclaim_mode**: `Optional[int]`
- **vm_dirty_background_ratio**: `Optional[int]`
- **vm_dirty_ratio**: `Optional[int]`
- **vm_dirty_writeback_centisecs**: `Optional[int]`
- **kernel_numa_balancing**: `Optional[int]`

## SyslogData Model

### Description

Data model for in band syslog logs

**Link to code**: [syslogdata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/syslog/syslogdata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **syslog_logs**: `list[nodescraper.connection.inband.inband.TextFileArtifact]`

## UptimeDataModel Model

**Link to code**: [uptimedata.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/uptime/uptimedata.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **current_time**: `str`
- **uptime**: `str`

## BmcArchiveDataModel Model

### Description

Collected BMC directory archives.

**Link to code**: [bmc_archive_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/bmc_archive/bmc_archive_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **results**: `list[nodescraper.plugins.ooband.bmc_archive.bmc_archive_data.ArchiveCollectionResult]`
- **archives**: `list[nodescraper.connection.inband.inband.BinaryFileArtifact]`

## RedfishEndpointDataModel Model

### Description

Collected Redfish endpoint responses: URI -> JSON body.

**Link to code**: [endpoint_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_endpoint/endpoint_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **responses**: `dict[str, dict]`

## RedfishOemDiagDataModel Model

### Description

Collected Redfish OEM diagnostic log results: OEM type -> result (success, error, metadata).

**Link to code**: [oem_diag_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_oem_diag/oem_diag_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **results**: `dict[str, nodescraper.plugins.ooband.redfish_oem_diag.oem_diag_data.OemDiagTypeResult]`

## ServiceabilityDataModel Model

### Description

Collected Redfish responses and intermediate serviceability fields.

**Link to code**: [serviceability_data.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/serviceability/serviceability_data.py)

**Bases**: ['DataModel']

### Model annotations and fields

- **responses**: `dict[str, Any]`
- **rf_events**: `list[Any]`
- **assembly_info**: `Dict[str, DeviceInfo]`
- **cper_raw**: `Dict[str, str]`
- **cper_data**: `Dict[str, Any]`
- **component_details**: `Optional[str]`
- **log_path**: `Optional[str]`
- **bmc_host**: `Optional[str]`
- **afid_events**: `List[AfidEvent]`
- **serviceability**: `Optional[ServiceabilityBlock]`
- **result**: `Optional[ServiceabilityResult]`

# Data Analyzers

## Data Analyzer Class GenericAnalyzer

### Description

Validate generic collection command results against analysis_args checks.

**Bases**: ['DataAnalyzer']

**Link to code**: [generic_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/generic_collection/generic_analyzer.py)

## Data Analyzer Class AmdSmiAnalyzer

### Description

Check AMD SMI Application data for PCIe, ECC errors, and CPER data.

**Bases**: ['CperAnalysisTaskMixin', 'DataAnalyzer']

**Link to code**: [amdsmi_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/amdsmi/amdsmi_analyzer.py)

## Data Analyzer Class BiosAnalyzer

### Description

Check bios matches expected bios details

**Bases**: ['DataAnalyzer']

**Link to code**: [bios_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/bios/bios_analyzer.py)

## Data Analyzer Class CmdlineAnalyzer

### Description

Check cmdline matches expected kernel cmdline

**Bases**: ['DataAnalyzer']

**Link to code**: [cmdline_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/cmdline/cmdline_analyzer.py)

## Data Analyzer Class DeviceEnumerationAnalyzer

### Description

Check Device Enumeration matches expected cpu and gpu count
    supported by all OSs, SKUs, and platforms.

**Bases**: ['DataAnalyzer']

**Link to code**: [device_enumeration_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/device_enumeration/device_enumeration_analyzer.py)

## Data Analyzer Class DkmsAnalyzer

### Description

Check dkms matches expected status and version

**Bases**: ['DataAnalyzer']

**Link to code**: [dkms_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dkms/dkms_analyzer.py)

## Data Analyzer Class DmesgAnalyzer

### Description

Check dmesg for errors

**Bases**: ['RegexAnalyzer']

**Link to code**: [dmesg_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dmesg/dmesg_analyzer.py)

### Class Variables

- **ERROR_REGEX**: `[
  regex=re.compile('(?:oom_kill_process.*)|(?:Out of memory.*)') message='Out of memory error' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('IO_PAGE_FAULT') message='I/O Page Fault' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\bkernel panic\\b.*', re.IGNORECASE) message='Kernel Panic' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('sq_intr') message='SQ Interrupt' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('sram_ecc.*') message='SRAM ECC' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\[amdgpu\\]\\] \\*ERROR\\* hw_init of IP block.*') message='Failed to load driver. IP hardware init error.' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\[amdgpu\\]\\] \\*ERROR\\* sw_init of IP block.*') message='Failed to load driver. IP software init error.' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('sched: RT throttling activated.*') message='Real Time throttling activated' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('rcu_preempt detected stalls.*') message='RCU preempt detected stalls' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('rcu_preempt self-detected stall.*') message='RCU preempt self-detected stall' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('qcm fence wait loop timeout.*') message='QCM fence timeout' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:[\\w-]+(?:\\[[0-9.]+\\])?\\s+)?general protection fault[^\\n]*') message='General protection fault' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:segfault.*in .*\\[)|(?:[Ss]egmentation [Ff]ault.*)|(?:[Ss]egfault.*)') message='Segmentation fault' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('amdgpu: Failed to disallow cf state.*') message='Failed to disallow cf state' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\*ERROR\\* Failed to terminate tmr.*') message='Failed to terminate tmr' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\*ERROR\\* suspend of IP block <\\w+> failed.*') message='Suspend of IP block failed' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(amdgpu \\w{4}:\\w{2}:\\w{2}\\.\\w:\\s+amdgpu:\\s+\\[\\S+\\]\\s*(?:retry|no-retry)? page fault[^\\n]*)(?:\\n[^\\n]*(amdgpu \\w{4}:\\w{2}:\\w{2}\\.\\w:\\s+amdgpu:[^\\n]*))?(?:\\n[^\\n]*(amdgpu \\w{4}:, re.MULTILINE) message='amdgpu Page Fault' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('page fault for address.*') message='Page Fault' event_category=<EventCategory.OS: 'OS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:amdgpu)(.*Fatal error during GPU init)|(Fatal error during GPU init)') message='Fatal error during GPU init' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(pcieport [\\w:.]+: AER: aer_status:[^\\n]*(?:\\n[^\\n]*){0,32}?pcieport [\\w:.]+: AER: aer_layer=[^\\n]*)', re.MULTILINE) message='PCIe AER Error Status' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(.*aer_cor_status: 0x[0-9a-fA-F]+, aer_cor_mask: 0x[0-9a-fA-F]+.*)') message='PCIe AER Correctable Error Status' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(.*aer_uncor_status: 0x[0-9a-fA-F]+, aer_uncor_mask: 0x[0-9a-fA-F]+.*)') message='PCIe AER Uncorrectable Error Status' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(.*aer_uncor_severity: 0x[0-9a-fA-F]+.*)(\\n.*TLP Header: (?:0x)?[0-9a-fA-F]+(?: (?:0x)?[0-9a-fA-F]+){3}.*)', re.MULTILINE) message='PCIe AER Uncorrectable Error Severity with TLP Header' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('Failed to read journal file.*') message='Failed to read journal file' event_category=<EventCategory.OS: 'OS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('journal corrupted or uncleanly shut down.*') message='Journal file corrupted or uncleanly shut down' event_category=<EventCategory.OS: 'OS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('ACPI BIOS Error') message='ACPI BIOS Error' event_category=<EventCategory.BIOS: 'BIOS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('ACPI Error') message='ACPI Error' event_category=<EventCategory.BIOS: 'BIOS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('EXT4-fs error \\(device .*\\):') message='Filesystem corrupted!' event_category=<EventCategory.OS: 'OS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(Buffer I\\/O error on dev)(?:ice)? (\\w+)') message='Error in buffered IO, check filesystem integrity' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('pcieport (\\w+:\\w+:\\w+\\.\\w+):\\s+(\\w+):\\s+(Slot\\(\\d+\\)):\\s+(Card not present)') message='PCIe card no longer present' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('pcieport (\\w+:\\w+:\\w+\\.\\w+):\\s+(\\w+):\\s+(Slot\\(\\d+\\)):\\s+(Link Down)') message='PCIe Link Down' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('pcieport (\\w+:\\w+:\\w+\\.\\w+):\\s+(\\w+):\\s+(current common clock configuration is inconsistent, reconfiguring)') message='Mismatched clock configuration between PCIe device and host' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.* correctable hardware errors detected in total in \\w+ block.*)') message='RAS Correctable Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.* uncorrectable hardware errors detected in \\w+ block.*)') message='RAS Uncorrectable Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.* deferred hardware errors detected in \\w+ block.*)') message='RAS Deferred Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('((?:\\[Hardware Error\\]:\\s+)?event severity: corrected.*)\\n.*(\\[Hardware Error\\]:\\s+Error \\d+, type: corrected.*)\\n.*(\\[Hardware Error\\]:\\s+section_type: PCIe error.*)') message='RAS Corrected PCIe Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.*GPU reset begin.*)') message='GPU Reset' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.*GPU reset(?:\\(\\d+\\))? failed.*)') message='GPU reset failed' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(Accelerator Check Architecture[^\\n]*)(?:\\n[^\\n]*){0,10}?(amdgpu[ 0-9a-fA-F:.]+:? [^\\n]*entry\\[\\d+\\]\\.STATUS=0x[0-9a-fA-F]+)(?:\\n[^\\n]*){0,5}?(amdgpu[ 0-9a-fA-F:.]+:? [^\\n]*entry\\[\\d+\\], re.MULTILINE) message='ACA Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(Accelerator Check Architecture[^\\n]*)(?:\\n[^\\n]*){0,10}?(amdgpu[ 0-9a-fA-F:.]+:? [^\\n]*CONTROL=0x[0-9a-fA-F]+)(?:\\n[^\\n]*){0,5}?(amdgpu[ 0-9a-fA-F:.]+:? [^\\n]*STATUS=0x[0-9a-fA-F]+)(?:\\n[^\\, re.MULTILINE) message='ACA Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('\\[Hardware Error\\]:[^\\n]*MC\\d+_STATUS\\[[^\\]]*\\|CE\\|[^\\]]*\\][^\\n]*', re.IGNORECASE) message='MCE Corrected Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('\\[Hardware Error\\]:[^\\n]*MC\\d+_STATUS\\[[^\\]]*\\|UC\\|[^\\]]*\\][^\\n]*', re.IGNORECASE) message='MCE Uncorrected Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)? (.*Mode2 reset failed.*)') message='Mode 2 Reset Failed' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\d{4}-\\d+-\\d+T\\d+:\\d+:\\d+,\\d+[+-]\\d+:\\d+)?(.*\\[Hardware Error\\]: Corrected error.*)') message='RAS Corrected Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('x86/cpu: SGX disabled by BIOS') message='SGX Error' event_category=<EventCategory.BIOS: 'BIOS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('Failed to load MMP firmware qat_4xxx_mmp.bin') message='MMP Error' event_category=<EventCategory.BIOS: 'BIOS'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('amdgpu \\w{4}:\\w{2}:\\w{2}.\\w: amdgpu: WARN: GPU is throttled.*') message='GPU Throttled' event_category=<EventCategory.SW_DRIVER: 'SW_DRIVER'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('amdgpu[ 0-9a-fA-F:.]+:(?:\\s*amdgpu:)?\\s+(?:{\\d+})?poison is consumed by client \\d+, kick off gpu reset flow') message='RAS Poison Consumed' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('amdgpu[ 0-9a-fA-F:.]+:(?:\\s*amdgpu:)?\\s+(?:{\\d+})?Poison is created') message='RAS Poison created' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(amdgpu: Saved bad pages (\\d+) reaches threshold value 128)') message='Bad page threshold exceeded' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('Hardware error from APEI Generic Hardware Error Source:.*(?:\\n.*){0,14}') message='RAS Hardware Error' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('Error Address.*(?:\\s.*)') message='Error Address' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('EDR: EDR event received') message='RAS EDR Event' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('DPC: .*') message='DPC Event' event_category=<EventCategory.RAS: 'RAS'> event_priority=<EventPriority.ERROR: 3>,
  regex=re.compile('(?:\\[[^\\]]+\\]\\s*)?LNetError:.*ko2iblnd:\\s*No matching interfaces', re.IGNORECASE) message='LNet: ko2iblnd has no matching interfaces' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('(?:\\[[^\\]]+\\]\\s*)?LNetError:\\s*.*Error\\s*-?\\d+\\s+starting up LNI\\s+\\w+', re.IGNORECASE) message='LNet: Error starting up LNI' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.WARNING: 2>,
  regex=re.compile('LustreError:.*ptlrpc_init_portals\\(\\).*network initiali[sz]ation failed', re.IGNORECASE) message='Lustre: network initialisation failed' event_category=<EventCategory.IO: 'IO'> event_priority=<EventPriority.WARNING: 2>
]`

### Regex Patterns

*58 items defined*

- **Built-in Regexes:**
- - Out of memory error: `(?:oom_kill_process.*)|(?:Out of memory.*)`
- - I/O Page Fault: `IO_PAGE_FAULT`
- - Kernel Panic: `\bkernel panic\b.*`
- - SQ Interrupt: `sq_intr`
- - SRAM ECC: `sram_ecc.*`
- - Failed to load driver. IP hardware init error.: `\[amdgpu\]\] \*ERROR\* hw_init of IP block.*`
- - Failed to load driver. IP software init error.: `\[amdgpu\]\] \*ERROR\* sw_init of IP block.*`
- - Real Time throttling activated: `sched: RT throttling activated.*`
- - RCU preempt detected stalls: `rcu_preempt detected stalls.*`
- - RCU preempt self-detected stall: `rcu_preempt self-detected stall.*`
- - QCM fence timeout: `qcm fence wait loop timeout.*`
- - General protection fault: `(?:[\w-]+(?:\[[0-9.]+\])?\s+)?general protectio...`
- - Segmentation fault: `(?:segfault.*in .*\[)|(?:[Ss]egmentation [Ff]au...`
- - Failed to disallow cf state: `amdgpu: Failed to disallow cf state.*`
- - Failed to terminate tmr: `\*ERROR\* Failed to terminate tmr.*`
- - Suspend of IP block failed: `\*ERROR\* suspend of IP block <\w+> failed.*`
- - amdgpu Page Fault: `(amdgpu \w{4}:\w{2}:\w{2}\.\w:\s+amdgpu:\s+\[\S...`
- - Page Fault: `page fault for address.*`
- - Fatal error during GPU init: `(?:amdgpu)(.*Fatal error during GPU init)|(Fata...`
- - PCIe AER Error Status: `(pcieport [\w:.]+: AER: aer_status:[^\n]*(?:\n[...`
- - PCIe AER Correctable Error Status: `(.*aer_cor_status: 0x[0-9a-fA-F]+, aer_cor_mask...`
- - PCIe AER Uncorrectable Error Status: `(.*aer_uncor_status: 0x[0-9a-fA-F]+, aer_uncor_...`
- - PCIe AER Uncorrectable Error Severity with TLP Header: `(.*aer_uncor_severity: 0x[0-9a-fA-F]+.*)(\n.*TL...`
- - Failed to read journal file: `Failed to read journal file.*`
- - Journal file corrupted or uncleanly shut down: `journal corrupted or uncleanly shut down.*`
- - ACPI BIOS Error: `ACPI BIOS Error`
- - ACPI Error: `ACPI Error`
- - Filesystem corrupted!: `EXT4-fs error \(device .*\):`
- - Error in buffered IO, check filesystem integrity: `(Buffer I\/O error on dev)(?:ice)? (\w+)`
- - PCIe card no longer present: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(Slot\(...`
- - PCIe Link Down: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(Slot\(...`
- - Mismatched clock configuration between PCIe device and host: `pcieport (\w+:\w+:\w+\.\w+):\s+(\w+):\s+(curren...`
- - RAS Correctable Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - RAS Uncorrectable Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - RAS Deferred Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - RAS Corrected PCIe Error: `((?:\[Hardware Error\]:\s+)?event severity: cor...`
- - GPU Reset: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - GPU reset failed: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - ACA Error: `(Accelerator Check Architecture[^\n]*)(?:\n[^\n...`
- - ACA Error: `(Accelerator Check Architecture[^\n]*)(?:\n[^\n...`
- - MCE Corrected Error: `\[Hardware Error\]:[^\n]*MC\d+_STATUS\[[^\]]*\|...`
- - MCE Uncorrected Error: `\[Hardware Error\]:[^\n]*MC\d+_STATUS\[[^\]]*\|...`
- - Mode 2 Reset Failed: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)? (...`
- - RAS Corrected Error: `(?:\d{4}-\d+-\d+T\d+:\d+:\d+,\d+[+-]\d+:\d+)?(....`
- - SGX Error: `x86/cpu: SGX disabled by BIOS`
- - MMP Error: `Failed to load MMP firmware qat_4xxx_mmp.bin`
- - GPU Throttled: `amdgpu \w{4}:\w{2}:\w{2}.\w: amdgpu: WARN: GPU ...`
- - RAS Poison Consumed: `amdgpu[ 0-9a-fA-F:.]+:(?:\s*amdgpu:)?\s+(?:{\d+...`
- - RAS Poison created: `amdgpu[ 0-9a-fA-F:.]+:(?:\s*amdgpu:)?\s+(?:{\d+...`
- - Bad page threshold exceeded: `(amdgpu: Saved bad pages (\d+) reaches threshol...`
- - RAS Hardware Error: `Hardware error from APEI Generic Hardware Error...`
- - Error Address: `Error Address.*(?:\s.*)`
- - RAS EDR Event: `EDR: EDR event received`
- - DPC Event: `DPC: .*`
- - LNet: ko2iblnd has no matching interfaces: `(?:\[[^\]]+\]\s*)?LNetError:.*ko2iblnd:\s*No ma...`
- - LNet: Error starting up LNI: `(?:\[[^\]]+\]\s*)?LNetError:\s*.*Error\s*-?\d+\...`
- - Lustre: network initialisation failed: `LustreError:.*ptlrpc_init_portals\(\).*network ...`

## Data Analyzer Class JournalAnalyzer

### Description

Check journalctl for errors

**Bases**: ['DataAnalyzer']

**Link to code**: [journal_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/journal/journal_analyzer.py)

## Data Analyzer Class KernelAnalyzer

### Description

Check kernel matches expected versions

**Bases**: ['DataAnalyzer']

**Link to code**: [kernel_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel/kernel_analyzer.py)

## Data Analyzer Class KernelModuleAnalyzer

### Description

Check kernel matches expected versions

**Bases**: ['DataAnalyzer']

**Link to code**: [kernel_module_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel_module/kernel_module_analyzer.py)

## Data Analyzer Class MemoryAnalyzer

### Description

Check memory usage is within the maximum allowed used memory

**Bases**: ['DataAnalyzer']

**Link to code**: [memory_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/memory/memory_analyzer.py)

## Data Analyzer Class NetworkAnalyzer

### Description

Check network statistics for errors.

**Bases**: ['RegexAnalyzer']

**Link to code**: [network_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/network/network_analyzer.py)

## Data Analyzer Class NicAnalyzer

### Description

Analyze niccli/nicctl data; checks Broadcom support_rdma, performance_profile (RoCE), pcie_relaxed_ordering (enabled), and getqos (expected QoS across adapters).

**Bases**: ['DataAnalyzer']

**Link to code**: [nic_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nic/nic_analyzer.py)

## Data Analyzer Class OsAnalyzer

### Description

Check os matches expected versions

**Bases**: ['DataAnalyzer']

**Link to code**: [os_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/os/os_analyzer.py)

## Data Analyzer Class PackageAnalyzer

### Description

Check the package version data against the expected package version data

**Bases**: ['DataAnalyzer']

**Link to code**: [package_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/package/package_analyzer.py)

## Data Analyzer Class PcieAnalyzer

### Description

Check PCIe Data for errors

    This calls checks the following:
    - PCIe link status for each BDF
        - This checks if the link speed and width are as expected
    - AER uncorrectable errors
        - Checks PCIe AER uncorrectable error registers UNCORR_ERR_STAT_REG and reports any errors
    - AER correctable errors
        - Checks the AERs correctable error registers CORR_ERR_STAT_REG and reports any errors
    - PCIe device status errors
        - Checks PCIe device status errors reported in fields `CORR_ERR_DET` `NON_FATAL_ERR_DET` `FATAL_ERR_DET` `UR_DET`
    - PCIe status errors
        - Checks PCIe status errors reported in fields `MSTR_DATA_PAR_ERR` `SIGNALED_TARGET_ABORT` `RCVD_TARGET_ABORT`
            `RCVD_MSTR_ABORT` `SIGNALED_SYS_ERR` `DET_PARITY_ERR`

**Bases**: ['DataAnalyzer']

**Link to code**: [pcie_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/pcie/pcie_analyzer.py)

### Class Variables

- **GPU_BRIDGE_USP_ID**: `0x1501`
- **GPU_BRIDGE_DSP_ID**: `0x1500`

## Data Analyzer Class ProcessAnalyzer

### Description

Check cpu and kfd processes are within allowed maximum cpu and gpu usage

**Bases**: ['DataAnalyzer']

**Link to code**: [process_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/process/process_analyzer.py)

## Data Analyzer Class RdmaAnalyzer

### Description

Check RDMA statistics for errors (RoCE and other RDMA error counters).

**Bases**: ['DataAnalyzer']

**Link to code**: [rdma_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rdma/rdma_analyzer.py)

## Data Analyzer Class RegexSearchAnalyzer

### Description

Run user-provided regexes against text loaded from --data (file or directory).

**Bases**: ['RegexAnalyzer']

**Link to code**: [regex_search_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/regex_search/regex_search_analyzer.py)

### Class Variables

- **ERROR_REGEX**: `[]`

## Data Analyzer Class RocmAnalyzer

### Description

Check ROCm matches expected versions.

    The expected ROCm version (exp_rocm) can be a string or a list of allowed strings.
    Sub-versions (exp_rocm_sub_versions) are a dict: each value can be a string or
    a list of allowed strings for that key.

**Bases**: ['DataAnalyzer']

**Link to code**: [rocm_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rocm/rocm_analyzer.py)

## Data Analyzer Class StorageAnalyzer

### Description

Check storage usage

**Bases**: ['DataAnalyzer']

**Link to code**: [storage_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/storage/storage_analyzer.py)

## Data Analyzer Class ScaleOutAristaAnalyzer

### Description

Check Arista switch data for errors and warnings.

    Walks every model in the collected :class:`ScaleOutAristaDataModel` and checks
    each ``error_fields`` / ``warning_fields`` ClassVar against an optional
    ``ports`` filter.

**Bases**: ['SwitchAnalyzerBase', 'DataAnalyzer']

**Link to code**: [scale_out_arista_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_arista/scale_out_arista_analyzer.py)

### Class Variables

- **VENDOR_NAME**: `Arista`
- **PORT_NAME_RE**: `re.compile('^(?:Ethernet)?(\\d+(?:/\\d+)*)$', re.IGNORECASE)`
- **PORT_FORMAT_HINT**: `expected slash-separated decimals (e.g. 'M/S', 'A/B/C')`

## Data Analyzer Class ScaleOutDellAnalyzer

### Description

Check Dell SONiC switch data for errors and warnings.

    Walks every model in the collected :class:`ScaleOutDellDataModel` and checks
    each ``error_fields`` / ``warning_fields`` ClassVar against an optional
    ``ports`` filter.

**Bases**: ['SwitchAnalyzerBase', 'DataAnalyzer']

**Link to code**: [scale_out_dell_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_dell/scale_out_dell_analyzer.py)

### Class Variables

- **VENDOR_NAME**: `Dell`
- **PORT_NAME_RE**: `re.compile('^(?:Eth)?(\\d+(?:/\\d+)*)$', re.IGNORECASE)`
- **PORT_FORMAT_HINT**: `expected slash-separated decimals (e.g. 'M/S', 'A/B/C')`

## Data Analyzer Class SysSettingsAnalyzer

### Description

Check sysfs settings against expected values from the checks list.

**Bases**: ['DataAnalyzer']

**Link to code**: [sys_settings_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sys_settings/sys_settings_analyzer.py)

## Data Analyzer Class SysctlAnalyzer

### Description

Check sysctl matches expected sysctl details

**Bases**: ['DataAnalyzer']

**Link to code**: [sysctl_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sysctl/sysctl_analyzer.py)

## Data Analyzer Class RedfishEndpointAnalyzer

### Description

Checks Redfish endpoint responses against configured thresholds and key/value rules.

**Bases**: ['DataAnalyzer']

**Link to code**: [endpoint_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_endpoint/endpoint_analyzer.py)

### Documented analysis

- For each entry in analysis_args.checks, reads JSON paths in collected responses and compares values to constraints (eq, min/max, anyOf, regex, etc.).
- URI key `*` runs checks against every collected response body.

## Data Analyzer Class RedfishOemDiagAnalyzer

### Description

Analyzes Redfish OEM diagnostic log collection results.

**Bases**: ['DataAnalyzer']

**Link to code**: [oem_diag_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_oem_diag/oem_diag_analyzer.py)

### Documented analysis

- Summarizes success/failure per OEM diagnostic type from collected results.
- When analysis_args.require_all_success is true, fails the run if any type failed collection.

## Data Analyzer Class MI3XXAnalyzer

### Description

Build AFID events from collected data and run the configured service hub.

**Bases**: ['DataAnalyzer']

**Link to code**: [mi3xx_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/serviceability/mi3xx/mi3xx_analyzer.py)

### Documented analysis

- Builds AFID events from collected Redfish event log members (and optional assembly metadata).
- Optionally decodes CPER attachments via analysis_args.cper_decode_module before hub analysis.
- Runs the configured Python service hub (hub_python_module) to produce service recommendations.
- When analysis_args.skip_hub is true, only builds AFID events without running the hub.

# Analyzer Args

## Analyzer Args Class GenericAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/generic_collection/analyzer_args.py)

### Annotations / fields

- **checks**: `list[nodescraper.plugins.generic_collection.analyzer_args.CommandCheck]` — Per-command validation rules keyed by collected command name.

## Analyzer Args Class AmdSmiAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/amdsmi/analyzer_args.py)

### Annotations / fields

- **check_static_data**: `bool` — If True, run static data checks (e.g. driver version, partition mode).
- **expected_gpu_processes**: `Optional[int]` — Expected number of GPU processes.
- **expected_max_power**: `Optional[int]` — Expected maximum power value (e.g. watts).
- **expected_power_management**: `Optional[str]` — Expected amd-smi metric power_management value per GPU (e.g. DISABLED for active/full power, ENABLED for power-managed idle).
- **expected_driver_version**: `Optional[str]` — Expected AMD driver version string.
- **expected_memory_partition_mode**: `Optional[str]` — Expected memory partition mode (e.g. sp3, dp).
- **expected_compute_partition_mode**: `Optional[str]` — Expected compute partition mode.
- **expected_firmware_versions**: `Optional[dict[str, str]]` — Expected firmware versions keyed by amd-smi fw_id (e.g. PLDM_BUNDLE).
- **l0_to_recovery_count_error_threshold**: `Optional[int]` — L0-to-recovery count above which an error is raised.
- **l0_to_recovery_count_warning_threshold**: `Optional[int]` — L0-to-recovery count above which a warning is raised.
- **vendorid_ep**: `Optional[str]` — Expected endpoint vendor ID (e.g. for PCIe).
- **vendorid_ep_vf**: `Optional[str]` — Expected endpoint VF vendor ID.
- **devid_ep**: `Optional[str]` — Expected endpoint device ID.
- **devid_ep_vf**: `Optional[str]` — Expected endpoint VF device ID.
- **sku_name**: `Optional[str]` — Expected SKU name string for GPU.
- **expected_xgmi_speed**: `Optional[list[float]]` — Expected xGMI speed value(s) (e.g. link rate).
- **analysis_range_start**: `Optional[datetime.datetime]` — Start of time range for time-windowed analysis.
- **analysis_range_end**: `Optional[datetime.datetime]` — End of time range for time-windowed analysis.

## Analyzer Args Class BiosAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/bios/analyzer_args.py)

### Annotations / fields

- **exp_bios_version**: `list[str]` — Expected BIOS version(s) to match against collected value (str or list).
- **regex_match**: `bool` — If True, match exp_bios_version as regex; otherwise exact match.

## Analyzer Args Class CmdlineAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/cmdline/analyzer_args.py)

### Annotations / fields

- **required_cmdline**: `Union[str, List]` — Command-line parameters that must be present (e.g. 'pci=bfsort').
- **banned_cmdline**: `Union[str, List]` — Command-line parameters that must not be present.
- **os_overrides**: `Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig]` — Per-OS overrides for required_cmdline and banned_cmdline (keyed by OS identifier).
- **platform_overrides**: `Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig]` — Per-platform overrides for required_cmdline and banned_cmdline (keyed by platform).

## Analyzer Args Class DeviceEnumerationAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/device_enumeration/analyzer_args.py)

### Annotations / fields

- **cpu_count**: `Optional[list[int]]` — Expected CPU count(s); pass as int or list of ints. Analysis passes if actual is in list.
- **gpu_count**: `Optional[list[int]]` — Expected GPU count(s); pass as int or list of ints. Analysis passes if actual is in list.
- **vf_count**: `Optional[list[int]]` — Expected virtual function count(s); pass as int or list of ints. Analysis passes if actual is in list.

## Analyzer Args Class DkmsAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dkms/analyzer_args.py)

### Annotations / fields

- **dkms_status**: `Union[str, list]` — Expected dkms status string(s) to match (e.g. 'amd/1.0.0'). At least one of dkms_status or dkms_version required.
- **dkms_version**: `Union[str, list]` — Expected dkms version string(s) to match. At least one of dkms_status or dkms_version required.
- **regex_match**: `bool` — If True, match dkms_status and dkms_version as regex; otherwise exact match.

## Analyzer Args Class DmesgAnalyzerArgs

**Bases**: ['TimeRangeAnalysisArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/dmesg/analyzer_args.py)

### Annotations / fields

- **analysis_range_start**: `Optional[datetime.datetime]` — Start of time range for analysis (ISO format). Only events on or after this time are analyzed.
- **analysis_range_end**: `Optional[datetime.datetime]` — End of time range for analysis (ISO format). Only events before this time are analyzed.
- **check_unknown_dmesg_errors**: `Optional[bool]` — If True, treat unknown/unmatched dmesg error lines as failures.
- **exclude_category**: `Optional[set[str]]` — Set of error categories to exclude from analysis.
- **interval_to_collapse_event**: `int` — Seconds within which repeated events are collapsed into one (for rate limiting).
- **num_timestamps**: `int` — Number of timestamps to include per event in output.
- **error_regex**: `Union[list[nodescraper.base.regexanalyzer.ErrorRegex], list[dict], NoneType]` — Custom error regex patterns; each item can be ErrorRegex or dict with category/pattern.
- **priority_override_rules**: `Optional[list[dict]]` — Rules to override the priority of matched ErrorRegex objects. Each rule is a dict where all keys except 'new_priority' and 'match_all' are filter fields matched against ErrorRegex attributes. 'new_priority' must be an EventPriority name (e.g. 'WARNING', 'ERROR') or 'NO_CHANGE' to leave the priority unchanged.
- **mce_threshold**: `Optional[int]` — When set, raise ERROR if correctable MCE/RAS error count for any component (CPU, GPU BDF/block, etc.) reaches or exceeds this value.
- **ignore_match_rules**: `Optional[list[dict[str, object]]]` — Rules that skip regex matches during analysis. Each rule may use line_regex, match_regex, message, and/or mce_banks. Within a rule all specified fields must match; any matching rule suppresses the hit. mce_banks accepts bank ids and inclusive ranges such as "60-63". When a rule matches an MCA bank, only [Hardware Error]: lines in that incident block are suppressed; interleaved non-MCE dmesg lines in the same block are not.

## Analyzer Args Class JournalAnalyzerArgs

### Description

Arguments for journal analyzer

**Bases**: ['TimeRangeAnalysisArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/journal/analyzer_args.py)

### Annotations / fields

- **analysis_range_start**: `Optional[datetime.datetime]` — Start of time range for analysis (ISO format). Only events on or after this time are analyzed.
- **analysis_range_end**: `Optional[datetime.datetime]` — End of time range for analysis (ISO format). Only events before this time are analyzed.
- **check_priority**: `Optional[int]` — Check against journal log priority (0=emergency..7=debug). If an entry has priority <= check_priority, an ERROR event is raised.
- **group**: `bool` — If True, group entries that have the same priority and message.

## Analyzer Args Class KernelAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel/analyzer_args.py)

### Annotations / fields

- **exp_kernel**: `Union[str, list]` — Expected kernel version string(s) to match (e.g. from uname -a).
- **exp_numa**: `Optional[int]` — Expected value for kernel.numa_balancing (e.g. 0 or 1).
- **regex_match**: `bool` — If True, match exp_kernel as regex; otherwise exact match.

## Analyzer Args Class KernelModuleAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/kernel_module/analyzer_args.py)

### Annotations / fields

- **kernel_modules**: `dict[str, dict]` — Expected kernel module name -> {version, etc.}. Analyzer checks collected modules match.
- **regex_filter**: `list[str]` — List of regex patterns to filter which collected modules are checked (default: amd).

## Analyzer Args Class MemoryAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/memory/analyzer_args.py)

### Annotations / fields

- **ratio**: `float` — Required free-memory ratio (0-1). Analysis fails if free/total < ratio.
- **memory_threshold**: `str` — Minimum free memory required (e.g. '30Gi', '1T'). Used when ratio is not sufficient.

## Analyzer Args Class NicAnalyzerArgs

### Description

Analyzer args for niccli/nicctl data, with expected_values keyed by canonical command key.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/nic/analyzer_args.py)

### Annotations / fields

- **expected_values**: `Optional[Dict[str, Dict[str, Any]]]` — Per-command expected checks keyed by canonical key (see command_to_canonical_key).
- **performance_profile_expected**: `str` — Expected Broadcom performance_profile value (case-insensitive). Default RoCE.
- **support_rdma_disabled_values**: `List[str]` — Values that indicate RDMA is not supported (case-insensitive).
- **pcie_relaxed_ordering_expected**: `str` — Expected Broadcom pcie_relaxed_ordering value (e.g. 'Relaxed ordering = enabled'); checked case-insensitively. Default enabled.
- **expected_qos_prio_map**: `Optional[Dict[Any, Any]]` — Expected priority-to-TC map (e.g. {0: 0, 1: 1}; keys may be int or str in config). Checked per device when set.
- **expected_qos_pfc_enabled**: `Optional[int]` — Expected PFC enabled value (0/1 or bitmask). Checked per device when set.
- **expected_qos_tsa_map**: `Optional[Dict[Any, Any]]` — Expected TSA map for ETS (e.g. {0: 'ets', 1: 'strict'}; keys may be int or str in config). Checked per device when set.
- **expected_qos_tc_bandwidth**: `Optional[List[int]]` — Expected TC bandwidth percentages. Checked per device when set.
- **require_qos_consistent_across_adapters**: `bool` — When True and no expected_qos_\* are set, require all adapters to have the same prio_map, pfc_enabled, and tsa_map.
- **nicctl_log_error_regex**: `Optional[List[Dict[str, Any]]]` — Optional list of error patterns for nicctl show card logs.

## Analyzer Args Class OsAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/os/analyzer_args.py)

### Annotations / fields

- **exp_os**: `Union[str, list]` — Expected OS name/version string(s) to match (e.g. from lsb_release or /etc/os-release).
- **exact_match**: `bool` — If True, require exact match for exp_os; otherwise substring match.

## Analyzer Args Class PackageAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/package/analyzer_args.py)

### Annotations / fields

- **exp_package_ver**: `Dict[str, Optional[str]]` — Map package name -> expected version (None = any version). Checked against installed packages.
- **regex_match**: `bool` — If True, match package versions with regex; otherwise exact or prefix match.
- **rocm_regex**: `Optional[str]` — Optional regex to identify ROCm package version (used when enable_rocm_regex is True).
- **enable_rocm_regex**: `bool` — If True, use rocm_regex (or default pattern) to extract ROCm version for checks.

## Analyzer Args Class PcieAnalyzerArgs

### Description

Arguments for PCIe analyzer

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/pcie/analyzer_args.py)

### Annotations / fields

- **exp_speed**: `int` — Expected PCIe link speed (generation 1–5).
- **exp_width**: `int` — Expected PCIe link width in lanes (1–16).
- **exp_sriov_count**: `int` — Expected SR-IOV virtual function count.
- **exp_gpu_count_override**: `Optional[int]` — Override expected GPU count for validation.
- **exp_max_payload_size**: `Union[Dict[int, int], int, NoneType]` — Expected max payload size: int for all devices, or dict keyed by device ID.
- **exp_max_rd_req_size**: `Union[Dict[int, int], int, NoneType]` — Expected max read request size: int for all devices, or dict keyed by device ID.
- **exp_ten_bit_tag_req_en**: `Union[Dict[int, int], int, NoneType]` — Expected 10-bit tag request enable: int for all devices, or dict keyed by device ID.

## Analyzer Args Class ProcessAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/process/analyzer_args.py)

### Annotations / fields

- **max_kfd_processes**: `int` — Maximum allowed number of KFD (Kernel Fusion Driver) processes; 0 disables the check.
- **max_cpu_usage**: `float` — Maximum allowed CPU usage (percent) for process checks.

## Analyzer Args Class RdmaAnalyzerArgs

### Description

Arguments for the RDMA analyzer.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rdma/analyzer_args.py)

### Annotations / fields

- **exclusion_regex**: `Optional[list[str]]` — Regex patterns matched against an interface netdev; matching interfaces are skipped.

## Analyzer Args Class RegexSearchAnalyzerArgs

### Description

Arguments for RegexSearchAnalyzer (dict items match Dmesg-style error_regex).

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/regex_search/analyzer_args.py)

### Annotations / fields

- **error_regex**: `Optional[list[dict[str, Any]]]` — Regex patterns to search for; each dict may include regex (str), message, event_category, event_priority (same as Dmesg analyzer error_regex).
- **interval_to_collapse_event**: `int` — Seconds within which repeated events are collapsed into one.
- **num_timestamps**: `int` — Number of timestamps to include per event in output.

## Analyzer Args Class RocmAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rocm/analyzer_args.py)

### Annotations / fields

- **exp_rocm**: `Union[str, list]` — Expected ROCm version string(s) to match (e.g. from rocminfo).
- **exp_rocm_latest**: `str` — Expected 'latest' ROCm path or version string for versioned installs.
- **exp_rocm_sub_versions**: `dict[str, Union[str, list]]` — Map sub-version name (e.g. version_rocm) to expected string or list of allowed strings.

## Analyzer Args Class StorageAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/storage/analyzer_args.py)

### Annotations / fields

- **min_required_free_space_abs**: `Optional[str]` — Minimum required free space per mount (e.g. '10G', '1T').
- **min_required_free_space_prct**: `Optional[int]` — Minimum required free space as percentage of total (0–100).
- **ignore_devices**: `Optional[list[str]]` — Mount points or devices to exclude from free-space checks.
- **check_devices**: `Optional[list[str]]` — If non-empty, only these mount points or devices are checked.
- **regex_match**: `bool` — If True, match device/mount names with regex; otherwise exact match.

## Analyzer Args Class ScaleOutAristaAnalyzerArgs

### Description

Arguments for the Arista switch analyzer.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_arista/analyzer_args.py)

### Annotations / fields

- **analysis_ports**: `Optional[List[str]]` — Restrict per-port analysis to the given ports. Ports are S/P/[SP] where subport is optional (e.g. ['1/1', '1/31', '1/1/1']) When omitted, every port present in the data is analyzed.Independent of any collection-time filter.
- **expected_port_bandwidth**: `int` — Expected interface bandwidth (bps) from show interfaces status (AristaPortStatus.bandwidth). Ports with a different bandwidth are flagged.

## Analyzer Args Class ScaleOutDellAnalyzerArgs

### Description

Arguments for the Dell SONiC switch analyzer.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/switch/scale_out_dell/analyzer_args.py)

### Annotations / fields

- **analysis_ports**: `Optional[List[str]]` — Restrict per-port analysis to the given ports. Accepts optional Eth prefix (e.g. ['1/1', '1/31', '1/1/1'] or ['Eth1/1/1']). When omitted, every port present in the data is analyzed. Independent of any collection-time filter.
- **expected_port_speed**: `int` — Expected interface speed (Mbps) from show interface status (DellInterfaceStatus.speed). Ports with a different speed are flagged.

## Analyzer Args Class SysSettingsAnalyzerArgs

### Description

Sysfs settings for analysis via a list of checks (path, expected values, name).

    The path in each check is the sysfs path to read; the collector uses these paths
    when collection_args is derived from analysis_args (e.g. by the plugin).

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sys_settings/analyzer_args.py)

### Annotations / fields

- **checks**: `Optional[list[nodescraper.plugins.inband.sys_settings.analyzer_args.SysfsCheck]]` — List of sysfs checks (path, expected values or pattern, display name).

## Analyzer Args Class SysctlAnalyzerArgs

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/sysctl/analyzer_args.py)

### Annotations / fields

- **exp_vm_swappiness**: `Optional[int]` — Expected vm.swappiness value.
- **exp_vm_numa_balancing**: `Optional[int]` — Expected vm.numa_balancing value.
- **exp_vm_oom_kill_allocating_task**: `Optional[int]` — Expected vm.oom_kill_allocating_task value.
- **exp_vm_compaction_proactiveness**: `Optional[int]` — Expected vm.compaction_proactiveness value.
- **exp_vm_compact_unevictable_allowed**: `Optional[int]` — Expected vm.compact_unevictable_allowed value.
- **exp_vm_extfrag_threshold**: `Optional[int]` — Expected vm.extfrag_threshold value.
- **exp_vm_zone_reclaim_mode**: `Optional[int]` — Expected vm.zone_reclaim_mode value.
- **exp_vm_dirty_background_ratio**: `Optional[int]` — Expected vm.dirty_background_ratio value.
- **exp_vm_dirty_ratio**: `Optional[int]` — Expected vm.dirty_ratio value.
- **exp_vm_dirty_writeback_centisecs**: `Optional[int]` — Expected vm.dirty_writeback_centisecs value.
- **exp_kernel_numa_balancing**: `Optional[int]` — Expected kernel.numa_balancing value.

## Analyzer Args Class RedfishEndpointAnalyzerArgs

### Description

Analyzer args for config-driven Redfish checks.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_endpoint/analyzer_args.py)

### Annotations / fields

- **checks**: `dict[str, dict[str, Union[int, float, str, bool, dict[str, Any]]]]` — Map: URI or `*` -> { property_path: constraint }. URI keys must match a key in the collected responses (exact match). Use `*` as the key to apply the inner constraints to every collected response body. Property paths use '/' for nesting and indices, e.g. 'Status/Health', 'PowerControl/0/PowerConsumedWatts'. Constraints: 'eq' — value must equal the given literal (int, float, str, bool). 'min' — value must be numeric and >= the given number. 'max' — value must be numeric and <= the given number. 'anyOf' — value must be in the given list (OR; any match passes). Example: { "/redfish/v1/Systems/1": { "Status/Health": { "anyOf": ["OK", "Warning"] }, "PowerState": "On" }, "\*": { "Status/Health": { "anyOf": ["OK"] } } }.

## Analyzer Args Class RedfishOemDiagAnalyzerArgs

### Description

Analyzer args for Redfish OEM diagnostic log results.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/ooband/redfish_oem_diag/analyzer_args.py)

### Annotations / fields

- **require_all_success**: `bool` — If True, analysis fails when any OEM type collection failed.

## Analyzer Args Class ServiceabilityAnalyzerArgs

### Description

Analyzer args for serviceability plugins that run a configurable Python hub.

**Bases**: ['AnalyzerArgs']

**Link to code**: [analyzer_args.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/serviceability/analyzer_args.py)

### Annotations / fields

- **hub_python_module**: `Optional[str]` — Import path for the hub module (class implements hub_analyze_method); hub_options forwards kwargs.
- **hub_display_name**: `Optional[str]` — Optional label for analyzer status messages.
- **afid_sag_path**: `Optional[str]` — Path to hub config (e.g. AFID_SAG.json); passed as hub_init_path_kwarg.
- **hub_init_path_kwarg**: `str` — Hub __init__ keyword that receives afid_sag_path.
- **hub_analyze_method**: `str` — Hub method called with rf_events first (default get_service_info).
- **skip_hub**: `bool` — If True, only build afid_events without running the service hub.
- **cper_decode_module**: `Optional[str]` — Module import path for CPER decoding when events include CPER attachments.
- **cper_decode_method**: `str` — Callable on cper_decode_module: file-like CPER in, (return_code, decode_dict) out.
- **hub_options**: `Optional[dict[str, Any]]` — Extra kwargs for hub __init__ and analyze; collected cper_data overrides cper_data key.
- **from_ac_cycle**: `int` — from_ac_cycle kwarg for the hub analyze call (merged after hub_options).
- **from_date**: `Optional[str]` — Optional from_date for the hub analyze call (merged after hub_options).
- **designation_serials**: `Optional[dict[str, str]]` — Optional designation_serials for the hub analyze call (merged after hub_options).
- **suppress_service_actions**: `Optional[list[str]]` — Optional suppress_service_actions for the hub analyze call (merged after hub_options).