mellanox/ufm-plugin-gnmi-nvos-events repository overview

⁠Deployment

⁠UFM WEB UI

• pull the plugin container with docker pull mellanox/ufm-plugin-gnmi-nvos-events;
• add the plugin through UFM WEB UI -> Settings -> Plugin Management;

⁠CLI

⁠To deploy the plugin on UFM Appliance:

• login as admin;
• run enable;
• run config terminal;
• make sure that UFM is running with show ufm status;
  • if UFM is down then run it with ufm start;
• make sure that GNMI NVOS Events plugin is disabled with show ufm plugin;
• pull the plugin container with docker pull mellanox/ufm-plugin-gnmi-nvos-events;
  • in case of HA load the plugin on the standby node as well;
• on UFM Enterprise Appliance (e.g., gen3), open the default SNMP port with ufw allow 162/udp (enter _shell, if needed);
• run ufm plugin gnmi_events add to enable the plugin;
• check that plugin is up and running with ufm plugin show;

⁠To deploy the plugin with UFM (SA or HA):

• install the latest version of UFM;
• run UFM with systemctl start ufm-infra;
• pull the plugin container with docker pull mellanox/ufm-plugin-gnmi-nvos-events;
  • in case of HA load the plugin on the standby node as well;
• run /opt/ufm/scripts/manage_ufm_plugins.sh add -p gnmi_events to enable the plugin;
• check that plugin is up and running with docker ps;

Log file gnmi_nvos_events.log is located in /opt/ufm/files/log/plugins/gnmi-nvos-events on the host.

⁠Usage

This plugin is listening to GNMI traps from all NVOS managed switches in the fabric and redirecting them as events to UFM.

⁠Testing

Upon a startup of the plugin, all managed switches in the fabric, that have an IP and SSH credentials (global or local), will be sending system events in "on change" mode to the plugin. The plugin then parses the events and sends them to UFM in the form of general external events. An example of a positive testing flow is the following:

• start UFM;
• load the plugin;
• make sure IP of a switch is valid in Managed Elements > Devices tab, or set it manually via Device Access tab;
• set global credentials through Settings > Device Access tab;
• login to the switch;
• reset any valid port (e.g., nv action reset platform transceiver sw1p1);
• check the event(s) was received in Events & Alarms tab.

NOTE:

• only the latest version of gnmi-server is supported, was tested on 4.13.0-3000