Merge pull request #233729 from GitHubber17/refresh-79519-nvidia-gpu-ext

Freshness Pass for User Story: 79519

Author: AnnaMHuff

articles/virtual-machines/extensions/hpccompute-gpu-windows.md

@@ -1,44 +1,50 @@
 ---
 title: NVIDIA GPU Driver Extension - Azure Windows VMs 
-description: Azure extension for installing NVIDIA GPU drivers on N-series compute VMs running Windows.
+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.
 services: virtual-machines
 ms.service: virtual-machines
 ms.subservice: hpc
 ms.collection: windows
 ms.topic: article
 ms.tgt_pltfrm: vm-windows
 ms.workload: infrastructure-services
-ms.date: 10/14/2021
+ms.date: 04/06/2023
 ms.author: mamccrea
 author: mamccrea
 ---
+
 # NVIDIA GPU Driver Extension for Windows
 
-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.
+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.
+
+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).
 
-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).
-An extension is also available to install NVIDIA GPU drivers on [Linux N-series VMs](hpccompute-gpu-linux.md).
+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).
 
 ## Prerequisites
 
-### Operating system
+Confirm your virtual machine satisfies the prerequisites for using the NVIDIA GPU Driver Extension.
 
-This extension supports the following OSs:
+### Operating system support
+
+The NVIDIA GPU Driver Extension supports the following Windows versions:
 
 | Distribution | Version |
-|---|---|
+| --- | --- |
+| Windows 11 | Core |
 | Windows 10 | Core |
+| Windows Server 2022 | Core |
 | Windows Server 2019 | Core |
 | Windows Server 2016 | Core |
 | Windows Server 2012 R2 | Core |
 
-### Internet connectivity
+### Internet connection required
 
-The Microsoft Azure Extension for NVIDIA GPU Drivers requires that the target VM is connected to the internet and has access.
+The NVIDIA GPU Driver Extension requires that the target VM is connected to the internet and has access.
 
-## Extension schema
+## Review the extension schema
 
