You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: NVIDIA GPU Driver Extension - Azure Windows VMs
3
-
description: Azure extension for installing NVIDIA GPU drivers on N-series compute VMs running Windows.
3
+
description: Learn how to install the NVIDIA GPU Driver Extension on N-series virtual machines running Windows from the Azure portal or by using an ARM template.
4
4
services: virtual-machines
5
5
ms.service: virtual-machines
6
6
ms.subservice: hpc
7
7
ms.collection: windows
8
8
ms.topic: article
9
9
ms.tgt_pltfrm: vm-windows
10
10
ms.workload: infrastructure-services
11
-
ms.date: 10/14/2021
11
+
ms.date: 04/06/2023
12
12
ms.author: mamccrea
13
13
author: mamccrea
14
14
---
15
+
15
16
# NVIDIA GPU Driver Extension for Windows
16
17
17
-
This extension installs NVIDIA GPU drivers on Windows N-series virtual machines (VMs). Depending on the VM family, the extension installs CUDA or GRID drivers. When you install NVIDIA drivers by using this extension, you're accepting and agreeing to the terms of the [NVIDIA End-User License Agreement](https://www.nvidia.com/en-us/data-center/products/nvidia-ai-enterprise/eula/). During the installation process, the VM might reboot to complete the driver setup.
18
+
The NVIDIA GPU Driver Extension for Windows installs NVIDIA GPU drivers on Windows N-series virtual machines (VMs). Depending on the VM family, the extension installs CUDA or GRID drivers. When you install NVIDIA drivers by using this extension, you accept and agree to the terms of the [NVIDIA End-User License Agreement](https://www.nvidia.com/en-us/data-center/products/nvidia-ai-enterprise/eula/). During the installation process, the VM might reboot to complete the driver setup.
19
+
20
+
The instructions for manual installation of the drivers, and the list of current supported versions are available for review. For more information, see [Install NVIDIA GPU drivers on N-series VMs running Windows](/azure/virtual-machines/windows/n-series-driver-setup).
18
21
19
-
Instructions on manual installation of the drivers and the current supported versions are available. For more information, see [Azure N-series NVIDIA GPU driver setup for Windows](../windows/n-series-driver-setup.md).
20
-
An extension is also available to install NVIDIA GPU drivers on [Linux N-series VMs](hpccompute-gpu-linux.md).
22
+
The NVIDIA GPU Driver Extension can also be deployed on Linux N-series VMs. For more information, see [NVIDIA GPU Driver Extension for Linux](hpccompute-gpu-linux.md).
21
23
22
24
## Prerequisites
23
25
26
+
Confirm your virtual machine satisfies the prerequisites for using the NVIDIA GPU Driver Extension.
27
+
24
28
### Operating system
25
29
26
-
This extension supports the following OSs:
30
+
The NVIDIA GPU Driver Extension supports the following Windows versions:
27
31
28
32
| Distribution | Version |
29
-
|---|---|
33
+
| --- | --- |
34
+
| Windows 11 | Core |
30
35
| Windows 10 | Core |
36
+
| Windows Server 2022 | Core |
31
37
| Windows Server 2019 | Core |
32
38
| Windows Server 2016 | Core |
33
39
| Windows Server 2012 R2 | Core |
34
40
35
41
### Internet connectivity
36
42
37
-
The Microsoft Azure Extension for NVIDIA GPU Drivers requires that the target VM is connected to the internet and has access.
43
+
The NVIDIA GPU Driver Extension requires that the target VM is connected to the internet and has access.
38
44
39
45
## Extension schema
40
46
41
-
The following JSON shows the schema for the extension:
47
+
The following JSON snippet shows the schema for the extension:
42
48
43
49
```json
44
50
{
@@ -62,59 +68,66 @@ The following JSON shows the schema for the extension:
62
68
63
69
### Properties
64
70
71
+
The JSON schema includes values for the following parameters.
72
+
65
73
| Name | Value/Example | Data type |
66
-
| ----| ----|---- |
67
-
| apiVersion | 2015-06-15 | date |
68
-
| publisher | Microsoft.HpcCompute | string |
69
-
| type | NvidiaGpuDriverWindows | string |
70
-
| typeHandlerVersion | 1.4 | int |
74
+
| --- | --- | --- |
75
+
|`apiVersion`| 2015-06-15 | date |
76
+
|`publisher`| Microsoft.HpcCompute | string |
77
+
|`type`| NvidiaGpuDriverWindows | string |
78
+
|`typeHandlerVersion`| 1.4 | int |
71
79
72
80
## Deployment
73
81
82
+
Azure VM extensions can be managed by using the Azure CLI, PowerShell, Azure Resource Manager (ARM) templates, and the Azure portal.
83
+
84
+
> [!Note]
85
+
> Some of the following examples use `<placeholder>` parameter values in the commands. Before you run each command, make sure to replace any placeholder values with specific values for your configuration.
86
+
74
87
### Azure portal
75
88
76
-
You can deploy Azure NVIDIA VM extensions in the Azure portal.
89
+
To install the NVIDIA GPU Driver Extension in the Azure portal, follow these steps:
77
90
78
-
1. In a browser, go to the [Azure portal](https://portal.azure.com).
91
+
1. In the [Azure portal](https://portal.azure.com), go to the virtual machine on which you want to install the extension.
79
92
80
-
1.Go to the virtual machine on which you want to install the driver.
:::image type="content" source="./media/nvidia-ext-portal/extensions-menu.png" alt-text="Screenshot that shows how to select Extensions + Applications for a virtual machine in the Azure portal." border="false":::
83
96
84
-
:::image type="content" source="./media/nvidia-ext-portal/extensions-menu.png" alt-text="Screenshot that shows selecting Extensions in the Azure portal menu.":::
97
+
1. Under **Extensions**, select **+ Add**.
85
98
86
-
1. Select **Add**.
99
+
:::image type="content" source="./media/nvidia-ext-portal/add-extension.png" alt-text="Screenshot that shows how to add an extension for a virtual machine in the Azure portal." border="false":::
87
100
88
-
:::image type="content" source="./media/nvidia-ext-portal/add-extension.png" alt-text="Screenshot that shows adding a V M extension for the selected V M.":::
101
+
1. Locate and select **NVIDIA GPU Driver Extension**, then select **Next**.
89
102
90
-
1. Scroll to find and select **NVIDIA GPU Driver Extension**, and then select **Next**.
103
+
:::image type="content" source="./media/nvidia-ext-portal/select-nvidia-extension.png" alt-text="Screenshot that shows how to locate and select the NVIDIA GPU Driver Extension for a virtual machine in the Azure portal." border="false":::
91
104
92
-
:::image type="content" source="./media/nvidia-ext-portal/select-nvidia-extension.png" alt-text="Screenshot that shows selecting NVIDIA G P U Driver Extension.":::
105
+
1. Select **Review + create**. Confirm the deployment action, and select **Create**.
93
106
94
-
1. Select **Review + create**, and select **Create**. Wait a few minutes for the driver to deploy.
107
+
Wait a few minutes for the extension to deploy.
95
108
96
-
:::image type="content" source="./media/nvidia-ext-portal/create-nvidia-extension.png" alt-text="Screenshot that shows selecting the Review + create button.":::
109
+
:::image type="content" source="./media/nvidia-ext-portal/create-nvidia-extension.png" alt-text="Screenshot that shows how to create the NVIDIA GPU Driver Extension on the selected virtual machine in the Azure portal." border="false":::
97
110
98
-
1.Verify that the extension was added to the list of installed extensions.
111
+
1.Confirm the extension is listed as an installed extension for the virtual machine.
99
112
100
-
:::image type="content" source="./media/nvidia-ext-portal/verify-extension.png" alt-text="Screenshot that shows the new extension in the list of extensions for the V M.":::
113
+
:::image type="content" source="./media/nvidia-ext-portal/verify-extension.png" alt-text="Screenshot that shows the NVIDIA GPU Driver Extension in the list of extensions for the virtual machine in the Azure portal." border="false":::
101
114
102
-
### Azure Resource Manager template
115
+
### ARM template
103
116
104
-
You can use Azure Resource Manager templates to deploy Azure VM extensions. Templates are ideal when you deploy one or more virtual machines that require post-deployment configuration.
117
+
ARM templates are ideal when you deploy one or more virtual machines that require post-deployment configuration.
105
118
106
-
The JSON configuration for a virtual machine extension can be nested inside the virtual machine resource or placed at the root or top level of a Resource Manager JSON template. The placement of the JSON configuration affects the value of the resource name and type. For more information, see [Set name and type for child resources](../../azure-resource-manager/templates/child-resource-name-type.md).
119
+
The JSON configuration for a virtual machine extension can be nested inside the virtual machine resource or placed at the root or top level of a JSON ARM template. The placement of the JSON configuration affects the value of the resource `name` and `type`. For more information, see [Set name and type for child resources](/azure/azure-resource-manager/templates/child-resource-name-type).
107
120
108
121
The following example assumes the extension is nested inside the virtual machine resource. When the extension resource is nested, the JSON is placed in the `"resources": []` object of the virtual machine.
@@ -129,11 +142,13 @@ The following example assumes the extension is nested inside the virtual machine
129
142
130
143
### PowerShell
131
144
145
+
Use the following PowerShell command to deploy the NVIDIA GPU Driver Extension to a virtual machine.
146
+
132
147
```powershell
133
148
Set-AzVMExtension
134
-
-ResourceGroupName "myResourceGroup" `
135
-
-VMName "myVM" `
136
-
-Location "southcentralus" `
149
+
-ResourceGroupName "<myResourceGroup>" `
150
+
-VMName "<myVM>" `
151
+
-Location "<location>" `
137
152
-Publisher "Microsoft.HpcCompute" `
138
153
-ExtensionName "NvidiaGpuDriverWindows" `
139
154
-ExtensionType "NvidiaGpuDriverWindows" `
@@ -144,53 +159,65 @@ Set-AzVMExtension
144
159
145
160
### Azure CLI
146
161
162
+
Run the following command in the Azure CLI to deploy the NVIDIA GPU Driver Extension to a virtual machine.
163
+
147
164
```azurecli
148
165
az vm extension set \
149
-
--resource-group myResourceGroup \
150
-
--vm-name myVM \
166
+
--resource-group <myResourceGroup> \
167
+
--vm-name <myVM> \
151
168
--name NvidiaGpuDriverWindows \
152
169
--publisher Microsoft.HpcCompute \
153
170
--version 1.4 \
154
171
--settings '{ \
155
172
}'
156
173
```
157
174
158
-
## Troubleshoot and support
175
+
## Troubleshoot
176
+
177
+
Here are some suggestions for how to troubleshoot deployment issues.
178
+
179
+
### Status and output logs
159
180
160
-
### Troubleshoot
181
+
Check the status of your extension deployment in the Azure portal, or by using PowerShell or the Azure CLI.
161
182
162
-
You can retrieve data about the state of extension deployments from the Azure portal and by using Azure PowerShell and the Azure CLI. To see the deployment state of extensions for a given VM, run the following command:
183
+
To see the deployment state of extensions for a given VM, run the following commands:
The following table lists common error codes for deployment and potential follow-up actions.
199
+
200
+
| Error | Description | Action |
181
201
| :---: | --- | --- |
182
-
| 0 | Operation successful. |
183
-
| 1 | Operation successful. Reboot required. |
184
-
| 100 | Operation not supported or couldn't be completed. | Possible causes are that the PowerShell version isn't supported, the VM size isn't an N-series VM, or a failure occurred in downloading data. Check the log files to determine the cause of the error. |
202
+
| 0 | Operation successful. | No required action. |
203
+
| 1 | Operation successful. | Reboot. |
204
+
| 100 | Operation not supported or couldn't be completed. | Check log files to determine cause of error, such as: <br>
205
+
- PowerShell version isn't supported. <br> - VM size isn't an N-series VM. <br> - Failure during data download. |
| -1 | Exception occurred. | Check the log files to determine the cause of the exception. |
187
-
| -5x | Operation interrupted due to pending reboot. | Reboot VM. Installation continues after the reboot. Uninstall should be invoked manually. |
207
+
| -1 | Exception occurred. | Check log files to determine cause of exception. |
208
+
| -5x | Operation interrupted due to pending reboot. | Reboot the VM. Installation continues after reboot. Uninstall should be invoked manually. |
188
209
189
210
### Support
190
211
191
-
If you need more help at any point in this article, contact the Azure experts on the [MSDN Azure and Stack Overflow forums](https://azure.microsoft.com/support/community/). Alternatively, you can file an Azure support incident. Go to [Azure support](https://azure.microsoft.com/support/options/) and select **Get support**. For information about using Azure support, read the [Azure support FAQ](https://azure.microsoft.com/support/faq/).
212
+
Here are some other options to help you resolve deployment issues:
213
+
214
+
- For assistance, contact the Azure experts on the [Q&A and Stack Overflow forums](https://azure.microsoft.com/support/community/).
215
+
216
+
- If you don't find an answer on the site, you can post a question for input from Microsoft or other members of the community.
217
+
218
+
- You can also [Contact Microsoft Support](https://support.microsoft.com/contactus/). For information about using Azure support, read the [Azure support FAQ](https://azure.microsoft.com/support/legal/faq/).
192
219
193
220
## Next steps
194
221
195
222
- For more information about extensions, see [Virtual machine extensions and features for Windows](features-windows.md).
196
-
- For more information about N-series VMs, see [GPU optimized virtual machine sizes](../sizes-gpu.md).
223
+
- For more information about N-series VMs, see [GPU optimized virtual machine sizes](/azure/virtual-machines/sizes-gpu).
0 commit comments