diff --git a/windows/client-management/images/9687427-text-actions-click-to-do.png b/windows/client-management/images/9687427-text-actions-click-to-do.png new file mode 100644 index 0000000000..edd75491e0 Binary files /dev/null and b/windows/client-management/images/9687427-text-actions-click-to-do.png differ diff --git a/windows/client-management/manage-click-to-do.md b/windows/client-management/manage-click-to-do.md new file mode 100644 index 0000000000..b4e8469363 --- /dev/null +++ b/windows/client-management/manage-click-to-do.md @@ -0,0 +1,106 @@ +--- +title: Manage Click to Do for Windows clients +description: Learn how to manage Click to Do for commercial environments and about Click to Do features. +ms.topic: how-to +ms.subservice: windows-copilot +ms.date: 03/28/2025 +ms.author: mstewart +author: mestew +ms.collection: + - windows-copilot + - magic-ai-copilot +appliesto: +- ✅ Copilot+ PCs +--- + +# Manage Click to Do + +>**Looking for consumer information?** See [Click to Do: do more with what's on your screen](https://support.microsoft.com/topic/6848b7d5-7fb0-4c43-b08a-443d6d3f5955). + +Click to Do (preview) helps users to get things done faster by identifying text and images that are currently on their screen so they can perform actions on them. This article provides information about Click to Do and how to manage it in a commercial environment. + +> [!NOTE] +> - The policy to manage Click to Do is now available in preview to Copilot+ PCs through the Windows Insider Program. For more information, see the [Windows Insider blog](https://blogs.windows.com/windows-insider/2025/03/28/announcing-windows-11-insider-preview-build-26120-3653-beta-channel/). +> - In-market commercial devices are defined as devices with an Enterprise (ENT) or Education (EDU) SKU or any premium SKU device that is managed by an IT administrator (whether via Microsoft Endpoint Manager or other endpoint management solution), has a volume license key, or is joined to a domain. Commercial devices during Out of Box Experience (OOBE) are defined as those with ENT or EDU SKU or any premium SKU device that has a volume license key or is Microsoft Entra joined. +> - Click to Do is optimized for select languages English, Chinese (simplified), French, German, Japanese, and Spanish. Content-based and storage limitations apply. For more information, see [https://aka.ms/copilotpluspcs](https://aka.ms/copilotpluspcs). + +## What is Click to Do? + +Click to Do (preview) analyzes what's on the screen and then allows users to choose the text or image they want to take action on. Users can open Click to Do by using **Windows key** + **Q** or with **Windows key** + **mouse click**. Other entry points for Click to Do include Snipping Tool, search results, and the Start menu. + +The analysis of screenshots is always performed locally on the device. Analysis only begins after users actively engage with Click to Do and ends when they exit Click to Do. Click to Do only identifies text and images, not the content of those text or images. It doesn't analyze any content in, for example, minimized applications that aren't on the screen. + +Content is only shared if users choose to complete an action like **Search the web**. When Click to Do is active, the cursor is blue and white. The cursor also changes shape depending on the type of info beneath it. What users can do with the info changes based on what kind of content Click to Do detects. For instance, users can perform actions on text such as copy, summarize or rewrite it, or share it. For images, users can perform actions such as copy, save, or blurring the background using Microsoft Photos. + +:::image type="content" source="images/9687427-text-actions-click-to-do.png" alt-text="Screenshot of the text actions in Click to Do" lightbox="images/9687427-text-actions-click-to-do.png"::: + + +## System requirements + +Click to Do has the following minimum requirements: + +- A [Copilot+ PC](https://aka.ms/copilotpluspcs) + - 40 TOPs NPU ([neural processing unit](https://support.microsoft.com/windows/all-about-neural-processing-units-npus-e77a5637-7705-4915-96c8-0c6a975f9db4)) + - 16 GB RAM + - 8 logical processors + - 256 GB storage capacity + +The more intelligent text actions are available only on Snapdragon-powered Copilot+ PCs today when your language is set to English with support for AMD and Intel-powered Copilot+ PCs coming soon. + + +## Configure policy for Click to Do + +When activated, Click to Do takes a screenshot of the user's screen and analyzes it to present actions. Click to Do ends when users exit it, and it can't take screenshots while closed. Screenshot analysis is always performed locally on the device. By default, Click to Do is enabled for users. + +The policy setting below allows you to determine whether Click to Do is available for users on their device: + +|   | Setting | +|---|---| +| **CSP** | ./Device/Vendor/MSFT/Policy/Config/WindowsAI/[DisableClickToDo](mdm/policy-csp-windowsai.md#disableclicktodo)

