35
QSG-07847-001 _v8.0 through 8.4 Revision 03 | July 2020 Virtual GPU Software Quick Start Guide

Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

  • Upload
    others

  • View
    5

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

QSG-07847-001 _v8.0 through 8.4 Revision 03   |   July   2020

Virtual GPU Software

Quick Start Guide

Page 2: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   ii

Table of Contents

About this Guide...................................................................................................................iii

Chapter 1. Getting Your NVIDIA vGPU Software..................................................................11.1. Before You Begin...................................................................................................................... 1

1.2. Your Order Confirmation Message.......................................................................................... 1

1.3. Creating your NVIDIA Enterprise Account...............................................................................3

1.4. Downloading your NVIDIA vGPU Software.............................................................................. 6

Chapter 2. Installing Your NVIDIA vGPU Software License Server and License Files...... 92.1. Overview of NVIDIA vGPU software Licensing.........................................................................9

2.2. Platform Configuration Requirements...................................................................................10

2.3. Installing the Java Runtime Environment............................................................................. 10

2.4. Installing the License Server Software..................................................................................12

2.5. Obtaining the License Server’s MAC Address.......................................................................16

2.6. Managing your License Servers and Getting your License Files..........................................17

2.6.1. Creating a License Server on the NVIDIA Licensing Portal........................................... 17

2.6.2. Downloading a License File.............................................................................................19

2.7.  Installing a License.................................................................................................................19

Chapter 3. Installing and Configuring NVIDIA vGPU Manager and the Guest Driver......223.1. Switching the Mode of a Tesla M60 or M6 GPU....................................................................22

3.2. Installing the NVIDIA Virtual GPU Manager.......................................................................... 23

3.2.1. Installing the NVIDIA Virtual GPU Manager on VMware vSphere.................................. 23

3.2.2. Installing the NVIDIA Virtual GPU Manager on Citrix Hypervisor.................................. 23

3.3. Disabling ECC Memory...........................................................................................................24

3.4. Attaching an NVIDIA vGPU Profile to a VM........................................................................... 25

3.4.1. Configuring a vSphere VM with NVIDIA vGPU................................................................ 25

3.4.2. Configuring a Citrix Hypervisor VM with Virtual GPU.....................................................27

3.5. Installing the NVIDIA vGPU Software Graphics Driver..........................................................27

3.6. Licensing an NVIDIA vGPU..................................................................................................... 29

Page 3: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   iii

About this Guide

Virtual GPU Software Quick Start Guide provides minimal instructions for installing andconfiguring NVIDIA® virtual GPU software on the Citrix Hypervisor or VMware vSpherehypervisor and for installing and configuring a single-instance NVIDIA virtual GPU LicenseServer on Windows. If you need complete instructions, are using other platforms, or requirehigh availability for the license server, refer to Virtual GPU Software User Guide and Virtual GPULicense Server User Guide.

Page 4: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

About this Guide

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   iv

Page 5: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   1

Chapter 1. Getting Your NVIDIA vGPUSoftware

After your order for NVIDIA vGPU software is processed, you will receive an order confirmationmessage from NVIDIA. This message contains information that you need for getting yourNVIDIA vGPU software from the NVIDIA Licensing Portal. To log in to the NVIDIA LicensingPortal, you must have an NVIDIA Enterprise Account.

1.1.  Before You BeginBefore following the procedures in this guide, ensure that the following prerequisites are met:

‣ You have a server platform that is capable of hosting your chosen hypervisor and NVIDIAGPUs that support NVIDIA vGPU software. For a list of validated server platforms, refer toNVIDIA GRID Certified Servers.

‣ One or more NVIDIA GPUs that support NVIDIA vGPU software is installed in your serverplatform.

‣ A supported virtualization software stack is installed according to the instructions in thesoftware vendor's documentation.

‣ A virtual machine (VM) running a supported Windows guest operating system (OS) isconfigured in your chosen hypervisor.

For information about supported hardware and software, and any known issues for thisrelease of NVIDIA vGPU software software, refer to the Release Notes for your chosenhypervisor:

‣ Virtual GPU Software for Citrix Hypervisor Release Notes

‣ Virtual GPU Software for VMware vSphere Release Notes

1.2.  Your Order Confirmation MessageAfter your order for NVIDIA vGPU software is processed, you will receive an order confirmationmessage to which your NVIDIA Entitlement Certificate is attached.

 

