Skip to content

Commit 3e4669e

Browse files
authored
Merge pull request #160 from GokulGijuMS/docs-editor/mde-plugin-wsl-1714026044
Update proxy instructions and fixing installation indentation(2)
2 parents c322d68 + 30a22f1 commit 3e4669e

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

defender-endpoint/mde-plugin-wsl.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
title: Microsoft Defender for Endpoint plug-in for Windows Subsystem for Linux (WSL)
3-
description: Learn how to set up and use the MDE plugin for Windows Subsystem for Linux
3+
description: Learn how to set up and use the MDE plugin for Windows Subsystem for Linux.
44
author: siosulli
55
ms.author: siosulli
66
manager: deniseb
7-
ms.reviewer: pahuijbr
7+
ms.reviewer: pahuijbr; gokulgiju
88
ms.service: defender-endpoint
99
ms.topic: how-to
1010
ms.localizationpriority: medium
1111
ms.collection:
1212
- m365-security
1313
- tier2
1414
audience: ITPro
15-
ms.date: 04/09/2024
15+
ms.date: 04/25/2024
1616
search.appverid: MET150
17-
1817
---
1918

2019
# Microsoft Defender for Endpoint plug-in for Windows Subsystem for Linux (WSL)
@@ -27,13 +26,13 @@ The Windows Subsystem for Linux (WSL) 2, which replaces the previous version of
2726

2827
Be aware of the following before you start:
2928

30-
1. The plug-in doesn't yet automatically update. When a new plug-in version is released, the new MSI package needs to be applied to perform the update. You can apply the new package by using any tool that deploys software. Updates are coming soon through Microsoft Update. If preferred, you can continue to use the MSI package method.
29+
1. The plug-in doesn't yet automatically update. When a new plug-in version is released, the new MSI package needs to be applied to perform the update. You can apply the new package by using any tool that deploys software. Updates are coming soon through Microsoft Update. If preferred, you can continue to use the MSI package method.
3130