./User/Vendor/MSFT/Policy/Config/WindowsAI/[DisableClickToDo](mdm/policy-csp-windowsai.md#disableclicktodo)| +| **Group policy** | Computer Configuration > Administrative Templates > Windows Components > Windows AI > **Disable Click to Do**

User Configuration > Administrative Templates > Windows Components > Windows AI > **Disable Click to Do**| + +- When the policy is enabled, the Click to Do component and entry points won't be available to users. +- When the policy is disabled or not configured, users will have Click to Do available on their device. + +> [!Important] +> This policy doesn't affect Click to Do in Recall. For more information, see [Manage Recall](manage-recall.md). + +## Click to Do privacy considerations + +When you choose to send info from Click to Do to an app, like Paint, Click to Do will temporarily save this info in order to complete the transfer. Click to Do creates a temporary file in the following location: + +- `C:\Users\{username}\AppData\Local\Temp` + +Temporary files may also be saved when you choose send feedback. These temporary files aren't saved long term. Click to Do doesn't keep any content from your screen after completing the requested action, but some [diagnostic data](/windows/privacy/configure-windows-diagnostic-data-in-your-organization) is gathered to keep Click to Do secure, up to date, and working. + +Click to Do's more intelligent text actions, including **Summarize**, **Rewrite (Casual)**, **Rewrite (Formal)**,**Rewrite (Refine)**, and **Create a bulleted list** are powered by a state-of-the-art small language model called Phi Silica. Phi Silica leverages the NPU and the language model runs locally on Copilot+ PCs. Phi Silica ships inbox with Windows on Copilot+ PCs. + +When a user clicks on the Click to Do text actions, the selected text and the chosen action are sent to Phi Silica as part of a prompt. Phi Silica intelligently rewrites the selected text as per the user's request and streams back the response from the model. Phi Silica provides responses quickly and efficiently, using little power. For more information, see [Phi Silica, small but mighty on-device SLM](https://blogs.windows.com/windowsexperience/?p=179250). + +In keeping with Microsoft's commitment to data privacy and security, all saved images and processed data are kept on the device and processed locally. However, Click to Do allows you to choose if you want to get more information about your selected content online. When you choose one of the following Click to Do actions, the selected content is sent to the online provider from your local device to complete your request: + +- **Search the web**: Sends the selected content to Bing using Microsoft Edge +- **Open website**: Opens the selected website in your default browser +- **Visual search with Bing**: Sends the selected content to [Bing visual search](https://support.microsoft.com/topic/62771a0c-4daa-47e4-a9f7-e1bfa85f0d7c) using your default browser + + +## Microsoft's commitment to responsible AI and Privacy + +Microsoft has been working to advance AI responsibly since 2017, when we first defined our AI principles and later operationalized our approach through our Responsible AI Standard. Privacy and security are core principles as we develop and deploy AI systems. We work to help our customers use our AI products responsibly, sharing our learnings, and building trust-based partnerships. For more about our responsible AI efforts, the principles that guide us, and the tools and capabilities we've created to assure that we develop AI technology responsibly, see [Responsible AI](https://www.microsoft.com/ai/responsible-ai). + +To provide clarity on how each AI feature works, it's important for you to understand its capabilities and limitations. You should understand the choices available to you in an AI feature and the responsibility associated with those choices. + +Click to Do suggests actions that you can take, and you can choose the apps that will be the provider (if applicable) for those actions. Once you choose the action and provider for the action, the results from that action are the responsibility of the provider. For example, from Click to Do you can choose the action Remove background with Paint, which means you've chosen Paint as the provider for the action. Once you have selected the action from the Click to Do context menu, it launches the Paint app and the selected image is processed by Paint. + + +Click to Do uses optical character recognition (OCR) on your PC to detect text entities on screenshots. For more information about OCR, see [Transparency note and use cases for OCR](/legal/cognitive-services/computer-vision/ocr-transparency-note). + +Click to Do's intelligent text actions use a small language model called Phi Silica. For more information on Phi Silica, see [Get started with Phi Silica in the Windows App SDK](/windows/ai/apis/phi-silica#responsible-ai). For information about the Responsible AI principles guiding Phi Silica deployment and the safety measures in place when using generative language models, see [Responsible Generative AI Development on Windows](/windows/ai/rai). + + +Click to Do's models have undergone fairness assessments, alongside comprehensive responsible AI, security and privacy assessments, to make sure the technology is effective and equitable while adhering to Microsoft's Responsible AI best practices. + +## Related links + +- [Policy CSP - WindowsAI](/windows/client-management/mdm/policy-csp-windowsai) +- [Responsible AI](https://www.microsoft.com/ai/responsible-ai) \ No newline at end of file diff --git a/windows/client-management/mdm/policies-in-preview.md b/windows/client-management/mdm/policies-in-preview.md index b3ead6b748..26e00d9b59 100644 --- a/windows/client-management/mdm/policies-in-preview.md +++ b/windows/client-management/mdm/policies-in-preview.md @@ -1,7 +1,7 @@ --- title: Configuration service provider preview policies description: Learn more about configuration service provider (CSP) policies that are available for Windows Insider Preview. -ms.date: 02/13/2025 +ms.date: 03/26/2025 ms.topic: generated-reference --- @@ -141,6 +141,17 @@ This article lists the policies that are applicable for Windows Insider Preview - [TS_SERVER_REMOTEAPP_USE_SHELLAPPRUNTIME](policy-csp-remotedesktopservices.md#ts_server_remoteapp_use_shellappruntime) +## RemoteRemediation CSP + +- [EnableCloudRemediation](remoteremediation-csp.md#cloudremediationsettingsenablecloudremediation) +- [EnableAutoRemediation](remoteremediation-csp.md#cloudremediationsettingsautoremediationsettingsenableautoremediation) +- [SetTimeToReboot](remoteremediation-csp.md#cloudremediationsettingsautoremediationsettingssettimetoreboot) +- [SetRetryInterval](remoteremediation-csp.md#cloudremediationsettingsautoremediationsettingssetretryinterval) +- [NetworkSSID](remoteremediation-csp.md#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkssid) +- [NetworkPassword](remoteremediation-csp.md#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpassword) +- [NetworkPasswordEncryptionType](remoteremediation-csp.md#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpasswordencryptiontype) +- [NetworkPasswordEncryptionStore](remoteremediation-csp.md#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpasswordencryptionstore) + ## SettingsSync - [EnableWindowsbackup](policy-csp-settingssync.md#enablewindowsbackup) diff --git a/windows/client-management/mdm/policy-csp-admx-desktop.md b/windows/client-management/mdm/policy-csp-admx-desktop.md index 89fc9aff2b..4dbafefca9 100644 --- a/windows/client-management/mdm/policy-csp-admx-desktop.md +++ b/windows/client-management/mdm/policy-csp-admx-desktop.md @@ -1,7 +1,7 @@ --- title: ADMX_Desktop Policy CSP description: Learn more about the ADMX_Desktop Area in Policy CSP. -ms.date: 03/12/2025 +ms.date: 03/20/2025 ms.topic: generated-reference --- @@ -224,7 +224,7 @@ This setting prevents users from trying to enable or disable Active Desktop whil If you disable this setting or don't configure it, Active Desktop is disabled by default, but users can enable it. > [!NOTE] -> If both the "Enable Active Desktop" setting and the "Disable Active Desktop" setting are enabled, the "Disable Active Desktop" setting is ignored. If the "Turn on Classic Shell" setting (in User Configuration\Administrative Templates\Windows Components\Windows Explorer) is enabled, Active Desktop is disabled, and both of these policies are ignored. +> If both the "Enable Active Desktop" setting and the "Disable Active Desktop" setting are enabled, the "Disable Active Desktop" setting is ignored. If the "Turn on Classic Shell" setting ( in User Configuration\Administrative Templates\Windows Components\Windows Explorer) is enabled, Active Desktop is disabled, and both of these policies are ignored. diff --git a/windows/client-management/mdm/policy-csp-windowsai.md b/windows/client-management/mdm/policy-csp-windowsai.md index 4708cd0e55..a8007969a9 100644 --- a/windows/client-management/mdm/policy-csp-windowsai.md +++ b/windows/client-management/mdm/policy-csp-windowsai.md @@ -1,7 +1,7 @@ --- title: WindowsAI Policy CSP description: Learn more about the WindowsAI Area in Policy CSP. -ms.date: 03/26/2025 +ms.date: 03/27/2025 ms.topic: generated-reference --- @@ -22,7 +22,7 @@ ms.topic: generated-reference | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -91,7 +91,7 @@ This policy setting allows you to determine whether the Recall optional componen | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 [10.0.26100] and later | +| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -158,13 +158,75 @@ If you set this policy to disabled, end users will have a choice to save snapsho + +## DisableClickToDo + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```User +./User/Vendor/MSFT/Policy/Config/WindowsAI/DisableClickToDo +``` + +```Device +./Device/Vendor/MSFT/Policy/Config/WindowsAI/DisableClickToDo +``` + + + + +Click to Do lets people take action on content on their screens. When activated, it takes a screenshot of their screen and analyzes it to present actions. Click to Do ends when they exit it, and it can't take screenshots while closed. Screenshot analysis is always performed locally on their device. By default, Click to Do is enabled for users. This policy setting allows you to determine whether Click to Do is available for users on their device. When the policy is enabled, the Click to Do component and entry points won't be available to users. When the policy is disabled, users will have Click to Do available on their device. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 1 | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 | Click to Do is enabled. | +| 1 (Default) | Click to Do is disabled. | + + + +**Group policy mapping**: + +| Name | Value | +|:--|:--| +| Name | DisableClickToDo | +| Path | WindowsAI > AT > WindowsComponents > WindowsAI | + + + + + + + + ## DisableCocreator | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
❌ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | @@ -226,7 +288,7 @@ This policy setting allows you to control whether Cocreator functionality is dis | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
❌ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | @@ -288,7 +350,7 @@ This policy setting allows you to control whether generative fill functionality | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
❌ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | @@ -371,7 +433,6 @@ This policy setting determines which app opens when the user presses the Copilot The property value is the Application User Model ID (AUMID) for the target application. For example: the Microsoft 365 Copilot app is `Microsoft.MicrosoftOfficeHub_8wekyb3d8bbwe!Microsoft.MicrosoftOfficeHub`. For more information, see [Find the application user model ID of an installed app](/windows/configuration/store/find-aumid?tabs=ps%2Cexplorer&pivots=windows-11). - @@ -408,7 +469,7 @@ The property value is the Application User Model ID (AUMID) for the target appli | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
✅ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -477,7 +538,7 @@ For example: `code.exe;Microsoft.WindowsNotepad_8wekyb3d8bbwe!App;ms-teams.exe` | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
✅ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -542,7 +603,7 @@ Adding `https://www.WoodgroveBank.com` to the list would also filter `https://Ac | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
✅ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -618,7 +679,7 @@ Snapshots aren't deleted until the maximum storage allocation for Recall is reac | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
✅ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | +| ✅ Device
✅ User | ❌ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 24H2 with [KB5052093](https://support.microsoft.com/help/5052093) [10.0.26100.3323] and later
✅ Windows Insider Preview | @@ -771,4 +832,4 @@ This policy setting allows you to turn off Windows Copilot. ## Related articles -[Policy configuration service provider](policy-configuration-service-provider.md) +[Policy configuration service provider](policy-configuration-service-provider.md) \ No newline at end of file diff --git a/windows/client-management/mdm/remoteremediation-csp.md b/windows/client-management/mdm/remoteremediation-csp.md new file mode 100644 index 0000000000..d19c21521d --- /dev/null +++ b/windows/client-management/mdm/remoteremediation-csp.md @@ -0,0 +1,551 @@ +--- +title: RemoteRemediation CSP +description: Learn more about the RemoteRemediation CSP. +ms.date: 03/26/2025 +ms.topic: generated-reference +--- + + + + +# RemoteRemediation CSP + +[!INCLUDE [Windows Insider tip](includes/mdm-insider-csp-note.md)] + + + + + + +The following list shows the RemoteRemediation configuration service provider nodes: + +- ./Vendor/MSFT/RemoteRemediation + - [CloudRemediationSettings](#cloudremediationsettings) + - [AutoRemediationSettings](#cloudremediationsettingsautoremediationsettings) + - [EnableAutoRemediation](#cloudremediationsettingsautoremediationsettingsenableautoremediation) + - [SetRetryInterval](#cloudremediationsettingsautoremediationsettingssetretryinterval) + - [SetTimeToReboot](#cloudremediationsettingsautoremediationsettingssettimetoreboot) + - [EnableCloudRemediation](#cloudremediationsettingsenablecloudremediation) + - [NetworkSettings](#cloudremediationsettingsnetworksettings) + - [NetworkCredentials](#cloudremediationsettingsnetworksettingsnetworkcredentials) + - [NetworkPassword](#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpassword) + - [NetworkPasswordEncryptionStore](#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpasswordencryptionstore) + - [NetworkPasswordEncryptionType](#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkpasswordencryptiontype) + - [NetworkSSID](#cloudremediationsettingsnetworksettingsnetworkcredentialsnetworkssid) + + + +## CloudRemediationSettings + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings +``` + + + + +Interior node containing settings related to cloud remediation. Delete on this node will reset all cloud remediation settings to their default values. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `node` | +| Access Type | Add, Delete, Get, Replace | +| Atomic Required | True | + + + + + + + + + +### CloudRemediationSettings/AutoRemediationSettings + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings +``` + + + + +Interior node containing settings related to auto remediation. Delete on this node will reset all auto remediation settings to their default values. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `node` | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +#### CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation +``` + + + + +Enable or disable auto remediation. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `bool` | +| Access Type | Add, Delete, Get, Replace | +| Dependency [EnableCloudRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/EnableCloudRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| true | Auto remediation enabled. | +| false | Auto remediation disabled. | + + + + + + + + + +#### CloudRemediationSettings/AutoRemediationSettings/SetRetryInterval + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/SetRetryInterval +``` + + + + +Get/set the retry interval (in minutes) during auto cloud remediation. The retry interval shouldn't be higher than the time to reboot. "SetRetryInterval" is dependent on "EnableAutoRemediation" and only takes effect if "EnableAutoRemediation" is set to true. Otherwise, an invalid argument error will be returned and no changes will be made. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[1,4320]` | +| Dependency [EnableAutoRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + + + + + + + +#### CloudRemediationSettings/AutoRemediationSettings/SetTimeToReboot + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/SetTimeToReboot +``` + + + + +Get/set the time to reboot (in minutes) during auto cloud remediation. The maximum time to reboot possible is 72 hours. "SetTimeToReboot" is dependent on "EnableAutoRemediation" and only takes effect if "EnableAutoRemediation" is set to true. Otherwise an invalid argument error will be returned and no changes will be made. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[1-4320]` | +| Dependency [EnableAutoRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + + + + + + + +### CloudRemediationSettings/EnableCloudRemediation + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/EnableCloudRemediation +``` + + + + +Enable or disable cloud remediation. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `bool` | +| Access Type | Add, Delete, Get, Replace | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| true | Cloud remediation enabled. | +| false | Cloud remediation disabled. | + + + + + + + + + +### CloudRemediationSettings/NetworkSettings + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings +``` + + + + +Interior node containing settings related to network. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `node` | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +#### CloudRemediationSettings/NetworkSettings/NetworkCredentials + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials +``` + + + + +Interior node containing settings related to network credentials. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `node` | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +##### CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPassword + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPassword +``` + + + + +Get/Set the password for the wifi network that cloud remediation will attempt to connect during cloud remediation. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `chr` (string) | +| Access Type | Add, Delete, Get, Replace | +| Dependency [EnableCloudRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + + + + + + + +##### CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionStore + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionStore +``` + + + + +The encryption store that's specified if we are using a custom certificate for password encryption. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `chr` (string) | +| Access Type | Add, Delete, Get, Replace | +| Dependency [EnableCloudRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings//AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + + + + + + + +##### CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionType + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionType +``` + + + + +The type of encryption that might be used for the network password. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `int` | +| Access Type | Add, Delete, Get, Replace | +| Dependency [EnableCloudRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings//AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 1 | No encryption. | +| 2 | Encrypt using Mdm certificate. | +| 3 | Encrypt with custom certificate. | + + + + + + + + + +##### CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkSSID + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview | + + + +```Device +./Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkSSID +``` + + + + +Get/Set the network SSID that cloud remediation will attempt to connect to during remediation. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | `chr` (string) | +| Access Type | Add, Delete, Get, Replace | +| Dependency [EnableCloudRemediation] | Dependency Type: `DependsOn`
Dependency URI: `Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation`
Dependency Allowed Value: `true`
Dependency Allowed Value Type: `ENUM`
| + + + + + + + + + + + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/remoteremediation-ddf-file.md b/windows/client-management/mdm/remoteremediation-ddf-file.md new file mode 100644 index 0000000000..0cd36d957d --- /dev/null +++ b/windows/client-management/mdm/remoteremediation-ddf-file.md @@ -0,0 +1,479 @@ +--- +title: RemoteRemediation DDF file +description: View the XML file containing the device description framework (DDF) for the RemoteRemediation configuration service provider. +ms.date: 03/26/2025 +ms.topic: generated-reference +--- + + + +# RemoteRemediation DDF file + +The following XML file contains the device description framework (DDF) for the RemoteRemediation configuration service provider. + +```xml + +]> + + 1.2 + + + + RemoteRemediation + ./Vendor/MSFT + + + + + The root node for remote remediation function. + + + + + + + + + + + + + + 99.9.99999 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBD;0xBF;0xCA;0xCB; + + + + CloudRemediationSettings + + + + + + + + Interior node containing settings related to cloud remediation. Delete on this node will reset all cloud remediation settings to their default values. + + + + + + + + + + + + + + + + EnableCloudRemediation + + + + + + + + Enable or disable cloud remediation. + + + + + + + + + + + + + + + true + Cloud remediation enabled + + + false + Cloud remediation disabled + + + + + + AutoRemediationSettings + + + + + + + + Interior node containing settings related to auto remediation. Delete on this node will reset all auto remediation settings to their default values. + + + + + + + + + + + + + + + EnableAutoRemediation + + + + + + + + Enable or disable auto remediation. + + + + + + + + + + + + + + + true + Auto remediation enabled + + + false + Auto remediation disabled + + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/EnableCloudRemediation + + + true + Cloud remediation enabled + + + + + + + + + SetTimeToReboot + + + + + + + + Get/set the time to reboot (in minutes) during auto cloud remediation. The maximum time to reboot possible is 72 hours. "SetTimeToReboot" is dependent on "EnableAutoRemediation" and only takes effect if "EnableAutoRemediation" is set to true. Otherwise an invalid argument error will be returned and no changes will be made. + + + + + + + + + + + + + + [1-4320] + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation + + + true + Auto remediation enabled + + + + + + + + + SetRetryInterval + + + + + + + + Get/set the retry interval (in minutes) during auto cloud remediation. The retry interval should not be higher than the time to reboot. "SetRetryInterval" is dependent on "EnableAutoRemediation" and only takes effect if "EnableAutoRemediation" is set to true. Otherwise, an invalid argument error will be returned and no changes will be made. + + + + + + + + + + + + + + [1,4320] + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation + + + true + Auto remediation enabled + + + + + + + + + + NetworkSettings + + + + + + + + Interior node containing settings related to network. + + + + + + + + + + + + + + + NetworkCredentials + + + + + + + + Interior node containing settings related to network credentials. + + + + + + + + + + + + + + + NetworkSSID + + + + + + + + Get/Set the network SSID that cloud remediation will attempt to connect to during remediation. + + + + + + + + + + + + + + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation + + + true + Cloud remediation enabled + + + + + + + + + NetworkPassword + + + + + + + + Get/Set the password for the wifi network that cloud remediation will attempt to connect during cloud remediation. + + + + + + + + + + + + + + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/EnableAutoRemediation + + + true + Cloud remediation enabled + + + + + + + + + NetworkPasswordEncryptionType + + + + + + + + The type of encryption that might be used for the network password. + + + + + + + + + + + + + + + 1 + No encryption + + + 2 + Encrypt using Mdm certificate + + + 3 + Encrypt with custom certificate + + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings//AutoRemediationSettings/EnableAutoRemediation + + + true + Cloud remediation enabled + + + + + + + + + NetworkPasswordEncryptionStore + + + + + + + + The encryption store that is specified if we are using a custom certificate for password encryption. + + + + + + + + + + + + + + + + + + Vendor/MSFT/RemoteRemediation/CloudRemediationSettings//AutoRemediationSettings/EnableAutoRemediation + + + true + Cloud remediation enabled + + + + + + + + + + + + +``` + +## Related articles + +[RemoteRemediation configuration service provider reference](remoteremediation-csp.md) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index 4b5c7ff09c..28c696c112 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -866,6 +866,11 @@ items: items: - name: RemoteFind DDF file href: remotefind-ddf-file.md + - name: RemoteRemediation + href: remoteremediation-csp.md + items: + - name: RemoteRemediation DDF file + href: remoteremediation-ddf-file.md - name: RemoteWipe href: remotewipe-csp.md items: diff --git a/windows/client-management/toc.yml b/windows/client-management/toc.yml index 955dee1921..149a74c64d 100644 --- a/windows/client-management/toc.yml +++ b/windows/client-management/toc.yml @@ -50,6 +50,8 @@ items: href: device-update-management.md - name: Updated Windows and Microsoft 365 Copilot Chat experience href: manage-windows-copilot.md + - name: Manage Click to Do + href: manage-click-to-do.md - name: Manage Recall href: manage-recall.md - name: Reference for sensitive information filtering in Recall diff --git a/windows/configuration/images/icons/feedback.svg b/windows/configuration/images/icons/feedback.svg new file mode 100644 index 0000000000..cd887f3a0f --- /dev/null +++ b/windows/configuration/images/icons/feedback.svg @@ -0,0 +1,3 @@ + + + diff --git a/windows/configuration/images/insider.png b/windows/configuration/images/insider.png new file mode 100644 index 0000000000..dbe00408cb Binary files /dev/null and b/windows/configuration/images/insider.png differ diff --git a/windows/configuration/includes/insider-note.md b/windows/configuration/includes/insider-note.md new file mode 100644 index 0000000000..a1160f8047 --- /dev/null +++ b/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::: diff --git a/windows/configuration/quick-machine-recovery/images/auto-remediation.png b/windows/configuration/quick-machine-recovery/images/auto-remediation.png new file mode 100644 index 0000000000..cd2661c837 Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/auto-remediation.png differ diff --git a/windows/configuration/quick-machine-recovery/images/boot-recovery.png b/windows/configuration/quick-machine-recovery/images/boot-recovery.png new file mode 100644 index 0000000000..5a5635fc27 Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/boot-recovery.png differ diff --git a/windows/configuration/quick-machine-recovery/images/diagram.png b/windows/configuration/quick-machine-recovery/images/diagram.png new file mode 100644 index 0000000000..385bdc6a9e Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/diagram.png differ diff --git a/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-network.png b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-network.png new file mode 100644 index 0000000000..54de1313b8 Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-network.png differ diff --git a/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-settings.png b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-settings.png new file mode 100644 index 0000000000..dac1200e44 Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-settings.png differ diff --git a/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-test-mode.png b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-test-mode.png new file mode 100644 index 0000000000..d8585a720f Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-test-mode.png differ diff --git a/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-winre.png b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-winre.png new file mode 100644 index 0000000000..bfcafb3d92 Binary files /dev/null and b/windows/configuration/quick-machine-recovery/images/quick-machine-recovery-winre.png differ diff --git a/windows/configuration/quick-machine-recovery/index.md b/windows/configuration/quick-machine-recovery/index.md new file mode 100644 index 0000000000..89b736888d --- /dev/null +++ b/windows/configuration/quick-machine-recovery/index.md @@ -0,0 +1,242 @@ +--- +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/28/2025 +ms.author: paoloma +author: paolomatarazzo +appliesto: + - "✅ Windows Insider" +--- + +# 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 Startup Repair as a local recovery option + :::column-end::: + :::column span="1"::: +:::image type="content" source="images/quick-machine-recovery-network.png" alt-text="Screenshot 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="Diagram of quick machine recovery 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 + + + + + + + + + +``` + +### 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`
- **Data type:** Boolean
- **Value:** `True`
- **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`
- **Data type:** Boolean
- **Value:** `True`
- **Description**: When set to `True`, auto remediation is enabled. | +|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/AutoRemediationSettings/SetTimeToReboot`
- **Data type:** Integer
- **Value:** 1-4320 (default = 180)
- **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`
- **Data type:** Integer
- **Value:** 1-4320 (default = 30)
- **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`
- **Data type:** string
- **Value:** Wi-Fi network Service Set Identifier (SSID)| +|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPassword`
- **Data type:** string
- **Value:** Wi-Fi network password| +|- **OMA-URI:** `./Device/Vendor/MSFT/RemoteRemediation/CloudRemediationSettings/NetworkSettings/NetworkCredentials/NetworkPasswordEncryptionType`
- **Data type:** Integer
- **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`
- **Data type:** string
- **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 + + + + + + + + + + +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 + +> [!NOTE] +> If after reboot the device goes into Windows RE instead of starting test mode, follow these steps: +> +> 1. In Windows RE, select **Continue** to boot Windows normally +> 1. In Windows, execute the two commands: +> +> - `reagentc.exe /Disable` +> - `reagentc.exe /Enable` +> +> 1. Retry the quick machine recovery simulation starting from step 1 + + + +### :::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**. + + + +[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 diff --git a/windows/configuration/toc.yml b/windows/configuration/toc.yml index 7d7497ddca..3905feae74 100644 --- a/windows/configuration/toc.yml +++ b/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 \ No newline at end of file