Page 6: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   2

 

Your NVIDIA Entitlement Certificate contains your product activation keys.

 

 

Your NVIDIA Entitlement Certificate also provides instructions for using the certificate.

Page 7: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   3

 

 

To get your NVIDIA vGPU software, you must have an NVIDIA Enterprise Account.

Note: For a Support, Upgrade, and Maintenance Subscription (SUMS) renewal, you shouldalready have an NVIDIA Enterprise Account and this requirement should already be met.

‣ If you do not have an account, follow the Register link in the instructions for using thecertificate to create your account. For details, see Creating your NVIDIA EnterpriseAccount.

‣ If you already have an account, follow the Login link in the instructions for using thecertificate to log in to the NVIDIA Enterprise Application Hub, go to the NVIDIA LicensingPortal, and download your NVIDIA vGPU software. For details, see Downloading yourNVIDIA vGPU Software.

1.3.  Creating your NVIDIA EnterpriseAccount

If you do not have an NVIDIA Enterprise Account, you must create an account to be able to login to the NVIDIA Licensing Portal.

Note: If you already have an account, skip this task and go to Downloading your NVIDIA vGPUSoftware.

Before you begin, ensure that you have your order confirmation message.

1. In the instructions for using your NVIDIA Entitlement Certificate, follow the Register link.

Page 8: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   4

2. Fill out the form on the NVIDIA Enterprise Account Registration page and click Register. 

 A message confirming that an account has been created appears and an e-mail instructingyou to set your NVIDIA password is sent to the e-mail address you provided.

3. Open the e-mail instructing you to set your password and click SET PASSWORD. 

 

Note: After you have set your password during the initial registration process, you will beable to log in to your account within 15 minutes. However, it may take up to 24 businesshours for your entitlement to appear in your account.

Page 9: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   5

For your account security, the SET PASSWORD link in this e-mail is set to expire in 24hours.

4. Enter and re-enter your new password, and click SUBMIT. 

 

A message confirming that your password has been set successfully appears. 

 

You are then automatically directed to log in to the NVIDIA Licensing Portal with your newpassword.

Page 10: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   6

1.4.  Downloading your NVIDIA vGPUSoftware

Before you begin, ensure that you have your order confirmation message and have created anNVIDIA Enterprise Account.

1. Visit the NVIDIA Enterprise Application Hub by following the Login link in the instructionsfor using your NVIDIA Entitlement Certificate or when prompted after setting the passwordfor your NVIDIA Enterprise Account.

2. When prompted, provide your e-mail address and password, and click LOGIN. 

  3. On the NVIDIA APPLICATION HUB page that opens, click NVIDIA LICENSING PORTAL.

The NVIDIA Licensing Portal dashboard page opens. 

Page 11: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   7

 

Note: Your entitlement might not appear on the NVIDIA Licensing Portal dashboard pageuntil 24 business hours after you set your password during the initial registration process.

4. In the NVIDIA Licensing Portal dashboard page opens, click the down arrow next to eachentitlement listed to view details of the NVIDIA vGPU software that you purchased. 

  5. In the left navigation pane of the NVIDIA Licensing Portal dashboard, click SOFTWARE

DOWNLOADS. 6. On the Product Download page that opens, follow the Download link for the brand and

version of your chosen hypervisor for the release of NVIDIA vGPU software that you areusing, for example, NVIDIA vGPU for vSphere 6.7 for NVIDIA vGPU software release 9.2. 

 

If you don't see the brand and version of your chosen hypervisor for the release of NVIDIAvGPU software that you are using, click ALL AVAILABLE to see a list of all NVIDIA vGPU

Page 12: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Getting Your NVIDIA vGPU Software

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   8

software available for download. Use the drop-down lists or the search box to filter thesoftware listed.

7. When prompted to accept the license for the software that you are downloading, clickAGREE & DOWNLOAD.

8. When the browser asks what it should do with the file, select the option to save the file.

When the download is complete, the Download Complete pop-up window remains openfor you to download any additional software that you might need for your NVIDIA vGPUsoftware deployment. 

  9. In the Download Complete pop-up window, follow the links to download any additional

software that you need for your NVIDIA vGPU software deployment. a). Follow the link to the NVIDIA vGPU software license server software for your license

server host machine’s operating system, for example, License Manager for Windows. b). If you are using an NVIDIA Tesla™ M60 or M6 GPU and think you might need to change

