NVIDIA UFM Cable Validation Tool
NVIDIA UFM Cable Validation Tool
Breadcrumbs

CVT Issues Integration with UFM Alarms

 Overview

When the Cable Validation Tool (CVT) runs as a UFM Plugin, cable-validation issues are pushed to UFM's Events log, so operators can view and act on them directly from the standard UFM Events UI alongside other system events.

Issues reported to UFM Events

  • Wrong neighbor / Unknown neighbor / Wrong port

  • Missing cable / Extra cable

  • Link down / Protocol down / Admin down / Rx disable

  • Negotiation failure / Flapping link / Anomalous port

  • Unprovisioned

  • Module P/N mismatch

Not reported to UFM Events

  • Unreachable switch – device-level, reported only inside CVT.

  • CC issue – detected by the collector, not forwarded.

  • RX/TX power mismatch (power loss) – detected by the collector, not forwarded.

Availability: this feature is supported only when CVT is installed as a UFM Plugin. Standalone CVT deployments do not send events to UFM.

 Prerequisites

#

Requirement

1

UFM Enterprise is installed and running.

2

CVT Plugin is installed on the UFM host and running.

3

You can edit cvt_env.conf and restart the CVT plugin.

3. Configuration file: cvt_env.conf

All settings for this feature live in the CVT configuration file cvt_env.conf, under the [ufm events] section.

Deployment

Path

UFM Plugin (inside container )

/config/cvt_env.conf

ufm machine  

/opt/ufm/files/conf/plugins/cablevalidation/cvt_env.conf


Enabling the feature

Edit cvt_env.conf and set:
[ufm events]
# Master switch to send CVT issues to UFM as external events
ENABLE_UFM_EXTERNAL_EVENTS = true

Then restart the CVT plugin.

If ENABLE_UFM_EXTERNAL_EVENTS is false or missing, CVT works normally but sends no events to UFM.

[ufm events] variables

Variable

Default

Description

ENABLE_UFM_EXTERNAL_EVENTS

false

Master switch. true = send CVT issues to UFM Events.

UFM_SEND_ON_NEW_ISSUE_ONLY

true

true = send events only for newly detected issues. false = send events for all current issues on every report cycle.

UFM_MAX_EVENTS_PER_SEND

100

Maximum events per batch sent to UFM. 0 disables batching (sends all in one request — not recommended for large event counts).

UFM_SEVERITY_<SYNDROME>

WARNING

Override severity per syndrome. Allowed values: INFO, WARNING, CRITICAL. Invalid values are ignored with a warning.

Severity override keys (supported syndromes)

LINK_DOWN, PROTO_DOWN, ADMIN_DOWN, RX_DISABLE, NEG_FAIL, UNPROVISIONED, WRONG_NEIGHBOR, UNKNOWN_NEIGHBOR, WRONG_PORT, MISSING_CABLE, EXTRA_CABLE, FLAPPING_LINK, ANOMALOUS_PORT, MODULE_PN_MISMATCH.



 Viewing CVT events in UFM

  1. Log in to the UFM Web UI.

  2. Open the Events page.

  3. Filter by Source = cable_validation(plugin).

  4. Each CVT event contains:Severity — INFO / WARNING / CRITICAL.Event ID — 551 (INFO), 553 (WARNING), 554 (CRITICAL).Source — always cable_validation(plugin).Source Type — the syndrome (e.g. Wrong-neighbor, Extra-cable, Link-down).Object — the affected port.Description — "<syndrome>: <port>. <corrective action>".

Last updated: