Merge pull request #220555 from ntrogh/als-reset-vm

[Azure Lab Services] Added concept article for troubleshooting a lab VM

Author: liljack17

articles/lab-services/TOC.yml

@@ -231,7 +231,7 @@
       href: connect-virtual-machine-chromebook-remote-desktop.md
     - name: Connect to Linux VM using X2Go
       href: connect-virtual-machine-linux-x2go.md
-    - name: How to troubleshoot a VM
+    - name: Troubleshoot a lab VM
       href: how-to-reset-and-redeploy-vm.md  
     - name: Set or reset passwords for VMs 
       href: how-to-set-virtual-machine-passwords-student.md 
@@ -289,6 +289,10 @@
       href: how-to-setup-lab-gpu-1.md
     - name: Az.LabServices PowerShell module for lab accounts
       href: reference-powershell-module.md     
+- name: Troubleshoot & debug
+  items:
+  - name: Troubleshoot lab VM Access
+    href: troubleshoot-access-lab-vm.md
 - name: Reference
   items:
   - name: .NET

articles/lab-services/how-to-reset-and-redeploy-vm.md

@@ -1,33 +1,82 @@
 ---
 title: Troubleshoot a VM in Azure Lab Services
-description: Learn how to troubleshoot a VM in Azure Lab Services
+description: Learn how to troubleshoot a VM in Azure Lab Services by redeploying or resetting the VM.
+services: lab-services
+ms.service: lab-services
 ms.topic: how-to
 ms.author: rosemalcolm
 author: RoseHJM
-ms.date: 01/21/2022
+ms.date: 12/06/2022
 ---
 <!-- As a student, I want to be able to troubleshoot connectivity problems with my VM so that I can get back up and running quickly, without having to escalate an issue -->
 
-# How to troubleshoot a VM
-On rare occasions, you may have problems connecting with a VM in one of your labs. There are some troubleshooting steps you can take as a student to resolve connectivity issues and get back up and running quickly. You can avoid having to escalate the issue to your educator and wait for a solution.
+# Troubleshoot a lab by redeploying or resetting the VM
+
+On rare occasions, you may have problems connecting to a VM in one of your labs. In this article, you learn how to redeploy or reset a lab VM in Azure Lab Services. You can use these troubleshooting steps to resolve connectivity issues for your assigned labs, without support from an educator or admin.
+
+Learn more about [strategies for troubleshooting lab VMs](./troubleshoot-access-lab-vm.md).
 
 ## Reset VMs
 