its mode, follow the Mode Change Utility link.For details about when you need to change the mode, see Switching the Mode of aTesla M60 or M6 GPU.

Page 13: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   9

Chapter 2. Installing Your NVIDIA vGPUSoftware License Serverand License Files

The NVIDIA vGPU software License Server is used to serve a pool of floating licenses to NVIDIAvGPU software licensed products. The license server is designed to be installed at a locationthat is accessible from a customer’s network, and be configured with licenses obtained fromthe NVIDIA Licensing Portal.

Note: These instructions cover only the installation and configuration of a single-instancelicense server. If you require high availability for the license server, refer to Virtual GPU LicenseServer User Guide for instrictions for how to configure a primary and secondary license server.If you do not register a secondary server when the primary server is registered, you cannotregister the secondary server later.

2.1.  Overview of NVIDIA vGPU softwareLicensing

NVIDIA vGPU software is a licensed product. Licensed vGPU functionalities are activatedduring guest OS boot by the acquisition of a software license served over the network from anNVIDIA vGPU software license server. The license is returned to the license server when theguest OS shuts down. 

Page 14: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   10

 

The licenses served by the NVIDIA vGPU software license server are obtained from the NVIDIALicensing Portal as downloadable license files, and installed into the license server through itsmanagement interface.

2.2.  Platform ConfigurationRequirements

‣ The platform must have a fixed (unchanging) IP address. The IP address may be assigneddynamically by DHCP or statically configured, but must be constant.

‣ The platform must have at least one unchanging Ethernet MAC address, to be used asa unique identifier when registering the server and generating licenses in the NVIDIALicensing Portal.

‣ The platform’s date and time must be set accurately. NTP is recommended.

2.3.  Installing the Java RuntimeEnvironment

If a suitable Java runtime environment (JRE) version is not already installed on your system,install a supported JRE before running the NVIDIA license server installer.

Install a JRE for the same the processor architecture as the license server that you will install:If you will install a 32-bit license server, install a 32-bit JRE; if you will install a 64-bit licenseserver, install a 64-bit JRE.

1. Download a supported Oracle Java SE JRE or OpenJDK JRE.

Page 15: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   11

‣ Download Oracle Java SE JRE from the java.com: Java + You page.

‣ Download OpenJDK JRE from the Community builds using source code from OpenJDKproject on GitHub.

2. Install the JRE that you downloaded.

‣ Oracle Java SE JRE installation: 

 

‣ OpenJDK JRE installation: 

  3. Set the JAVA_HOME system variable to the full path to the jre folder of your JRE

installation.For example:

Page 16: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   12

‣ For 64-bit Oracle Java SE JRE: C:\Program Files\Java\jre1.8.0_191

‣ For 32-bit Oracle Java SE JRE: C:\Program Files (x86)\Java\jre1.8.0_191

‣ For 64-bit OpenJDK JRE: C:\Program Files\ojdkbuild\java-1.8.0-openjdk-1.8.0.201-1\jre

‣ For 32-bit OpenJDK JRE: C:\Program Files (x86)\ojdkbuild\java-1.8.0-openjdk-1.8.0.201-1\jre

Ensure that the path does not include any trailing characters, such as a slash or a space.

The license server installer warns users if the path in the JAVA_HOME system environmentvariable appears to be incorrect.

If you are upgrading to a new version of the JRE, update the value of the JAVA_HOMEsystem variable to the full path to the jre folder of your new JRE version.

4. Ensure that the Path system variable contains the path to the java.exe executable file.The installer may have already added this path for you.For example:

‣ For 64-bit Oracle Java SE JRE: C:\Program Files\Java\jre1.8.0_191\bin

‣ For 32-bit Oracle Java SE JRE: C:\Program Files (x86)\Java\jre1.8.0_191\bin

‣ For 64-bit OpenJDK JRE: C:\Program Files\ojdkbuild\java-1.8.0-openjdk-1.8.0.201-1\bin

‣ For 32-bit OpenJDK JRE: C:\Program Files (x86)\ojdkbuild\java-1.8.0-openjdk-1.8.0.201-1\bin

2.4.  Installing the License ServerSoftware

1. Unzip the license server installer and run setup.exe. 2. Accept the EULA for the license server software and the Apache Tomcat software used to

support the license server’s management interface. 

Page 17: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   13

  3. Choose the destination folder where you want the license server software to be installed.

 

