Is this page helpful?

Installing the NVIDIA vGPU Software Graphics Driver#

The process for installing the NVIDIA vGPU software graphics driver depends on the OS that you are using. However, for any OS, the process for installing the driver is the same in a VM configured with vGPU, in a VM that is running pass-through GPU, or on a physical host in a bare-metal deployment.

After you install the NVIDIA vGPU software graphics driver, you can license any NVIDIA vGPU software licensed products that you are using.

Installing the NVIDIA vGPU Software Graphics Driver and NVIDIA Control Panel on Windows#

To fully enable GPU operation in a VM or on a bare-metal host, the NVIDIA vGPU software graphics driver must be installed. If the NVIDIA Control Panel app is not installed when the graphics driver is installed, you can install it separately from the graphics driver.

Installing the NVIDIA vGPU Software Graphics Driver on Windows#

Installation in a VM: After you create a Windows VM on the hypervisor and boot the VM, the VM should boot to a standard Windows desktop in VGA mode at 800×600 resolution. You can use the Windows screen resolution control panel to increase the resolution to other standard resolutions, but to fully enable GPU operation, the NVIDIA vGPU software graphics driver must be installed. Windows guest VMs are supported on all NVIDIA vGPU types, namely: Q-series, B-series, and A-series NVIDIA vGPU types.

Installation on bare metal: When the physical host is booted before the NVIDIA vGPU software graphics driver is installed, boot and the primary display are handled by an on-board graphics adapter. To install the NVIDIA vGPU software graphics driver, access the Windows desktop on the host by using a display connected through the on-board graphics adapter.

The procedure for installing the driver is the same in a VM and on bare metal.

  1. Copy the NVIDIA Windows driver package to the guest VM or physical host where you are installing the driver.

  2. Execute the package to unpack and run the driver installer.

    Screen capture showing NVIDIA driver installation

    Figure 16 NVIDIA driver installation#

  3. Click through the license agreement.

  4. Select Express Installation and click NEXT.

    After the driver installation is complete, the installer may prompt you to restart the platform.

  5. If prompted to restart the platform, do one of the following:

    • Select Restart Now to reboot the VM or physical host.

    • Exit the installer and reboot the VM or physical host when you are ready.

    After the VM or physical host restarts, it boots to a Windows desktop.

  6. Verify that the NVIDIA driver is running.

    1. Right-click on the desktop.

    2. From the menu that opens, choose NVIDIA Control Panel.

    3. In the NVIDIA Control Panel, from the Help menu, choose System Information.

      NVIDIA Control Panel reports the vGPU or physical GPU that is being used, its capabilities, and the NVIDIA driver version that is loaded.

    Screen capture showing the verification of NVIDIA driver operation using NVIDIA Control Panel

    Figure 17 Verifying NVIDIA driver operation using NVIDIA Control Panel#

Installation in a VM: After you install the NVIDIA vGPU software graphics driver, you can license any NVIDIA vGPU software licensed products that you are using. For instructions, refer to Virtual GPU Software Client Licensing User Guide.

Note

The graphics driver for Windows in this release of NVIDIA vGPU software is distributed in a DCH-compliant package. A DCH-compliant package differs from a driver package that is not DCH compliant in the following ways:- The Windows registry key for license settings for a DCH-compliant package is different than the key for a driver package that is not DCH compliant. If you are upgrading from a driver package that is not DCH compliant in a VM that was previously licensed, you must reconfigure the license settings for the VM. Existing license settings are not propagated to the new Windows registry key for a DCH-compliant package.

  • NVIDIA System Management Interface, nvidia-smi, is installed in a folder that is in the default executable path.

  • The NVWMI binary files are installed in the Windows Driver Store under %SystemDrive%\Windows\System32\DriverStore\FileRepository\.

  • NVWMI help information in Windows Help format is not installed with graphics driver for Windows guest OSes.

Installation on bare metal: After you install the NVIDIA vGPU software graphics driver, complete the bare-metal deployment as explained in Bare-Metal Deployment.

Installing the Standalone NVIDIA Control Panel App#

The NVIDIA Control Panel app is now distributed through the Microsoft Store. If your system does not allow the installation apps from the Microsoft Store, the NVIDIA Control Panel app is not installed when the NVIDIA vGPU software graphics driver for Windows is installed.

Your system might not allow the installation apps from the Microsoft Store for any of the following reasons:

  • The Microsoft Store app is disabled.

  • Your system is not connected to the Internet

  • Installation of apps from the Microsoft Store is blocked by your system settings.