-The following JSON shows the schema for the extension:
+The following JSON snippet shows the schema for the extension:
 
 ```json
 {
@@ -62,59 +68,66 @@ The following JSON shows the schema for the extension:
 
 ### Properties
 
+The JSON schema includes values for the following parameters.
+
 | Name | Value/Example | Data type |
-| ---- | ---- | ---- |
-| apiVersion | 2015-06-15 | date |
-| publisher | Microsoft.HpcCompute | string |
-| type | NvidiaGpuDriverWindows | string |
-| typeHandlerVersion | 1.4 | int |
+| --- | --- | --- |
+| `apiVersion` | 2015-06-15 | date |
+| `publisher` | Microsoft.HpcCompute | string |
+| `type` | NvidiaGpuDriverWindows | string |
+| `typeHandlerVersion` | 1.4 | int |
 
-## Deployment
+## Deploy the extension
+
+Azure VM extensions can be managed by using the Azure CLI, PowerShell, Azure Resource Manager (ARM) templates, and the Azure portal.
+
+> [!Note]
+> 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.
 
 ### Azure portal
 
-You can deploy Azure NVIDIA VM extensions in the Azure portal.
+To install the NVIDIA GPU Driver Extension in the Azure portal, follow these steps:
 
-1. In a browser, go to the [Azure portal](https://portal.azure.com).
+1. In the [Azure portal](https://portal.azure.com), go to the virtual machine on which you want to install the extension.
 
-1. Go to the virtual machine on which you want to install the driver.
+1. Under **Settings**, select **Extensions + Applications**.
 
-1. On the left menu, select **Extensions**.
+   :::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":::
 
-    :::image type="content" source="./media/nvidia-ext-portal/extensions-menu.png" alt-text="Screenshot that shows selecting Extensions in the Azure portal menu.":::
+1. Under **Extensions**, select **+ Add**.
 
-1. Select **Add**.
+   :::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":::
 
-    :::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.":::
+1. Locate and select **NVIDIA GPU Driver Extension**, then select **Next**.
 
-1. Scroll to find and select **NVIDIA GPU Driver Extension**, and then select **Next**.
+   :::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":::
 
-    :::image type="content" source="./media/nvidia-ext-portal/select-nvidia-extension.png" alt-text="Screenshot that shows selecting NVIDIA G P U Driver Extension.":::
+1. Select **Review + create**. Confirm the deployment action, and select **Create**.
 
-1. Select **Review + create**, and select **Create**. Wait a few minutes for the driver to deploy.
+   Wait a few minutes for the extension to deploy.
 
-    :::image type="content" source="./media/nvidia-ext-portal/create-nvidia-extension.png" alt-text="Screenshot that shows selecting the Review + create button.":::
+   :::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":::
 
-1. Verify that the extension was added to the list of installed extensions.
+1. Confirm the extension is listed as an installed extension for the virtual machine.
 
-    :::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.":::
+   :::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":::
 
-### Azure Resource Manager template
+### ARM template
 
-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.
+ARM templates are ideal when you deploy one or more virtual machines that require post-deployment configuration.
 
-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).
+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).
 
 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.
 
 ```json
 {
-  "name": "myExtensionName",
+  "name": "<myExtensionName>",
   "type": "extensions",
-  "location": "[resourceGroup().location]",
+  "location": "[<resourceGroup().location>]",
   "apiVersion": "2015-06-15",
   "dependsOn": [
-    "[concat('Microsoft.Compute/virtualMachines/', myVM)]"
+    "[concat('Microsoft.Compute/virtualMachines/', <myVM>)]"
   ],
   "properties": {
     "publisher": "Microsoft.HpcCompute",
@@ -129,11 +142,13 @@ The following example assumes the extension is nested inside the virtual machine
 
 ### PowerShell
 
+Use the following PowerShell command to deploy the NVIDIA GPU Driver Extension to a virtual machine.
+
 ```powershell
 Set-AzVMExtension
-    -ResourceGroupName "myResourceGroup" `
-    -VMName "myVM" `
-    -Location "southcentralus" `
+    -ResourceGroupName "<myResourceGroup>" `
+    -VMName "<myVM>" `
+    -Location "<location>" `
     -Publisher "Microsoft.HpcCompute" `
     -ExtensionName "NvidiaGpuDriverWindows" `
     -ExtensionType "NvidiaGpuDriverWindows" `
@@ -144,53 +159,65 @@ Set-AzVMExtension
 
 ### Azure CLI
 
+Run the following command in the Azure CLI to deploy the NVIDIA GPU Driver Extension to a virtual machine.
+
 ```azurecli
 az vm extension set \
-  --resource-group myResourceGroup \
-  --vm-name myVM \
+  --resource-group <myResourceGroup> \
+  --vm-name <myVM> \
   --name NvidiaGpuDriverWindows \
   --publisher Microsoft.HpcCompute \
   --version 1.4 \
   --settings '{ \
   }'
 ```
 
-## Troubleshoot and support
+## <a name="troubleshoot-and-support"></a> Troubleshoot issues
+
+Here are some suggestions for how to troubleshoot deployment issues.
+
+### Check extension status
 
-### Troubleshoot
+Check the status of your extension deployment in the Azure portal, or by using PowerShell or the Azure CLI.
 
-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:
+To see the deployment state of extensions for a given VM, run the following commands:
 
 ```powershell
-Get-AzVMExtension -ResourceGroupName myResourceGroup -VMName myVM -Name myExtensionName
+Get-AzVMExtension -ResourceGroupName <myResourceGroup> -VMName <myVM> -Name <myExtensionName>
 ```
 
 ```azurecli
-az vm extension list --resource-group myResourceGroup --vm-name myVM -o table
+az vm extension list --resource-group <myResourceGroup> --vm-name <myVM> -o table
 ```
+### Review output logs
 
-Extension execution output is logged to the following directory:
+View output logs for the NVIDIA GPU Driver Extension deployment under
+`C:\WindowsAzure\Logs\Plugins\Microsoft.HpcCompute.NvidiaGpuDriverWindows\`.
 
-```cmd
-C:\WindowsAzure\Logs\Plugins\Microsoft.HpcCompute.NvidiaGpuDriverWindows\
-```
+### Respond to error codes
 
-### Error codes
+The following table lists common error codes for deployment and potential follow-up actions.
 
-| Error Code | Meaning | Possible action |
+| Error | Description | Action |
 | :---: | --- | --- |
-| 0 | Operation successful. |
-| 1 | Operation successful. Reboot required. |
-| 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. |
+| 0 | Operation successful. | No required action. |
+| 1 | Operation successful. | Reboot. |
+| 100 | Operation not supported or couldn't be completed. | Check log files to determine cause of error, such as: <br>- PowerShell version isn't supported. <br> - VM size isn't an N-series VM. <br> - Failure during data download. |
 | 240, 840 | Operation timeout. | Retry operation. |
-| -1 | Exception occurred. | Check the log files to determine the cause of the exception. |
-| -5x | Operation interrupted due to pending reboot. | Reboot VM. Installation continues after the reboot. Uninstall should be invoked manually. |
+| -1 | Exception occurred. | Check log files to determine cause of exception. |
+| -5x | Operation interrupted due to pending reboot. | Reboot the VM. Installation continues after reboot. <br> Uninstall should be invoked manually. |
+
+### Get support
+
+Here are some other options to help you resolve deployment issues:
+
+- For assistance, contact the Azure experts on the [Q&A and Stack Overflow forums](https://azure.microsoft.com/support/community/). 
 
-### Support
+- 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.
 
-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/).
+- 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/).
 
 ## Next steps
 
 - For more information about extensions, see [Virtual machine extensions and features for Windows](features-windows.md).
-- For more information about N-series VMs, see [GPU optimized virtual machine sizes](../sizes-gpu.md).
+- For more information about N-series VMs, see [GPU optimized virtual machine sizes](/azure/virtual-machines/sizes-gpu).