Page 18: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   14

  4. In the Choose Firewall Options dialog box, select the ports to be opened in the firewall.

To enable remote clients to access licenses from the server and prevent remote access tothe management interface, use the default setting, which sets ports as follows:

‣ Port 7070 is open to enable remote clients to access licenses from the server.

‣ Port 8080 is closed to ensure that the management interface is available only througha web browser running locally on the license server host.

 

Page 19: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   15

  5. After installation has completed successfully, click Done to exit the installer.

 

Page 20: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   16

 

2.5.  Obtaining the License Server’s MACAddress

The license server’s Ethernet MAC address uniquely identifies your server to the NVIDIALicensing Portal. You will need this address to register your license server with the NVIDIALicensing Portal to generate license files.

1. Open a web browser on the license server host and connect to the URL http://localhost:8080/licserver.

2. In the license server management interface, select Configuration. 3. On the License Server Configuration page that opens, in the Server host ID drop-down

list, select the platform’s ETHERNET address. 

Page 21: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   17

 

2.6.  Managing your License Servers andGetting your License Files

To be able to download NVIDIA vGPU software licenses, you must create at least one licenseserver on the NVIDIA Licensing Portal and allocate licenses to the server. After creating alicense server and allocating licenses to it, you can download your license file.

2.6.1.  Creating a License Server on the NVIDIALicensing Portal

To be able to download NVIDIA vGPU software licenses, you must create at least one licenseserver on the NVIDIA Licensing Portal. Creating a license server on the NVIDIA LicensingPortal registers your license server host with the NVIDIA Licensing Portal through the MACaddress of the host.

1. In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which youwant to create the license server. a). If you are not already logged in, log in to the NVIDIA Enterprise Application Hub and

click NVIDIA LICENSING PORTAL to go to the NVIDIA Licensing Portal. b). Optional: If your assigned roles give you access to multiple virtual groups, select

the virtual group for which you are creating the license server from the list of virtualgroups at the top right of the page.

If no license servers have been created for your organization or virtual group, the NVIDIALicensing Portal dashboard displays a message asking if you want to create a licenseserver. 

Page 22: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   18

  2. On the NVIDIA Licensing Portal dashboard, click CREATE LICENSE SERVER.

The Create License Server pop-up window opens. 

  3. Provide the details of your license server.

a). In the Server Name field, enter the host name of the license server. b). In the Description field, enter a text description of the license server.

This description is required and will be displayed on the details page for the licenseserver that you are creating.

c). In the MAC Address field, enter the MAC address of your license server. 4. Add the licenses for the products that you want to allocate to this license server.

For each product, add the licenses as follows: a). From the Product drop-down list, select the product for which you want to add

licenses. b). In the Licenses field, enter the number of licenses for the product that you want to add. c). Click ADD.

5. Leave the Failover License Server and Failover MAC Address fields unset. 6. Click CREATE LICENSE SERVER.

Page 23: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   19

2.6.2.  Downloading a License FileEach license server that you create has license file associated with it. The license file containsall the licenses that you allocated to the license server. After downloading the license file,you can install it on the license server host associated with the license server on the NVIDIALicensing Portal.

1. In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which youwant to download the license file. a). If you are not already logged in, log in to the NVIDIA Enterprise Application Hub and

click NVIDIA LICENSING PORTAL to go to the NVIDIA Licensing Portal. b). Optional: If your assigned roles give you access to multiple virtual groups, select the

virtual group for which you are downloading the license file from the list of virtualgroups at the top right of the page.

2. In the list of license servers on the NVIDIA Licensing Portal dashboard, select the licenseserver whose associated license file you want to download.

3. In the License Server Details page that opens, review the licenses allocated to the licenseserver. 

  4. Click DOWNLOAD LICENSE FILE and save the .bin license file to your license server for

installation.

2.7.  Installing a LicenseNVIDIA vGPU software licenses are distributed as .bin files for download from the NVIDIALicensing Portal.

Page 24: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   20

Before installing a license, ensure that you have downloaded the license file from the NVIDIALicensing Portal.

1. In the license server management interface, select License Management. 2. On the License Management page that opens, click Choose File.

 

  3. In the file browser that opens, select the .bin file and click Open. 4. Back on the License Management page, click Upload to install the license file on the

license server.The license server should confirm successful installation of the license file. 

