Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Install the password reset extension on VMs for your Azure Stack Edge Pro GPU device description: Describes how to install the password reset extension on virtual machines (VMs) on an Azure Stack Edge Pro GPU device. services: databox author: alkohli ms.service: azure-stack-edge ms.topic: how-to ms.date: 04/14/2022 ms.author: alkohli ms.custom: - devx-track-azurepowershell - sfi-image-nochange #Customer intent: As an IT admin, I need to understand how install the password reset extension on virtual machines (VMs) on my Azure Stack Edge Pro GPU device. --- # Install the password reset extension on VMs for your Azure Stack Edge Pro GPU device [!INCLUDE [applies-to-GPU-and-pro-r-and-mini-r-skus](../../includes/azure-stack-edge-applies-to-gpu-pro-r-mini-r-sku.md)] This article covers steps to install, verify, and remove the password reset extension using Azure Resource Manager templates on both Windows and Linux VMs. ## Prerequisites Before you install the password reset extension on the VMs running on your device: 1. Make sure to have access to an Azure Stack Edge device on which you've deployed one or more VMs. For more information, see [Deploy VMs on your Azure Stack Edge Pro GPU device via the Azure portal](azure-stack-edge-gpu-deploy-virtual-machine-portal.md). Here's an example where Port 2 was used to enable the compute network. If Kubernetes isn't deployed on your environment, you can skip the Kubernetes node IP and external service IP assignment.  1. [Download the templates](https://aka.ms/ase-vm-templates) to your client machine. Unzip the files into a directory you’ll use as a working directory. 1. Verify that the client you'll use to access your device is connected to the local Azure Resource Manager over Azure PowerShell. For detailed instructions, see [Connect to Azure Resource Manager on your Azure Stack Edge device](azure-stack-edge-gpu-connect-resource-manager.md). The connection to Azure Resource Manager expires every 1.5 hours or if your Azure Stack Edge device restarts. If your connection expires, any cmdlets that you execute will return error messages to the effect that you aren't connected to Azure. In this case, sign in again. ## Edit parameters file Depending on the operating system for your VM, you can install the extension for Windows or for Linux. You'll find the parameter and template files in the *PasswordResetExtension* folder. ### [Windows](#tab/windows) To change the password for an existing VM, edit the `addPasswordResetExtensionTemplate.parameters.json` parameters file and then deploy the template `addPasswordResetExtensionTemplate.json`. The file `addPasswordResetExtensionTemplate.parameters.json` takes the following parameters: ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "vmName": { "value": "<Name of the VM>" }, "extensionType": { "value": "<OS type of the VM, for example, Linux or Windows>" }, "username": { "value": "<Existing username for connecting to your VM>" }, "Password": { "value": "<New password for the user>" } } } ``` ### [Linux](#tab/linux) To change the password for an existing VM, edit the `addPasswordResetExtensionTemplate.parameters.json` parameters file and then deploy the template `addPasswordResetExtensionTemplate.json`. The file `addPasswordResetExtensionTemplate.parameters.json` takes the following parameters: ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "vmName": { "value": "<Name of the VM>" }, "extensionType": { "value": "<OS type of the VM, for example, Linux or Windows>" }, "username": { "value": "<Existing username for connecting to your VM>" }, "Password": { "value": "<New password for the user>" } } } ``` --- ## Deploy template ### [Windows](#tab/windows) Set some parameters. Run the following command: ```powershell $templateFile = "<Path to addPasswordResetExtensionTemplate.json file>" $templateParameterFile = "<Path to addPasswordResetExtensionTemplate.parameters.json file>" $RGName = "<Name of resource group>" New-AzResourceGroupDeployment -ResourceGroupName $RGName -TemplateFile $templateFile -TemplateParameterFile $templateParameterFile -Name "<Deployment name>" -AsJob ``` The extension deployment is a long running job and takes about 10 minutes to complete. Here's a sample output: ```powershell PS C:\WINDOWS\system32> $templateFile = "C:\PasswordResetVmExtensionTemplates\addPasswordResetExtensionTemplate.json" PS C:\WINDOWS\system32> $templateParameterFile = "C:\PasswordResetVmExtensionTemplates\addPasswordResetExtensionTemplate.parameters.json" PS C:\WINDOWS\system32> $RGName = "myasepro2rg" PS C:\WINDOWS\system32> New-AzResourceGroupDeployment -ResourceGroupName $RGName -TemplateFile $templateFile -TemplateParameterFile $templateParameterFile -Name "windowsvmdeploy" -AsJob Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 9 Long Running... AzureLongRun... Running True localhost New-AzResourceGro... PS C:\WINDOWS\system32> ``` ### [Linux](#tab/linux) Set some parameters. Run the following command: ```powershell $templateFile = "<Path to addPasswordResetExtensionTemplate.json file>" $templateParameterFile = "<Path to addPasswordResetExtensionTemplate.parameters.json file>" $RGName = "<Name of resource group>" New-AzResourceGroupDeployment -ResourceGroupName $RGName -TemplateFile $templateFile -TemplateParameterFile $templateParameterFile -Name "<Deployment name>" -AsJob ``` The extension deployment is a long running job and takes about 10 minutes to complete. Here's a sample output: ```powershell PS C:\WINDOWS\system32> $templateFile = "C:\PasswordResetVmExtensionTemplates\addPasswordResetExtensionTemplate.json" PS C:\WINDOWS\system32> $templateParameterFile = "C:\PasswordResetVmExtensionTemplates\addPasswordResetExtensionTemplate.parameters.json" PS C:\WINDOWS\system32> $RGName = "myasepro2rg" PS C:\WINDOWS\system32> New-AzResourceGroupDeployment -ResourceGroupName $RGName -TemplateFile $templateFile -TemplateParameterFile $templateParameterFile -Name "linuxvmdeploy" -AsJob Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 4 Long Running... AzureLongRun... Running True localhost New-AzResourceGroupDep... ``` --- ## Track deployment ### [Windows](#tab/windows) To check the deployment status of extensions for a given VM, run the following command: ```powershell Get-AzVMExtension -ResourceGroupName <MyResourceGroup> -VMName <MyWindowsVM> -Name <Name of the extension> ``` Here's a sample output: ```powershell PS C:\WINDOWS\system32> Get-AzVMExtension -ResourceGroupName myasepro2rg -VMName mywindowsvm -Name windowsVMAccessExt ResourceGroupName : myasepro2rg VMName : mywindowsvm Name : windowsVMAccessExt Location : dbelocal Etag : null Publisher : Microsoft.Compute ExtensionType : VMAccessAgent TypeHandlerVersion : 2.4 Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myasepro2rg/provi ders/Microsoft.Compute/virtualMachines/mywindowsvm/extensions/windowsVMAccessExt PublicSettings : { "username": "azureuser" } ProtectedSettings : ProvisioningState : Succeeded Statuses : SubStatuses : AutoUpgradeMinorVersion : True ForceUpdateTag : PS C:\WINDOWS\system32> ``` You can see below that the extension has been installed successfully.  ### [Linux](#tab/linux) To check the deployment status of extensions for a given VM, run the following command: ```powershell Get-AzVMExtension -ResourceGroupName <MyResourceGroup> -VMName <MyLinuxVM> -Name <Name of the extension> ``` Here's a sample output: ```powershell PS C:\WINDOWS\system32> Get-AzVMExtension -ResourceGroupName myasepro2rg -VMName mylinuxvm5 -Name linuxVMAccessExt ResourceGroupName : myasepro2rg VMName : mylinuxvm5 Name : linuxVMAccessExt Location : dbelocal Etag : null Publisher : Microsoft.OSTCExtensions ExtensionType : VMAccessForLinux TypeHandlerVersion : 1.5 Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups /myasepro2rg/providers/Microsoft.Compute/virtualMachines/mylinuxvm 5/extensions/linuxVMAccessExt PublicSettings : {} ProtectedSettings : ProvisioningState : Succeeded Statuses : SubStatuses : AutoUpgradeMinorVersion : True ForceUpdateTag : PS C:\WINDOWS\system32> ``` You can see below that the extension has been installed successfully.  --- ## Verify the updated VM password ### [Windows](#tab/windows) To verify the VM password update, connect to the VM using the new password. For detailed instructions, see [Connect to a Windows VM.](azure-stack-edge-gpu-deploy-virtual-machine-portal.md#connect-to-a-windows-vm)  ### [Linux](#tab/linux) To verify the VM password update, connect to the VM using the new password. For detailed instructions, see [Connect to a Linux VM.](azure-stack-edge-gpu-deploy-virtual-machine-portal.md#connect-to-a-linux-vm) Here's a sample output: ```powershell Microsoft Windows [Version 10.0.22000.556] (c) Microsoft Corporation. All rights reserved. C:\WINDOWS\system32>ssh -l azureuser 10.57.51.13 azureuser@10.57.51.13's password: Welcome to Ubuntu 18.04.3 LTS (GNU/Linux 5.0.0-1027-azure x86_64) * Documentation: https://help.ubuntu.com * Management: https://landscape.canonical.com * Support: https://ubuntu.com/advantage System information as of Wed Mar 30 21:22:24 UTC 2022 System load: 1.06 Processes: 113 Usage of /: 5.4% of 28.90GB Users logged in: 0 Memory usage: 14% IP address for eth0: 10.57.51.13 Swap usage: 0% * Super-optimized for small spaces - read how we shrank the memory footprint of MicroK8s to make it the smallest full K8s around. https://ubuntu.com/blog/microk8s-memory-optimisation 230 packages can be updated. 160 updates are security updates. New release '20.04.4 LTS' available. Run 'do-release-upgrade' to upgrade to it. *** System restart required *** Last login: Wed Mar 30 21:16:52 2022 from 10.191.227.85 To run a command as administrator (user "root"), use "sudo <command>". See "man sudo_root" for details. azureuser@mylinuxvm5:~$ ``` --- ## Remove the extension ### [Windows](#tab/windows) To remove the password reset extension, run the following command: ```powershell Remove-AzVMExtension -ResourceGroupName <Resource group name> -VMName <VM name> -Name <Name of the extension> ``` Here's a sample output: ```powershell PS C:\WINDOWS\system32> Remove-AzVMExtension -ResourceGroupName myasepro2rg -VMName mywindowsvm5 -Name windowsVMAccessExt Virtual machine extension removal operation This cmdlet will remove the specified virtual machine extension. Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Yes RequestId IsSuccessStatusCode StatusCode ReasonPhrase --------- ------------------- ---------- ------------ True OK OK PS C:\WINDOWS\system32> ``` ### [Linux](#tab/linux) To remove the password reset extension, run the following command: ```powershell Remove-AzVMExtension -ResourceGroupName <Resource group name> -VMName <VM name> -Name <Name of the extension> ``` Here's a sample output: ```powershell PS C:\WINDOWS\system32> Remove-AzVMExtension -ResourceGroupName myasepro2rg -VMName mylinuxvm5 -Name linuxVMAccessExt Virtual machine extension removal operation This cmdlet will remove the specified virtual machine extension. Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Yes RequestId IsSuccessStatusCode StatusCode ReasonPhrase --------- ------------------- ---------- ------------ True OK OK PS C:\WINDOWS\system32> ``` --- ## Next steps Learn how to: - [Monitor VM activity on your device](azure-stack-edge-gpu-monitor-virtual-machine-activity.md) - [Manage VM disks](azure-stack-edge-gpu-manage-virtual-machine-disks-portal.md) - [Manage VM network interfaces](azure-stack-edge-gpu-manage-virtual-machine-network-interfaces-portal.md) - [Manage VM sizes](azure-stack-edge-gpu-manage-virtual-machine-resize-portal.md)