You can install the NVIDIA Control Panel app separately from the graphics driver by downloading and running the standalone NVIDIA Control Panel installer that is available from NVIDIA Licensing Portal.

  1. Download and extract the standalone NVIDIA Control Panel installer from NVIDIA Licensing Portal.

  2. Copy the extracted standalone NVIDIA Control Panel installer to the guest VM or physical host where you are installing the NVIDIA Control Panel app.

  3. Double-click the installer executable file to start the installer.

  4. When asked if you want to allow the installer app to make changes to your device, click Yes.

  5. Accept the NVIDA software license agreement.

  6. Select the Express installation option and click NEXT.

  7. When the installation is complete, click CLOSE to close the installer.

    The NVIDIA Control Panel app opens.

Installing the NVIDIA vGPU Software Graphics Driver on Linux#

The NVIDIA vGPU software graphics driver for Linux is distributed as a .run file that can be installed on all supported Linux distributions. The driver is also distributed as a Debian package for Ubuntu distributions and as an RPM package for Red Hat distributions.

Installation in a VM: After you create a Linux VM on the hypervisor and boot the VM, install the NVIDIA vGPU software graphics driver in the VM to fully enable GPU operation. Linux guest VMs are supported on all NVIDIA vGPU types, namely: Q-series, B-series, and A-series NVIDIA vGPU types.

Installation on bare metal: When the physical host is booted before the NVIDIA vGPU software graphics driver is installed, the vesa Xorg driver starts the X server. If a primary display device is connected to the host, use the device to access the desktop. Otherwise, use secure shell (SSH) to log in to the host from a remote host.

In addition to the proprietary release of the NVIDIA vGPU software graphics driver for Linux, a release that is based on NVIDIA Linux open GPU kernel modules is also available. The release that is based on NVIDIA Linux open GPU kernel modules is compatible with the following NVIDIA vGPU software deployments:

  • NVIDIA vGPU deployments on GPUs that are based on the NVIDIA Ada Lovelace GPU architecture or later architectures

  • Bare-metal deployments on GPUs that are based on the NVIDIA Turing GPU architecture or later architectures

The release that is based on NVIDIA Linux open GPU kernel modules can be installed only from the .run file, not from a Debian package or RPM package.

The procedure for installing the driver is the same in a VM and on bare metal.

Before installing the NVIDIA vGPU software graphics driver, ensure that the following prerequisites are met:

  • OpenSSL is installed in the VM. If OpenSSL is not installed, the VM will not be able to obtain NVIDIA vGPU software licenses.

  • NVIDIA Direct Rendering Manager Kernel Modesetting (DRM KMS) is disabled. By default, DRM KMS is disabled. However, if it has been enabled, remove nvidia-drm.modeset=1 from the kernel command-line options.

  • If the VM uses UEFI boot, do one of the following:

    • Ensure that secure boot is disabled.

    • Self-sign the driver as explained in the Linux README file that is included in the .run file distribution of the driver.

  • If the Nouveau driver for NVIDIA graphics cards is present, disable it. For instructions, refer to Disabling the Nouveau Driver for NVIDIA Graphics Cards.

  • If you are using a Linux OS for which the Wayland display server protocol is enabled by default, disable it as explained in Disabling the Wayland Display Server Protocol for Red Hat Enterprise Linux.

How to install the NVIDIA vGPU softwaregraphics driver on Linux depends on the distribution format from which you are installing the driver. For detailed instructions, refer to:

Installation in a VM: After you install the NVIDIA vGPU software graphics driver, you can license any NVIDIA vGPU software licensed products that you are using. For instructions, refer to Virtual GPU Software Client Licensing User Guide.

Installation on bare metal: After you install the NVIDIA vGPU software graphics driver, complete the bare-metal deployment as explained in Bare-Metal Deployment.

Installing the NVIDIA vGPU Software Graphics Driver on Linux from a .run File#

You can use the .run file to install the NVIDIA vGPU software graphics driver on any supported Linux distribution.

Installation of the NVIDIA vGPU software graphics driver for Linux from a .run file requires:

  • Compiler toolchain

  • Kernel headers

If a driver has previously been installed on the guest VM or physical host from a Debian package or RPM package, uninstall that driver before installing the driver from a .run file.