Page 25: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing Your NVIDIA vGPU Software License Server and License Files

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   21

 

Page 26: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   22

Chapter 3. Installing and ConfiguringNVIDIA vGPU Manager andthe Guest Driver

Before installing and configuring NVIDIA vGPU Manager and the Guest Driver, ensure that aVM running a supported Windows guest OS is configured in your chosen hypervisor.

The factory settings of some supported GPU boards are incompatible with NVIDIA vGPUsoftware. Before configuring NVIDIA vGPU software on these GPU boards, you must configurethe boards to change these settings.

3.1.  Switching the Mode of a Tesla M60 orM6 GPU

Tesla M60 and M6 GPUs support compute mode and graphics mode. NVIDIA vGPU requiresGPUs that support both modes to operate in graphics mode.

Note: Only Tesla M60 and M6 GPUs require and support mode switching. Other GPUs thatsupport NVIDIA vGPU do not require or support mode switching.

Recent Tesla M60 GPUs and M6 GPUs are supplied in graphics mode. However, your GPUmight be in compute mode if it is an older Tesla M60 GPU or M6 GPU, or if its mode haspreviously been changed.

If your GPU supports both modes but is in compute mode, you must use the gpumodeswitchtool to change the mode of the GPU to graphics mode. If you are unsure which mode your GPUis in, use the gpumodeswitch tool to find out the mode.

For more information, see gpumodeswitch User Guide.

Page 27: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   23

3.2.  Installing the NVIDIA Virtual GPUManager

Before guests enabled for NVIDIA vGPU can be configured, the NVIDIA Virtual GPU Managermust be installed in your chosen hypervisor. The process for installing the NVIDIA Virtual GPUManager depends on the hypervisor that you are using.

If you need more detailed instructions, refer to the appropriate NVIDIA vGPU installation guide.

3.2.1.  Installing the NVIDIA Virtual GPU Manager onVMware vSphere

The NVIDIA Virtual GPU Manager for VMware vSphere ESXi is distributed as a vSphereInstallation Bundle (VIB) file.

1. Copy the NVIDIA Virtual GPU Manager VIB file to the ESXi host. 2. Put the ESXi host into maintenance mode.

$ esxcli system maintenanceMode set –-enable true

3. Run the esxcli command to install the NVIDIA Virtual GPU Manager from the VIB file.$ esxcli software vib install –v directory/NVIDIA**.vib

directory is the path to the directory that contains the VIB file. 4. Exit maintenance mode.

$ esxcli system maintenanceMode set –-enable false

5. Reboot the ESXi host.$ reboot

6. Verify that the NVIDIA kernel driver can successfully communicate with the physical GPUsin your system by running the nvidia-smi command without any options.$ nvidia-smi

If successful, the nvidia-smi command lists all the GPUs in your system.

3.2.2.  Installing the NVIDIA Virtual GPU Manager onCitrix Hypervisor

The NVIDIA Virtual GPU Manager for Citrix Hypervisor is distributed as an RPM PackageManager (RPM) file. It runs in the Citrix Hypervisor Control Domain (dom0) shell.

1. Copy the NVIDIA Virtual GPU Manager RPM file to the Citrix Hypervisor dom0 shell. 2. Run the rpm command to install the package.

[root@xenserver ~]# rpm -iv NVIDIA-**.rpm

3. Reboot the Citrix Hypervisor platform.[root@xenserver ~]# shutdown -r now

Page 28: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   24

4. After the Citrix Hypervisor host has rebooted, verify the installation of the NVIDIA VirtualGPU Manager package for Citrix Hypervisor by checking for the NVIDIA kernel driver in thelist of kernel-loaded modules.[root@xenserver ~]# lsmod |grep nvidianvidia 8152994 0i2c_core 20294 2 nvidia,i2c_

3.3.  Disabling ECC MemoryTesla M60, Tesla M6, and GPUs based on the Pascal GPU architecture, for example Tesla P100or Tesla P4, support error correcting code (ECC) memory for improved data integrity. TeslaM60 and M6 GPUs in graphics mode are supplied with ECC memory disabled by default, but itmay subsequently be enabled using nvidia-smi. GPUs based on the Pascal GPU architectureare supplied with ECC memory enabled.

However, NVIDIA vGPU does not support ECC memory. If ECC memory is enabled, NVIDIAvGPU fails to start. Therefore, you must ensure that ECC memory is disabled on all GPUs ifyou are using NVIDIA vGPU.

