Running UFM Server Software

NVIDIA UFM Enterprise User Manual v6.14.0

  • Perform initial configuration.

  • Ensure that all ports used by the UFM server for internal and external communication are open and available. For the list of ports, see Used Ports.
    You can run the UFM server software in the following modes:

  • Management

  • Monitoring

  • High Availability

  • High Availability with failover to an external SM


In Management or High Availability mode, ensure that all Subnet Managers in the fabric are disabled before running UFM. Any remaining active Subnet Managers will prevent UFM from running.

After installing, run the UFM Server by invoking:


systemctl start ufm-enterprise.service


/etc/init.d/ufmd - Available for backward compatibility.

Log files are located under /opt/ufm/files/log (the links to log files are in /opt/ufm/log).

On the Master server, run the UFM Server by invoking:


ufm_ha_cluster start

You can specify additional command options for the ufmha service.

ufm_ha_cluster Command Options




Starts UFM HA cluster.


Stops UFM HA cluster.


Initiates failover (change mastership from local server to remote server).


Initiates takeover (change mastership from remote server to local server).


Shows current HA cluster status.


Cleans the HA configurations on this node.


Displays help text.

Run UFM in Monitoring mode while running concurrent instances of Subnet Manager on NVIDIA switches. Monitoring and event management capabilities are enabled in this mode. UFM non-monitoring features such as provisioning and performance optimization are disabled in this mode.

The following table describes whether features are enabled or disabled in Monitoring mode.

Features Enabled/Disabled in Monitoring Mode


Enabled/Disabled in Monitoring Mode

Fabric Discovery


Topology Map


Fabric Dashboard


Fabric Monitoring


Alerts and Thresholds (inc. SNMP traps)


Fabric Logical Model


Subnet Manager and plugins


Subnet Manager Configuration


Automatic Fabric Partitioning


Central Device Management


Quality of Service


Failover (High Availability mode)


Traffic Aware Routing Algorithm


Device Management


Integration with Schedulers


Unhealthy Ports


In Monitoring mode, UFM periodically discovers the fabric and updates the topology maps and database.

For Monitoring mode, connect UFM to the fabric using port ib0 only. The fabric must have a subnet manager (SM) running on it (on another UFM, HBSM, or switch SM).


When UFM is running in Monitoring mode, the internal OpenSM is not sensitive to changes in OpenSM configuration (opensm.conf).


When running in Monitoring mode, the following parameters are automatically

overwritten in the /opt/ufm/files/conf/opensm/opensm_mon.conf file on startup:

  • event_plugin_name osmufmpi

  • event_plugin_options --vendinfo -m 0

Any other configuration is not valid for Monitoring mode.

  1. In the /opt/ufm/conf/gv.cfg configuration file:

  • Set monitoring_mode to yes

  • If required, change mon_mode_discovery_period (the default is 60 seconds)

  • Set reset_mode to no_reset

    We recommend this setting when running multiple instances of UFM so that each port counter is not reset by different UFM instances. For more information, see Resetting Physical Port Counters.

2. Restart the UFM Server.
The Running mode is set to Monitoring, and the frequency of fabric discovery is updated according to the setting of mon_mode_discovery_period.

Note that a monitor icon will appear at the top of the navigation bar indicating that monitoring mode is enabled:


After installation, you can configure the web server to communicate in the secure protocol HTTP/S. For further information, please refer to the Launching a UFM Web UI Session section.

Port 8088 is an internal port that is used by the UFM server (a port that is not exposed to the user by the Apache Web Server). Apache web server listens on port 80 and forwards the incoming traffic to the local port 8088. Port 8088 is configurable, port 80 is not.

To configure using HTTP/S protocol instead of the default HTTP, add the following to the configuration file at /opt/ufm/conf/gv.cfg::


# WebServices Protocol (http/https) and Port ws_port = 8088 ws_protocol = https

