Merge pull request #10706 from paolomatarazzo/pm-qmr

QMR initial documentation

windows/configuration/images/icons/feedback.svg

@@ -0,0 +1,3 @@
+<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M15.75 10.3496C15.4857 10.2585 15.2441 10.1309 15.0254 9.9668C14.8158 9.80273 14.6335 9.61133 14.4785 9.39258C14.3236 9.17383 14.2051 8.93685 14.123 8.68164C14.041 8.42643 14 8.15755 14 7.875V2.625C14 2.26953 14.0684 1.93229 14.2051 1.61328C14.3418 1.29427 14.5286 1.01628 14.7656 0.779297C15.0117 0.533203 15.2943 0.341797 15.6133 0.205078C15.9323 0.0683594 16.2695 0 16.625 0H25.375C25.7305 0 26.0677 0.0683594 26.3867 0.205078C26.7057 0.341797 26.9837 0.533203 27.2207 0.779297C27.4668 1.01628 27.6582 1.29427 27.7949 1.61328C27.9316 1.93229 28 2.26953 28 2.625V7.875C28 8.23047 27.9316 8.56771 27.7949 8.88672C27.6582 9.20573 27.4668 9.48828 27.2207 9.73438C26.9837 9.97135 26.7057 10.1582 26.3867 10.2949C26.0677 10.4316 25.7305 10.5 25.375 10.5H20.4805L17.9922 13.002C17.737 13.2572 17.4271 13.3848 17.0625 13.3848C16.8984 13.3848 16.7298 13.3483 16.5566 13.2754C16.3014 13.1751 16.1009 13.0156 15.9551 12.7969C15.8184 12.5781 15.75 12.3366 15.75 12.0723V10.3496ZM17.5 11.0059L19.7559 8.75H25.375C25.612 8.75 25.8171 8.66341 25.9902 8.49023C26.1634 8.31706 26.25 8.11198 26.25 7.875V2.625C26.25 2.38802 26.1634 2.18294 25.9902 2.00977C25.8171 1.83659 25.612 1.75 25.375 1.75H16.625C16.388 1.75 16.1829 1.83659 16.0098 2.00977C15.8366 2.18294 15.75 2.38802 15.75 2.625V7.875C15.75 8.07552 15.7865 8.23503 15.8594 8.35352C15.9414 8.47201 16.0417 8.56315 16.1602 8.62695C16.2878 8.68164 16.4245 8.7181 16.5703 8.73633C16.7253 8.75456 16.8802 8.76367 17.0352 8.76367C17.1172 8.76367 17.1947 8.76367 17.2676 8.76367C17.3496 8.75456 17.4271 8.75 17.5 8.75V11.0059ZM3.5 10.5V10.3906C3.5 9.67969 3.64128 9.01432 3.92383 8.39453C4.20638 7.76562 4.58919 7.21875 5.07227 6.75391C5.55534 6.28906 6.11133 5.92448 6.74023 5.66016C7.37826 5.38672 8.04818 5.25 8.75 5.25C9.47917 5.25 10.1628 5.38672 10.8008 5.66016C11.4388 5.93359 11.9948 6.30729 12.4688 6.78125C12.9427 7.25521 13.3164 7.8112 13.5898 8.44922C13.8633 9.08724 14 9.77083 14 10.5C14 11.2292 13.8633 11.9128 13.5898 12.5508C13.3164 13.1888 12.9427 13.7448 12.4688 14.2188C11.9948 14.6927 11.4388 15.0664 10.8008 15.3398C10.1628 15.6133 9.47917 15.75 8.75 15.75C8.02083 15.75 7.33724 15.6133 6.69922 15.3398C6.0612 15.0664 5.50521 14.6927 5.03125 14.2188C4.55729 13.7448 4.18359 13.1888 3.91016 12.5508C3.63672 11.9128 3.5 11.2292 3.5 10.5ZM12.25 10.5V10.4316C12.25 9.95768 12.1543 9.51562 11.9629 9.10547C11.7715 8.6862 11.5163 8.32161 11.1973 8.01172C10.8783 7.70182 10.5046 7.45573 10.0762 7.27344C9.6569 7.09115 9.21484 7 8.75 7C8.26693 7 7.8112 7.0957 7.38281 7.28711C6.96354 7.4694 6.5944 7.72005 6.27539 8.03906C5.96549 8.34896 5.71484 8.7181 5.52344 9.14648C5.34115 9.57487 5.25 10.026 5.25 10.5C5.25 10.9831 5.34115 11.4388 5.52344 11.8672C5.71484 12.2865 5.96549 12.6556 6.27539 12.9746C6.5944 13.2845 6.96354 13.5352 7.38281 13.7266C7.8112 13.9089 8.26693 14 8.75 14C9.22396 14 9.67513 13.9089 10.1035 13.7266C10.5319 13.5352 10.901 13.2845 11.2109 12.9746C11.5299 12.6556 11.7806 12.2865 11.9629 11.8672C12.1543 11.4388 12.25 10.9831 12.25 10.5ZM0 20.5625C0 20.1888 0.0638021 19.8197 0.191406 19.4551C0.31901 19.0814 0.501302 18.7533 0.738281 18.4707C0.97526 18.179 1.25781 17.9466 1.58594 17.7734C1.92318 17.5911 2.29232 17.5 2.69336 17.5H14.8066C15.2077 17.5 15.5723 17.5911 15.9004 17.7734C16.2376 17.9466 16.5247 18.179 16.7617 18.4707C16.9987 18.7533 17.181 19.0814 17.3086 19.4551C17.4362 19.8197 17.5 20.1888 17.5 20.5625C17.5 21.9753 17.1855 23.224 16.5566 24.3086C15.9277 25.3841 14.9935 26.2591 13.7539 26.9336C12.9883 27.3529 12.1771 27.6354 11.3203 27.7812C10.4635 27.9271 9.60677 28 8.75 28C7.98438 28 7.21419 27.9362 6.43945 27.8086C5.67383 27.681 4.9401 27.4714 4.23828 27.1797C3.54557 26.8789 2.90755 26.487 2.32422 26.0039C1.75 25.5117 1.27148 24.9056 0.888672 24.1855C0.597005 23.6204 0.373698 23.0326 0.21875 22.4219C0.0729167 21.8112 0 21.1914 0 20.5625ZM15.75 20.5625C15.75 20.4349 15.7272 20.2936 15.6816 20.1387C15.6452 19.9837 15.5859 19.8424 15.5039 19.7148C15.431 19.5781 15.3353 19.4688 15.2168 19.3867C15.0983 19.2956 14.9616 19.25 14.8066 19.25H2.69336C2.53841 19.25 2.40169 19.2956 2.2832 19.3867C2.16471 19.4688 2.06445 19.5781 1.98242 19.7148C1.90951 19.8424 1.85026 19.9837 1.80469 20.1387C1.76823 20.2936 1.75 20.4349 1.75 20.5625C1.75 21.6016 1.94141 22.4857 2.32422 23.2148C2.70703 23.9349 3.21745 24.5228 3.85547 24.9785C4.5026 25.4251 5.24544 25.7487 6.08398 25.9492C6.93164 26.1497 7.82031 26.25 8.75 26.25C9.67969 26.25 10.5638 26.1497 11.4023 25.9492C12.25 25.7487 12.9928 25.4251 13.6309 24.9785C14.278 24.5228 14.793 23.9349 15.1758 23.2148C15.5586 22.4857 15.75 21.6016 15.75 20.5625Z" fill="#0883D9"/>
+</svg>