Before you begin, ensure that NVIDIA Virtual GPU Manager is installed on your hypervisor.

1. Use nvidia-smi to list the status of all GPUs, and check for ECC noted as enabled onGPUs.# nvidia-smi -q

==============NVSMI LOG==============

Timestamp : Tue Dec 19 18:36:45 2017Driver Version : 384.99

Attached GPUs : 1GPU 0000:02:00.0

[...]

Ecc Mode Current : Enabled Pending : Enabled

[...]

2. Change the ECC status to off on each GPU for which ECC is enabled.

‣ If you want to change the ECC status to off for all GPUs on your host machine, run thiscommand:# nvidia-smi -e 0

‣ If you want to change the ECC status to off for a specific GPU, run this command:# nvidia-smi -i id -e 0

id is the index of the GPU as reported by nvidia-smi.

This example disables ECC for the GPU with index 0000:02:00.0.# nvidia-smi -i 0000:02:00.0 -e 0

3. Reboot the host. 4. Confirm that ECC is now disabled for the GPU.

Page 29: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   25

# nvidia—smi —q

==============NVSMI LOG==============

Timestamp : Tue Dec 19 18:37:53 2017Driver Version : 384.99

Attached GPUs : 1GPU 0000:02:00.0[...]

Ecc Mode Current : Disabled Pending : Disabled

[...]

3.4.  Attaching an NVIDIA vGPU Profile to aVM

To attach an NVIDIA vGPU profile to a virtual machine (VM), you must configure the VMhardware. The process for attaching an NVIDIA vGPU profile to a VM depends on thehypervisor that you are using.

3.4.1.  Configuring a vSphere VM with NVIDIA vGPU

CAUTION: Output from the VM console in the VMware vSphere Web Client is not available forVMs that are running vGPU. Make sure that you have installed an alternate means of accessingthe VM (such as VMware Horizon or a VNC server) before you configure vGPU.

VM console in vSphere Web Client will become active again once the vGPU parameters areremoved from the VM’s configuration.

1. Open the vCenter Web UI. 2. In the vCenter Web UI, right-click the VM and choose Edit Settings. 3. Click the Virtual Hardware tab. 4. In the New device list, select Shared PCI Device and click Add.

The PCI device field should be auto-populated with NVIDIA GRID vGPU. 

Page 30: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   26

  5. From the GPU Profile drop-down menu, choose the type of vGPU you want to configure

and click OK. 6. Ensure that VMs running vGPU have all their memory reserved:

a). Select Edit virtual machine settings from the vCenter Web UI. b). Expand the Memory section and click Reserve all guest memory (All locked).

After you have configured a vSphere VM with a vGPU, start the VM. VM console in vSphere WebClient is not supported in this vGPU release. Therefore, use VMware Horizon or VNC to accessthe VM’s desktop.

Page 31: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   27

3.4.2.  Configuring a Citrix Hypervisor VM withVirtual GPU

1. Ensure the VM is powered off. 2. Right-click the VM in XenCenter, select Properties to open the VM’s properties, and select

the GPU property.The available GPU types are listed in the GPU type drop-down list: 

 

After you have configured a Citrix Hypervisor VM with a vGPU, start the VM, either fromXenCenter or by using xe vm-start in a dom0 shell. You can view the VM’s console inXenCenter.

3.5.  Installing the NVIDIA vGPU SoftwareGraphics Driver

After you create a Windows VM on the hypervisor and boot the VM, the VM should boot to astandard Windows desktop in VGA mode at 800×600 resolution. You can use the Windowsscreen resolution control panel to increase the resolution to other standard resolutions, but tofully enable GPU operation, the NVIDIA vGPU software graphics driver must be installed.

1. Copy the NVIDIA Windows driver package to the guest VM where you are installing thedriver.

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

Page 32: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   28

 

  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 theplatform.

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

‣ Select Restart Now to reboot the VM.

‣ Exit the installer and reboot the VM when you are ready.

After the VM restarts, it boots to a Windows desktop. 6. Verify that the NVIDIA driver is running.

a). Right-click on the desktop. b). From the menu that opens, choose NVIDIA Control Panel. c). In the NVIDIA Control Panel, from the Help menu, choose System Information.

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

Page 33: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   29

 

3.6.  Licensing an NVIDIA vGPUPerform this task from the guest VM to which the vGPU is assigned.