UFM installation configures HTTPS protocol in the webserver as follows:

  • Configures listening on port 443

  • Configures default virtual host

  • Creates/uses local certificates

For instructions, please refer to the UFM Quick Start Guide.

UFM User Authentication is based on standard Apache User Authentication. Each Web Service client application must authenticate against the UFM server to gain access to the system.

The UFM software comes with one predefined user:

  • Username: admin

  • Password: 123456

You can add, delete, or update users via User Management Tab.

Microsoft Azure Authentication is a service provided by Microsoft Azure, the cloud computing platform of Microsoft. It is designed to provide secure access control and authentication for applications and services hosted on Azure.

UFM supports Authentication using Azure Active Directory, and to do so, you need to follow the following steps:

Register UFM in Azure AD Portal

To log in via Azure, UFM must be registered in the Azure portal using the following steps:

  1. Log in to Azure Portal, then click "Azure Active Directory" in the side menu.

  2. If you have access to more than one tenant, select your account in the upper right. Set your session to the Azure AD tenant you wish to use.

  3. Under "Manage" in the side menu, click App Registrations > New Registration.


  4. Provide the application details: Name: Enter a descriptive name. Supported account types: Account types that are allowed to login and use the registered application. Redirect URL: select the app type Web, and Add the following redirect URL https:///auth/login images/networking/download/attachments/137332432/azureauth2.png Then, click Register. The app’s Overview page opens.
  5. Under Manage in the side menu, click Certificates & Secrets > New client secret.


    Provide a description for the client secret and set an expiration time, then click "Add."

  6. Copy the client secret key value which will be needed to configure the UFM with Azure AD (Please note that the value of the generated secret will be hidden and will not be able to be copied/read after you leave the page.
    Under "Manage" in the side menu, click App roles > Create app role.


  7. Provide the role details. Please note that the role value must be a valid UFM role; otherwise, the login will fail.


  8. Assign the created role to the user. Follow the below steps:





  9. Click on "Overview" in the side menu to view the application information, such as tenant ID, client ID, and other details.

Enable Azure Authentication from UFM

Azure authentication is disabled by default. To enable it, please refer to Enabling Azure AD Authentication.

Azure Authentication Login Page

The UFM Azure AD login page contains a button that redirects the user to the Microsoft sign-in page.

UFM license is subscription-based featuring the following subscription options:

  • 1-year subscription

  • 3-year subscription

  • 5-year subscription

  • Evaluation 30-day trial license


UFM will continue to support old license types, but they are no longer available to obtain.

2 months before the expiration of your subscription license, UFM will warn you that your license will expire soon. After the subscription expires, UFM will continue to work with the expired license for two months beyond its expiration.

During this extra two-month period, UFM will generate a critical alarm indicating that the UFM license has expired and that you need to renew your subscription. Failing to do so within that 2-month period activates UFM Limited Mode. Limited mode blocks all REST APIs and access to the UFM web UI.

UFM enables functionality based on the license that was purchased and installed. This license determines the functionality and the maximum allowed number of nodes in the fabric.

To renew your UFM subscription, purchase a new license and install the new license file by downloading the license file to a temp directory on the UFM master server and then copying the license file to /opt/ufm/files/licenses/ directory.


UFM may not detect new license files if downloaded directly to /opt/ufm/files/licenses. If UFM does not detect the new license file, a UFM restart may be required.

If several licenses are installed on the server (more than one license file exists under /opt/ufm/files/licenses/), UFM uses only the strongest license and takes into consideration the expiration date, and the managed device limits on it, regardless of any other licenses that may exist on the server.

For instructions on how to view your license, please refer to the UFM Quick Start Guide.

A script under /opt/ufm/scripts calls, which allows the user to view the current status of UFM's main processes.

Running the command with the –e (extended_processes) option shows the main and sub-processes being handled by the UFM.



© Copyright 2023, NVIDIA. Last updated on Sep 8, 2023.