32-
2. As it takes a few minutes for the plug-in to fully instantiate and up to 30 minutes for a WSL2 instance to onboard itself, short-lived WSL container instances might result in the WSL2 instance not showing up in the Microsoft Defender portal ([https://security.microsoft.com](https://security.microsoft.com)). Once a (any) distribution has been running long enough (at least 30 minutes), it does show up.
31+
2. As it takes a few minutes for the plug-in to fully instantiate and up to 30 minutes for a WSL2 instance to onboard itself, short-lived WSL container instances might result in the WSL2 instance not showing up in the Microsoft Defender portal ([https://security.microsoft.com](https://security.microsoft.com)). Once a (any) distribution has been running long enough (at least 30 minutes), it does show up.
3332

34-
3. If you're using a proxy in your (test) environment, make sure that the plug-in is set up to use it correctly. WSL is typically not automatically configured to use a proxy. For more information, see the section, [Setting a proxy for Defender running in WSL](#setting-a-proxy-for-defender-running-in-wsl).
33+
3. If you're using a proxy in your (test) environment, make sure that the plug-in is set up to use it correctly. WSL is typically not automatically configured to use a proxy. For more information, see the section, [Setting a proxy for Defender running in WSL](#setting-a-proxy-for-defender-running-in-wsl).
3534

36-
4. The use of a custom kernel in combination with the plug-in is not supported. When you attempt to launch WSL with the plugin installed, you will encounter the error *A fatal error was returned by plugin 'DefenderforEndpointPlug-in'. Error message: 'Custom Kernel/Configuration not supported.'*.
35+
4. The use of a custom kernel in combination with the plug-in isn't supported. When you attempt to launch WSL with the plugin installed, you'll encounter the error *A fatal error was returned by plugin 'DefenderforEndpointPlug-in'. Error message: 'Custom Kernel/Configuration not supported.'*.
3736

3837
## Software prerequisites
3938

@@ -63,7 +62,7 @@ Components installed:
6362

6463
## Installation steps
6564

66-
If you Windows Subsystem for Linux isn't installed yet, follow these steps:
65+
If your Windows Subsystem for Linux isn't installed yet, follow these steps:
6766

6867
1. Open Terminal or Command Prompt. (In Windows, go to **Start** > **Command Prompt**. Or, right-click the start button and then select **Terminal**.)
6968

@@ -98,7 +97,7 @@ After WSL is running and fully up to date, follow these steps to install the plu
9897

9998
4. Run the command `.\healthcheck.exe`.
10099

101-
5. Review the details of Defender and WSL and make sure they match or exceed the following:
100+
5. Review the details of Defender and WSL and make sure they match or exceed the following requirements:
102101

103102
- **Defender Plug-in Version**: `0.23.1102.4`
104103
- **WSL Version**: `2.0.7.0` or later
@@ -117,15 +116,15 @@ If you want to use the host network and network proxy setting for MDE for WSL pl
117116

118117
## Plug-in Proxy selection
119118

120-
If your host machine contains multiple proxy settings, the plug-in will select the proxy configurations with the following hierarchy
119+
If your host machine contains multiple proxy settings, the plug-in selects the proxy configurations with the following hierarchy:
121120

122-
1. Defender for Endpoint static proxy setting (`TelemetryProxyServer`)
121+
1. Defender for Endpoint static proxy setting (`TelemetryProxyServer`).
123122

124-
2. Winhttp proxy (configured through netsh command)
123+
2. `Winhttp` proxy (configured through `netsh` command).
125124

126-
3. Network & Internet proxy settings
125+
3. Network & Internet proxy settings.
127126

128-
Example: If your host machine as both Winhttp proxy as well as Network & Internet proxy, plug-in will select `Winhttp proxy` as the proxy configuration for plug-in.
127+
Example: If your host machine has both *Winhttp proxy* and *Network & Internet proxy*, the plug-in selects `Winhttp proxy` as the proxy configuration.
129128

130129
## Connectivity test for Defender running in WSL
131130

@@ -135,20 +134,20 @@ The following procedure describes how to confirm that Defender in Endpoint in WS
135134

136135
2. Create a registry key with the following details:
137136

138-
- **Name:** `ConnectivityTest`
139-
- **Type:** `REG_DWORD`
140-
- **Value:** `Number of seconds plug-in must wait before running test. (Recommended: 60 seconds)`
141-
- **Path:** `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Lxss\Plugins\DefenderPlug-in`
137+
- **Name**: `ConnectivityTest`
138+
- **Type**: `REG_DWORD`
139+
- **Value**: `Number of seconds plug-in must wait before running test. (Recommended: 60 seconds)`
140+
- **Path**: `Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Lxss\Plugins\DefenderPlug-in`
142141

143142
3. Once the registry is set, restart wsl using the following steps:
144143

145-
1. Open Command Prompt and run `wsl --shutdown`.
144+
1. Open Command Prompt and run the command, `wsl --shutdown`.
146145

147146
2. Run the command `wsl`.
148147

149148
4. Wait for 5 minutes and then run `healthcheck.exe` (located at `C:\Program Files\Microsoft Defender for Endpoint plug-in for WSL\tools` for the results of the connectivity test).
150149

151-
If successful, the connectivity test shows success.
150+
If successful, you can see that the connectivity test was successful.
152151

153152
> [!NOTE]
154153
> To set a proxy for use in WSL containers (the distributions running on the subsystem), see [Advanced settings configuration in WSL](/windows/wsl/wsl-config).
@@ -270,19 +269,17 @@ DeviceProcessEvents
270269

271270
:::image type="content" source="media/mdeplugin-wsl/wsl-health-check-overview.png" alt-text="Screenshot showing status in PowerShell output." lightbox="media/mdeplugin-wsl/wsl-health-check-overview.png":::
272271

273-
6. Microsoft Defender Endpoint for WSL supports Linux distributions running on WSL 2. If they are associated with WSL 1, you may face issues. Therefore, it is advised to disable WSL 1. To do so with the Intune policy, perform the following steps :
272+
6. Microsoft Defender Endpoint for WSL supports Linux distributions running on WSL 2. If they're associated with WSL 1, you might encounter issues. Therefore, it is advised to disable WSL 1. To do so with the Intune policy, perform the following steps :
274273

275274
1. Navigate to your Microsoft Intune admin center portal.
276275

277-
2. Go to Devices -> Configuration Profiles -> Create -> New Policy.
276+
2. Go to **Devices** > **Configuration Profiles** > **Create** > **New Policy**.
278277

279-
3. Select Windows 10 and later -> Settings catalog.
278+
3. Select **Windows 10 and later** > **Settings catalog**.
280279

281-
4. Create a name for the new profile and search for Windows Subsystem for Linux to see and add the full list of available settings.
280+
4. Create a name for the new profile, and search for **Windows Subsystem for Linux** to see and add the full list of available settings.
282281

283-
5. Set the Allow WSL1 setting to Disabled.
284-
285-
This will ensure only WSL 2 distributions can be used.
282+
5. Set the **Allow WSL1** setting to **Disabled**, to ensure that only WSL 2 distributions can be used.
286283

287284
Alternately, if you want to keep using WSL 1, or not use the Intune Policy, you can selectively associate your installed distributions to run on WSL 2, by running the command in PowerShell:
288285

0 commit comments

Comments
 (0)