|
| 1 | +--- |
| 2 | +title: AMD GPU driver extension - Azure Windows VMs |
| 3 | +description: Microsoft Azure extension for installing AMD GPU Drivers on NVv4-series VMs running Windows. |
| 4 | +services: virtual-machines-windows |
| 5 | +documentationcenter: '' |
| 6 | +author: vikancha |
| 7 | +manager: jkabat |
| 8 | +editor: '' |
| 9 | + |
| 10 | +ms.assetid: |
| 11 | +ms.service: virtual-machines-windows |
| 12 | +ms.topic: article |
| 13 | +ms.tgt_pltfrm: vm-windows |
| 14 | +ms.workload: infrastructure-services |
| 15 | +ms.date: 05/10/2020 |
| 16 | +ms.author: vikancha |
| 17 | + |
| 18 | +--- |
| 19 | +# AMD GPU driver extension for Windows |
| 20 | + |
| 21 | +This article provides an overview of the VM extension to deploy AMD GPU drivers on Windows [NVv4-series](https://docs.microsoft.com/azure/virtual-machines/nvv4-series) VMs. When you install AMD drivers using this extension, you are accepting and agreeing to the terms of the [AMD End-User License Agreement](https://amd.com/radeonsoftwarems). During the installation process, the VM may reboot to complete the driver setup. |
| 22 | + |
| 23 | +Instructions on manual installation of the drivers and the current supported versions are available [here](https://docs.microsoft.com/azure/virtual-machines/windows/n-series-amd-driver-setup). |
| 24 | + |
| 25 | +## Prerequisites |
| 26 | + |
| 27 | +### Operating system |
| 28 | + |
| 29 | +This extension supports the following OSs: |
| 30 | + |
| 31 | +| Distribution | Version | |
| 32 | +|---|---| |
| 33 | +| Windows 10 EMS | Build 1903 | |
| 34 | +| Windows 10 | Build 1809 | |
| 35 | +| Windows Server 2016 | Core | |
| 36 | +| Windows Server 2019 | Core | |
| 37 | + |
| 38 | +### Internet connectivity |
| 39 | + |
| 40 | +The Microsoft Azure Extension for AMD GPU Drivers requires that the target VM is connected to the internet and have access. |
| 41 | + |
| 42 | +## Extension schema |
| 43 | + |
| 44 | +The following JSON shows the schema for the extension. |
| 45 | + |
| 46 | +```json |
| 47 | +{ |
| 48 | + "name": "<myExtensionName>", |
| 49 | + "type": "extensions", |
| 50 | + "apiVersion": "2015-06-15", |
| 51 | + "location": "<location>", |
| 52 | + "dependsOn": [ |
| 53 | + "[concat('Microsoft.Compute/virtualMachines/', <myVM>)]" |
| 54 | + ], |
| 55 | + "properties": { |
| 56 | + "publisher": "Microsoft.HpcCompute", |
| 57 | + "type": "AmdGpuDriverWindows", |
| 58 | + "typeHandlerVersion": "1.0", |
| 59 | + "autoUpgradeMinorVersion": true, |
| 60 | + "settings": { |
| 61 | + } |
| 62 | + } |
| 63 | +} |
| 64 | +``` |
| 65 | + |
| 66 | +### Properties |
| 67 | + |
| 68 | +| Name | Value / Example | Data Type | |
| 69 | +| ---- | ---- | ---- | |
| 70 | +| apiVersion | 2015-06-15 | date | |
| 71 | +| publisher | Microsoft.HpcCompute | string | |
| 72 | +| type | AmdGpuDriverWindows | string | |
| 73 | +| typeHandlerVersion | 1.0 | int | |
| 74 | + |
| 75 | + |
| 76 | +## Deployment |
| 77 | + |
| 78 | +### Azure Resource Manager Template |
| 79 | + |
| 80 | +Azure VM extensions can be deployed with Azure Resource Manager templates. Templates are ideal when deploying one or more virtual machines that require post deployment configuration. |
| 81 | + |
| 82 | +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/resource-manager-template-child-resource.md). |
| 83 | + |
| 84 | +The following example assumes the extension is nested inside the virtual machine resource. When nesting the extension resource, the JSON is placed in the `"resources": []` object of the virtual machine. |
| 85 | + |
| 86 | +```json |
| 87 | +{ |
| 88 | + "name": "myExtensionName", |
| 89 | + "type": "extensions", |
| 90 | + "location": "[resourceGroup().location]", |
| 91 | + "apiVersion": "2015-06-15", |
| 92 | + "dependsOn": [ |
| 93 | + "[concat('Microsoft.Compute/virtualMachines/', myVM)]" |
| 94 | + ], |
| 95 | + "properties": { |
| 96 | + "publisher": "Microsoft.HpcCompute", |
| 97 | + "type": "AmdGpuDriverWindows", |
| 98 | + "typeHandlerVersion": "1.0", |
| 99 | + "autoUpgradeMinorVersion": true, |
| 100 | + "settings": { |
| 101 | + } |
| 102 | + } |
| 103 | +} |
| 104 | +``` |
| 105 | + |
| 106 | +### PowerShell |
| 107 | + |
| 108 | +```powershell |
| 109 | +Set-AzVMExtension |
| 110 | + -ResourceGroupName "myResourceGroup" ` |
| 111 | + -VMName "myVM" ` |
| 112 | + -Location "southcentralus" ` |
| 113 | + -Publisher "Microsoft.HpcCompute" ` |
| 114 | + -ExtensionName "AmdGpuDriverWindows" ` |
| 115 | + -ExtensionType "AmdGpuDriverWindows" ` |
| 116 | + -TypeHandlerVersion 1.0 ` |
| 117 | + -SettingString '{ ` |
| 118 | + }' |
| 119 | +``` |
| 120 | + |
| 121 | +### Azure CLI |
| 122 | + |
| 123 | +```azurecli |
| 124 | +az vm extension set ` |
| 125 | + --resource-group myResourceGroup ` |
| 126 | + --vm-name myVM ` |
| 127 | + --name AmdGpuDriverWindows ` |
| 128 | + --publisher Microsoft.HpcCompute ` |
| 129 | + --version 1.0 ` |
| 130 | + --settings '{ ` |
| 131 | + }' |
| 132 | +``` |
| 133 | + |
| 134 | +## Troubleshoot and support |
| 135 | + |
| 136 | +### Troubleshoot |
| 137 | + |
| 138 | +Data about the state of extension deployments can be retrieved from the Azure portal, and by using Azure PowerShell and Azure CLI. To see the deployment state of extensions for a given VM, run the following command. |
| 139 | + |
| 140 | +```powershell |
| 141 | +Get-AzVMExtension -ResourceGroupName myResourceGroup -VMName myVM -Name myExtensionName |
| 142 | +``` |
| 143 | + |
| 144 | +```azurecli |
| 145 | +az vm extension list --resource-group myResourceGroup --vm-name myVM -o table |
| 146 | +``` |
| 147 | + |
| 148 | +Extension execution output is logged to the following directory: |
| 149 | + |
| 150 | +```cmd |
| 151 | +C:\WindowsAzure\Logs\Plugins\Microsoft.HpcCompute.NvidiaGpuDriverMicrosoft\ |
| 152 | +``` |
| 153 | + |
| 154 | +### Error codes |
| 155 | + |
| 156 | +| Error Code | Meaning | Possible Action | |
| 157 | +| :---: | --- | --- | |
| 158 | +| 0 | Operation successful | |
| 159 | +| 1 | Operation successful. Reboot required. | |
| 160 | +| 100 | Operation not supported or could not be completed. | Possible causes: PowerShell version not supported, VM size is not an N-series VM, Failure downloading data. Check the log files to determine cause of error. | |
| 161 | +| 240, 840 | Operation timeout. | Retry operation. | |
| 162 | +| -1 | Exception occurred. | Check the log files to determine cause of exception. | |
| 163 | +| -5x | Operation interrupted due to pending reboot. | Reboot VM. Installation will continue after reboot. Uninstall should be invoked manually. | |
| 164 | + |
| 165 | + |
| 166 | +### Support |
| 167 | + |
| 168 | +If you need more help at any point in this article, you can 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 the [Azure support site](https://azure.microsoft.com/support/options/) and select Get support. For information about using Azure Support, read the [Microsoft Azure support FAQ](https://azure.microsoft.com/support/faq/). |
| 169 | + |
| 170 | +## Next steps |
| 171 | +For more information about extensions, see [Virtual machine extensions and features for Windows](features-windows.md). |
| 172 | + |
| 173 | +For more information about N-series VMs, see [GPU optimized virtual machine sizes](../windows/sizes-gpu.md). |
0 commit comments