If Dynamic Kernel Module Support (DKMS) is enabled, ensure that the dkms package is installed.

  1. Copy the NVIDIA vGPU software Linux driver package, for example NVIDIA-Linux_x86_64-580.178.04-grid.run, to the guest VM or physical host where you are installing the driver.

  2. Before attempting to run the driver installer, exit the X server and terminate all OpenGL applications.

    • On Red Hat Enterprise Linux and CentOS systems, exit the X server by transitioning to runlevel 3:

      [nvidia@localhost ~]$ sudo init 3

    • On Ubuntu platforms, do the following:

      1. Switch to a console login prompt.

        • If you have access to the terminal’s function keys, press CTRL-ALT-F1.

        • If you are accessing the guest VM or physical host through VNC or a web browser and do not have access to the terminal’s function keys, run the chvt command of the OS as root.

          [nvidia@localhost ~]$ sudo chvt 3

      2. Log in and shut down the display manager:

        • For Ubuntu 18 and later releases, stop the gdm service.

          [nvidia@localhost ~]$ sudo service gdm stop

        • For releases earlier than Ubuntu 18, stop the lightdm service.

          [nvidia@localhost ~]$ sudo service lightdm stop

  3. From a console shell, run the driver installer as the root user.

    • To install the proprietary release of the driver, run the driver installer without any additional options.

      sudo sh ./NVIDIA-Linux_x86_64-580.178.04-grid.run

    • To install the release that is based on NVIDIA Linux open GPU kernel modules, run the driver installer with the -m=kernel-open option.

      sudo sh ./NVIDIA-Linux_x86_64-580.178.04-grid.run -m=kernel-open

    If DKMS is enabled, set the -dkms option. This option requires the dkms package to be installed.

    sudo sh ./NVIDIA-Linux_x86_64-580.178.04-grid.run -dkms

    In some instances, the installer may fail to detect the installed kernel headers and sources. In this situation, rerun the installer, specifying the kernel source path with the --kernel-source-path option.

    sudo sh ./NVIDIA-Linux_x86_64-580.178.04-grid.run \
--kernel-source-path=/usr/src/kernels/3.10.0-229.11.1.el7.x86_64

  4. When prompted, accept the option to update the X configuration file (xorg.conf).

    Screen capture of the character-based user interface of the NVIDIA Linux driver installer displaying the prompt to update the X configuration file ( xorg.conf ) settings

    Figure 18 Update xorg.conf settings#

  5. After the installation is complete, select OK to exit the installer.

  6. Verify that the NVIDIA driver is operational.

    1. Reboot the system and log in.

    2. Run nvidia-settings.

      [nvidia@localhost ~]$ nvidia-settings

      The NVIDIA X Server Settings dialog box opens to show that the NVIDIA driver is operational.

Installing the NVIDIA vGPU Software Graphics Driver on Ubuntu from a Debian Package#

The NVIDIA vGPU software graphics driver for Ubuntu is distributed as a Debian package file.

This task requires sudo privileges.

  1. Copy the NVIDIA vGPU software Linux driver package, for example nvidia-linux-grid-580_580.178.04_amd64.deb, to the guest VM where you are installing the driver.

  2. Log in to the guest VM as a user with sudo privileges.

  3. Open a command shell and change to the directory that contains the NVIDIA vGPU software Linux driver package.

  4. From the command shell, run the command to install the package.

    $ sudo apt-get install ./nvidia-linux-grid-580_580.178.04_amd64.deb

  5. Verify that the NVIDIA driver is operational.

    1. Reboot the system and log in.

    2. After the system has rebooted, confirm that you can see your NVIDIA vGPU device in the output from the nvidia-smi command.

      $ nvidia-smi

Installing the NVIDIA vGPU Software Graphics Driver on Red Hat Distributions from an RPM Package#

The NVIDIA vGPU software graphics driver for Red Hat Distributions is distributed as an RPM package file.

This task requires root user privileges.

  1. Copy the NVIDIA vGPU software Linux driver package, for example nvidia-linux-grid-580-580.178.04-1.x86_64.rpm, to the guest VM where you are installing the driver.

  2. Log in to the guest VM as a user with root user privileges.

  3. Open a command shell and change to the directory that contains the NVIDIA vGPU software Linux driver package.

  4. From the command shell, run the command to install the package.

    $ rpm -iv ./nvidia-linux-grid-580-580.178.04-1.x86_64.rpm

  5. Verify that the NVIDIA driver is operational.

    1. Reboot the system and log in.

    2. After the system has rebooted, confirm that you can see your NVIDIA vGPU device in the output from the nvidia-smi command.

      $ nvidia-smi