windows/configuration/includes/insider-note.md

@@ -0,0 +1,16 @@
+---
+author: paolomatarazzo
+ms.author: paoloma
+ms.topic: include
+ms.date: 01/11/2024
+---
+
+:::row:::
+:::column span="1":::
+:::image type="content" source="../images/insider.png" alt-text="Logo of Windows Insider." border="false":::
+:::column-end:::
+:::column span="3":::
+> [!IMPORTANT]
+>This article describes features or settings that are under development and only applicable to [Windows Insider Preview builds](/windows-insider/). The content is subject to change and may have dependencies on other features or services in preview.
+:::column-end:::
+:::row-end:::

windows/configuration/quick-machine-recovery/index.md

@@ -0,0 +1,231 @@
+---
+title: Quick Machine Recovery
+description: Learn about quick machine recovery and how to configure it with the RemoteRemediation configuration service provider (CSP).
+ms.topic: how-to
+ms.date: 03/14/2025
+ms.author: paoloma
+author: paolomatarazzo
+appliesto:
+  - "✅ <a href=\"https://learn.microsoft.com/windows-insider/flight-hub\" target=\"_blank\">Windows Insider</a>"
+---
+
+# Quick machine recovery
+
+[!INCLUDE [insider-note](../includes/insider-note.md)]
+
+Quick machine recovery is a feature that enables the recovery of Windows devices when they encounter critical errors that prevent them from booting. This feature can automatically search for remediations in the cloud and recover from widespread boot failures, significantly reducing the burden on IT administrators when multiple devices are affected.
+
+Building on the foundation of [Startup Repair][SMC-1], quick machine recovery uses a secure and connected [Windows Recovery Environment][SMC-2] to scan Windows Update for remediation options. This allows devices to be recovered without requiring manual intervention.
+
+## How it works
+
+There are two main settings of quick machine recovery: cloud remediation and auto remediation.
+
+### Cloud remediation
+
+:::row:::
+    :::column span="3":::
+Cloud remediation is the process of using Windows Update to find remediations and fix issues on devices:
+
+- When enabled, devices connect to the network and utilize Windows Update during recovery scenarios
+- When disabled, Windows uses Statup Repair as a local recovery option
+    :::column-end:::
+    :::column span="1":::
+:::image type="content" source="images/quick-machine-recovery-network.png" alt-text="Screnshot of quick machine recovery boot while attempting to connect to the network." border = "false" lightbox="images/quick-machine-recovery-network.png":::
+    :::column-end:::
+:::row-end:::
+
+> [!NOTE]
+> Quick machine recovery is a best-effort feature. It might not always be able to find a solution for every issue.
+
+### Auto remediation
+
+:::row:::
+    :::column span="3":::
+
+Auto remediation allows you to automate the recovery process:
+
+  - When enabled, the device connects automatically to Windows Update and tries to find a remediation. If a solution isn't found on the first attempt, the device retries without requiring manual intervention
+    :::column-end:::
+    :::column span="1":::
+:::image type="content" source="images/auto-remediation.png" alt-text="Screnshot of the Windows Recovery Environment in the auto remediation screen, showing that the device retries to find a solution." border = "false" lightbox="images/auto-remediation.png":::
+:::row-end:::
+:::row:::
+    :::column span="3":::
+  - When disabled or not configured, the device requires manual intervention to continue the recovery process
+
+    :::column-end:::
+    :::column span="1":::
+:::image type="content" source="images/quick-machine-recovery-winre.png" alt-text="Screnshot of Windows Recovery Environment showing the quick machine recovery option." border = "false"lightbox="images/quick-machine-recovery-winre.png":::
+
+:::row-end:::
+
+### Quick machine recovery process
+
+Here are the phases of the quick machine recovery process:
+
+1. **Device crash**: When the device fails to boot repeatedly, the system automatically detects the issue and initiates the recovery process
+1. **Boot to recovery**: The device boots into the recovery environment to initiate the quick machine recovery process
+1. **Network connection**: After a network connection is established, the device scans Windows Update for remediations
+1. **Remediation**
+    - If no solution is found, the system retries the process based on the configured retry scanning intervals and time-outs
+    - If a solution is found, the system downloads and applies it
+1. **Reboot**: After a remediation is applied, the device reboots:
+    - If the solution is successful, the device boots into Windows
+    - If the solution fails, the device reboots into the recovery environment again and the process repeats from step 2
+
+:::image type="content" source="images/diagram.png" alt-text="Quick machine recovery diagram showing the five phases of recovery." border="false" lightbox="images/diagram.png":::
+
+## Configuration
+
+Cloud remediation is enabled by default on Windows Home edition devices, while auto remediation is turned off by default. For Windows Pro and Enterprise editions, both cloud remediation and auto remediation are disabled by default. Organizations can decide the best configuration for their devices based on their specific needs.
+
+The configuration options consist of:
+
+- Enable or disable cloud remediation
+- Enable or disable auto remediation
+- Configure auto remediation scanning intervals and time-outs to optimize remediation triggers
+- Configure network connections to ensure smooth recovery workflows
+    > [!IMPORTANT]
+    > Currently, only wired and WPA/WPA2 password-based Wi-Fi networks are supported. Ensure your network uses this configuration for compatibility.
+
+[!INCLUDE [tab-intro](../../../includes/configure/tab-intro.md)]
+
+# [:::image type="icon" source="../images/icons/cmd.svg"::: **Command prompt**](#tab/cmd)
+
+To configure quick machine recovery using the command line, you must create an XML file with the desired settings and then use the `reagentc.exe` command to apply those settings.
+
+Use the following command to apply the settings:
+
+```cmd
+reagentc.exe /setrecoverysettings /path settings.xml
+```
+
+Where `settings.xml` is the path to the XML file containing the quick machine recovery configuration.
+
+### XML file example
+
+The following XML file example configures quick machine recovery with the following settings:
+
+- The Wi-Fi network has an SSID `ContosoWiFi` and a password `ContosoWiFiPassword`
+- Cloud remediation is enabled (`state="1"`)
+- Auto remediation is enabled (`state="1"`)
+  - The `totalwaittime` is set to 2,400 minutes (40 hours) and the `waitinterval` is set to 120 minutes (2 hours). Once configured, the system waits for 40 hours before rebooting, and it checks for remediation every 2 hours
+
+```xml
+<?xml version='1.0' encoding='utf-8'?>
+
+<WindowsRE>
+    <WifiCredential>
+        <Wifi ssid="ContosoWiFi" password="ContosoWiFiPassword" />
+    </WifiCredential>
+    <CloudRemediation state="1" />
+    <AutoRemediation state="1" totalwaittime="2400" waitinterval="120"/>
+</WindowsRE>
+```
+
+### Remove recovery settings
+
+To remove the configured recovery settings, run the following command from an elevated command prompt:
+
+```cmd
+reagentc.exe /clearrecoverysettings
+```
+
+# [:::image type="icon" source="../images/icons/intune.svg" border="false"::: **Intune/CSP**](#tab/intune)
+
+You can configure devices using a [custom policy][INT-1] with the [RemoteRemediation CSP][CSP-1].
+
+### Cloud remediation configuration
+
+Enable or disable cloud remediation using the following settings:
+
+| Setting |
+|--|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/EnableCloudRemediation`<br>- **Data type:** Boolean<br>- **Value:** `True`<br>- **Description**: When set to `True`, cloud remediation is enabled. |
+
+### Auto remediation configuration
+
+Configure the following settings to customize the auto remediation experience:
+
+| Setting |
+|--|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation`<br>- **Data type:** Boolean<br>- **Value:** `True`<br>- **Description**: When set to `True`, auto remediation is enabled. |
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/SetTimeToReboot`<br>- **Data type:** Integer<br>- **Value:** 1-4320 (default = 180)<br>- **Description**: Configure the time to reboot (in minutes) during auto remediation. The maximum time to reboot possible is 72 hours.|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/SetRetryInterval`<br>- **Data type:** Integer<br>- **Value:** 1-4320 (default = 30)<br>- **Description**: Configure the retry interval (in minutes) during auto remediation. The retry interval shouldn't be higher than the time to reboot.|
+
+### Wi-Fi network connection configuration
+
+To configure the Wi-Fi network connection used during recovery, use the following settings:
+
+|Setting|
+|--|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkSSID`<br>- **Data type:** string<br>- **Value:** Wi-Fi network Service Set Identifier (SSID)|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPassword`<br>- **Data type:** string<br>- **Value:** Wi-Fi network password|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionType`<br>- **Data type:** Integer<br>- **Value:** `0` = The password isn't encrypted; `1` = The password is encrypted with the MDM certificate, `2` = The password is encrypted with custom certificate. When this value is used, you must also specify the custom store name in the `NetworkPasswordEncryptionStore` node.|
+|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionStore`<br>- **Data type:** string<br>- **Value:** When a value of `2` is contained in `NetworkPasswordEncryptionType`, specify the store name where the certificate for decrypting the Network Password is stored.|
+
+---
+
+### Verify Recovery Settings
+
+To check the configured recovery settings, run the following command from an elevated command prompt:
+
+```cmd
+reagentc.exe /getrecoverysettings
+```
+
+Output example:
+
+```console
+C:\>reagentc.exe /getrecoverysettings
+<?xml version='1.0' encoding='utf-8'?>
+
+<WindowsRE>
+    <WifiCredential>
+        <Wifi ssid="ContosoWiFi" password="ContosoWiFiPassword" />
+    </WifiCredential>
+    <CloudRemediation state="1" />
+    <AutoRemediation state="1" totalwaittime="2400" waitinterval="120"/>
+</WindowsRE>
+
+REAGENTC.EXE: Operation Successful.
+```
+
+## Test mode
+
+:::row:::
+    :::column span="3":::
+Quick machine recovery offers a *test mode*, providing a controlled, simulated environment for you to validate your configurations and the auto remediation process without triggering an actual system failure. Test mode allows you to verify that the recovery experience functions as expected before deployment to production systems.
+    :::column-end:::
+    :::column span="1":::
+:::image type="content" source="images/quick-machine-recovery-test-mode.png" alt-text="Screenshot of the Windows boot screen where quick machine recovery is attempting to connect to the network." border="false" lightbox="images/quick-machine-recovery-test-mode.png":::
+    :::column-end:::
+:::row-end:::
+
+To simulate the quick machine recovery experience, use the following commands from an elevated command prompt:
+
+1. Enable test mode:
+    ```cmd
+    reagentc.exe /SetRecoveryTestmode
+    ```
+1. Configure Windows to boot to Windows Recovery Environment on the next boot:
+    ```cmd
+    reagentc.exe /BootToRe
+    ```
+1. Reboot your device. The system goes through autoremediation of a simulated crash and reboots back to Windows
+
+<!--
+1. To verify the quick machine recovery remediation, go to **Settings** > **Windows Update** > **[Update history](ms-settings:windowsupdate-history)**. The remediation should be listed under **Quality updates**-->
+
+### :::image type="icon" source="../images/icons/feedback.svg" border="false"::: Provide feedback
+
+To provide feedback for quick machine recovery, open [**Feedback Hub**][FHUB] and use the category **Recovery and Uninstall** > **Quick Machine Recovery**.
+
+<!--links-->
+
+[SMC-1]: https://support.microsoft.com/topic/85deb0b9-fa3d-44a3-a3d0-d0f1515c2c9b
+[SMC-2]: https://support.microsoft.com/topic/0eb14733-6301-41cb-8d26-06a12b42770b
+[FHUB]: feedback-hub://?tabid=2&newFeedback=true&feedbackType=1
+[CSP-1]: /windows/client-management/mdm/remoteremediation-csp
+[INT-1]: /mem/intune/configuration/settings-catalog

windows/configuration/toc.yml

@@ -15,6 +15,8 @@ items:
   href: settings/page-visibility.md
 - name: Microsoft Store
   href: store/toc.yml
+- name: Quick machine recovery
+  href: quick-machine-recovery/index.md
 - name: Cellular settings
   href: cellular/provisioning-apn.md
 - name: Windows kiosk options
@@ -36,5 +38,4 @@ items:
     - name: Configure Custom Logon
       href: custom-logon/index.md
     - name: Troubleshoot
-      href: custom-logon/troubleshoot.md
-
+      href: custom-logon/troubleshoot.md