-To reset one or more VMs, select them in the list, and then select **Reset** on the toolbar.
+When you reset a lab VM, Azure Lab Services will shut down the VM, delete it, and recreate a new lab VM from the original template VM. You can think of a reset as a refresh of the entire VM.
+
+You can reset a lab VM that is assigned to you. If you have the Lab Assistant, Lab Contributor, or Lab Operator role, you can reset any lab VM for which you have permissions.
+
+You can also reset a lab VM by using the [REST api](/rest/api/labservices/virtual-machines/reimage), [PowerShell](/powershell/module/az.labservices/update-azlabservicesvmreimage), or the [.NET SDK](/dotnet/api/azure.resourcemanager.labservices.labvirtualmachineresource.reimage).
+
+> [!WARNING]
+> After you reset a lab VM, all the data that you saved on the OS disk (usually the C: drive on Windows), and the temporary disk (usually the D: drive on Windows), is lost. Learn how you can [store the user data outside the lab VM](./troubleshoot-access-lab-vm.md#store-user-data-outside-the-lab-vm).
+
+To reset a lab VM in the Azure Lab Services website that's assigned to you:
+
+1. Go to the [Azure Lab Services website](https://labs.azure.com/virtualmachines) to view your virtual machines.
+
+1. For a specific lab VM, select **...** > **Reset**.
+
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-single-vm.png" alt-text="Screenshot that shows how to reset a lab VM in the Lab Services web portal, highlighting the Reset button.":::
+
+1. On the **Reset virtual machine** dialog box, select **Reset**.
+
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-single-vm-confirmation.png" alt-text="Screenshot that shows the confirmation dialog for resetting a single VM in the Lab Services web portal.":::
+
+Alternatively, if you have permissions across multiple labs, you can reset multiple VMs for a lab:
+
+1. Go to the [Azure Lab Services website](https://labs.azure.com).
+
+1. Select a lab, and then go to the **Virtual machine pool** tab.
+
+1. Select one or multiple VMs from the list, and then select **Reset** in the toolbar.
+
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-vm-button.png" alt-text="Screenshot that shows the virtual machine pool in the Lab Services web portal, highlighting the Reset button.":::
+
+1. On the **Reset virtual machine** dialog box, select **Reset**.
+
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-vms-dialog.png" alt-text="Screenshot that shows the reset virtual machine confirmation dialog in the Lab Services web portal.":::
+
+## Redeploy VMs
+
+When you use lab plans, introduced in the [April 2022 Update](lab-services-whats-new.md), you can now also redeploy a lab VM. This operation is labeled  **Troubleshoot** in the Azure Lab Services website and is available in the student's view of their VMs.
+
+When you redeploy a lab VM, Azure Lab Services will shut down the VM, move the VM to a new node in within the Azure infrastructure, and then power it back on. You can think of a redeploy operation as a refresh of the underlying VM for your lab. All data that you saved in the [OS disk](/azure/virtual-machines/managed-disks-overview#os-disk) (usually the C: drive on Windows) of the VM will still be available after the redeploy operation. Any data on the [temporary disk](/azure/virtual-machines/managed-disks-overview#temporary-disk) (usually the D: drive on Windows) is lost after a redeploy operation.
+
+You can only redeploy a lab VM in the Azure Lab Services website that is assigned to you.
+
+You can also redeploy a lab VM by using the [REST api](/rest/api/labservices/virtual-machines/redeploy), [PowerShell](/powershell/module/az.labservices/start-azlabservicesvmredeployment), or the [.NET SDK](/dotnet/api/azure.resourcemanager.labservices.labvirtualmachineresource.redeploy).
 
-:::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-vm-button.png" alt-text="Screenshot of virtual machine pool.  Reset button is highlighted.":::
+> [!WARNING]
+> After you redeploy a VM, all the data that you saved on the [temporary disk](/azure/virtual-machines/managed-disks-overview#temporary-disk) (D: drive by default on Windows) is lost.
 
-On the **Reset virtual machine(s)** dialog box, select **Reset**.
+To redeploy a lab VM in the Azure Lab Services website:
 
-:::image type="content" source="./media/how-to-reset-and-redeploy-vm/reset-vms-dialog.png" alt-text="Screenshot of reset virtual machine confirmation dialog.":::
+1. Go to the [Azure Lab Services website](https://labs.azure.com/virtualmachines) to view your virtual machines.
 
-### Redeploy VMs
+1. For a specific lab VM, select **...** > **Troubleshoot**.
 
-In the [April 2022 Update](lab-services-whats-new.md), redeploying VMs replaces the previous reset VM behavior.  In the Lab Services web portal: [https://labs.azure.com](https://labs.azure.com), the command is named **Troubleshoot** and is available in the student's view of their VMs.
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/redeploy-vms.png" alt-text="Screenshot that shows the Redeploy virtual machine menu option in the Lab Services web portal.":::
 
-If you're facing difficulties accessing their VM, redeploying the VM may provide a resolution for the issue. Redeploying, unlike resetting, doesn't cause the data on the OS to be lost.  When you [redeploy a VM](/troubleshoot/azure/virtual-machines/redeploy-to-new-node-windows), Azure Lab Services will shut down the VM, move it to a new host, and restart it.  You can think of it as a refresh of the underlying VM for your machine.  You don’t need to re-register to the lab or perform any other action.  Any data you saved in the OS disk (usually C: drive) of the VM will still be available after the redeploy operation.  Anything saved on the temporary disk (usually D: drive) will be lost.
+1. On the **Troubleshoot virtual machine** dialog box, select **Redeploy**.
 
-:::image type="content" source="./media/how-to-reset-and-redeploy-vm/redeploy-vms.png" alt-text="Screenshot of redeploy virtual machine menu option.":::
+    :::image type="content" source="./media/how-to-reset-and-redeploy-vm/redeploy-single-vm-confirmation.png" alt-text="Screenshot that shows the confirmation dialog for redeploying a single VM in the Lab Services web portal.":::
 
 ## Next steps
 

articles/lab-services/media/how-to-reset-and-redeploy-vm/redeploy-single-vm-confirmation.png

@@ -0,0 +1,88 @@
+---
+title: Troubleshoot lab VM access
+titleSuffix: Azure Lab Services
+description: Learn the different approaches for troubleshooting lab VMs in Azure Lab Services. Understand how each approach affects user data.
+services: lab-services
+ms.service: lab-services
+author: ntrogh
+ms.author: nicktrog
+ms.topic: troubleshooting
+ms.date: 12/05/2022
+---
+
+# Troubleshoot accessing lab VMs in Azure Lab Services
+
+In this article, you learn about the different approaches for troubleshooting lab VMs. Understand how each approach affects your lab environment and user data on the lab VM. There can be different reasons why you're unable to connect to a lab VM in Azure Lab Services, or why you're stuck to complete a course. For example, the underlying VM is experiencing issues, your organization's firewall settings have changed, or a software change in the lab VM operating system.
+
+## Symptoms
+
+To use and access a lab VM, you connect to it by using Remote Desktop (RDP) or Secure Shell (SSH). You may experience difficulties to access your lab VM:
+
+- You're unable to connect to the lab VM from your computer by using RDP or SSH. There might be a problem with the underlying VM, or a network or firewall configuration might prevent you from connecting.
+- After connecting to the lab VM, the VM is not working correctly. 
+
+## Troubleshooting steps
+
+1. If you're not able to connect to the lab VM with Remote Desktop (RDP) or Secure Shell (SSH):
+
+    1. [Redeploy your lab VM](./how-to-reset-and-redeploy-vm.md#redeploy-vms) to another infrastructure node, while maintaining the user data. 
+
+        This approach might help resolve issues with the underlying virtual machine. Learn more about [redeploying versus resetting a lab VM](#redeploy-versus-reset-a-lab-vm) and how they affect your user data.
+
+    1. [Verify your organization's firewall settings for your lab](./how-to-configure-firewall-settings.md) with the educator and IT admin.
+
+        A change in the organization's firewall or network settings might prevent your computer to connect to the lab VM.
+
+    1. If you still can't connect to the lab VM, [reset the lab VM](./how-to-reset-and-redeploy-vm.md#reset-vms).
+
+        > [!IMPORTANT]
+        > Resetting a lab VM deletes the user data in the VM. Make sure to [store the user data outside the lab VM](#store-user-data-outside-the-lab-vm).
+    
+1. After you connect to the lab VM, it's not working correctly.
+
+    The lab VM might be malfunctioning as a result of installing a software component, or making a change to the operating system configuration.
+
+    1. If the lab VM uses Windows, you might use the Windows System Restore built-in functionality to undo a previous change to the operating system. Verify with an educator or IT admin how to use [System Restore](https://support.microsoft.com/windows/use-system-restore-a5ae3ed9-07c4-fd56-45ee-096777ecd14e).
+
+    1. If the lab VM is still in an incorrect state, [reset the lab VM](./how-to-reset-and-redeploy-vm.md#reset-vms).
+
+        > [!IMPORTANT]
+        > Resetting a lab VM deletes the user data in the VM. Make sure to [store the user data outside the lab VM](#store-user-data-outside-the-lab-vm).
+
+## Redeploy versus reset a lab VM
+
+Azure Lab Services lets you redeploy, labeled *troubleshooting* in the Azure portal, or reset a lab VM. Both operations are similar, and result in the creation of a new virtual machine instance. However, there are fundamental differences that affect the user data on the lab VM.
+
+When you redeploy a lab VM, Azure Lab Services will shut down the VM, move the VM to a new node in within the Azure infrastructure, and then power it back on. You can think of a redeploy operation as a refresh of the underlying VM for your lab. All data that you saved in the [OS disk](/azure/virtual-machines/managed-disks-overview#os-disk) (usually the C: drive on Windows) of the VM will still be available after the redeploy operation. Any data on the [temporary disk](/azure/virtual-machines/managed-disks-overview#temporary-disk) (usually the D: drive on Windows) is lost after a redeploy operation and after a VM shutdown.
+
+Learn more about how to [redeploy a lab VM in the Azure Lab Services website](./how-to-reset-and-redeploy-vm.md#redeploy-vms).
+
+When you reset a lab VM, Azure Lab Services will shut down the VM, delete it, and recreate a new lab VM from the original template VM. You can think of a reset as a refresh of the entire VM. After you reset a lab VM, all the data that you saved on the OS disk (usually the C: drive on Windows), and the temporary disk (usually the D: drive on Windows), is lost. To avoid losing data on the VM, [store the user data outside the lab VM](#store-user-data-outside-the-lab-vm).
+
+Learn more about how to [reset a lab VM in the Azure Lab Services website](./how-to-reset-and-redeploy-vm.md#reset-vms).
+
+> [!NOTE]
+> Redeploying a VM is only available for lab VMs that you created in a lab plan. VMs that are connected to a lab account only support the reset operation.
+
+## Store user data outside the lab VM
+
+When you reset a lab VM, all user data on the VM is lost. To avoid losing this data, you have to store the user data outside of the lab VM. You have different options to configure the template VM:
+
+- [Use OneDrive to store user data](./how-to-prepare-windows-template.md#install-and-configure-onedrive).
+- [Attach external file storage](./how-to-attach-external-storage.md), such as Azure Files or Azure NetApp Files.
+
+## Create multiple labs for a course
+
+As students use a lab VM to advance through a course, they might get stuck at specific steps. For example, they're unable to install and configure a software component on the lab VM. To unblock students, you can create multiple labs, based off different template VMs, for each of the key stages in the course.
+
+Learn how to [set up a new lab](./tutorial-setup-lab.md#create-a-lab) and how to [create and manage templates](./how-to-create-manage-template.md).
+
+## Contact us for help
+
+If you have questions or need help, [create a support request](https://ms.portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview?DMC=troubleshoot), or ask [Azure community support](/answers/topics/azure-labservices.html).
+
+## Next steps
+
+- As a student, learn how to [reset or deploy lab VMs](./how-to-reset-and-redeploy-vm.md).
+- As an admin or educator, [attach external file storage to a lab](./how-to-attach-external-storage.md).
+- As an educator, [use OneDrive to store user data](./how-to-prepare-windows-template.md#install-and-configure-onedrive).