Disabling the Nouveau Driver for NVIDIA Graphics Cards#

If the Nouveau driver for NVIDIA graphics cards is present, disable it before installing the NVIDIA vGPU software graphics driver.

Note

If you are using SUSE Linux Enterprise Server, you can skip this task because the Nouveau driver is not present in SUSE Linux Enterprise Server.

Run the following command and if the command prints any output, the Nouveau driver is present and must be disabled.

$ lsmod | grep nouveau

  1. Create the file /etc/modprobe.d/blacklist-nouveau.conf with the following contents:

    blacklist nouveau
options nouveau modeset=0

  2. Regenerate the kernel initial RAM file system (initramfs).

    The command to run to regenerate the kernel initramfs depends on the Linux distribution that you are using.

    Linux Distribution

    Command

    CentOS

    		 
    $ sudo dracut --force

    Debian

    		 
    $ sudo update-initramfs -u

    Red Hat Enterprise Linux

    		 
    $ sudo dracut --force

    Ubuntu

    		 
    $ sudo update-initramfs -u

  3. Reboot the host or guest VM.

Disabling the Wayland Display Server Protocol for Red Hat Enterprise Linux#

Starting with Red Hat Enterprise Linux Desktop 8.0, the Wayland display server protocol is used by default on supported GPU and graphics driver configurations. However, the NVIDIA vGPU software graphics driver for Linux requires the X Window System. Before installing the driver, you must disable the Wayland display server protocol to revert to the X Window System.

Perform this task from the host or guest VM that is running Red Hat Enterprise Linux Desktop.

This task requires administrative access.

  1. In a plain text editor, edit the file /etc/gdm/custom.conf and remove the comment from the option WaylandEnable=false.

  2. Save your changes to /etc/gdm/custom.conf.

  3. Reboot the host or guest VM.

Disabling GSP Firmware#

Some GPUs include a GPU System Processor (GSP), which may be used to offload GPU initialization and management tasks. In GPU pass through and bare-metal deployments on Linux, GSP is supported only for NVIDIA vGPU for Compute. If you are using any other product in a GPU pass through or bare-metal deployment on Linux, you must disable the GSP firmware.

Note

For NVIDIA vGPU deployments on Linux and all NVIDIA vGPU software deployments on Windows, omit this task.

GSP firmware is supported with NVIDIA vGPU deployments on GPUs that are based on the NVIDIA Ada Lovelace GPU architecture. For NVIDIA vGPU deployments on Linux and all NVIDIA vGPU software deployments on Windows on GPUs based on earlier GPU architectures, GSP is also not supported but GSP firmware is already disabled.

For each NVIDIA vGPU software product, the following table lists whether GSP is supported in deployments in which GSP firmware can be enabled. The table also summarizes the behavior of NVIDIA vGPU software if a VM or host requests a license when GSP firmware is enabled. The deployments in which GSP firmware can be enabled are GPU pass through and bare-metal deployments on Linux.

Product

GSP

License Request

Error Message

NVIDIA vGPU for Compute

Supported

Allowed

Not applicable

NVIDIA Virtual Applications

Not supported

Blocked

Printed

NVIDIA RTX Virtual Workstation

Not supported

Blocked

Printed

When a license request is blocked, the following error message is written to the licensing event log file at the location given in Virtual GPU Software Client Licensing User Guide:

Invalid feature requested for the underlying GSP firmware configuration.
Disable GSP firmware to use this feature.

Perform this task on the VM to which the GPU is passed through or on the bare-metal host.

Ensure that the NVIDIA vGPU software graphics driver for Linux is installed on the VM or bare-metal host.

  1. Log in to the VM or bare-metal host and open a command shell.

  2. Determine whether GSP firmware is enabled.

    $ nvidia-smi -q

    • If GSP firmware is enabled, the command displays the GSP firmware version, for example:

      GSP Firmware Version                 : 580.178.04

    • Otherwise, the command displays N/A as the GSP firmware version.

  3. If GSP firmware is enabled, disable it by setting the NVIDIA module parameter NVreg_EnableGpuFirmware to 0.

    Set this parameter by adding the following entry to the /etc/modprobe.d/nvidia.conf file:

    options nvidia NVreg_EnableGpuFirmware=0

    If the /etc/modprobe.d/nvidia.conf file does not already exist, create it.

  4. Reboot the VM or bare-metal host.

If you later need to enable GSP firmware, set the NVIDIA module parameter NVreg_EnableGpuFirmware to 1.