The NVIDIA Control Panel tool that you use to perform this task detects that a vGPU isassigned to the VM and, therefore, provides no options for selecting the license type. Afteryou license the vGPU, NVIDIA vGPU software automatically selects the correct type of licensebased on the vGPU type.

Note: These instructions cover only licensing for a single-instance license server. If youconfigured a primary and secondary license server, refer to Virtual GPU Client Licensing UserGuide for instructions for how to specify the address and port number of the primary andsecondary license servers.

1. Open NVIDIA Control Panel:

‣ Right-click on the Windows desktop and select NVIDIA Control Panel from the menu.

‣ Open Windows Control Panel and double-click the NVIDIA Control Panel icon.

2. In NVIDIA Control Panel, select the Manage License task in the Licensing section of thenavigation pane.

Note: If the Licensing section and Manage License task are not displayed in NVIDIA ControlPanel, the system has been configured to hide licensing controls in NVIDIA Control Panel.For information about registry settings, see Virtual GPU Client Licensing User Guide.

The Manage License task pane shows that NVIDIA vGPU is currently unlicensed. 

Page 34: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Installing and Configuring NVIDIA vGPU Manager and the Guest Driver

Virtual GPU Software QSG-07847-001 _v8.0 through 8.4 Revision 03   |   30

  3. In the Primary License Server field, enter the address of yourNVIDIA vGPU software

License Server.The address can be a fully-qualified domain name such as gridlicense1.example.com,or an IP address such as 10.31.20.45.

4. Leave the Port Number field under the Primary License Server field unset.The port defaults to 7070, which is the default port number used by NVIDIA vGPU softwareLicense Server.

5. Leave the Secondary License Server field and the Port Number field under it unset. 6. Click Apply to assign the settings.

The system requests the appropriate license for the current vGPU from the configuredlicense server.

The vGPU within the VM should now exhibit full frame rate, resolution, and display outputcapabilities. The VM is now capable of running the full range of DirectX and OpenGL graphicsapplications.

You have now completed the process of installing NVIDIA vGPU software and setting up asingle VM to use NVIDIA vGPU.

If the system fails to obtain a license, see Virtual GPU Client Licensing User Guide for guidanceon troubleshooting.

Page 35: Virtual GPU Software - Nvidia...Server on Windows. If you need complete instructions, are using other platforms, or require high availability for the license server, refer to Virtual

Notice

This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIACorporation (“NVIDIA”) makes no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in thisdocument and assumes no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for anyinfringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material(defined below), code, or functionality.

NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.

Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.

NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreedin an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying anycustomer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formedeither directly or indirectly by this document.

NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applicationswhere failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIAaccepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.

NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each productis not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document,ensure the product is suitable and fit for the application planned by customer, and perform the necessary testing for the application in order to avoid a default ofthe application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additionalor different conditions and/or requirements beyond those contained in this document. NVIDIA accepts no liability related to any default, damage, costs, or problemwhich may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this document or (ii) customer product designs.

No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document.Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warrantyor endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party,or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.

Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliancewith all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.

THIS DOCUMENT AND ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS(TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OROTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, ANDFITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDINGWITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OFTHE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the productsdescribed herein shall be limited in accordance with the Terms of Sale for the product.

VESA DisplayPort

DisplayPort and DisplayPort Compliance Logo, DisplayPort Compliance Logo for Dual-mode Sources, and DisplayPort Compliance Logo for Active Cables aretrademarks owned by the Video Electronics Standards Association in the United States and other countries.

HDMI

HDMI, the HDMI logo, and High-Definition Multimedia Interface are trademarks or registered trademarks of HDMI Licensing LLC.

OpenCL

OpenCL is a trademark of Apple Inc. used under license to the Khronos Group Inc.

Trademarks

NVIDIA, the NVIDIA logo, NVIDIA GRID, NVIDIA GRID vGPU, NVIDIA Maxwell, NVIDIA Pascal, NVIDIA Turing, NVIDIA Volta, Quadro, and Tesla are trademarks orregistered trademarks of NVIDIA Corporation in the U.S. and other countries. Other company and product names may be trademarks of the respective companieswith which they are associated.

Copyright© 2013-2020 NVIDIA Corporation. All rights reserved.

NVIDIA Corporation  |  2788 San Tomas Expressway, Santa Clara, CA 95051http://www.nvidia.com